Get Started with Integration Studio Designer

The secure agent is the engine that moves data between sources and targets. This lightweight, self-upgrading application runs behind your firewall and processes the integrations on your network.

It basically provides the communication to Informatica Cloud from your local machine (or server). It is important to note that the Informatica Secure Agent provides secure access to your data sources and never uploads your data to the Informatica Cloud servers. This is shown in this Informatica diagram (Informatica, 2015). The UKG Pro database is indicated in the Local Files and/or Databases section.

You can install the Secure Agent from your local machine or you can choose to run this from a server. It is best that you install this on a machine that is always running, such as a server.

1. Log in to Informatica Cloud Services from the destination machine.
2. From the Administrator page, select Runtime Environments.
3. Select Download Secure Agent. The Download Agent pop-up window appears.
4. Select your platform (Windows or Linux) and then select Download.
5. When the Download is complete, install the agent by running the agent_install.exe file.
6. Follow the onscreen prompts to complete the installation.
7. Near the end of the installation process, a prompt to register the secure agent appears.
8. Enter your Informatica Cloud Services login credentials (user name and password).
9. When the installation is complete, the agent appears on the Runtime Environments page in an Active status.
   

   Note

   If the Secure Agent is not listed or is in an inactive status, there may be a communications problem between the Agent and the Informatica Cloud Services. For Secure Agent troubleshooting tips, check the Informatica Cloud Services online help or visit the Informatica Community site.

A service account provides the credentials required to integrate with UKG Pro using Web Services, Report Exports, or Integration Studio Designer.

1. From the Service Account Administration page, complete one of the following:
   • To add a service account, select Add. The Add/Change Service Account page appears.
   • To change a service account, select the User Name link for the service account from the list.
2. From the Add/Change Service Account page, enter a user name for the account. The user name must be unique; it cannot be an existing user account name used to access the portal. We recommend that you add the partner name to the end of the recommended user names as shown in the table below.
3. Enter an email address for the service account.
4. The Generate New Password box is automatically selected when adding a new Service Account. After entering the remaining required information and selecting Save, a New Password window displays with the randomly generated password. You can copy the password and save it in a secure location. You will not be able to see this password again after closing the New Password page. If the password is lost or forgotten, a new one will need to be generated.
   
