PingOne Advanced Identity Cloud

Provision an application

The topics in this section are for tenants created on or after January 12, 2023. Learn more in Application management migration FAQ.

On the Applications page, use the Provisioning tab to set up provisioning and configure the following:

  • Details about the application.

  • Properties in the target application.

  • Data in the target application.

  • Mappings from the Advanced Identity Cloud admin console to the target application.

  • Rules that specify the actions to take when certain reconciliation events occur.

  • Reconciliation to ensure data is synchronized between the Advanced Identity Cloud admin console and the target application.

  • Schedules to run reconciliation of accounts.

  • Privacy and consent for end-user data sharing and synchronization.

  • Provisioning rules to specify actions to take when provisioning between Advanced Identity Cloud and a target application.

  • Advanced Sync to create and manage mappings between an identity profile and an application or between applications.

After you register an application, you can use the Provisioning tab to create and manage connections to a target system like Salesforce.

The object type determines the side tabs that display on the Provisioning tab. Use the object type list to select an object type, such as Group. Afterward, you can configure properties in the different sub-tabs under the Provisioning tab.

Sub-tabs under the Provisioning tab
Provisioning tab Description Related sections

Details

View and manage an application, including name, ID, and native type.

Select the specific application from Provision settings for an application.

Properties

View and manage properties for the selected object type.

Manage application attributes

Data

View data about the selected object type.

View user access data

Mapping

View and manage mappings from the Advanced Identity Cloud admin console properties to external system properties and from external system properties to the Advanced Identity Cloud admin console properties.

Manage mappings

Reconciliation

Preview mappings on target applications between external systems and the Advanced Identity Cloud admin console, and reconcile the data between the two systems.

View and manage rules for the users and groups that use your application.

View and manage schedules for Full and Incremental reconciliation.

Reconcile and synchronize end-user accounts

Privacy & Consent

Manage end-user data sharing and synchronization.

Configure end-user data sharing

Rules

View and manage provisioning rules for mappings between Advanced Identity Cloud and a target application.

Manage provisioning rules

Advanced Sync

Create and manage mappings between an identity profile and an application or between applications.

Manage advanced sync

Provision settings for an application

While the application templates contain the same basic settings, some applications have specific settings that you must configure in the Provisioning tab.

Learn more about accessing built-in connectors through the IDM native admin console in Connectors.

For existing applications that use a deprecated version, there’s no upgrade requirement. You can safely continue using your current version unless notified otherwise. To use a newer application template version, you must create a new application.

Manage application attributes

Properties are the application attributes that Advanced Identity Cloud creates automatically. You can use the Properties tab to view and modify the properties of an account object or group/organization identity that can access your application.

The tab displays the name, identity type, and other information such as multivalued or required, for a property.

Add or edit a property

  1. On the Properties tab, do one of the following:

    • To add a new property, click Add a Property.

    • To edit a property, double-click a property.

  2. In the Name drop-down field, select a property.

  3. In the Type drop-down field, select a property type.

  4. Set one or more of the following options:

    Field Description

    Multi-valued

    Make the property a multi-value property.

    Required

    Make the property a required property.

    User-specific

    Make the property specific to individual users and not roles. If you don’t check this option, the property appears in the role’s relationship page when you add a role to an application.

  5. Optionally, click Show advanced settings to set any of the following options:

    Field Description

    Creatable

    Make the property creatable.

    Readable

    Make the property readable. Required for the property to appear in the Users & Roles tab.

    Updatable

    Make the property updatable.

    Returned by default

    Set the property to be returned by default. Requires the Readable option to be checked.

    Enumerated Values

    A list of allowed values that constrain the values you can set for the property. Supported for string and array type properties.

    To define a list of values for this property:

    1. Beside the Values field, click the plus sign.

    2. In the text field, enter the unique identifier for the value.

    3. In the value field, enter the display text for the value.

    4. To add another value, click the plus sign, and repeat steps 2 and 3 above.

    5. To delete a value, click the negative sign beside a value.

  6. Click Save.

Set a property as user-specific

You can set a property to be for a specific user.

  1. On the Properties tab, click a property.

  2. Enable User-specific.

  3. Click Save.

Set the display order of a property

When you add a new user or role, you specify properties for the identity. You can set the display order of the properties.

  1. In the Provisioning page, under the application name and logo, click the drop-down arrow and select a user or role. For example, select User.

  2. On the Properties tab, to set the order of a property, drag and drop a property up or down to the desired location.

  3. To verify your changes, add a new user or role. For example, on the Users & Roles tab, select Users, and click + Assign Users.

  4. The modal should display the properties in the order that you set.

Delete a property

  1. On the Properties tab, to the right of the property, click the ellipsis (...).

  2. Click Delete.

You cannot undo the delete action.

View user access data

After you successfully connect to the target application, review the Data tab to verify the users and groups/organizations that have access to the application.

Customize columns

  1. In the upper right corner of the Data page, click the horizontal ladder icon.

  2. Select the column types to display.

  3. Click Apply.

End-user data sharing

Users who have accounts in target applications can share their data with other applications. After a preference to share data with other applications has been configured, data from the target applications is synchronized with Advanced Identity Cloud.

