do-start-workflow

Starts the workflow specified by workflow-id for the recipient specified by <arg-dn> on the User Application server specified by the URL using credentials specified by ID and <arg-password>. The recipient must be an LDAP format DN of an object in the directory served by the User Application server. The additional arguments to the workflow may be specified by named <arg-string>. You can specify multiple values and delimit them by using a semi-colon(;). Use a backslash (\) to escape the semi-colon(;). The number of the strings and the names used depend on the workflow to be started. There are some names that have special meaning and are available regardless of the workflow being started.

Remark

:InitiatorOverrideDN: The LDAP format DN of the initiator of the workflow, if other than the user used to authenticate.
:CorrelationID: An identifier used to correlate related workflows.

If any type of error occurs while starting the workflow, the error string will be available to the enclosing policy in the local variable named error.do-start-workflow. Otherwise that local variable will be unavailable.

Example

<do-start-workflow id="cn=WorkflowAdmin,o=People" url="http://localhost:8080/IDMProv" workflow-id="CN=ApproveCellPhone,CN=RequestDefs,CN=AppConfig,CN=UserApplication,CN=DriverSet,O=novell" time-out="5000">
  <arg-password>
    <token-named-password name="workflow-admin"/>
  </arg-password>
  <arg-dn>
    <token-parse-dn dest-dn-format="ldap" src-dn-format="qualified-slash">
      <token-xpath expression="@qualified-src-dn"/>
    </token-parse-dn>
  </arg-dn>
  <arg-string name="provider">
    <token-text>ACMEWireless</token-text>
  </arg-string>
  <arg-string name="reason">
    <token-text>new hire</token-text>
  </arg-string>
  <arg-string name="email">
    <token-text>jmiller@acme.com; jack.miller@gmail.com; jackm@outlook.com</token-text>
  </arg-string>
  <arg-string name="text">
    <token-text>one, two, and three\; a, b, and c\; first, second, and third</token-text>
  </arg-string>
</do-start-workflow>

Allowed Content

Element	Description
arg-password	Password argument.
arg-dn	DN argument.
arg-string	String argument.

Attributes

Attribute	Possible Values	Default Value
disabled	true \| false True, if this element is disabled.	false
id	CDATA The LDAP format DN of a user authorized to start workflows on the User Application server. Supports variable expansion.	#REQUIRED
notrace	true \| false True, if this element should not be traced during execution of the policy.	false
time-out	CDATA The number of milliseconds Identity Manager should wait to establish a connection with the User Application server before timing out. Supports variable expansion.	0
url	CDATA The URL of the User Application server where the workflow runs. Supports variable expansion.	#REQUIRED
workflow-id	CDATA The LDAP format DN of the workflow to start. Supports variable expansion.	#REQUIRED

Content Rule

( arg-password , arg-dn, arg-string * )

Parent Elements

Element	Description
actions	Actions that are performed by a <rule>.
arg-actions	Actions argument.