---
title: Installing the Ultipro app
slug: installing-the-ultipro-app
docTags: 
createdAt: 2023-03-24T20:35:36.000Z
---

This section covers setting up the Ultipro integration app, which allows you to sync your employee roster to ChartHop. 

## Review your payroll system data

Your ChartHop payroll app syncs your employee data from your payroll system and builds your org chart in ChartHop. Once your Org Chart is created, you can start using ChartHop.

ChartHop recommends reviewing the data in your payroll system to ensure it is what you expect before you sync it to ChartHop. For example, if an employee has multiple system IDs in your payroll system, that employee’s data won’t sync properly. You should also be sure that your payroll system reflects an accurate view of your organization, including reporting structures, employee locations, and compensation. 

## Create an Ultipro User account

Before you can install the Ultipro app, you need to create an Ultipro user account and enable some specific permissions.  Link your Ultipro user account to the Ultipro app in ChartHop using your created login credentials when you install the app.

To create an Ultipro user account:

1. Login to Ultipro, and navigate to **System Configuration**.
2. Select **Service Account Administration**.
3. Select **Add**.
4. Enter a Username, Password, and Email for for the account
5. &#x20;Select the Web Service permissions and enable view permissions for the following options:
   - compensation-details
   - person-details
   - employee-job-history-details
   - Employee/User-defined fields
   - Personnel Integration
6. Select **Save**.

## Copy an Ultipro Customer API key

For ChartHop to access your organization's Ultipro payroll data, you need to use your Ultipro **Customer API key**. The key is automatically created when you create your Ultipro user account and configure your **Service Account Administration** settings.

To access your Ultipro API key: 

1. In Ultipro, navigate to **Service Account Administration**.
2. Copy the **Customer API key**.

## Create an Ultipro domain/service host name

You need the domain/service host name when you install the Ultipro app in ChartHop.

To access your Ultipro domain/server host name:

1. In Ultipro, select **Menu**.
2. Select **System Configuration**.
3. Select **Security**.
4. From the **Web Services** page, copy the **Domain/Service Host Name&#x20;**&#x69;n the following format:
   - &#x20;`service$.ultipro.com` (where $ is a numeric value).

## Install the Ultipro app

After you have your Ultipro Customer API key and service account administration credentials, you can install the Ultipro integration app in ChartHop.

1. From the left sidebar, select **Apps & Bundles**.
2. From the sub-menu, select **Apps,&#x20;**&#x69;f not already pre-selected.
3. Select the **Availible Apps** tab.
4. Scroll to your payroll app and select **Install&#x20;**&#x6F;n the far right of the respective app's row.

### Connect the Ultipro app

When you select **Install**, you'll be prompted to walk through configuring your payroll app.

1. Enter your **Service Account Username&#x20;**&#x61;nd **Service Account Password&#x20;**&#x69;n the provided fields.
2. Paste your Ultipro **Customer API key** to the provided field.
3. Paste your **Domain/Service Host Name&#x20;**&#x74;o the provided field.
4. Select **Next step**.

### Configure data sync settings for Ultipro

Data sync settings control how and what data is synced to ChartHop from your payroll system. For example, you can choose whether or not to create a backfill position in ChartHop when you have a departure in your payroll system. Other advanced settings allow you to exclude certain employees.

- Select one of the two options:
  - **Automatically create backfills** - This option creates a backfill position in ChartHop (open job) when an employee is marked as departed in your payroll system.
  - **Sync departures only** - This option removes the departed employee from ChartHop. The employee's job history remains in ChartHop.

### Configure advanced settings

Advanced settings allow you to better control how your payroll data syncs to ChartHop.

ChartHop recommends accepting the default values for these settings. Please get in touch with ChartHop Support or your Customer Success Manager for assistance if needed.

1. Expand the **Advanced settings** section. 
2. Use the following table to guide you through advanced settings decisions. 
3. When finished, select **Next step**.

| **Setting**                              | **Description&#xA0;**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Missing location information<br /><br /> | Select one of the two options for what should happen if location information is set for an employee.<br />* **Set Remote as the default location in ChartHop** - When selected, any open role that does not have a location set will be set to have a Remote location in ChartHop.
* **Leave location blank in ChartHop&#x20;**- When selected, any open role that does not have a location set in your payroll app will not have a location set in ChartHop.                                                                                                                                                       |
| Advanced sync options                    | Select the data changes you want to include in your sync. You can include some or all of the following employee data: <br />* Job titles 
* Managers 
* Groups 
* Compensation 
* Hire dates                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Overwrite person fields <br /><br />     | ChartHop recommends using this setting to avoid needing to update both ChartHop and your payroll system when a change is made to any field value that is synced from your payroll system.<br /><br />When you choose this option, your payroll system remains the source of truth for the following fields in ChartHop: birthdate, gender, home address, and so on. Any edits you or an employee make to this data in ChartHop are overwritten during synchronization. This can pose an issue when someone uses ChartHop to update employee fields in ChartHop, without requesting an update in the source system.  |
| Historical data                          | Choose whether or not you want to sync historical data. You can turn this off if you want to exclude any historical changes before the date of your initial sync.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Exclude IDs                              | To exclude specific individuals from the sync, enter their unique payroll system IDs here, separated by commas. <br /><br />Generally, the company ID should be left blank unless otherwise informed by your ChartHop Customer Success team.                                                                                                                                                                                                                                                                                                                                                                        |
| Job change history<br />                 | When importing job data into ChartHop, include changes within the specified period.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

### Run an initial one-time sync of your payroll data

When you first configure your payroll app, you should run a one-time sync to verify that the sync is operating as you expect it to and that your data is what you expect.

To run a one-time sync:

1. In the setup wizard, select the **Run one-time sync** option.
2. Select **Finish setup**.

## Verify your data in ChartHop

After running your first sync, you can use the Data Sheet and Org Chart pages to spot-check your data. You can use the Sync History page to verify when the sync was run and if it encountered any issues. 

You should spot-check your ChartHop org for the following:

- Correct management reporting lines
- Compensation data
- Employee information on profiles (names, addresses, and so on)
- Job titles
- Departments
- Locations

:::hint{type="info"}
Remember that most issues with your synced data originate in your payroll system. ChartHop allows you to visualize your employee data to make finding these discrepancies easier. Still, you’ll need to fix any data discrepancies in your payroll system and rerun the sync to view the fixes in ChartHop.
:::

## Configure your payroll app sync to run daily

After you’ve synced your data for the first time and verified your Org Chart, you should configure a daily sync. The value of syncing your payroll data to ChartHop is that it ensures that your employee data is always up to date. 

1. From the left sidebar, select **Apps & Bundles**.
2. From the sub-menu, select **Apps,&#x20;**&#x69;f not already pre-selected.
3. Select the **Installed Apps** tab.
4. Scroll to your payroll app and select the gear (settings) icon on the far right of the row to view app settings.
5. Within the **App status & sync** settings section, select the **Edit** (pencil) icon.
6. Toggle the auto-sync option to on.
7. Select **Save**.


