WorkflowDefinition

The WorkflowDefinition resource represents a FIM workflow. The XOML property contains the definition of the workflow in XML format.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="http://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="http://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="WorkflowDefinition">
    <xs:sequence>
      <xs:element minOccurs="0" name="ObjectID" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="ObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="CreatedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Creator" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="MVObjectID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DeletedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DetectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="DisplayName">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ExpectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ExpirationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Locale">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ResourceTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="ClearRegistration" type="xs:boolean" />
      <xs:element minOccurs="1" name="RequestPhase">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(Authentication|Authorization|Action)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="Rules" type="xs:string" />
      <xs:element minOccurs="0" name="RunOnPolicyUpdate" type="xs:boolean" />
      <xs:element minOccurs="1" name="XOML" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the WorkflowDefinition resource.

Property Description

ClearRegistration

(Temporarily used by password reset. This property will be removed.)

RequestPhase

Required String property. Indicates the phase of request processing in which the workflow will run. Valid values are:

Authentication

Authorization

Action

See Request Processing.

Rules

Optional String property. This is a workflow rule definition.

RunOnPolicyUpdate

Optional Boolean property that can only be set for action workflows (see Request Processing).If this value is true, the workflow will be triggered in the following additional ways:

  1. When it is added to a "Set Transition" ManagementPolicyRule, it will be applied to all members of the ResourceFinalSet of the ManagementPolicyRule.

  2. When the ResourceFinalSet of a "Set Transition" ManagementPolicyRule that this workflow is mapped to is modified to reference a different set, this workflow will be applied to all members of the new ResourceFinalSet.

  3. When the ResourceFinalSet of a "Set Transition" ManagementPolicyRule that this workflow is mapped to has its Filter property or ExplicitMember property modified, this workflow will be applied to all members entering the ResourceFinalSet.

    For more information about "Set Transition" ManagementPolicyRule resources, see ManagementPolicyRuleType Property.

XOML

Required String property. Stores the definition of the workflow in XML format.

Parent Elements

None

Remarks

All of the resource types in FIM have the same attribute bindings as the Resource type by default. For more information, see Forefront Identity Manager Schema.

See Also

Concepts

How to: Retrieve the FIM Service Schema Using WS-MetadataExchange

Other Resources

Forefront Identity Manager Schema