Configure end-user data sharing (consent-based provisioning)

  1. In the Advanced Identity Cloud admin console, on the Provisioning tab, click the Privacy & Consent tab.

    Personal Data Sharing option in admin UI

  2. In the Consent-based Provisioning section, click Activate to let end users prevent sharing of their personal data. To remove consent-based provisioning, click Deactivate.

  3. To share only the data of users who have set sharing preferences:

    1. In the Advanced Identity Cloud admin console, go to Hosted Pages and select Realm Default theme.

    2. Go to Account Pages and select Layout.

    3. Enable the Consent option.

    4. Click Save. The end-user profile page now displays the Personal Data Sharing option.

Configure preference-based provisioning

  1. In the Advanced Identity Cloud admin console, on the Provisioning tab, click the Privacy & Consent tab.

  2. In the Preference-based Provisioning section, click Activate to provision only users who have opted in for specified preferences. To remove preference-based provisioning, click Deactivate.

  3. Choose which preferences to enable for end users:

    1. marketing - to send special offers and services

    2. updates - to send news and updates

  4. In the Advanced Identity Cloud admin console, go to Hosted Pages and select Realm Default theme.

  5. Go to Account Pages and select Layout.

  6. Enable the Preferences checkbox.

  7. Click Save. The end-user profile page now displays the communication Preferences section.

    Communication preferences in end-user UI

Manage mappings

The Mapping tab lets you create identity object and attribute mappings between Advanced Identity Cloud and an external system application. You define mappings between a source and a target.

The definition of source and target depends on if you’re provisioning user attributes from Advanced Identity Cloud (source) to an external target application (target) or if you’re reconciling user attributes from an external authoritative application (source) to Advanced Identity Cloud (target).

To avoid inconsistencies between systems, don’t update mappings while a provisioning or reconciliation is in progress.

Create a mapping (provisioning)

  1. In the Advanced Identity Cloud admin console, go to Applications, then select your application, then click the Provisioning tab.

  2. In the left navigation panel, click the Mapping tab.

  3. Click + Add a property to open a mapping configuration modal.

    1. In the list of targets, select an attribute to update in the external target application.

    2. Click Next.

Edit a mapping (provisioning)

  1. In the Advanced Identity Cloud admin console, go to Mappings, then click a mapping to open its configuration modal.

  2. In the list of sources, select an Advanced Identity Cloud attribute to provide a source value.

    This step is optional if you intend to apply a transformation script or a default value.

Create a mapping (authoritative)

If your application is connected to an external authoritative application:

  1. Click + Add a property to open a mapping configuration modal.

  2. In the list of targets, select an Advanced Identity Cloud attribute to update.

  3. Click Next.

Edit a mapping (authoritative)

  1. Click a mapping to open its mapping configuration modal.

  2. In the list of sources, select an attribute from the external authoritative application to provide a source value.

    This step is optional if you intend to apply a transformation script or a default value.

  3. (Optional) Apply a transformation script to the mapping.

  4. (Optional) Apply a conditional update to the mapping.

  5. (Optional) Apply a default value to the mapping.

  6. Click Save to save the mapping and close the mapping configuration modal.

Apply a transformation script to a mapping

You can apply a transformation script to a mapping to compute a target value using a combination of source values and string manipulations. For example, you may want to combine first name and last name attributes into a single name attribute.

  1. Refer to steps 1 - 3 in Create a mapping (provisioning).

  2. In the mapping configuration modal:

    1. Check Apply transformation script.

    2. Insert your transformation script into the Transformation Script editor. Refer to these examples:

    3. (Optional) To use custom global variables in the script, refer to Define custom global variables for a script.

    4. Click Save to save the mapping and close the mapping configuration modal.

Source object behavior

The source object in a transformation script changes depending on what you select from the drop-down list of sources:

  • If you select a source attribute, such as source.name, the source object represents just that attribute. For example, to access name.familyName you would reference source.familyName.

  • If you don’t select a source attribute, the source object represents the entire identity object and its attributes. For example, to access name.familyName you would reference source.name.familyName.

Transformation script example 1

source.name ? source.name.familyName : null ;

In this example, the script checks if a value exists for source.name. If it does, we know source.name is an object and familyName is one of the attributes on that object, so the script sets the field with the value of source.name.familyName. Otherwise, the script sets this field to null.

Transformation script example 2

source.givenName + ' ' + source.sn ;

In this example, the script sets the field to a combination of the given name and surname, with a space in the middle; for example, "Jane Fergus".

Transformation script example 3a

source.active ? 'active' : 'inactive';

In this example, the script checks if the source.active property has any value set. If true, the script sets this field to the string active. Otherwise, the script sets the field to inactive.

Transformation script example 3b

You can configure the previous script slightly differently if you prefer (as described in Source object behavior). If you select source.active from the drop-down list of sources, source.active is represented as source in the transformation script. So the transformation script would be:

source ? 'active' : 'inactive';

Apply a conditional update to a mapping

You can apply a conditional update to a mapping so that the target attribute is only updated when certain conditions evaluate to true.

  1. Refer to steps 1 – 3 in Create a mapping (provisioning).

  2. In the mapping configuration modal:

    1. Click Show advanced settings.

    2. Check Apply conditional update.

    3. Choose one of the following ways to conditionally update the attribute:

      • To use filter fields:

        1. Make sure Filter is selected.

        2. Use the fields to set the conditions that must occur to update the attribute.

          For example, if you want to update the attribute only for users in the United States, select "Country" from the list of attributes, select "is" from the list of operators, and enter "United States" in the open text field:

          mapping conditional update filter fields

      • To use a filter query:

        1. Make sure Filter is selected.

        2. Click Advanced Editor.

          If you build a filter with the filter fields, it is automatically populated as a query filter in the advanced editor.

        3. In the editor, edit the query filter.

          For example, if you want to update the attribute only for users in the United States, enter /object/country eq "United States":

          mapping conditional update filter query

      • To use a script:

        1. Click Script.

        2. In the Conditional Update Script field, modify the script that defines the condition.

          For example, if you want to update the attribute only for users in the United States, enter object.country == "United States":

          mapping conditional update script

        3. (Optional) To use custom global variables in the script, refer to Define custom global variables for a script.

    4. Click Save to save the mapping and close the mapping configuration modal.

