You can use the WorkflowStep type script operations to
create, delete, modify, and retrieve workflow step information.
getEditableAttributeGroups script operation
Gets the editable attribute groups of a workflow step. The result is an array attribute collection names. The optional parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'.
getLocationHierarchyNames script operation
Returns the list of location hierarchy
names defined in the given workflow step. The optional parameter canModifyAvailability
filters the list of location hierarchy names based on the 'modify location
hierarchy availability' flag. If not specified, no filtering takes place.
getModifyLocationHierarchyAvailability script operation
Returns the 'modify location hierarchy
availability' flag for a given location hierarchy in the given workflow step.
The optional parameter locationHierarchyName is required when
the subViewType is 'ITEM_LOCATION'.
getRequiredAttributeGroups script operation
Gets the required attribute groups of a workflow step. The result is an array of attribute collection names. The optional parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'.
getViewableAttributeGroups script operation
Gets the viewable attribute groups of a workflow step. The result is an array attribute collection names. The optional parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'.
getWflStepTimeoutDuration script operation
Gets the timeout duration for the workflow step. Returns an integer in seconds. If no timeout duration was set, 0 is returned.
getWflStepView script operation
Returns a ctg view with a given subViewType for the given workflow step. The parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'.
mapWflStepExitValueToNextStep script operation
Maps the exit value of the WorkflowStep
to the nextStep. The nextStep can either be the stepName or one WorkflowStep
or an array of StepNames or an array of WorkflowSteps.
setEditableAttributeGroups script operation
Sets the editable attribute groups for the workflow step for a given subViewType. The parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'. WorflowStep cannot be of type "SUCCESS", as it is hardwired that an Entry must validate against its Container Spec in order to leave the Success step.
setRequiredAttributeGroups script operation
Sets the required attribute groups for the workflow step for a given subViewType. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'. WorflowStep cannot be of type "SUCCESS", as it is hardwired that an Entry must validate against its Container Spec in order to leave the Success step.
setViewableAttributeGroups script operation
Sets the viewable attribute groups for the workflow step for a given subViewType. The parameter subViewType can be 'ITEM_LOCATION', 'BULK_EDIT', 'ITEM_EDIT', 'CATEGORY_EDIT', or 'CATEGORY_BULK_EDIT'. The optional parameter locationHierarchyName is required when the subViewType is 'ITEM_LOCATION'. WorflowStep cannot be of type "SUCCESS", as it is hardwired that an Entry must validate against its Container Spec in order to leave the Success step.
setWflStepEntryNotification script operation
Sets up the notification e-mails which
will get sent when the item gets into the step. Email addresses must be separated
by semicolons.
setWflStepScriptPath script operation
Sets up the workflow script path for
this step. If no argument is passed, the default location is used (script/(workflow
name)/(step name)). Note that this operation does not check that
the script is already loaded (it allows you to load the script later if needed).
setWflStepTimeoutDate script operation
Sets up the timeout date for the workflow step. This is a date which, when reached, causes the workflow step to timeout.
setWflStepTimeoutDuration script operation
Sets the timeout duration for the workflow step. The duration is in seconds and is the period that an item may remain in a workflow step before being timed out.