VarRecord StartTransition() Method

(SBM On-Premise/PaaS only) Starts a transition on an item.

Function Signature

 bool StartTransition( trans [, bool stealLock ] )

Parameters

Parameter	Type	Description
trans	Variant	Can be transition ID, 0 (will use default Update transition for item), transition UUID, or transition internal name.
stealLock	bool	Optional. If true, any item lock on this item will be stolen by this transition. If it was locked, the user who had the item locked (in transition) will not be able to complete their transition. Does not guarantee that the transition succeeds, as scripts can steal locks from each other.

Return

Type	Description
bool	Returns true if transition was started. If false, use Shell.GetLastErrorMessage() for more information.

Technical Details

SBM ModScript version: 11.3.

Example

var varRecord = Ext.CreateVarRecord( tableId );
var read =  varRecord.Read( itemTitle );
if ( !varRecord.StartTransition( transitionId )){
  // write an error to Active Diagnostics
  ADLog.Message( __FILE__, __LINE__, ADLogLevelConstants.ERROR, 
    "StartTransition failed:\n" + Shell.GetLastErrorMessage() );
  ExitScript();
}

Notes

VarRecord must have been read before invoking this function.
StartTransition() is not required, script can simply invoke QuickTransition() if all required field values have already been set on the item. StartTransition() 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).
Locks item, use AppRecord.Unlock() if you do not wish to complete the transition. Re-read item to get it re-initialized if transition is not desired to be completed.

VarRecord StartTransition() Method

Function Signature

Parameters

Return

Technical Details

Example

Notes

Related Topics