Apply a default value to a mapping

You can apply a default value to a mapping. The default value is applied to a target attribute if the result of a mapping (including after any transformation script or conditional update) is a value of null.

  1. Refer to steps 1 - 3 in Create a mapping (provisioning).

  2. In the mapping configuration modal:

    1. Click Show advanced settings.

    2. Check Apply a default if value is null.

    3. Insert your default value into the editor.

    4. Click Save to save the mapping and close the mapping configuration modal window.

Define custom global variables for a script

  1. In the Transformation Script field or the Conditional Update Script field, click + Add Variables.

  2. To specify the variables in a JSON format, check the JSON toggle.

  3. To give the variable a name, enter a name in the Name field.

  4. To give the variable a value, enter a value in the Value field.

  5. To add more global variables for your script, click the plus sign and repeat the previous two steps.

  6. Click Save.

Preview a mapping

Previewing provides an example of how user mapping appears from source to target.

You can preview mappings only in target applications.

  1. In the left navigation panel, click the Mapping tab.

  2. Click Preview.

  3. In the list, choose an end user to preview. The page displays a preview of the target object that will be created when provisioning.

  4. Click Done.

Delete a mapping

  1. In the Advanced Identity Cloud admin console, go to Applications, then select your application, then click the Provisioning tab.

  2. In the left navigation panel, click the Mapping tab.

  3. Click a mapping.

  4. Find the mapping you want to delete and click its ellipsis icon (more_horiz), then click Delete.

  5. In the Delete Mapping? modal, click Delete.

Reconcile and synchronize end-user accounts

A reconciliation operation involves a target system (the system with user account updates) and the Advanced Identity Cloud admin console (the system that receives the updates). For example, a Salesforce application and the Advanced Identity Cloud admin console. Mappings define the relationship between the target system and the Advanced Identity Cloud admin console.

The goal of reconciliation is to ensure synchronization and consistency between the Advanced Identity Cloud admin console and the external system application. Reconciliation uses the details you define in the Mappings tab to determine how to map and update properties.

Running reconciliation syncs end-user account changes, such as new accounts, updated accounts, and deleted accounts from an authoritative application to Advanced Identity Cloud.

Run or schedule a reconciliation

To manually run a reconciliation:

  1. In the Advanced Identity Cloud admin console, go to Applications, select your application, then click the Provisioning tab.

  2. From the Reconciliation drop-down menu, select Reconcile and click Reconcile Now.

To schedule a full or incremental reconciliation:

  1. In the Advanced Identity Cloud admin console, go to Applications, select your application, then click the Provisioning tab.

  2. From the Reconciliation drop-down menu, select Settings.

  3. Click Set Up in the Schedule Jobs section to configure a Full Reconciliation or an Incremental Reconciliation.

Synchronize an identity

You can synchronize an identity in Advanced Identity Cloud with an identity that exists in a target system. To achieve this, Advanced Identity Cloud models the identity in the target system and makes it available for mapping as a series of objects and properties:

Account object

The account object represents the user entity in the target system. Examples of account object properties are name and email.

For example, in a Salesforce application, the account.email object property is mapped to mail in the Advanced Identity Cloud user identity.

Non-account object

Non-account objects represent entities linked to the user entity in the target system. Examples of non-account objects are roles, groups, departments, permissions, and licenses.

For example, in a Salesforce application, the group object property is mapped to the GroupIds field in the Advanced Identity Cloud user identity.

Each templated application in Advanced Identity Cloud contains an account object and may contain one or more non-account objects that are modelled specifically to the target system.

Manually set non-account objects for an account object

After you create certain connectors and run reconciliation, you can start mapping the account object to various non-account objects. These non-account objects are predefined. For more information about connectors with predefined non-account objects, refer to Connectors with predefined non-account objects.

However, connectors for non-authoritative applications, such as a Scripted REST connector, a Scripted Groovy connector, or a Scripted Table connector, don’t have predefined non-account objects. The reason is that these types of connectors can have different non-account objects. These non-account objects are nonpredefined objects.

For connectors for non-authoritative applications, you must manually select the non-account objects that map to specific properties for an account object.

  1. Select the Provisioning tab.

  2. Select the Properties tab.

  3. Edit a property.

  4. On the Edit Property screen, enable Constrain values for this property.

  5. On the Edit Property screen, enable Application Object Type.

  6. In the Select Object Type drop-down field, select a non-account object type to map to the current property.

  7. On the Edit Property screen, enable Entitlement.

  8. Click Save.

Connectors with predefined non-account objects

The following connectors have predefined non-account object types. After creating a connector that is listed in the table and running reconciliation, you can associate the account object in the second column with the non-account objects in the third column.

Connector Account object Predefined non account objects

Active Directory

ldapGroups

Group

