Skip to main content

Omnilert Connector

This connector supports both identity and Provisioning.

  • The Identity component of the Omnilert connector allows you, as an Identity administrator, to configure Omnilert as a connected system and then make Identity users part of the subscriber of Omnilert system. The connector also enables the user or Identity administrator to reset Omnilert account passwords and enable and disable user accounts.
  • The Provisioning component of this connector enables exporting and importing of user accounts and Groups on a Omnilert.

This is a REST based connector implementation and support Subscriber and Group data format.

Functionalities

The basic functionalities that can be done via this connector are listed below.

Identity Integration

Product Feature

Supported
Authenticate (test Connection) Yes
Validate User Yes
Enable/Disable User Yes
Reset Password Yes

Provisioning Integration

Data Format

Export

Create

Modify

Delete

Trigger
Subscriber

Yes

 Yes Yes Yes No
Group

Yes

 Yes Yes Yes No


Prerequisites

Ensure that these prerequisites are satisfied:

  • An administrator account that can be used to establish a connection and has authority to manage subscribers on the Omnilert connected system.
  • Identity Administrator rights.

Creating and Managing the Connected System

Connected system can be managed from both Admin UI and Workflow and Connectivity studio. The step by step explanation to create is provided in the following sub sections. Clicking on the connected system from the listing page(admin UI)/selecting the desired system and clicking on View button(Studio) will take you to a detail page where you can can manage the connected system.

Create from Admin UI

  1. Log in to Identity Administration and click the Systems tab.

  2. On the Connected System View page, click the Add button and select the Omnilert connected system from the Type drop-down list. The Connected System Details page displays the default values:

  3. Enter the desired information:

    Definition 

    Supported Connectors

    		 Displays whether the connected system is Identity only, Provisioning only, or both.
    Type Select the connected system type.

    Locale

    		 Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system.
    Name The name for this connected system. Note: The name cannot be modified later.
    Display Name The display name of the new connected system.
    Description The description of the connected system.

    Associated With 

    Select how the connector associated with this system will run:

    • Server (default) - Runs locally on the Provisioning/Identity Server.
    • Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list.
    • See Using the Global Identity Gateway with Connected Systems for additional information.
    Password Reset By  Enables administrators to configure password management functions normally available to Users and OBO (On Behalf Of) Users:
    • OBO User Only - Connected system and account association information is displayed only in Self-Service user management (for OBO Users). OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset). End users will not see their accounts on this connected system in Self-Service and Kiosk; therefore, they cannot reset passwords for accounts on this connected system.
    • Users and OBO User - Connected system and account association information is displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset).
    • External - Connected system and account association information is not displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users cannot reset passwords for accounts on this connected system.

    Note: When user management configuration enables OBO Users to perform password resets, this definition must be set to OBO User Only or Users and OBO User. For connectors that support Provisioning only, there is no password reset capability.
    Provisioning Option Select the provisioning option:
    • Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
    • Administrative - The connected system cannot be used as an object in a workflow.
    Enable HPAM Support  Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity.
    Connection Information 

    Account Key 

    		 Unique Identifier key of the Service Account
    Service Account Name  Username of the global administrator user.
    Service Account Password  Password of the global administrator user.Password of the global administrator user.

  4. Click the Test Connection button to test the Connection Information:

    • If successful, this message will display:

    Message: Connection from Provisioning to the connected system was established successfully.

    • If unsuccessful, this message will display:

    Error: Failed to establish connection from Provisioning to the connected system.

    Note: If the connection fails, additional messages may display providing more information regarding the failure, and additional information may be posted to the Provisioning and Identity logs.

  5. System Owner (Optional) Adds or removes users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users:

    1. To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays:



    2. Select the owners and then click the Select button. The system owner displays under the System Owner section:

      The HPAM column indicates whether the system owner is authorized to use the HPAM feature. The Approvers column indicates whether the system owner is an approver in the approval process. The Status column indicates whether the system owner is active.

      Note: More than one user can be assigned as an owner.

    3. To add additional system owners, click the Add button.

  6. On the Connected System Details page, click the Add button to save the configured connected system. The Object Category Association page displays a list of categories that are already associated and/or can be selected to add additional associations to this connected system:


    1. Select one or more available object categories or provide search criteria and click the Search button to find specific categories to select. If there are no available categories to select, proceed to Step 7.

    2. Click the Add Association button to associate the selected object categories to the connected system.

  7. Click the Back button to return to the Connected System View page. The new connected system displays in the list.

