The WorkflowStep class allows access to the according object type of DOCUMENTS. More...

Public Member Functions
boolean	forwardFile (String controlFlowId, String comment="")
	Forward the file to its next WorkflowStep. More...

String	getAttribute (String attribute)
	Get the String value of an attribute of the WorkflowStep. More...

ControlFlowIterator	getControlFlows ()
	Retrieve an iterator representing a list of all outgoing ControlFlows of the WorkflowStep. More...

String	getLastError ()
	Function to get the description of the last error that occurred. More...

String	getOID (boolean oidLow=false)
	Returns the object-id. More...

String	getWorkflowName ()
	Retrieve the name of the workflow, the WorkflowStep belongs to. More...

String	getWorkflowProperty (String propertyName)
	Retrieve a property value of the workflow action, the WorkflowStep belongs to. More...

String	getWorkflowVersion ()
	Retrieve the version number of the workflow, the WorkflowStep belongs to. More...

boolean	setAttribute (String attribute, String value)
	Set the String value of an attribute of the WorkflowStep to the desired value. More...

boolean	setNewExecutiveGroup (String accessProfileName)
	Reassign the current WorkflowStep object to the given user group. More...

boolean	setNewExecutiveUser (String loginUser)
	Reassigns the current WorkflowStep object to the given user. More...

Public Attributes
String	executiveGroup
	String value containing the locking user group of the WorkflowStep. More...

String	executiveType
	String value containing the type of recipient of the WorkflowStep. More...

String	executiveUser
	String value containing the locking user of the WorkflowStep. More...

String	firstControlFlow
	String value containing the unique internal ID of the first outgoing ControlFlow. More...

String	id
	String value containing the unique internal ID of the WorkflowStep. More...

String	name
	String value containing the technical name of the WorkflowStep. More...

String	status
	String value containing the status of the WorkflowStep. More...

String	templateId
	String value containing the unique internal ID of the Workflow template. More...

Detailed Description

The WorkflowStep class allows access to the according object type of DOCUMENTS.

You may access WorkflowStep objects by the different methods described in the DocFile chapter.

Note: This class and all of its methods and attributes require a full workflow engine license, it does not work with pure submission lists.

Member Function Documentation

◆ forwardFile()

boolean WorkflowStep::forwardFile	(	String	controlFlowId,
		String	comment = `""`
	)

Forward the file to its next WorkflowStep.

This requires the internal ID (as a String value) of the ControlFlow you want the file to pass through. The optional comment parameter will be stored as a comment in the file's monitor.

Parameters

controlFlowId	String value containing the internal ID of the ControlFlow you want to pass through.
comment	optional String value containing your desired comment for the file's monitor.

Returns: true if successful, false in case of any error

Note: This function requires a full workflow engine license, it does not work with pure submission lists.
The current user's permissions are not checked when using this function!

Since: ELC 3.50e / otrisPORTAL 5.0e

◆ getAttribute()

String WorkflowStep::getAttribute ( String attribute )

Get the String value of an attribute of the WorkflowStep.

Parameters

attribute String containing the name of the desired attribute

Returns: String containing the value of the desired attribute

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: ELC 3.51e / otrisPORTAL 5.1e

◆ getControlFlows()

ControlFlowIterator WorkflowStep::getControlFlows ( )

Retrieve an iterator representing a list of all outgoing ControlFlows of the WorkflowStep.

Returns: ControlFlowIterator containing the outgoing ControlFlows of the current WorkflowStep object.

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: ELC 3.51e / otrisPORTAL 5.1e

◆ getLastError()

String WorkflowStep::getLastError ( )

Function to get the description of the last error that occurred.

Returns: Text of the last error as String

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: ELC 3.50 / otrisPORTAL 5.0

See also: DocFile.getLastError()

◆ getOID()

String WorkflowStep::getOID ( boolean oidLow = false )

Returns the object-id.

Parameters

oidLow Optional flag:
If true only the id of the WorkflowStep object (m_oid) will be returned.
If false the id of the WorkflowStep object will be returned together with the id of the corresponding class in the form class-id:m_oid.
The default value is false.

Returns: String with object-id

Since: ELC 3.60c / otrisPORTAL 6.0c; DOCUMENTS 5.0 (new parameter oidLow)

◆ getWorkflowName()