Azure AD

  • __roles__

  • memberOf

  • __servicePlanIds__

  • Directory Role

  • Group

  • servicePlan

Google Workspace

  • __ROLES__

  • __GROUPS__

  • __LICENSE_ASSIGNMENTS__

  • Role

  • __GROUP__

  • __LICENSE_ASSIGNMENTS__

LDAP

ldapGroups

Group

Powershell

Dynamic

N/A

Salesforce

  • __PermissionSetIds__

  • __GroupIds__

  • Profile Id

  • UserRoleId

  • FeatureLicenses

  • Permission Set

  • Group

  • Profile

  • UserRole

  • FeatureLicense

SAP SuccessFactors

__GROUP__

Group

SCIM

groups

Group

Sripted Groovy

Dynamic

N/A

Scripted REST

Dynamic

N/A

Sripted SQL

Dynamic

N/A

ServiceNow

  • location

  • costcenter

  • company

  • department

  • group

  • roles

  • location

  • costcenter

  • company

  • department

  • group

  • role

Map target system object properties to Identity Cloud

To ensure all properties that are associated with a user account or role account synchronize during reconciliation, perform the following steps.

  1. If your connector is not predefined, perform the steps in Manually set non-account objects for an account object.

  2. Select the Provisioning tab.

  3. Click Mapping.

  4. Follow steps 3 - 6 in Edit a mapping (authoritative).

Run a reconciliation

Before you perform the following steps, to ensure you synchronize all information for the identity, map all relevant object properties with the identity.

  1. On the Reconciliation > Reconcile tab, click the ellipsis (…​) to the right of a mapping.

  2. Click Reconcile Identity.

  3. Verify the information on the page, and click Reconcile Identity.

  4. After the reconciliation process is complete, click Done.

View a report about the last reconciliation

You can view information about the last reconciliation, such as:

  • The percent of all accounts successfully reconciled.

  • Information about each reconciled account: mapping source, mapping target, attempted action, and the result of the reconciliation.

Before you perform the following steps, make sure you run reconciliation.

  1. On the Reconciliation > Settings tab, click Show advanced settings.

  2. To view a searchable table report of the last reconciliation results, set Persist Associations to true.

    • If set to true, the UI displays a reconciliation report table and a search field that lets you search the table. The table displays below the reconciliation percentage graphic and percentage bars.

    • If set to false, the UI does not display a reconciliation report table.
      To filter the report results, enter text in the Search users field.
      To view different subsets of the report (1-to-1 match / no match), click View and select an item from the drop-down list.

To avoid performance issues for large reconciliation jobs, set Persist Associations to false.

Manage reconciliation schedules

The Schedules section of the Reconciliation > Settings tab lets you view and schedule reconciliation events for accounts or groups/organizations that have access to your application.

You can schedule two types of reconciliation:

  • Full Reconciliation: A process that completely synchronizes the source and target. This process usually happens once a week on a weekend or once a month but at longer intervals. The long intervals are because the synchronization process is very labor-intensive and can take a large amount of time depending on the reconciliation data.

  • Incremental Reconciliation: Also referred to as liveSync, incremental reconciliation is a process that only synchronizes the deltas between the source and target. You can run incremental reconciliation every few minutes to get new updates. For example, if you run an incremental reconciliation at 12:55 PM, then again at 2:00 PM, the Advanced Identity Cloud admin console only looks at the timeframe in between to update, create, or delete data if anything changes in the source or target. Depending on the application, a timestamp or change number is used to synchronize the delta.

You can edit existing schedules and activate or deactivate them.

Set up a full or incremental reconciliation schedule

The initial state of a schedule is inactive.

  1. On the Reconciliation > Settings tab, go to the Schedules section.

  2. Click an inactive schedule: Full Reconciliation or Incremental Reconciliation.

  3. Choose one of the following ways to edit the schedule:

    • Edit the fields on the Set up page and click Save Schedule.

    • To use a text editor to edit the schedule:

      1. Enable the Use cron toggle.

      2. Enter a valid cron string in the Frequency field.

      3. Click Save Schedule.

Deactivate a schedule

  1. On the Reconciliation > Settings tab, go to the Schedules section.

  2. Click an active schedule.

  3. Click Deactivate Schedule.

Manage reconciliation rules

You use rules to define the actions you want Advanced Identity Cloud to perform when certain events occur during reconciliation. For example, if reconciliation detects that an identity object exists in Advanced Identity Cloud but not in the target application, Advanced Identity Cloud creates an identity object in the target application and links it to a source object in Advanced Identity Cloud if both of the following are true:

  • Reconciliation detects that the identity object exists in Advanced Identity Cloud but not in the target application.

  • You select Advanced Identity Cloud to take the action CREATE.

Each rule has an action. Advanced Identity Cloud performs the action when a rule triggers an action to be performed on a record. Advanced Identity Cloud evaluates each record. When an event meets a rule condition, Advanced Identity Cloud performs the action you have defined for that rule.

The Situation Rules section of the Reconciliation > Settings tab displays the name and action of the rules for your application.

Situation (application) rules

Situation rule Description

Ambiguous

The source identity object matches multiple target identity objects based on the defined unique attribute. There must be a one-to-one link between a source and target identity object. can’t accurately make this link due to ambiguity.

Source Missing

For authoritative apps only.

The target identity object links to a missing source. This usually means the source identity object was deleted.

Missing

The source links to a missing target identity object. This usually means the target identity object was deleted.

Found Already Linked

