Updated on 2024-12-30 GMT+08:00

Object Models

Object models, including the application account model and application organization model, are the basis for synchronizing data from OneAccess to downstream applications.

After synchronization is enabled, common attributes such as the account name, name, and application organization are defined by OneAccess. To synchronize more attributes, add attributes and configure mappings through the object model. The added attribute name must be the same as that of the application. In addition, You can set the status of an application account or organization after the system user or organization is deleted or disabled.

Application Accounts

  • Attributes
    1. Log in to the administrator portal.
    2. On the top navigation bar, choose Resources > Applications.
    3. On the displayed page, click an application name to access the application details page.
    4. Click the application icon to access the general information page.
    5. In the navigation pane on the left, choose Object Models > Application Accounts. On the displayed Attributes tab page, click Add, configure the application account attribute, and click Save.

      Table 1 Attribute parameters

      Parameter

      Description

      * Attribute

      Attribute name of an application account.

      * Label

      Identifier of an attribute. It is recommended that the value of this parameter be matched with that of Attribute.

      Description

      Description of Attribute.

      * Attribute Type

      Type of an attribute. You can select a value from the drop-down list box.

      Format

      This parameter specifies the text format. It is required only when Attribute Type is set to Text.

      Required

      If this option is selected, the attribute must be set when user data is synchronized to the application. If the attribute is left empty, a message will be displayed, indicating that label is mandatory.

      Unique

      It is required only when Attribute Type is set to Text. If this option is selected, the attribute value must be unique when user data is synchronized to the application. If the attribute value is duplicate, a message is displayed, indicating that the label already exists.

      Sensitive

      It is required only when Attribute Type is set to Text. If this option is selected, the data is hidden when user data is synchronized to the application. You can click to check the data.

    6. You can click Modify or Delete in the Operation column on the right to edit or delete an attribute. Built-in attributes cannot be deleted.
  • Mappings
    Go to the Mappings tab page, click Modify, and configure account attribute mappings. To prevent synchronization exceptions, you are advised to add account attributes of the same type as the user attributes to be mapped.
    Table 2 Mapping parameters

    Parameter

    Description

    User

    User attribute mapped to the Application Account. You can select a value from the drop-down list box.

    Conversion Mode

    Mode of attribute mapping between User and Application Account.

    Script Expression

    Enter the mapping script. For details, see Developing Mapping Scripts.

    Execution Mode

    Synchronization mode of the Application Account attribute. You can select a value from the drop-down list box.

    Application Account

    Label of the application account attribute.

  • Configuration

    Click the Configure tab. By default, Delete System User is set to Delete application account, and Disable System User is set to Disable application account. Click Modify to modify the configuration. If you choose to disable or retain the application account for Delete System User, the account automatically changes to an orphan account because the user has been deleted. You can choose to retain an application account for Disable System User. Click Save to make the modification take effect.

Application Organizations

Before configuring the application organization, you need to enable it. The configuration method is similar to that of the application account. For details, see Application Accounts.

To prevent synchronization exceptions, you are advised to add organization attributes of the same type as the application organization attributes to be mapped.

  • Attributes
    1. Log in to the administrator portal.
    2. On the top navigation bar, choose Resources > Applications.
    3. On the displayed page, click an application name to access the application details page.
    4. Click the application icon to access the general information page.
    5. In the navigation pane on the left, choose Object Models > Application Organization. On the displayed page, click . In the displayed dialog box, click OK to enable the application organization. On the displayed Attributes tab page, click Add, configure the application organization attribute, and click Save.

      Table 3 Attribute parameters

      Parameter

      Description

      * Attribute

      Attribute of an application organization.

      * Label

      Identifier of an attribute. It is recommended that the value of this parameter be matched with that of Attribute.

      Description

      Description of Attribute.

      * Attribute Type

      Type of an attribute. You can select a value from the drop-down list box.

      Format

      This parameter specifies the text format. It is required only when Attribute Type is set to Text.

      Required

      If this option is selected, the attribute must be set when organization data is synchronized to the application. If the attribute is left empty, a message will be displayed, indicating that label is mandatory.

      Unique

      It is required only when Attribute Type is set to Text. If this option is selected, the attribute value is unique when organization data is synchronized to the application. If the attribute value is duplicate, a message is displayed, indicating that the label already exists.

      Sensitive

      It is required only when Attribute Type is set to Text. If this option is selected, the data is hidden when organization data is synchronized to the application. You can click to check the data.

    You can click Modify or Delete in the Operation column on the right to edit or delete an attribute. Built-in attributes cannot be deleted.

  • Mappings
    Go to the Mappings tab page, click Modify, and configure account attribute mappings. To prevent synchronization exceptions, you are advised to add account attributes of the same type as the user attributes to be mapped.
    Table 4 Mapping parameters

    Parameter

    Description

    Organization

    Organization attribute mapped to the application organization. You can select a value from the drop-down list box.

    Conversion Mode

    Mode of attribute mapping between Organization and Application Organization.

    Script Expression

    Enter the mapping script. For details, see Developing Mapping Scripts.

    Execution Mode

    Synchronization mode of the Application Organization attribute. You can select a value from the drop-down list box.

    Application Organization

    Label of the application organization attribute.

  • Configuration

    Click the Configure tab. By default, Delete System Org is set to Delete application organization, and Disable System Org is set to Disable application organization. You can click Modify to modify the configuration. You can set Delete System Org to Disable application organization or Do not affect, and set Disable System Org to Do not affect. Click Save for the modification to take effect.