The SynchronizationRule resource determines which FIM resources are synchronized to connected systems by the FIM Synchronization Service.
Schema
Copy Code | |
---|---|
<?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="SynchronizationRule"> <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="1" name="ConnectedObjectType"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value=".{0,448}" /> </xs:restriction> </xs:simpleType> </xs:element> <xs:element minOccurs="1" name="ConnectedSystem"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value=".{0,448}" /> </xs:restriction> </xs:simpleType> </xs:element> <xs:element minOccurs="0" name="ConnectedSystemScope" type="xs:string" /> <xs:element minOccurs="1" name="CreateConnectedSystemObject" type="xs:boolean" /> <xs:element minOccurs="1" name="CreateILMObject" type="xs:boolean" /> <xs:element minOccurs="1" name="DisconnectConnectedSystemObject" type="xs:boolean" /> <xs:element minOccurs="0" name="Dependency" type="rm:ReferenceType" /> <xs:element minOccurs="0" name="ExistenceTest" type="rm:TextCollectionType" /> <xs:element minOccurs="1" name="FlowType"> <xs:simpleType> <xs:restriction base="xs:integer" /> </xs:simpleType> </xs:element> <xs:element minOccurs="1" name="ILMObjectType"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value=".{0,448}" /> </xs:restriction> </xs:simpleType> </xs:element> <xs:element minOccurs="0" name="InitialFlow" type="rm:TextCollectionType" /> <xs:element minOccurs="0" name="PersistentFlow" type="rm:TextCollectionType" /> <xs:element minOccurs="0" name="Precedence" type="xs:integer" /> <xs:element minOccurs="1" name="RelationshipCriteria"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value=".{0,448}" /> </xs:restriction> </xs:simpleType> </xs:element> <xs:element minOccurs="0" name="SynchronizationRuleParameters" type="rm:StringCollectionType" /> <xs:element minOccurs="0" name="ManagementAgentID" type="rm:ReferenceType" /> </xs:sequence> </xs:complexType> </xs:schema> |
Properties
The following table lists the properties of the SynchronizationRule resource:
Property | Description |
---|---|
ConnectedObjectType |
Required String property. The resource type on the connected system to which the synchronization rule applies. The String length must be no more than 448 characters. |
ConnectedSystem |
Required String property. The Management Agent name that identifies a connected system the synchronization rule applies to. The String length must be no more than 448 characters. |
ConnectedSystemScope |
Optional String property. Identifies the objects in a connected system that an inbound Synchronization Rule applies to. |
CreateConnectedSystemObject |
Required Boolean property. If true, the matching resource will be created in the connected system if it does not already exist in that system. See RelationshipCriteria. |
CreateILMObject |
Required Boolean property. If true, the matching resource will be created in FIM if it does not already exist. See RelationshipCriteria. |
Dependency |
Optional property. Reference to a SynchronizationRule resource. This is the SynchronizationRule resource that this synchronization rule depends upon. |
DisconnectConnectedSystemObject |
Required Boolean property. If true, resource will be deleted from the connected system if it is removed from FIM. |
ExistenceTest |
Optional multi-valued String property. Each outbound flow within a transformation can be marked as an existence test for the SynchronizationRule. |
FlowType |
Required Integer property. See FlowType Property table. |
ILMObjectType |
Required String property. The FIM resource type that the synchronization rule applies to. The String length must be no more than 448 characters. |
InitialFlow |
Optional multi-valued String property. A series of directional flows between FIM properties and connected system properties. Only executed upon creation of new resource. |
ManagementAgentID |
Optional Reference property set by the FIM Service. It refers to the ma-data resource that corresponds to the connected system specified by the ConnectedSystem property. |
PersistentFlow |
Optional multi-valued String property. Each PersistentFlow element represents a property flow definition. |
Precedence |
Optional Integer property. A number indicating the SynchronizationRule’s precedence compared to all other SynchronizationRule resources for the same connected system. |
RelationshipCriteria |
Required String property. Defines how a relationship between a resource in the FIM and a connected system resource is detected. The String length must be no more than 448 characters. |
SynchronizationRuleParameters |
Optional multi-valued String property. Contains parameters which require values to be provided from the workflow that manages the SynchronizationRule. |
FlowType Property
The following table contains valid values for the FlowType property:
Value | Description |
---|---|
0 |
Indicates a flow that is inbound to FIM only. |
1 |
Indicates a flow that is outbound to connected systems only. |
2 |
Indicates a bi-directional flow. |
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.