The target identity object is linked to an old source object, usually deleted, and can’t be linked to the new source identity object. This usually the source identity object was deleted and tried to recreate the source object. On reconciliation, Advanced Identity Cloud identified that it already found a source and target identity object linked. For more information on Found Already Linked, refer to the knowledge base article How do I resolve the Found Already Linked situation in Advanced Identity Cloud?.

Unassigned

The reconciliation finds a valid target identity object with no link established. This usually means another reconciliation needs to happen to establish a link (if you set the action to Link).

Unqualified

The source identity object doesn’t qualify, but target identity objects were found.

Link Only

A link is found, but the target identity object is missing. Advanced Identity Cloud had a matching source and target with a link but can no longer find the target identity object.

Confirmed

The ideal situation for a record. The source and target identity objects both exist and a valid link between the two are present. This means the source and target both have a unique identifier that can only match one-to-one, and Advanced Identity Cloud established a link between the two.

Found

A valid source and target identity object match, but there is no link between the two. On a following reconciliation, Advanced Identity Cloud creates a link and the record moves from Found to the Confirmed rule.

Absent

The source identity object doesn’t find a target identity object. This usually means a new record was created on the source, and typically, the action is Create. This creates a target identity object and links the source and target identity object.

Rule action types

When a reconciliation determines the situation of a record, you must specify the action to be taken. There can only be one action per situation rule.

Action Description

Async

An asynchronous process has started. Don’t perform any action or generate any report.

Create

Create a target identity object and link the source and target.

Delete

Delete the target identity object and unlink the source and target.

Exception

Flag the link situation as an exception and log the incident.

Ignore

Don’t change the link or target object state.

Link

Create a link between the source and the correlated target identity object.

No Report

Don’t perform any action or generate any report.

Onboard

Onboard the account and link the correlated target object.

Report

Don’t perform any action but report what would happen if the default action were performed.

Unlink

Unlink the linked target from the source.

Update

Update the target identity object and create a link between source and target.

Configure basic and advanced correlation between accounts

You can correlate the user accounts in an application to user accounts in the Advanced Identity Cloud admin console. This correlation is important because account attributes in the application may have different names than account attributes in the Advanced Identity Cloud admin console.

The Account Correlation section of the Reconciliation > Settings tab lets you choose the attribute(s) to use to match users in your application to users in the Advanced Identity Cloud admin console.

  1. On the Reconciliation > Settings tab, go to the Account Correlation section.

  2. Click Match using.

  3. In the Attribute(s) to Match list, choose the attribute(s) to use to match users in the target system to users in the Advanced Identity Cloud admin console.

  4. To use a query to set or edit match attributes, click Use advanced query.

    • For an authoritative application:

      1. Choose to correlate a user if any or all attributes are matched.

      2. Use the User property field to set the user property(s) to match.

    • For a target application:

      1. Edit the correlation query script.

  5. Click Save.

Manage reconciliation events

Event hooks allow you to set an action that occurs when a specific event happens.

The Event Hooks section of the Reconciliation > Settings tab lets you view and define event hooks for reconciliation events.

Add an event hook

  1. On the Reconciliation > Settings tab, in the Event Hooks section, you can view a table of available event hooks by Name and Script.

    In the Script column, the default state is Not Configured.

    • The event hook workflows include:

      • Account Change Detected

      • Create

      • Update

      • Delete

      • Link

      • Unlink

  2. Click an event hook row or click add Add on the right of an event hook row to open the Add Event Hook modal.

  3. Edit the script for the event hook.

  4. Click Save or Save and Close.

Configure account change detection

To maintain data consistency between a source and target system, you can configure an event hook script to detect account changes during reconciliation. The script allows administrators to perform custom logic in response to unexpected changes in the target application. This response can be to revert the change, email the application owner, log a message, begin a workflow, or another action that the script author chooses because of the change.

  1. In the Event Hooks section of the Reconciliation > Settings tab, click Account Change Detected or add Add to open the Add Event Hook modal.

  2. Add a script and include optional Passed Variables.

    For example:

    // Available bindings
// oldSource = Advanced Identity Cloud’s local version of the account
// source = Remote version of the account
// isLinked
// accountQualifier = default

if (isLinked) { (1)
  // if value has a delta, revert to existing value
  if(oldSource.value !== source.value) { (2)
    source.value = oldSource.value; (3)
    // Overwrite the account
    //source = openidm.update('system/connector-name/User/' + source['_id'], null, source);
  }
}
source; (4)

    Only make direct updates of the source object in the source system, if it’s necessary that the change is reverted immediately after it’s detected. Direct in-memory changes of the source object are preferred.

    If you choose to update the source object directly in the remote system, the state returned by the update must have all of the original fields that the synchronization engine used when it originally queried the source object. These fields are located in the mappings defaultSourceFields.
    1 Only execute if the account is already linked.
    2 Check if the incoming value is different from the existing value.
    3 Revert the incoming value back to the existing value.
    4 Send the modified object back to the sync engine.
    The script expects that the return value is the current state of the source object or account that IDM is using. The script should always return what the author wants the state of the account to be, either by directly changing the bound source object or by returning the result of direct updates to the source object in the source system.

  3. Click Save and Close to set the Script state to Configured.

