Skip to main content

Ultimate UltiPro

The Ultimate UltiPro connector supports only Provisioning.

Provisioning functionalities of this connector enable exporting and importing Employees on an Ultimate UltiPro system. The Report data format can be used to execute any report configured in UltiPro system and fetch the required data.


 

Functionalities

Provisioning Integration

Data Format

Export

Create

Modify

Delete

Trigger

Employee

Yes

No

Yes

No

No

Report

Yes

No

No

No

No

 

Prerequisites

Fischer Identity's Ultimate UltiPro connector is using the UltiPro SOAP APIs. The following prerequisites need to be satisfied in order to use the connector:

  • Create an UltiPro Service Account.
  • Customer API key from the UltiPro Web Service administrative page.
  • User API key from the Service Account administrative page.
  • Grant appropriate permissions
    • Employee: Permission to execute the services Employee-Person-Service and Employee-UserDefinedFields-Service
    • Report: Permission to execute the service Reports-as-a-Service.

Creating the Connected System in the Admin UI

1.      Log in to the Identity Administration UI and use the menu item Systems->Connected Systems. Click Add button to display the connected system details page.
2.      Select the Ultimate UltiPro connected systems from the Type drop-down list. The default values display.


3.      Enter the required information. Only configurations which are specific to Ultimate UltiPro are described below. For an overview of the configuration which are common to all connectors, please refer to our "Connected Systems Guide".

Connection Information

Service URL

The URL where the Ultimate UltiPro Server is hosted.

Customer API Key

Customer API key from the UltiPro Web Service administrative page.

User API Key

User API key from the Service Account administrative page.

Service Account Name

The UltiPro Service Account username.

Service Account Password

The UltiPro Service Account password

Company Code

An optional parameter which can be used to limit operations to particular companies when there are multiple companies in the UltiPro system. Can specify comma separated values to support multiple companies

Enable Advanced Logging

Option to log SOAP requests submitted to UltiPro. When this is on, all requests to this system will be logged in a file named under UltiProSOAPMessages.log logs folder.

Creating the Connected System in 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 Ultimate UltiPro connected systems from the Type drop-down list. The default values display.

3. Enter the required information. Only configurations which are specific to Ultimate UltiPro are described below. For an overview of the configuration which are common to all connectors, please refer to our "Connected Systems Guide".

Connection Information



Service URL

The URL where the Ultimate UltiPro Server is hosted.

Customer API Key

Customer API key from the UltiPro Web Service administrative page.

User API Key

User API key from the Service Account administrative page.

Service Account Name

The UltiPro Service Account username.

Service Account Password

The UltiPro Service Account password

Company Code

An optional parameter which can be used to limit operations to particular companies when there are multiple companies in the UltiPro system. Can specify comma separated values to support multiple companies

Enable Advanced Logging

Option to log SOAP requests submitted to UltiPro. When this is on, all requests to this system will be logged in a file named under UltiProSOAPMessages.log logs folder.

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 UltiPro-EmployeeExport workflow listed under the projects folder. If a workflow does not already exist, create an export workflow. See Workflow and Connectivity Studio for details on creating export workflows.

Configure the Export Connector

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

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

 

Associated Connected System

Select the connected System from the list. The export will be done from this connected system

Data Formats

Select the type of data format to use: Employee (Default)

DataDelimiter

Delimiter character to be used for separating report data columns. Available only for Report data format.

DeltaExportMode

Select the type of attribute to export if a change takes place (this works in conjunction with ExportMode when DeltaExport is selected):
o    OnlyChangedAttributes - Performs a partial export of only the changed attributes from the last time the query was run.
o    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.
o    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):
o    None - There will not be any Dynamic System Support.
o    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.
o    GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.

ExecuteGIGAssociatedTaskAsynchronously

This property controls execution mode for GIG associated tasks. If this property is true, GIG associated tasks will execute asynchronously.

ExportMode

Select the type of data to export:
o    FullExport - Exports all attributes
o    DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property setting.

Filter

Specify search criteria to determine the objects to be exported from the Ultimate UltiPro System. Use the Set Filter button that becomes active to create a filter. See "Set Filter" section for additional information.

GetEmployeeByID

Option to fetch details of an employee by providing the employee ID. Available only for Employee data format.

MaxResults

Maximum number of results to be returned. If this property has a value 0, all entries matching the search criteria are returned. This property can only be configured/used when ExportMode is FullExport.

ReportParameters

Option to configure parameters supported by the report. Available only for Report data format.

ReportPath

