ProjectBasedRecord

Description

A ProjectBasedRecord is any record from a primary table. It thus represents items that belong to a project and can be transitioned. ProjectBasedRecord objects require a table ID at creation, so they cannot be created with CreateObject(). Use Ext.CreateProjectBasedRecord().

Inheritance

AppRecord->VarRecord->ProjectBasedRecord

Methods

• GetProjectId(): Identify the calling record's project.

  Input: N/A

  Output: N/A

  Return: (long integer) – TS_ID of the calling record's project.

• StartSubmitToProject( project ) (On-premise only): Starts a submit transition for an item using a project ID, project UUID, or project internal name.

  Input: project – Can be project ID, project UUID, or project internal name.

  Return: (bool)

  Note the following:

  • StartSubmitToProjectis not required, script can simply invoke QuickSubmitToProject if all required field values have already been set on the item. StartSubmitToProject will initialize fields as if the transition form has been opened on the end user interface. Fields will respond correctly to GetRequiredFlag.
  • Sets Shell.LastErrorMessage on error (returns false).

  Example:

  var projectRecord = Ext.CreateProjectBasedRecord( projectTableId );
  projectRecord.StartSubmitToProject(projectId);

• FinishSubmitToProject( [ signedUserID, signedUserPwd ] ) (On-premise only): Finishes a submit transition for an item.

  Input: signedUserID, signedUserPwd – If the transition requires user signature, this is a way to provide the signature.

  Return: (bool)

  Note the following:

  • StartSubmitToProject should have been invoked. See notes on StartSubmitToProject.
  • StartSubmitToProject sets the project field on the item, so FinishSubmitToProject does not require the project to be specified.
  • Sets Shell.LastErrorMessage on error (returns false).

  UserID and Pwd required on submit Example:

  projectRecord.SetFieldValue( "title", "My Title");
  projectRecord.FinishSubmitToProject("UserName", "pass");

• QuickSubmitToProject( project [, signedUserID, signedUserPwd ] ) (On-premise only): Identical to FinishSubmitToProject except StartSubmitToProject is not required, and thus, the project must be specified. All field value changes must be in place on the item.

  Input: project – Can be project ID, project UUID, or project internal name.

  Input: signedUserID, signedUserPwd – If the transition requires user signature, this is a way to provide the signature.

  Return: (bool)

  UserID and Pwd not required Example:

  var projectRecord = Ext.CreateProjectBasedRecord(projectTableId);
  projectRecord.SetFieldValue( "title" , "My Title" );
  projectRecord.QuickSubmitToProject( projectID );