Restrict reconciliation to specific identities

  1. On the Reconciliation > Settings tab, click Show advanced settings.

  2. Configure the following settings:

    • To restrict reconciliation to specific identities in an application by defining an explicit source query:

      1. Enable Filter Source.

      2. Choose to filter the source if Any or All conditions are met.

      3. Use the remaining fields to define the explicit source query. You can define the query using all the properties available in the target system.

    • To restrict reconciliation to specific identities in Advanced Identity Cloud by defining an explicit target query:

      1. Enable Filter Target.

      2. Choose to filter the target if Any or All conditions are met.

      3. Use the remaining fields to define the explicit target query using all the properties available in Advanced Identity Cloud.

    • To filter the application identities that are included in reconciliation using a script:

      1. Enable Valid Source Script.

      2. Edit the script.

    • To view a searchable table report of the last reconciliation results, set Persist Associations to true. For more information, refer to View a report about the last reconciliation.

    • To filter the Advanced Identity Cloud admin console identities that are included in reconciliation using a script:

      1. Enable Valid Target Script.

      2. Edit the script.

    • To allow correlation of source objects to empty target objects, enable Correlate empty target objects.

    • To prefetch each link in the database before processing each source or target object, enable Prefetch Links.

    • To allow reconciliations from an empty source to delete all data in a target resource, enable Allow reconciliations from an Empty Source.

    • To tune performance by adjusting the number of concurrent threads dedicated to reconciliation, in the Threads Per Reconciliation field, enter the number of concurrent threads.

    • To set the synchronization token used for incremental inbound reconciliation, enter a value in the Sync Token field.

  3. Click Save.

Reset the last reconciliation job

You may need to reset the last reconciliation job if it failed or if it made a change you want to revert; for example, if the last reconciliation job added a new application user.

To reset the last reconciliation job, you must reset the sync token attribute. The sync token attribute stores the value of the last incremental reconciliation job that synced data inbound from a target system to Advanced Identity Cloud.

  1. In your target system, get or create the reset value for the sync token attribute. To understand how to do this, refer to the documentation provided by the vendor of your target system.

  2. In the Advanced Identity Cloud admin console, go to Applications > Provisioning > Reconciliation.

  3. Click the Settings tab.

  4. Scroll down and click Show advanced settings.

  5. In the Sync Token text field, enter a new value for the sync token attribute.

  6. Click Save.

Manage provisioning rules

Provisioning rules define the actions to perform when provisioning between Advanced Identity Cloud and a target application.

The Rules tab displays the action and result for your application.

Rule action types

Rule action types specify the consequence of an action and the related action to perform when an application event occurs.

The application-name placeholder represents the application template name displayed in the Advanced Identity Cloud admin console.
Action Result

application-name application is assigned

Create account in application-name

application-name account is updated

Update account in application-name

application-name account is revoked

Delete account in application-name

Identity is deleted

Delete account in application-name

Provisioning failure

Do nothing

Edit a provisioning rule

Edit a provisioning rule to specify an action to perform in the target application after successfully completing a rule action in Advanced Identity Cloud:

  1. In the Advanced Identity Cloud admin console, go to Applications > Provisioning > Rules, click the ellipsis icon ( ) adjacent to a rule and click Edit or click the row of the rule.

  2. In the Edit Provisioning Rule modal, select the action option to perform on the target application:

    • For application is assigned and account is updated:

      1. Select the Action to perform in application-name when an account is assigned or updated in Advanced Identity Cloud:

        • Create or Update account

        • Do nothing

      2. Select one of the following actions to perform after successfully completing the first action:

      3. Click Save.

    • For account is revoked:

      1. Choose the Action to perform in application-name when an account is revoked in Advanced Identity Cloud:

      2. Click Save.

    • For Identity is deleted:

      1. Choose the Action to perform in application-name when an identity is deleted in Advanced Identity Cloud:

      2. Click Save.

    • For Provisioning failure:

      1. Choose the Action to perform in application-name when provisioning fails:

      2. Click Save.

Manage advanced sync

In addition to the mapping on the Mapping tab, the Advanced Sync tab lets you create as many mappings as you want between your current application object type and another application or identity profile. The data can flow either to or from your current application and object type.

Swap the sync direction depending on if your current application is the source or target. The source and target determine if you’re sending or receiving data from:

  • Application to application

  • Application to identity profile (custom or default)

  • Identity profile (custom or default) to application

Configure advanced sync mappings

For each application, there are different object types, and advanced sync is specific to each object type. For example, an application could have the Account and Group object type.

To create a new Advanced Sync mapping:

  1. In the Advanced Identity Cloud admin console, go to Applications, select your application, then click the Provisioning tab and select an object type for a mapping:

    Select object type

  2. On the Advanced Sync tab, click add Sync Data.

    One half of the mapping is always the current application and the current object type. This half of the mapping can be the source or target. After you’ve created the mapping, you can’t change the source, target, and sync direction.

  3. In the Add Sync Data modal:

    1. Set your source to Sync From an Application and choose from the object types the application supports.

    2. Set your target to Sync To an Application and Object type, or to an Identity Profile.

      By default, you’re syncing from the current application and object type, and you choose to sync to an application and object type, or to an identity profile.

      If you created a custom identity profile through the IDM admin console (native console), it’s available to select in the Identity Profile list. Learn more in Create and modify object types.
      To reverse the sync source and target, click the arrow.

  4. Click Save to add the mapping.

Edit or delete an advanced sync mapping