Path of the report to be executed. Can be specified in the format zzzCompany Folders -> Apollo Group, Inc -> FischerIdentity -> HRA_ActivePrimaryJobs_Fischer. Available only for Report data format.

ResultsPerPage

Configuration to control the items to be fetched per page. Available only for Employee data format.

SkipHeaderEntry

Set this to true if the first row of the report is the header and it should not be included with the data. Available only for Report data format.

3.      (Optional) Select the Attributes tab. Only the standard attributes display: Modify schema attributes using these buttons.

Add

Add additional attributes to the list. The Add New attribute dialog displays. Note: Only attributes that are present in the business Object schema can be added. If they are not in the business Object schema they will be disregarded.

Export

Export the schema list to an XML file.

Import

Imports the schema list from an XML file.

Reset Schema

Resets the schema definition to the default schema prepackaged with the IDM Suite, plus any global variable added.

4. (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.

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

6.  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 The Configure Link window displays.

Element

Description

Source Attributes

Select the attribute to export

Selected Attributes

Displays default attributes and those attributes that have been selected from the Source Attributes.
Note: 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 data/time format to be applied to the selected date type attribute, for example, StartDate. During export, the attribute's value is converted to the specified format. See the Format Date steps below for additional information.
Note: 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 in Workflow and Connectivity Studio documentation for additional information
  1. From the Attribute Selection tab, select attributes to export.
  2. (Optional) Click the Format button to specify a data/time format to be applied to the selected date type attribute. The Format Date window displays.
    • Select the include Time check box to add the timestamp with the date
    • Select the 24 hour or 12 hour option button and then select the required date/time format.
    • Click OK to save the selected format. The configure Link window displays.
  3. Click Ok to save any changes and return to Workflow and Connectivity Studio window.
  4. Deploy the workflow by selecting Deploy New Deployment. See the Workflow and Connectivity Studio documentation for details of deployment options.
  5. Manage and run the deployed workflow from the Admin UI Server See the documentation for details.

Configuring for Import

Perform these procedures to configure the connector for data import:

  • Configure the import Connector
  • Configure the Import Link

From the Workflow and Connectivity Studio, select the Ultimate UltiPro EmployeeModify workflow listed under the projects folder.
If a workflow does not already exist, create an import workflow. See the Workflow and Connectivity Studio documentation 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:

Element

Description

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.

DynamicConnectedSystem

Select the global variable to use as the dynamic connected system name. This works in conjunction with the 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.

ExecuteGIGAssociatedTaskAsynchronously

This property controls execution mode for GIG associated tasks. If this property is true, GIG associated tasks will execute asynchronously.

Id

Enter the attribute that contains the value used to uniquely identity the user account user ID on the Ultimate UltiPro system.

loginId

Enter the attribute that contains the value used to uniquely identity the user account login ID on the connected system.


3. (Optional) Select the Attributes Only standard attributes display: Modify schema attributes with the buttons.

4. (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.

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

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

Element

Description

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.

Select 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.

Format

Displays the Format Date window to specify a data/time format to be imported to the selected date type attribute, for example, StartDate. During import, the attribute's value is converted from the specified format to the system specific one. See the Format Date steps below for additional information.
Note:
·         The format button is only enabled for date attributes
·         The Refresh Schema button on the Configure Data Source window's Attributes tab must be used to refresh the schema and enable the Format button for date attributes

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.

Key Attribute

Select the attribute to be used as the key attribute.
  1. From the Attribute Selection tab, select attributes to import.
  2. (Optional) Select the Appearance tab to change how the link displays in the Design pane.
  3. Click OK to save any changes and return to the Workflow and Connectivity Studio window.
  4. Deploy the workflow by selecting Deploy New Deployment. See the Workflow and Connectivity Studio for details of deployment options.
  5. Manage and run the deployed workflow from the Admin UI Server tab. See the Identity Suite Administration documentation for details.

Configuration Details for Provisioning

Configuration import properties id, loginId are used by the Provisioning Policy and IdentitytHub 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.

Configuration Import Properties

Identity Property

System Attribute

Id

Configure the attribute to be used as the Account Id. The import workflows will get this value in the attribute Account-ID. EmployeeNumber is the default configured value.

Login Id

Configure the attribute to be used as the Account User Name. EmployeeNumber is the default configured value.

Supported Data Formats

Employee and Report are the two data formats supported by the UltiPro connector.

Employee Data Format

We can use this data format in import mode to modify Employee.
The items in the MV (Multiple values), 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)
  • Y* = Required (attribute is mandatory for this operation)

  • NA = Not Applicable

    Name

    MV

    Export

    Create

    Modify

    Delete

    Description

    Employee person information attributes







    AlternateEmailAddress

    N

    Y

    N

    Y

    N

    Alternate email address.

    EmailAddress

    N

    Y

    N

    Y

    N

    Primary email address.

    FirstName

    N

    Y

    N

    Y

    N

    First name of the person.

    FormerLastName

    N

    Y

    N

    Y

    N

    Former last name of the person.

    LastName

    N

    Y

    N

    Y

    N

    Last name of the person.

    MiddleName

    N

    Y

    N

    Y

    N

    Middle name of the person.

    PreferredFirstName

    N

    Y

    N

    Y

    N

    Preferred name of the person.

    Prefix

    N

    Y

    N

    Y

    N

    A valid UltiPro prefix code.

    SSN

    N

    Y

    N

    Y

    N

    Social Security Number

    Suffix

    N

    Y

    N

    Y

    N

    A valid UltiPro suffix code.

    SuppressSSN

    N

    Y

    N

    Y

    N

    Determines if the SSN should be suppressed in the UltiPro portal.

    EmployeeNumber

    N

    Y*

    N

    Y

    N

    ID that represents a person.

    Employee User Defined Field Attributes







    EepUDField01

    N

    Y

    N

    Y

    N

    Employee User Defined Field1

    EepUDField02

    N

    Y

    N

    Y

    N

    Employee User Defined Field2

    EepUDField03

    N

    Y

    N

    Y

    N

    Employee User Defined Field3

    EepUDField04

    N

    Y

    N

    Y

    N

    Employee User Defined Field4

    EepUDField05

    N

    Y

    N

    Y

    N

    Employee User Defined Field5

    EepUDField06

    N

    Y

    N

    Y

    N

    Employee User Defined Field6

    EepUDField07

    N

    Y

    N

    Y

    N

    Employee User Defined Field7

    EepUDField08

    N

    Y

    N

    Y

    N

    Employee User Defined Field8

    EepUDField09

    N

    Y

    N

    Y

    N

    Employee User Defined Field9

    EepUDField10

    N

    Y

    N

    Y

    N

    Employee User Defined Field10

    EepUDField11

    N

    Y

    N

    Y

    N

    Employee User Defined Field11

    EepUDField12

    N

    Y

    N

    Y

    N

    Employee User Defined Field12

    EepUDField13

    N

    Y

    N

    Y

    N

    Employee User Defined Field13

    EepUDField14

    N

    Y

    N

    Y

    N

    Employee User Defined Field14

    EecUDField01

    N

    Y

    N

    Y

    N

    Company User Defined Field1

    EecUDField02

    N

    Y

    N

    Y

    N

    Company User Defined Field2

    EecUDField03

    N

    Y

    N

    Y

    N

    Company User Defined Field3

    EecUDField04

    N

    Y

    N

    Y

    N

    Company User Defined Field4

    EecUDField05

    N

    Y

    N

    Y

    N

    Company User Defined Field5

    EecUDField06

    N

    Y

    N

    Y

    N

    Company User Defined Field6

    EecUDField07

    N

    Y

    N

    Y

    N

    Company User Defined Field7

    EecUDField08

    N

    Y

    N

    Y

    N

    Company User Defined Field8

    EecUDField09

    N

    Y

    N

    Y

    N

    Company User Defined Field9

    EecUDField10

    N

    Y

    N

    Y

    N

    Company User Defined Field10

    EecUDField11

    N

    Y

    N

    Y

    N

    Company User Defined Field11

    EecUDField12

    N

    Y

    N

    Y

    N

    Company User Defined Field12

    EecUDField13

    N

    Y

    N

    Y

    N

    Company User Defined Field13

    EecUDField14

    N

    Y

    N

    Y

    N

    Company User Defined Field14

    EecUDField15

    N

    Y

    N

    Y

    N

    Company User Defined Field15

    EecUDField16

    N

    Y

    N

    Y

    N

    Company User Defined Field16

    EecUDField17

    N

    Y

    N

    Y

    N

    Company User Defined Field17

    EecUDField18

    N

    Y

    N

    Y

    N

    Company User Defined Field18

    EecUDField19

    N

    Y

    N

    Y

    N

    Company User Defined Field19

    EecUDField20

    N

    Y

    N

    Y

    N

    Company User Defined Field20

    EecUDField21

    N

    Y

    N

    Y

    N

    Company User Defined Field21

    EecUDField22

    N

    Y

    N

    Y

    N

    Company User Defined Field22

    EecUDField23

    N

    Y

    N

    Y

    N

    Company User Defined Field23

    EecUDField24

    N

    Y

    N

    Y

    N

    Company User Defined Field24

    EecUDField25

    N

    Y

    N

    Y

    N

    Company User Defined Field25

    EecUDField26

    N

    Y

    N

    Y

    N

    Company User Defined Field26

    EecUDField27

    N

    Y

    N

    Y

    N

    Company User Defined Field27

    EecUDField28

    N

    Y

    N

    Y

    N

    Company User Defined Field28

    EecUDField29

    N

    Y

    N

    Y

    N

    Company User Defined Field29
    EinUDField01 N Y N Y N International Employee User Defined Field1
    EinUDField02 N Y N Y N International Employee User Defined Field2
    EinUDField03 N Y N Y N International Employee User Defined Field3
    EinUDField04 N Y N Y N International Employee User Defined Field4
    EinUDField05 N Y N Y N International Employee User Defined Field5
    EinUDField06 N Y N Y N International Employee User Defined Field6
    EinUDField07 N Y N Y N International Employee User Defined Field7
    EinUDField08 N Y N Y N International Employee User Defined Field8
    EinUDField09 N Y N Y N International Employee User Defined Field9
    EinUDField10 N Y N Y N International Employee User Defined Field10
    EinUDField11 N Y N Y N International Employee User Defined Field11
    EinUDField12 N Y N Y N International Employee User Defined Field12
    EinUDField13 N Y N Y N International Employee User Defined Field13
    EinUDField14 N Y N Y N International Employee User Defined Field14

Report Data Format

Report is an export only data format which can be used to execute the report configured in UltiPro to fetch data. The Report to be executed and the Report parameters should configured in the plug-in.


DataDelimiter Delimiter to be provided for separating attributes when report data is returned.

Filter Filter to control the entries to be exported. There is no option to provide filter while executing report. So the filter processing is done at the connector level.

ReportParameters Configure the available report parameters using this configuration. There is a custom UI to configure report parameters.

ReportPath Path of the report to be executed. Path components can be separated by →. zzzCompany Folders -> Apollo Group, Inc -> FischerIdentity -> HRA_ActivePrimaryJobs_Fischer is a sample report path.

SkipHeadeEntry The first entry will be the header of the report data. When this configuration is true, that entry will be skipped from export data.

There is no pre-configured attributes for this data format. The attributes should be configured based on the report it is going to use. Ther are multiple options to configure the report attributes. The attributes tab for report will looks like as shown below.

Static Names set static names like Column.0, Column.1, Column.2 etc.

Execute Report option use the connected system and plug-in configurations to execute the report and use the header data to build the attribute names.

Sample Data File option use the header data of a sample data file to build the attribute names.

Entitlement support

UltiPro connector doesn't support entitlements.

Set Filter

In order to get specific data from the connected system, use the Filter export option. Filtering can be used during Lookup as shown in the next section.

  1. Select the Filter option from the Export connector screen. Then click Set Filter. The below screen will be displayed.
  3. The Attribute list shows the attributes that are available to filter for the selected data format. The attributes are specific for the data format.
  4. The Comparison list shows the available operators for filtering. The available operator are:
    1. Equal to
    2. Present
    3. Starting with
    4. Ending with
    5. Contains
  5. The value will be used to do the filtering in conjunction with the comparison operator.
  6. The Condition List displays the filtering conditions being configured.
    1. Add will add the configured condition to the list of conditions
    2. Delete will delete the highlighted condition from the list of conditions
    3. Clear will clear the list of conditions.

Note: Every condition added to the list of condition is considered as an AND operation. Only one condition per attribute is allowed.As conditions are added to the list of conditions a filter will be displayed in the Filter Syntax The filter can be modified and created manually if necessary by checking the Edit Filter Manually check box. The manually created filter will go through a validation for the filter syntax.

Lookup Data

To lookup data from UltiPro, use the Lookup Data map rule.

  1. Log in the Workflow and Connectivity studio and double-click the Data Mapper object on the Design 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 Ultimate UltiPro system from the Select System drop-down list.
  5. In the Enter Lookup Prefix field, enter the prefix to be added to the lookup fields.
  6. Select the Lookup Type (Employee or Report) from the drop-down list.
  7. Select the lookup method (i.e. By Filter, By Employee Id) for the lookup type Employee
  8. Based on the settings #6, the next field and the button will change accordingly. Use the Build/Pick button to configure the setting. The Filter usage is explained earlier in section "Set Filter".
  9. The Fields section is used to define the attributes to be fetched using the lookup.
  10. The Advanced Settings option can be used to configure additional configurations like ReportPath, ReportParameters, ResultsPerPage etc.
  11. 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.
  12. Click OK.



Was this article helpful?