Connect to UltiPro

EmpowerID provides connectors for a wide range of user directories and resource systems. As an administrator, you can use these connectors to quickly connect EmpowerID to your organization's identity-aware systems and applications. When you do so, you create an account store for that application in the EmpowerID Identity Warehouse and use that account store to configure how you want EmpowerID to manage the identity information in that system.

Prerequisites

Before connecting EmpowerID to an external directory, please review the Getting Started with Directory Systems topic. The topic walks you through the prerequisites you need to complete before connecting to an external directory for the first time. These prerequisites include:

Configuring the appropriate server roles for your EmpowerID servers
Reviewing the Join and Provision Rules for your environment
Reviewing the Join and Provision Filters for your environment

If you have already connected EmpowerID to another external directory, you can skip the above prerequisites.

Prerequisites

In order to connect EmpowerID to UltiPro, you must have an UltiPro account that is configured to interface with external systems. This means that you must have the following (provided by UltiPro):

Username
Password
User Access Key
Client Access Key

These values are used to authenticate EmpowerID to UltiPro. In addition, you must create a report as a Web service that specifies the fields you want to expose and then provide EmpowerID with the path to that service.

Additionally, you will need to create a report and expose it as a service. The report needs to have the below fields. Fields designated as required indicate that a value must be provided.

Step 1 – Create an UltiPro account store in EmpowerID

On the navbar, expand Admin > Applications and Directories and then click Account Stores and Systems.
On the Account Stores page, click Create Account Store.
Under System Types, search for UltiPro.
Click UltiPro to select the type and then click Submit.
On the UltiPro Settings page that appears, fill in the following information:
1. Name — Enter a name for the account store
2. Client Key — The Customer API Key issued by UltiPro
3. User API Key — The User API Key issued by UltiPro
4. Report Path — The path to the report that you created in UltiPro and exposed as a service
5. Base URL — The Base URL for your UltiPro system, e.g. https://service123.ultipro.com/service/
6. User Name and Password — Your UltiPro credentials
When ready click Submit to create the account store.
EmpowerID creates the account store and the associated resource system. The next step is to configure attribute flow between the account store and EmpowerID.

Step 2 – Configure Attribute Flow

EmpowerID supports the configuration of attribute synchronization rules for flowing attribute changes between directories and the EmpowerID Identity Warehouse. Attribute Flow rules are visually configured and are always relative to the relationship between an attribute in a directory and the corresponding attribute in the EmpowerID Identity Warehouse. Attribute Flow rules define the specific fields and attributes that are synchronized between the EmpowerID Identity Warehouse person objects and the external user accounts to which they are linked. Additionally, Attribute Flow rules can be weighted by account store. For example, if you have connected EmpowerID to an HR system as well as Active Directory, and you want any changes made to an attribute in the HR system to take priority over changes made in Active Directory or EmpowerID (while allowing changes to be made in any system), you would give a higher score for each CRUD operation originating from the HR account store and correspondingly lower scores for the Active Directory account store.

The following flow rules are available:

No Sync 🔴 – When this option is selected, no information flows between EmpowerID and the native system.
Bidirectional Flow – When this option is selected, changes made within EmpowerID update the native system and vice-versa. For most attributes, this is the default setting.
Account Store Changes Only – When this option is selected, changes can only be made in the native system and are then passed to EmpowerID.
EmpowerID Changes Only – When this option is selected, changes can only be made in EmpowerID and are then passed to the native system.

The following CRUD operations are available:

Create – This operation is used to create an attribute value for an existing attribute when the value of that attribute is null.
Update – This operation is used to update the value of an attribute.
Delete – This operation is used to delete the value of an attribute.

From the Account Stores tab of the Account Stores and Systems page, search for the account store you just created and click the Account Store link for it.
Click the Attribute Flow Rules tab to view the current rules for the account store. Please note that the attributes available depend on the account store.
To change the flow for an attribute, click the Attribute Flow drop-down located between the Person Attribute column and the External Directory Attribute column, and select the desired flow direction from the context menu.
To change the score for any of the available CRUD operations (Create, Update and Delete), enter the new score in the appropriate field. By default, scores are weighted evenly, which means that a change to an attribute originating in one connected external directory has the same authority as a change to an attribute occurring in another connected external directory.

EmpowerID only considers scores for attribute CRUD operations when multiple account stores with the same user records are connected to EmpowerID, such as would be the case if an HR System and this account store were being inventoried by EmpowerID.

Now that the attribute flow has been set, the next steps include configuring the account store and enabling EmpowerID to inventory it.

Step 3 – Configure account store settings

On the Account Store and Resource System page, click the Account Store tab and then click the pencil icon to put the account store in edit mode.

This opens the edit page for the account store. This page allows you to specify the account proxy used to connect EmpowerID to your UltiPro account as well as how you want EmpowerID to handle the user information it discovers in UltiPro during inventory. Settings that can be edited are described in the table below the image.

Account Store Settings
Setting	Description
General Settings
IT Environment Type	Allows you to specify the type of environment in which you are creating the account store.
Inventoried Directory Server	Allows you to select a connected server as the directory server for the account store.
Provisioning Settings
Allow Person Provisioning (Joiner Source)	Specifies whether EmpowerID Persons can be provisioned from user accounts in the account store.
Allow Account Creation on Membership Request	Specifies whether EmpowerID creates user accounts in the account store when an EmpowerID Person without one requests membership within a group belonging to the account store.
Recertify All Group Changes as Detected	Specifies whether detected group changes should trigger recertification.
Directory Clean Up Enabled Settngs
Directory Clean Up Enabled	Specifies whether the SubmitAccountTermination permanent workflow should claim the account store for processing account terminations. When enabled, accounts in the account store that meet the qualifications to be marked for deletion are moved into a special OU within the external directory, disabled and finally deleted after going through an automated approval process. This process involves setting a number of system settings in EmpowerID and requires multiple approvals by designated personnel before an account is finally removed from the account store.
Report Only Mode (No Changes)	When enabled, a report of what the Directory Clean Up process would do is written to the log. The process itself is ignored and all accounts are set to Termination Pending,
Special Use Settings
Queue Password Changes on Failure	Specifies whether EmpowerID should send password changes to the Account Password Reset Inbox only when the change fails.

Edit the account store as needed and then click Save to save your changes.

Next, enable the Account Inbox permanent workflow to allow the Account Inbox to provision or join the user accounts in UltiPro to EmpowerID Persons as demonstrated below.

EmpowerID recommends using the Account Inbox for provisioning and joining.

Step 4 – Enable the Account Inbox Permanent Workflow

On the navbar, expand Infrastructure Admin > EmpowerID Server and Settings and select Permanent Workflows.
On the Permanent Workflows page, click the Display Name link for Account Inbox.
On the Permanent Workflow Details page that appears, click the pencil icon to put the workflow in edit mode.
Check Enabled.
Click Save to save your changes.

Step 5 – Monitor Inventory

On the navbar, expand Identity Lifecycle and select Account Inbox.

The Account Inbox page appears. This page provides tabbed views of all information related to processing new user accounts discovered in a connected account store during inventory. An explanation of these tabs follows.
- All — This tab displays a grid view of all user accounts and the status of those accounts in relation to the Account Inbox.
- Dashboard — This tab provides a quick summary of account inbox activity.
- Orphans — This tab displays a grid view of all user accounts without an EmpowerID Person.