See Copying, Modifying, and Deleting Connected Systems for additional information.

Creating from Studio

  1. Log in to the Workflow and Connectivity Studio and click Connectivity ► Add Systems on the menu bar. The Add Connected Systems window displays.

  2. Select the Omnilert connected system from the Type drop-down list. The default values display:


  3. Enter the desired information:

    Definition 
    Type Select the connected system type.
    Name  The name for this connected system. Note: The name cannot be modified later.
    Display Name  The display name of the new connected system.
    Description  The description of the connected system.
    Supported Connectors  Displays whether the connected system is Identity only, Provisioning only, or both. Only connectors that support Provisioning are available here.
    Associated With  Select how the connector associated with this system will run:
    • Server (default) - Runs locally on the Provisioning/Identity Server.
    • Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list.

    See the Using the Global Identity Gateway with Connected Systems for additional information.
    Password Reset By  This feature is not available for this connector.

    Provisioning Option 

    Select the provisioning option:

    • Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
    • Administrative - The connected system cannot be used as an object in a workflow.
    Enable HPAM Support  Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity.
    Connection Information 

    Account Key 

    		 Unique Identifier key of the Service Account
    Service Account Name  Username of the global administrator user.
    Service Account Password  Password of the global administrator user.Password of the global administrator user.

  4. Click the Test Connection button to test the Connection Information:

    • If successful, this message will display:

    Message: Connection from Studio to the connected system was established successfully.

    • If unsuccessful, this message will display:

    Error: Failed to establish connection from Studio to the connected system.

    Note: If the connection fails, additional messages may display providing more information regarding the failure.


  5. Click the Apply button to apply changes. The Category Association window displays.


    1. Select one or more object categories from the Available Categories list or enter a category name and click the Search button to find a specific category to select. If there are no available categories to select, proceed to Step 6.

    2. Click the Add button to associate the selected object categories to the connected system.

  6. Click OK to accept selected categories.

See Copying, Modifying, and Deleting Connected Systems for additional information.

Using the Connected System for Identity


Perform these procedures to configure the connector:

  • Connector Details for Identity
  • Identity Password Management

Connector Details for Identity

Field System Attribute Example Value
Login ID

username

 john.smith
Account ID id 54541464

Identity Password Management

See User Management for details on password management.

Using the Connected System for Provisioning


Perform these procedures to configure the connector:

  • Configuring for Export
  • Configuring for Import
  • Connector Details for Provisioning

Note: If the number of records to be processed exceeds one thousand, we recommend configuring the workflow to use bulk mode, which lowers the memory consumption of the system by streaming data to files. Because data is streamed for every task, performance of the workflow execution will be decreased due to increased read-write operations. See the Workflow and Connectivity Studio document for details on how to configure bulk mode.

Configuring for Export

Perform these procedures to configure the connector for data export:

  • "Configuring the Export Connector
  • "Configuring the Export Link" 

From the Workflow and Connectivity Studio, select the Omnilert UserExport workflow listed under the projects folder.

If a workflow does not already exist, create an export workflow. See the Workflow and Connectivity Studio document for details on creating export workflows.

Configuring the Export Connector

  1. In the Design pane, double-click the export object (the first workflow object after the Start object). The Configure Data Source window displays:



From the Configure Plug-in tab, set these properties as required:

Associated Connected System Select the connected system from the list. The export operation will be done from this connected system.
Data Formats  Select the type of data format to use: Profiles (default) or ChangeLog.