5. For each Web Service, select which types of methods (Add, Delete, View, and/or Edit) the service account will be able to access.
   Note Granting View access allows access to the Find method (if applicable) and Get methods for a Web Service. Some methods are not available for certain Web Services and cannot be selected.

   For the following integrations, ensure that the minimum access required is selected for the associated service account methods:

   Web Service Integrations
   Partners	Service Account Method Required	Recommended Username	Minimum Access Required
   * Denotes a Partner Integration that is Coming Soon
   Applicant Tracking System
   Greenhouse iCIMS connector Powered by The Cloud Connectors Jobvite Lever Taleo connector Powered by Modulus Data	Company Configuration Integration Employee Export	ApplicantTracking-PartnerName	View Access
   Compensation Data
   PayScale	Company Configuration Integration Compensation Details Employee Job History Person Details Personnel Integration	CompData-PartnerName	View Access
   Compensation Management
   HRSoft	Company Configuration Integration Employee Compensation Details Employee Employment Information Employee Job History Details Employee Person Details Employee User-Defined Fields Personnel Integration	CompManagement-PartnerName	View Access
   Employee Verification
   Note For Equifax customers, refer to the Income and Employment Verification from Equifax Integration job aid in the UKG Community Library for more information.
   Equifax US Equifax Canada Vault Verify	Employee Compensation Employee Pay Statement Employee Phone Information Employee Termination Company Configuration Integration Employee Export Personnel Integration Employee Job History Details Employee Person Details Employee Compensation Details	EmployeeVerification-PartnerName	View Access
   Expense Management
   Chrome River	Company Configuration Integration Employee Direct Deposit Employee Export	ExpenseManagement-PartnerName	View Access
   Financial Wellness
   Vault	Company Configuration Integration Employee Export Personnel Integration	FinancialWellness-PartnerName	View Access
   Global Payroll
   activpayroll CloudPay Immedis PayAsia Groupo Ono*	Company Configuration Integration Employee Compensation Details Employee Job History Details Employee Person Details Employee Export Global Employee Direct Deposit Payroll Integration Personnel Integration Third Party Pay Services	GlobalPayroll-PartnerName	View Access Note: The Third Party Pay Services requires: Add, View, Edit, and Delete Access
   Identity Management
   CyberArk ManageEngine OneLogin Ping	Company Configuration Integration Employee Person Details Personnel Integration Note: OneLogin also requires Reports-As-A-Service	IdentityManagement-PartnerName	View Access
   Integration Studio / Informatica
   Integration Studio Informatica	Employee Self-Service API	IntegrationStudio	View Access
   Job Posting
   Appcast TeamWork Online Symphony Talent	Reports-As-A-Service	JobPosting-PartnerName	Business Intelligence (BI) Access
   Learning Management System (LMS)
   Cornerstone OnDemand	Employee Export (for Employee Changes API) Company Configuration Integration (For Organization Levels, Jobs Configuration and Locations Configuration APIs) Development Opportunity Participation Service Development Opportunity Service Development Opportunity Session Service	LMSIntegration-PartnerName	View Access Note: These services require Add, View, Edit, and Delete Access: Development Opportunity Participation Service Development Opportunity Service Development Opportunity Session Service
   Organization Chart
   Ingentis Softwareentwicklung GmbH OrgChart Now by OfficeWork Software	Employee Compensation Details Employee Person Details Personnel Details	OrganizationChartIntegration-PartnerName	View Access
   PayCard
   rapid! PayCard	Company Configuration Integration Employee Direct Deposit Employee Person Employee Person Details	PayCardIntegration-PartnerName	View Access
   Scheduling
   Humanity*	Company Configuration Integration Employee Export Personnel Integration	SchedulingIntegration-PartnerName	View Access
   Social Collaboration
   Planned Companies Beekeeper	Company Configuration Integration Employee Export	SocialCollaboration-PartnerName	View Access
   Work Opportunity Tax Credits (WOTC)
   HireCredit	Employee Pay Statement Service Personnel Integration	WOTC_PartnerName	View Access
   Additional Functionality to Support Background Screening
   Additional functionality to support Background Screening	Company Configuration Integration	BackgroundScreening-PartnerName	View Access

6. Select Save. The Service Account Administration page appears with the new or modified service account.

The User API Key and Customer API Key are required to authenticate a call to UKG Pro for integrations using Web Services and Integration Studio Designer.

1. From the Service Account Administration page,
   • locate the value for the Customer API Key
   • locate the User API Key for the applicable service account.

   
2. Note the value of the keys for use when configuring Web services or an Informatica Cloud connection.

Create the UKG Pro connection from the Connections page of Informatica Cloud. The connection is necessary to extract data from UKG Pro and holds the connection information for a specific endpoint.

1. From the Connections page, select New Connection. The New Connection page appears.
   • Enter a unique name for the connection in the Connection Name field.
   • Enter an optional description in the Description field, if desired.
   • From the Type drop-down list, select UKG Pro (UKG). The UKG Pro Connection Properties section appears.
2. From the Runtime Environment drop-down list, select the name of the server where you installed the Informatica Cloud Secure Agent.
3. At the Password and UKG Pro User Name fields, enter the UKG Pro Service Account password and username.
4. At the Service Host Name field, enter the service host name. The service host name is your company UKG Pro domain. The format of the domain is service$.ultipro.com, where $ is a numerical value. You can find the service host name in the web service endpoints from the Web Services page in UKG Pro (Menu > System Configuration > Security > Web Services).
   Note

   When you enter the service host name, do not include the "http://" from the endpoint path found on the Web Services page.

5. At the Customer API Key field, enter your customer API key.
6. At the User API Key, enter your user API key. (Be sure to enter the User API key associated with the Service Account.)
7. From the Application Module drop-down list, select the applicable application module. For most general UKG Pro integrations, select HR, Payroll, Talent, Benefits.
   

   Note

   The application modules are explained as follows:

   • The HR, Payroll, Talent, Benefits application module is used to extract HR, Payroll, Talent, and Benefits data, including integrations triggered by an Integration Event.
   • The Integration Events application module is only used to extract a list of completed UKG Pro Events on-demand.
   • The Other application module is used for Time Management integrations.
8. Select Test to test the new connection for UKG Pro. A status message appears to let you know if the connection is valid.
   Note

   Verify that the secure agent is active and running before you test the connection.

9. Select Save to save the new connection.