Related Topics
The Workflow object is the legacy process model used in early versions of Process Director. BP Logix recommends the use of the Process Timeline object, and not the Workflow object. The Workflow object remains in the product for backwards compatibility, but doesn't receive any new functionality updates, other than required bug fixes. No new features have been added to this object since Process Director v4.5. All new process-based functionality is solely added to the Process Timeline.
AddToWorkflow
This method will add an object to a Workflow instance.
Input Parameters
WFINSTID: The ID of the Workflow Instance.
ID: The ID of the object to add.
Type: ObjectType - The type of object to add.
Group: The optional group name to add the object into.
Returns
WorkflowInstance: The Workflow instance which the call ran (or null if an error occurred).
Authenticate
This method will authenticate web service requests. Call this method prior to other web service calls. It will automatically populate the SOAP header with a validation token that enables subsequent web service calls.
Input Parameters
User: The built-in or Windows UserID to use for the context of all calls.
Password: The password for this UserID.
Returns
Boolean: True if the operation succeeds.
AuthenticateJSON
This method will authenticate web service requests. Call this method prior to other web service calls. The return is a JSON string with the session ID.
Input parameters
User: The built-in or Windows UserID to use for the context of all calls.
Password: The password for this UserID.
Returns
JSON: The Session ID.
Restart
This method will restart an existing Workflow instance WFINSTID at an optional step STID.
Input Parameters
WFINSTID: The ID of the Workflow Instance to restart.
STID: The STEP ID of the STEP in the Workflow definition to restart (optional).
Returns
WorkflowInstance: The Workflow instance which the call restarted, or null if an error prevents execution of the operation.
RunWorkflow
This method will create and run a new Workflow instance and optionally add a Workflow object.
Input Parameters
PID: The Partition ID or Name.
PathName: The full path of the Workflow definition (e.g. /Workflows/My Workflow).
ID: The ID of the object to add.
Type: ObjectType - Place "NotSet" in this field.
Group: The optional group name to add the object into.
InitiatorUID: The optional UID of the Workflow initiator.
Returns
WorkflowInstance: The Workflow instance which was created , or null if an error prevents execution of the operation.
RunWorkflowWithForm
This method will create a new form instance, a new Workflow instance and attach the form.
Input Parameters
PID: The Partition ID or Name.
WorkflowPathName: The full path of the Workflow definition (e.g. /Workflows/My Workflow).
FormPathName: The full path of the form definition (e.g. /Forms/My Form).
FormValues: The list of name/value pairs to set in the new form instance.
SkipDefaultValues: Set to true to skip merging default form values the first time the form is viewed.
Group: The optional group name to add the object into.
InitiatorUID: The optional UID of the Workflow initiator.
Returns
WorkflowInstance: The Workflow instance which was created , or null if an error prevents execution of the operation.
SetContextUID
This method will set the context UID for all future web service calls. For instance, this UID will be used as the current user for running Knowledge Views, permission checking, etc.
Input Parameters
UID: The ID of the user to use for the context of all calls.
Returns
Boolean: True if the operation succeeds.
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