To edit or delete an advanced sync mapping:

  1. On the Advanced Sync tab, click the ellipsis icon ( ) adjacent to the mapping to edit or delete.

  2. Click Edit or click the row of the mapping to open the Mapping page where you Define the mapping rules and add properties, apply transformation scripts and conditional updates, and configure other advanced settings.

  3. To remove a mapping, click Delete.

Define and preview mapping rules

To define mapping rules to reconcile the source with the target, add a property to the mapping:

  1. On the Mapping tab, click Add a property to open the Add a property modal, then select a target-property-name in the property list.

  2. On the next window of the modal, select a source-property-name (optional) from the property list.

    Selecting a source-property-name is optional if you’re defining a transformation script or adding a default value.

  3. (Optional) Select the Apply transformation script checkbox. Learn more about transformation scripts in Apply a transformation script to a mapping.

  4. (Optional) Click Show advanced settings and select:

    1. (Optional) Apply conditional update. Learn more about conditional updates in Apply a conditional update to the mapping.

    2. (Optional) Apply a default if value is null. Learn more about how to Apply a default value to a mapping.

  5. Click Save.

    If the mapping source is an identity profile, click Preview to view an example of how the mapping displays between the source and target. Learn more in Preview a mapping.

Configure a correlation

The goal of correlation is to avoid creating duplicate records in a target system. If duplicate records are a possibility, you can define a correlation query to try to find a record in the target environment that matches a record in the source environment. If a matching record is found, the query updates the existing record rather than create a new record.

Learn more in Correlate source objects with existing target objects.

To configure the correlation query in advanced sync:

  1. On the Correlation Query tab, click Configure to open the Edit Correlation modal.

  2. View or edit the default correlation query.

  3. Click Save.

    After you’ve saved a correlation, click Edit adjacent to Custom to open the modal and edit the query, if needed.

Correlation best practice

Typically, you choose a unique property to match, such as a username or email. For example, if you have an account/user mapping, you could correlate the email address. If the email field in the target is called Email, and in the source, it’s called mail, in the correlation query, you’d direct Advanced Identity Cloud to look at the Email field it receives from the target and attempt to find a match for the mail field in the source. Depending on the result of the attempted match, Advanced Identity Cloud will take the action specified by the appropriate situation rule.

All situation rules have the Async action by default. A common action for a successful 1:1 match is to link the matched source and target, which means to set the Found situation rule with the Link action. Learn more in Advanced sync situation rules and in Advanced sync rule action types.

Reconciliation

In advanced sync, reconciliation uses the details you define on the Mapping tab to determine how to map and update properties between two systems.

Running reconciliation syncs all data in the source and target systems, not just the data that has changed. Learn more about Source reconciliation and Target reconciliation.

Run a manual reconciliation

When you perform a reconciliation, sets of data between the source and target systems are evaluated based on the defined mapping rules. You can review details about how individual records are evaluated by setting Persist Associations in the Advanced tab to true. Learn more in Reconciliation association details.

To run a manual reconciliation for an advanced sync mapping:

  1. In the Advanced Identity Cloud admin console, go to Applications > Provisioning > Advanced Sync.

  2. On the Advanced Sync tab, click the ellipsis icon ( ) adjacent to the mapping to edit.

  3. Click Edit or click the row of the mapping to open the Mapping page, which opens additional advanced sync options.

  4. On the Reconcile tab, click Reconcile Now to Reconcile your data between source-name and target-name.

Understanding reconciliation results

Advanced Identity Cloud uses the first three mapping rules that have a source and target object defined to display reconciliation results, for example:

  • source.userPrincipalName

  • source.mail

  • source.surname

The target object will always exist in the mapping rule, however, target data might not show in the reconciliation results table.
Reconciliation results table
If there is no data in the first three rows of mapping rules, no data or Not found displays for the reconciliation results. Learn more in View a report about the last reconciliation.
If a mapping contains a transformation script and a target, but no source, the mapping rule won’t be used to display reconciliation results for the source column.

Manage advanced sync schedules

On the Advanced Sync > Schedules tab, create a schedule to Periodically perform a full reconciliation:

  1. Click the Full Reconciliation row or click Set Up adjacent to the Inactive Status column.

    The initial schedule state is inactive.

  2. In the Schedule Full Reconciliation Job modal, manually configure the Frequency and interval or Use cron.

    • To manually schedule a full reconciliation (default):

      1. In the Frequency section:

        1. Enter a value for Run every X day(s). Alternatively, from the day(s) drop-down list, select:

          • hour(s)

          • days(s) (default)

          • week(s)

          • month(s)

        2. (Optional) Select the Set a Start Time checkbox and enter values for:

          • mm/dd/yyyy

          • --:-- -- (time in hours:minutes seconds)

          • Timezone (GMT + 0:00). Learn more in the Time zones chart.

        3. For Repeat, choose one of the following intervals:

          • X times

          • Until specific date

          • Indefinitely

      2. Click Save.

        If you specify a start date and an end date, the time zones must match to create a valid schedule.

    • To schedule a full reconciliation using cron:

      1. Enable the Use cron toggle.

      2. In the Frequency field, Enter a valid cron string.

        An Invalid Cron error displays if the cron string isn’t valid.

      3. Click Save.

Define advanced sync situation rules

Each advanced sync situation rule has an action. Advanced Identity Cloud performs the action when a rule triggers an action to be performed on a record. Advanced Identity Cloud evaluates each record. When an event meets a rule condition, Advanced Identity Cloud performs the action you’ve defined for that rule.

On the Advanced Sync > Situation Rules tab, a table displays the Situation and Action that Define rules for various sync situations.

