Process Designer

Process Step (getStepByWorkflowId)

This function allows you to determine the step object of the selected step.

Parameter	Type	Description
$workflowId	string	A JobRouter Workflow ID

The function returns a step object. In case of an error a JobRouterException is thrown.

Example:

…

$selectedWorkflowIds = $this->getWorkflowIds();

foreach ($selectedWorkflowIds as $workflowId) {

$step = $this->getStepByWorkflowId($workflowId);

// further actions with the Step object

}

…

Please note: This function is only available for function type Box action.

The Step object has the following methods:

Method	Description
getStep	Retrieve the step number.
getProcessId	Retrieve the processid of the step.
getWorkflowId	Retrieve the workflowid of the step.
getBacklink	Retrieve the workflowid of the previous step.
getPool	Retrieve the pool of the step.
getJobfunction	Retrieve the jobfunction of the step.
getUsername	Retrieve the user of the step.
getDialogName	Retrieve the dialog name.
getIndate	Retrieve the entry date of the step.
getOutdate	Retrieve the outdate of the step.
getEscalationDate	Retrieve the escalation date.
getEscalationTimeStamp	Retrieve the escalation date as timestamp.
isRequest	Returns true, if a question was posed, false otherwise.
isAssigned	Returns true, if the step is assigned to a user or jobfunction, false otherwise.
isAnswer	Returns true, if an answer is given, false otherwise.
isAborted	Returns true, if the step was aborted, false otherwise.
getTableValue	Retrieve a table field value.
getStatus	Retrieve the step status.
isReserved	Returns true, if the step is reserved, false otherwise.
getResubmissionDate	Retrieve the resubmission date.
getPriority	Retrieve the priority of the step.
getProcessName	Retrieve the process name.
getVersion	Retrieve the process version.
getIncidentNumber	Retrieve the process instance number.
getStepId	Retrieve process_step_id.
getSummary	Retrieve the process summary
getNotice	Retrieve the text of a question or assignment.
getNotice2	Retrieve the text of an answer.

Please enable JavaScript to view this site.