String WorkflowStep::getWorkflowName ( )

Retrieve the name of the workflow, the WorkflowStep belongs to.

Returns: String containing the workflow name

Note: This function is only available for workflows, but not submission lists.

Since: ELC 3.60d / otrisPORTAL 6.0d

See also: WorkflowStep.getWorkflowVersion()

◆ getWorkflowProperty()

String WorkflowStep::getWorkflowProperty ( String propertyName )

Retrieve a property value of the workflow action, the WorkflowStep belongs to.

Parameters

propertyName String containing the name of the desired property

Returns: String containing the property value

Note: This function is only available for workflows, but not submission lists.

Since: DOCUMENTS 4.0a

◆ getWorkflowVersion()

String WorkflowStep::getWorkflowVersion ( )

Retrieve the version number of the workflow, the WorkflowStep belongs to.

Returns: String containing the workflow version number

Note: This function is only available for workflows, but not submission lists.

Since: ELC 3.60d / otrisPORTAL 6.0d

See also: WorkflowStep.getWorkflowName()

◆ setAttribute()

boolean WorkflowStep::setAttribute	(	String	attribute,
		String	value
	)

Set the String value of an attribute of the WorkflowStep to the desired value.

Parameters

attribute	String containing the name of the desired attribute
value	String containing the desired value of the attribute

Returns: true if successful, false in case of any error

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: ELC 3.51e / otrisPORTAL 5.1e

◆ setNewExecutiveGroup()

boolean WorkflowStep::setNewExecutiveGroup ( String accessProfileName )

Reassign the current WorkflowStep object to the given user group.

Parameters

accessProfileName String containing the technical name of the access profile.

Returns: true if successful, false in case of any error.

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: DOCUMENTS 4.0c

Example:: var f = context.file;
var step = f.getCurrentWorkflowStep();
if (!step)
step = f.getFirstLockingWorkflowStep();
if (!step)
util.out("File is not in a workflow.");
if (!step.setNewExecutiveGroup("AccessProfile1"))
util.out(step.getLastError());

◆ setNewExecutiveUser()

boolean WorkflowStep::setNewExecutiveUser ( String loginUser )

Reassigns the current WorkflowStep object to the given user.

Parameters

loginUser String containing the login name of the desired user.

Returns: true if successful, false in case of any error

Note: This function requires a full workflow engine license, it does not work with pure submission lists.

Since: ELC 3.50e / otrisPORTAL 5.0e

Member Data Documentation

◆ executiveGroup

String WorkflowStep::executiveGroup

String value containing the locking user group of the WorkflowStep.

Returns: String value containing the WorkflowStep's locking user group.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: DOCUMENTS 4.0c

◆ executiveType

String WorkflowStep::executiveType

String value containing the type of recipient of the WorkflowStep.

Returns: String value containing the type of recipient.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ executiveUser

String WorkflowStep::executiveUser

String value containing the locking user of the WorkflowStep.

Returns: String value containing the WorkflowStep's locking user.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ firstControlFlow

String WorkflowStep::firstControlFlow

String value containing the unique internal ID of the first outgoing ControlFlow.

Returns: String value containing the first outgoing ControlFlow's unique ID.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ id

String WorkflowStep::id

String value containing the unique internal ID of the WorkflowStep.

Returns: String value containing the unique WorkflowStep ID.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ name

String WorkflowStep::name

String value containing the technical name of the WorkflowStep.

Returns: String value containing the WorkflowStep's technical name.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ status

String WorkflowStep::status

String value containing the status of the WorkflowStep.

Returns: String value containing the WorkflowStep's status.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

◆ templateId

String WorkflowStep::templateId

String value containing the unique internal ID of the Workflow template.

Returns: String value containing the unique Workflow template ID.

Note: This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since: ELC 3.50 / otrisPORTAL 5.0

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ forwardFile()

◆ getAttribute()

◆ getControlFlows()

◆ getLastError()

◆ getOID()

◆ getWorkflowName()

◆ getWorkflowProperty()

◆ getWorkflowVersion()

◆ setAttribute()

◆ setNewExecutiveGroup()

◆ setNewExecutiveUser()

Member Data Documentation

◆ executiveGroup

◆ executiveType

◆ executiveUser

◆ firstControlFlow

◆ id

◆ name

◆ status

◆ templateId