Profile.TargetDomain
These functions are used to gather or set values based on settings within the selected template and the Stage Data step of a workflow. Some functions will simply return a value and others will return a computed value based on which setting was selected. For example, Profile.TargetDomain returns a computed value which is a domain in the format of redfishhotels.com where getdn(CN) returns a complete value adding the source CN to the Target OU within the Stage Data setting. These functions all begin with uppercase letters to differentiate them from other functions.
-
Purpose: This profile setting will return the domain selected in the UI below during the configuration of the Stage Data step in a workflow. It will apply to the mapping template selected within the Stage Data Step.
-
Syntax: Profile.TargetDomain or P.TargetDomain
-
Location: The Stage Data Step of a workflow for Local and Cloud Environments
-
Based on the above the use of Profile.TargetDomain or P.TargetDomain will result in a value of "TwoFishHotels.com"
-
Purpose: This profile setting refers to the Default password set in the template used within a Stage Data step of a workflow and is used to encode a password so that it can be applied to newly created objects in AD
-
Syntax: Profile.DefaultPassword or P.DefaultPassword
-
Location: The Template Settings for Local and Cloud environments
-
Based on the above the use of Profile.DefaultPassword or P.DefaultPassword would return the value entered and masked by the *’s. It will not be encoded, but rather be in plain text.
-
Purpose: This function works like a profile setting where it returns the behavior defined within the template. Further details of this function can be found in the function section of this document.
-
Syntax: AllowTargetAddress()
-
Location: This profile setting refers to the setting selected by the user for targetAddress within the template.
-
The allow target address function is used as a condition and should ONLY be used on the targetAddress attribute. The product will determine the correct course of action based on the selection in the settings. This setting can be ignored if you remove AllowTargetAddress() from the condition on the default mapping of the targetAddress.
-
Purpose: Calculate target group type based on profile settings and the source or target object's group type
-
Syntax: GetGroupType()
-
Location: In the template under Objects – Groups. The possible setting values vary based on the target environment type.
-
GetGroupType() will look at the setting to determine what group type to create in the target. If the target environment is a local Active Directory, it will determine if it should convert the group to another type, skip it, or create it as-is. If the target environment is Microsoft Entra ID, it will look at the options allowed to determine how you would like the group created.
-
Purpose: Calculate the target DN value using the given cn value and the value of the target DN
-
Syntax: GetDN(cn)
-
Location: The default domain
-
Based on the above selection and a user with the source CN of john.smith, the DN of the user would be calculated as CN=john.smith,OU=CW-Test,DC=redfishhotels,DC=com
-
Purpose: Calculates UserAccountControl value based on profile settings. Applies to Local AD target only. If the source is a Cloud object, it will read the AccountDisabled Flag and set the object in AD to match the value.
-
Syntax: GetUserAccountControl()
-
Location: This setting can be in the template under Objects-Users
-
When using this function only 3 settings from about apply. Enabled, Disabled, and As-Is. The value of UserAccountControl will be set to 512, or 514 based on the values for enabled/disabled, or as it is existing in the source.
Profile.DefaultPassword
These functions are used to gather or set values based on settings within the selected template and the Stage Data step of a workflow. Some functions will simply return a value and others will return a computed value based on which setting was selected. For example, Profile.TargetDomain returns a computed value which is a domain in the format of redfishhotels.com where getdn(CN) returns a complete value adding the source CN to the Target OU within the Stage Data setting. These functions all begin with uppercase letters to differentiate them from other functions.
-
Purpose: This profile setting will return the domain selected in the UI below during the configuration of the Stage Data step in a workflow. It will apply to the mapping template selected within the Stage Data Step.
-
Syntax: Profile.TargetDomain or P.TargetDomain
-
Location: The Stage Data Step of a workflow for Local and Cloud Environments
-
Based on the above the use of Profile.TargetDomain or P.TargetDomain will result in a value of "TwoFishHotels.com"
-
Purpose: This profile setting refers to the Default password set in the template used within a Stage Data step of a workflow and is used to encode a password so that it can be applied to newly created objects in AD
-
Syntax: Profile.DefaultPassword or P.DefaultPassword
-
Location: The Template Settings for Local and Cloud environments
-
Based on the above the use of Profile.DefaultPassword or P.DefaultPassword would return the value entered and masked by the *’s. It will not be encoded, but rather be in plain text.
-
Purpose: This function works like a profile setting where it returns the behavior defined within the template. Further details of this function can be found in the function section of this document.
-
Syntax: AllowTargetAddress()
-
Location: This profile setting refers to the setting selected by the user for targetAddress within the template.
-
The allow target address function is used as a condition and should ONLY be used on the targetAddress attribute. The product will determine the correct course of action based on the selection in the settings. This setting can be ignored if you remove AllowTargetAddress() from the condition on the default mapping of the targetAddress.
-
Purpose: Calculate target group type based on profile settings and the source or target object's group type
-
Syntax: GetGroupType()
-
Location: In the template under Objects – Groups. The possible setting values vary based on the target environment type.
-
GetGroupType() will look at the setting to determine what group type to create in the target. If the target environment is a local Active Directory, it will determine if it should convert the group to another type, skip it, or create it as-is. If the target environment is Microsoft Entra ID, it will look at the options allowed to determine how you would like the group created.
-
Purpose: Calculate the target DN value using the given cn value and the value of the target DN
-
Syntax: GetDN(cn)
-
Location: The default domain
-
Based on the above selection and a user with the source CN of john.smith, the DN of the user would be calculated as CN=john.smith,OU=CW-Test,DC=redfishhotels,DC=com
-
Purpose: Calculates UserAccountControl value based on profile settings. Applies to Local AD target only. If the source is a Cloud object, it will read the AccountDisabled Flag and set the object in AD to match the value.
-
Syntax: GetUserAccountControl()
-
Location: This setting can be in the template under Objects-Users
-
When using this function only 3 settings from about apply. Enabled, Disabled, and As-Is. The value of UserAccountControl will be set to 512, or 514 based on the values for enabled/disabled, or as it is existing in the source.
AllowTargetAddress
These functions are used to gather or set values based on settings within the selected template and the Stage Data step of a workflow. Some functions will simply return a value and others will return a computed value based on which setting was selected. For example, Profile.TargetDomain returns a computed value which is a domain in the format of redfishhotels.com where getdn(CN) returns a complete value adding the source CN to the Target OU within the Stage Data setting. These functions all begin with uppercase letters to differentiate them from other functions.
-
Purpose: This profile setting will return the domain selected in the UI below during the configuration of the Stage Data step in a workflow. It will apply to the mapping template selected within the Stage Data Step.
-
Syntax: Profile.TargetDomain or P.TargetDomain
-
Location: The Stage Data Step of a workflow for Local and Cloud Environments
-
Based on the above the use of Profile.TargetDomain or P.TargetDomain will result in a value of "TwoFishHotels.com"
-
Purpose: This profile setting refers to the Default password set in the template used within a Stage Data step of a workflow and is used to encode a password so that it can be applied to newly created objects in AD
-
Syntax: Profile.DefaultPassword or P.DefaultPassword
-
Location: The Template Settings for Local and Cloud environments
-
Based on the above the use of Profile.DefaultPassword or P.DefaultPassword would return the value entered and masked by the *’s. It will not be encoded, but rather be in plain text.
-
Purpose: This function works like a profile setting where it returns the behavior defined within the template. Further details of this function can be found in the function section of this document.
-
Syntax: AllowTargetAddress()
-
Location: This profile setting refers to the setting selected by the user for targetAddress within the template.
-
The allow target address function is used as a condition and should ONLY be used on the targetAddress attribute. The product will determine the correct course of action based on the selection in the settings. This setting can be ignored if you remove AllowTargetAddress() from the condition on the default mapping of the targetAddress.
-
Purpose: Calculate target group type based on profile settings and the source or target object's group type
-
Syntax: GetGroupType()
-
Location: In the template under Objects – Groups. The possible setting values vary based on the target environment type.
-
GetGroupType() will look at the setting to determine what group type to create in the target. If the target environment is a local Active Directory, it will determine if it should convert the group to another type, skip it, or create it as-is. If the target environment is Microsoft Entra ID, it will look at the options allowed to determine how you would like the group created.
-
Purpose: Calculate the target DN value using the given cn value and the value of the target DN
-
Syntax: GetDN(cn)
-
Location: The default domain
-
Based on the above selection and a user with the source CN of john.smith, the DN of the user would be calculated as CN=john.smith,OU=CW-Test,DC=redfishhotels,DC=com
-
Purpose: Calculates UserAccountControl value based on profile settings. Applies to Local AD target only. If the source is a Cloud object, it will read the AccountDisabled Flag and set the object in AD to match the value.
-
Syntax: GetUserAccountControl()
-
Location: This setting can be in the template under Objects-Users
-
When using this function only 3 settings from about apply. Enabled, Disabled, and As-Is. The value of UserAccountControl will be set to 512, or 514 based on the values for enabled/disabled, or as it is existing in the source.
GetGroupType
These functions are used to gather or set values based on settings within the selected template and the Stage Data step of a workflow. Some functions will simply return a value and others will return a computed value based on which setting was selected. For example, Profile.TargetDomain returns a computed value which is a domain in the format of redfishhotels.com where getdn(CN) returns a complete value adding the source CN to the Target OU within the Stage Data setting. These functions all begin with uppercase letters to differentiate them from other functions.
-
Purpose: This profile setting will return the domain selected in the UI below during the configuration of the Stage Data step in a workflow. It will apply to the mapping template selected within the Stage Data Step.
-
Syntax: Profile.TargetDomain or P.TargetDomain
-
Location: The Stage Data Step of a workflow for Local and Cloud Environments
-
Based on the above the use of Profile.TargetDomain or P.TargetDomain will result in a value of "TwoFishHotels.com"
-
Purpose: This profile setting refers to the Default password set in the template used within a Stage Data step of a workflow and is used to encode a password so that it can be applied to newly created objects in AD
-
Syntax: Profile.DefaultPassword or P.DefaultPassword
-
Location: The Template Settings for Local and Cloud environments
-
Based on the above the use of Profile.DefaultPassword or P.DefaultPassword would return the value entered and masked by the *’s. It will not be encoded, but rather be in plain text.
-
Purpose: This function works like a profile setting where it returns the behavior defined within the template. Further details of this function can be found in the function section of this document.
-
Syntax: AllowTargetAddress()
-
Location: This profile setting refers to the setting selected by the user for targetAddress within the template.
-
The allow target address function is used as a condition and should ONLY be used on the targetAddress attribute. The product will determine the correct course of action based on the selection in the settings. This setting can be ignored if you remove AllowTargetAddress() from the condition on the default mapping of the targetAddress.
-
Purpose: Calculate target group type based on profile settings and the source or target object's group type
-
Syntax: GetGroupType()
-
Location: In the template under Objects – Groups. The possible setting values vary based on the target environment type.
-
GetGroupType() will look at the setting to determine what group type to create in the target. If the target environment is a local Active Directory, it will determine if it should convert the group to another type, skip it, or create it as-is. If the target environment is Microsoft Entra ID, it will look at the options allowed to determine how you would like the group created.
-
Purpose: Calculate the target DN value using the given cn value and the value of the target DN
-
Syntax: GetDN(cn)
-
Location: The default domain
-
Based on the above selection and a user with the source CN of john.smith, the DN of the user would be calculated as CN=john.smith,OU=CW-Test,DC=redfishhotels,DC=com
-
Purpose: Calculates UserAccountControl value based on profile settings. Applies to Local AD target only. If the source is a Cloud object, it will read the AccountDisabled Flag and set the object in AD to match the value.
-
Syntax: GetUserAccountControl()
-
Location: This setting can be in the template under Objects-Users
-
When using this function only 3 settings from about apply. Enabled, Disabled, and As-Is. The value of UserAccountControl will be set to 512, or 514 based on the values for enabled/disabled, or as it is existing in the source.