Advanced sync situation rules

Situation Description

Ambiguous

Source object correlates to multiple target objects, without a link.

Source Missing

Valid target found, link found.

Missing

The source links to a missing target object.

Found Already Linked

Correlation from source points to a target object already linked to a different source.

Unqualified

Source object not qualified, but target objects found.

Unassigned

Valid target found, no link.

Link Only

Link found, target object not found.

Target Ignored

Does not pass validTarget script.

Source Ignored

Does not pass validSource script.

All Gone

Source object removed, link not found, correlation not possible.

Confirmed

Valid source and target objects linked.

Found

Correlation query from source points to one target object.

Absent

Source object has no matching target.

Advanced sync rule action types

When a reconciliation determines the situation of a record, you must specify the action to be taken.

Async is the default action state.
Action Description

Async (default)

An asynchronous process has been started, so do not perform any action or generate any report

Create

Create and link a target object

Delete

Delete and unlink the target object

Unlink

Unlink the linked target object

Exception

Flag the link situation as an exception

Update

Link and update a target object

Ignore

Do not change the link or target object state

Report

Do not perform any action but report what would happen if the default action were performed

No Report

Do not perform any action or generate any report

Edit advanced sync situation rules

To edit the situation rules you’ve defined for advanced sync situations:

  1. On the Situation Rules tab, click the Situation rule to edit or click the ellipsis icon ( ) adjacent to the Situation and Action, then click Edit.

  2. In the Situation Rule modal, in the When situation occurs list, select Perform Action (default) or Execute Script:

    • For Execute Script:

      • Enter your script in the commented code block:

        // Script has access to the following variables:
// source, target, sourceAction, linkQualifier, context, recon
// the recon.actionParam object contains information about the current recon operation.

  3. In the second list for When situation occurs, select an action as described in Advanced sync rule action types.

  4. For advanced settings, click Show advanced settings to display the following options:

    • Restrict situation lets you Specify query filters or add a script to restrict policy actions to a subset of records where situation is applicable.

    • Execute script on action complete lets you Set up a script to execute after your action is complete.

  5. Click Save.

Trigger advanced sync event hooks

Event hooks allow you to Trigger a script or a workflow when specified reconciliation events occur.

On the Event Hooks tab, you can view and define event hooks for reconciliation events.

Add an event hook

  1. On the Event Hooks tab, you can view a table of available event hooks by Name and Script.

    In the Script column, the default state is Not Configured.

    • The event hook workflows include:

      • Account Change Detected (Learn more)

      • Create

      • Update

      • Delete

      • Link

      • Unlink

  2. Click an event hook row or click add Add on the right of an event hook row to open the Add Event Hook modal.

  3. Edit the script for the event hook.

  4. Click Save or Save and Close.

Configure advanced reconciliation settings

In advanced sync, the Advanced tab includes settings to Filter and tune reconciliation to improve performance.

Name Definition

Filter Source

Restrict reconciliation to specific records by defining an explicit source query.

Filter Target

Restrict reconciliation to specific records by defining an explicit target query.

Valid Source Script

Filter the records that are included in reconciliation using a script.

Persist Associations

Record associations between source or target objects to allow UI to show results of last recon.

Valid Target Script

Filter the records that are included in reconciliation using a script.

Correlate empty target objects

Allow correlation of source objects to empty target objects.

Prefetch Links

Prefetch each link in the database before processing each source or target object.

Allow reconciliations from an Empty Source

Allow reconciliations from an empty source to delete all data in a target resource.

Threads Per Reconciliation

Tune performance by adjusting the number of concurrent threads dedicated to reconciliation.

To configure advanced reconciliation settings:

  1. On the Advanced Sync > Advanced tab, configure the following optional settings:

    • (Optional) To restrict reconciliation to specific records in a source by defining an explicit source query:

      1. Enable the Filter Source checkbox.

      2. Choose to filter the source if Any or All conditions are met.

      3. Use the remaining fields to define the explicit source query using all properties available in the source system.

    • (Optional) To restrict reconciliation to specific records in the target by defining an explicit target query:

      1. Enable the Filter Target checkbox.

      2. Choose to filter the target if Any or All conditions are met.

      3. Use the remaining fields to define the explicit target query using all the properties available in the target.

    • (Optional) To filter the records that are included in reconciliation using a script:

      1. Enable the Valid Source Script checkbox.

      2. Edit the script.

    • (Optional) To record associations between source or target objects, which allows the UI to show results of the last reconciliation, set Persist Associations to true. Learn more in View a report about the last reconciliation.

      To avoid performance issues for large reconciliation jobs, set Persist Associations to false. Learn more in Reconciliation association details.

    • (Optional) To filter the target records that are included in reconciliation using a script:

      1. Enable the Valid Target Script checkbox.

      2. Edit the script.

    • (Optional) To allow correlation of source objects to empty target objects, enable the Correlate empty target objects checkbox.

    • (Optional) To prefetch each link in the database before processing each source or target object, enable the Prefetch Links checkbox.

    • (Optional) To allow reconciliations from an empty source to delete all data in a target resource, enable the Allow reconciliations from an Empty Source checkbox.

    • (Optional) To tune performance by adjusting the number of concurrent threads dedicated to reconciliation, in the Threads Per Reconciliation field, enter the number of concurrent threads.

      The default number of Threads Per Reconciliation is 10.

  2. Click Save.

Next steps