DeltaExportMode

Select the type of attribute to export if a change takes place (this works in conjunction with ExportMode when DeltaExport is selected):

  • OnlyChangedAttributes - Performs a partial export of only the changed attributes from the last time the query was run.
  • ChangedAndMandatoryAttributes (default) - Performs a partial export of both changed and mandatory attributes from the last time the query was run. Mandatory attributes are exported whether they have been changed or not.
  • AllAttributes - Performs a full export of all attributes that contain a value.
DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected.
DynamicConnectedSystemOption  Select how to control Dynamic System Support (DSS):
  • None - There will not be any Dynamic System Support.
  • Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
  • GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.

ExportEntryByID 

 Option to fetch the details of an entry by providing id.

ExportMode

Select the type of data to export:

  • FullExport - Exports all attributes.
  • DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property setting.

MaxResults 

 Select the maximum number of results to be returned (this works in conjunction with ExportMode when FullExport is selected). If this is 0, all entries matching the search criteria are returned.

  1. In the Design pane, double-click the export link between the export object (the first workflow object after the Start object) and the Data Mapper object. The Configure Link window displays:

    Description
    Source Attributes  Select the attributes to export.

    Selected Attributes

    Displays default attributes and those attributes that have been selected from the Source Attributes.

    Notes: The check boxes are used only for delta export operations. These checked attributes will always be exported whether they were changed or not. Usually, the attributes that are selected as mandatory attributes help in identifying or verifying an entry when completing mapping functions.
    Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, whenChanged. During export, the attribute’s value is converted to the specified format. See the Format Date steps below for additional information.
    Notes:
    • The Format button is only enabled for date attributes.
    Advanced Settings  Displays the Configure Attributes window for configuring advanced settings for attributes. See the Configure Attributes window on page 39 for additional information.

  2. From the Attribute Selection tab, select attributes to export. Usually, these attributes that are selected (mandatory attributes) help in identifying or verifying an entry when completing Data Mapper functions.

  3. (Optional) Click the Format button to specify a date/time format to be applied to the selected date type attribute. The Format Date window displays.

    1. Select the Include Time check box to add the timestamp with the date.

    2. Select the 24 Hour or 12 Hour option button and then select the required date/time format.
    3. Click OK to save the selected format. The Configure Link window displays.

  4. Click OK to save any changes and return to the Workflow and Connectivity Studio window.

  5. Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio documentation for details of deployment options.

  6. Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration documentation for details.

Configuring for Import

Perform these procedures to configure the connector for data import:

  • Configuring the Import Connector
  • Configuring the Import Link

From the Workflow and Connectivity Studio, select the Omnilert UserAdd, UserModify, or UserDelete workflow listed under the projects folder.

If a workflow does not already exist, create an import workflow. See the Workflow and Connectivity Studio document for details on creating import workflows.

Configuring the Import Connector

  1. In the Design pane, double-click the import object (the last workflow object). The Configure Data Source window displays:


  2. From the Configure Plug-in tab, set these properties as required:

    Associated Connected System Select the connected system from the list. The import operation will be done to this connected system. 
    Data Formats  Select the type of data format to use: Profiles (default) or ChangeLog.
    DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected.
    DynamicConnectedSystemOption Select how to control Dynamic System Support (DSS):
    • None - There will not be any Dynamic System Support.
    • Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
    • GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.

    See the Dynamic System Support appendix in the Workflow and Connectivity Studio document for additional information.
    Id * Enter the attribute that contains the value used to uniquely identify the user account user ID on the connected system.
    loginId * Enter the attribute that contains the value used to uniquely identify the user account login ID on the connected system.

    Notes:

    * Id and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_ID and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.

    Hover the pointer over a property to view its description.

    Omnilert user name does not support special characters.

  3. In the Design pane, double-click the import link between the Data Mapper object and the import object (the last workflow object). The Configure Link window displays:

    Source Attributes  Select the attributes to import.

    Check for attribute-level auditing.

    		 If auditing is enabled and these attributes below are checked, Provisioning will log all events for auditing purposes. 
    Selected Attributes  Displays default attributes and those attributes that have been selected from the Source Attributes. Note: The default attributes are those that are commonly used to create a new user.
    Advanced Settings  Displays the Configure Attributes window for configuring advanced settings for attributes. Under the Encrypted column, check the box of any attribute that needs to be encrypted.
    Under the Diff With Target column, check the box of any attribute to update using differencing (DiffWithTarget, AddDiffWithTarget, and RemoveDiffWithTarget).

