W

A "W" or workflow is an object that completely describes a workflow. A workflow consists of tasks, triggers, edges, groups and many other entities.

Instance Methods

getName() → String

Returns the name of the workflow

Returns: String - The workflow's name.

getId() → String

Returns the id that uniquely identifies the workflow within situate.

Returns: String - The workflow's unique ID.

getTimeZone() → String

Returns default time zone.

Returns: String - The workflow's default time zone.

getProtectDelay() → int

Returns protection delay for this workflow. (Not implemented as of 1.11)

Returns: int - The workflow's protect delay

getDaysToKeep() → int

Returns the number of days of logs to keep or a negative value indicating the number of runs to keep.

Returns: int - The log days to keep

getApprovedBy() → String

The user who approved the workflow

Returns: String - The users who approved the workflow.

getTimeApproved() → Date

The time the workflow was approved

Returns: Date - The time the workflow was approved.

getSubmittedBy() → String

The user that submitted the workflow (new or changes)

Returns: String - The user who submitted the workflow.

getTimeSubmitted() → Date

The time the workflow was last submitted for approval.

Returns: Date - The time the workflow was submitted.

getLastRun() → Date

The time the workflow was last executed.

Returns: Date - The time of last execution.

getNextRun() → Date

If scheduled, the time the workflow will run next, assuming nothing interferes with its current scheule and configuration.

Returns: Date - The time the workflow is scheduled to next run.

getLastRunBy() → String

The user who last exeucted the workflow

Returns: String - The user who last executed the workflow.

getCleanup() → int

The number of days this workflow will remain in the unconfirmed state before situate automatically confirms it.

Returns: int - The number of days.

getConfirm() → int

When a workflow exits, it must be confirmed or it will stay in the queue. This function returns how auto-confirmation is configured for the workflow.

Returns: int - One of the values (1 = ON_SUCCESS, 2 = ALWAYS, 3 = NEVER, 4 = ON_FAILURE)

getNotify() → int

Returns when the workflow will execute a notification workflow.

Returns: int - One of the values (1 = ON_SUCCESS, 2 = ALWAYS, 3 = NEVER, 4 = ON_FAILURE)

getNotifyWho() → String

The value of the variable notify.who passed to a child notification workflow.

Returns: String - The value of "who" on the notify tab.

getNotifyWorkflow() → String

The id of the workflow to run to perform notification.

Returns: String - The Id.

getNotifyWorkflowTrigger() → String

The name of the trigger within the notification workflow to call when a notification is performed.

Returns: String - The trigger name.

getKeywords()

An array of strings representing all the keywords associated with this workflow.

getWorkflowDocumentVersion() → int

The version of the workflow document. From time to time new features are added. Each time a feature changes the structure of the workflow document, this value is increased. This value can be useful for determining what level, if any, of backward compatability should be employed.

Returns: int - The document version

getDescription() → String

The description field from the workflow

Returns: String - The description