Start-Workflow
The Start-Workflow webject starts an instance of a Windchill workflow object.
Syntax
<ie:webject name="Start-Workflow" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DELAY_START" data="delay_start"/>
<ie:param name="DESCRIPTION" data="description"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="DUE_IN" data="due_in"/>
<ie:param name="FIELD" data="field"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PRIORITY" data="priority"/>
<ie:param name="PROCESS_NAME" data="process_name"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TEAM_TEMPLATE_NAME" data="team_template_name"/>
<ie:param name="TEMPLATE_NAME" data="template_name"/>
<ie:param name="TEMPLATE_REF" data="template_ref"/>
<ie:param name="UNFORMATED" data="dataType" />
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
TEMPLATE_NAME
|
CONTAINER_REF
|
ATTRIBUTE
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
DESCRIPTOR
|
CONNECTION_ATTEMPT_INTERVAL
|
|
FIELD
|
DELAY_START
|
|
GROUP_FILTER
|
DESCRIPTION
|
|
PASSWD
|
DUE_IN
|
|
REFERENCE_ EXCEPTIONS
|
FORMAT
|
|
TEMPLATE_REF
|
GROUP_OUT
|
|
|
PRIORITY
|
|
|
PROCESS_NAME
|
|
|
REFERENCE_DELIMITER
|
|
|
REFERENCE_OUTPUT_DELIMITER
|
|
|
SESSION_ID
|
|
|
TEAM_TEMPLATE_NAME
|
|
|
UNFORMATTED
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters section in Adapter Webjects Overview. |
CONTAINER_REF
An explicit context reference that can be passed externally using the webject, or it can be deduced from the primary object, if there is one. Otherwise, the default exchange context is used.
DELAY_START
The number of minutes to delay the start of the workflow process. If a value is not specified for this parameter, the workflow process is started immediately. This parameter is optional.
DESCRIPTION
Any information specific to this instance of the workflow process. If a value is not specified for this parameter, the description provided in the activity setting of the workflow process definition is used. This parameter is optional.
DUE_IN
The number of minutes allowed for the completion of the workflow process. The allowed time begins when the workflow actually starts, not necessarily when the webject is invoked. This parameter is optional.
FIELD
An attribute and associated value to be included in the requested operation. The attribute and associated value are separated by an equals sign. For example:
<ie:param name="FIELD" data="source=wt.part.Source.make"/>
The attribute and value are dependent on the object and operation being performed. This parameter is optional. This parameter can have multiple values.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
PRIORITY
The priority setting for the workflow process. If a value is not specified for this parameter, the priority of the process is set to NORMAL. Valid values are locale specific and are in the Priority menu in the Windchill Initiate Workflow page. For English, these values are HIGHEST, HIGH, NORMAL, LOW, and LOWEST. This parameter is optional.
PROCESS_NAME
The name for this instance of the workflow process definition. If a value is not specified for this parameter, the name of the process defaults to the name of the template, as specified in the TEMPLATE_NAME parameter. This parameter is optional.
TEAM_TEMPLATE_NAME
The team template used to create the team for the workflow process. It is set to the default team template unless it is explicitly set through the webject. The CONTAINER_REF parameter defines the context to search for the team template.
TEMPLATE_NAME
The name of the workflow template. This parameter is required.
TEMPLATE_REF
Specifies the workflow process template. If TEMPLATE_NAME is not specified, then TEMPLATE_REF is required. If both are specified, TEMPLATE_NAME takes precedence.