Connector Details for Provisioning

Connector Attributes

The items in the Export, Create, Modify, and Delete columns have these meanings:

  • Y = Yes (attribute is supported for this operation)
  • N = No (attribute is not supported for this operation) 

*  - mandatory attributes

Subscriber Data Format

Name Type Multi-valued Export Create Modify Delete

access_level

Boolean

N

    Y

   Y

   Y

   Y

account expiration date

Boolean

N

    Y

   Y

   Y

   Y

devices->email->active_status

Boolean

Y

    Y

   Y

   Y

   Y

devices->email->email

String

Y

    Y

   Y

   Y

   Y

devices->email->id

String

Y

    Y

   Y

   Y

   Y

devices->email->user_id

String

Y

    Y

   Y

   Y

   Y

devices->email->validation_status

Boolean

Y

    Y

   Y

   Y

   Y

devices->sms->active_status

Boolean

Y

    Y

   Y

   Y

   Y

devices->sms->carrier_id

String

Y

    Y

   Y

   Y

   Y

devices->sms->carrier_name

String

Y

    Y

   Y

   Y

   Y

devices->sms->id

String

Y

    Y

   Y

   Y

   Y

devices->sms->phone

String

Y

    Y

   Y

   Y

   Y

devices->sms->user_id

String

Y

    Y

   Y

   Y

   Y

devices->sms->validation_status

Boolean

Y

    Y

   Y

   Y

   Y

exclude_from_all_users

Boolean

N

    N

   Y

   Y

   Y

firstname

String

N

    Y

   Y*

   Y

   Y*

groups

String

N

    Y

   Y

   Y

   Y

id

String

N

    Y

   Y

   Y*

   Y*

lastname

String

N

    Y

   Y*

   Y

   Y*

password

String

N

   N

   Y*

   Y

   Y*

preferred_languages

String

N

    Y

   N

   N

   N

tags

String

N

    Y

   Y

   Y

   Y

username

String

N

    Y

   Y*

   Y

   Y*

validated

Boolean

N

    Y

  N

   N

   N

Note: To remove all groups of a subscriber, the value of groups should be set to 'null'.

Group Data Format

Name Type Multi-valued Export Create Modify Delete

group_default

Boolean

N

Y

    Y*

    Y

    Y

group_description

String

N

Y

    Y*

    Y

    Y

group_name

String

N

Y

    Y*

    Y

    Y

group_private

Boolean

N

Y

    Y*

    Y

    Y

id

String

N

Y

  Y

    Y*

    Y*
keyword String N Y     Y*     Y     Y

Lookup Data

To lookup data from Omnilert, use the Data Mapper rule Lookup Data.

  1. Log in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design pane. The Configure Data Mapper window displays.

  2. Select the Lookup Data rule under the Mapping Rule column, and then click the Source Value. The Configure Lookup window displays.

  3. Select the Omnilert system from the Select System drop-down list:


  4. In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.

  5. Select the Lookup Type from the drop-down list Subscriber or Group by Id.

  6. Click the Pick button to set the Id.


  7. Click the Fields Pick button to select the attributes to be fetched after a successful lookup.


  8. Select the Exit as Mapper Task Failed on Lookup Failure check box to exit the task with Failed status on lookup failure. It will not process the succeeding entries and will ignore the already processed entries and will not return any data. This is selected by default.

  9. Click OK.



Was this article helpful?