Configure the Virtual Roster Employee Demographics Export Integration

This topic describes how to configure this integration.

HCM Dimensions is the system of record for time and attendance data, and people information for employees. Person records include demographic attributes such as name, address, primary job, hire date, termination date.

This integration exports data in person records to a flat file for import by Virtual Roster.

Przestroga :Recommendation: Run this integration for only the data types that you need. If you run this integration for all demographic data at once, system performance suffers.

Typically, you run this integration once a day to update records for all active and newly hired employees.

Before you start

Before you run this integration, you must do the following:

  1. Map the organization chart in Virtual Roster to the business structure in Workforce Dimensions.
  2. Map the leave types in Virtual Roster to the paycodes in Workforce Dimensions.
  3. Get the following credentials: URL for the APIGatewayServer and the URL, User, and Password for the VRServer.
  4. Assign the Virtual Roster license to the people whose records are to be exported.
  5. Configure the hyperfind Wyszukiwarka, która filtruje i wybiera grupy pracowników przy użyciu zapytań określających warunki lub lokalizacje (kryteria). query for Virtual Roster; see the Hyperfind queries topic.
  6. Deploy the HCMDemographicsExport integration pack; see Deploy Integrations.

Configure the integration

Select the environment

  1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

    Uwaga: If prompted, enter your Username and Password. Kliknij Dotknij Log in.

  2. Wybierz kartę Zarządzaj > Zarządzanie atomem.
  3. Wybierz swoje środowisko.

Select environment extensions

  1. In Administration, kliknij dotknij Environment Extensions.
  2. In Process Filter, kliknij dotknij the magnifying glass Search button. It can take several seconds before the button becomes active.
  3. Scroll to and select the integration pack: Virtual Roster People Export > DemographicsExport-v1.

Przestroga :Jeśli wybierzesz Użyj wartości domyślnej w ustawieniach połączenia i właściwościach procesu, upewnij się, że Wartość jest pusta. Jeśli Wartość nie jest pusta, wartość ta uchyla wartość domyślną niezależnie od tego, czy wybrano opcję Użyj domyślnej, czy wyczyszczono ją. Przykład: Jeśli wartość domyślna to abc, ale Wartość pokazuje xyz, integracja wykorzystuje xyz niezależnie od ustawienia Użyj wartości domyślnej.

Configure connection settings

  1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    (Opcjonalnie) Aby zmienić domyślny serwer bramy API:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź Adres URL do serwera.

      Przykład: <URLdzierżawcy>/api
    SFTPServer Required

    Ustawienie serwera SFTP definiuje połączenie z plikiem zawierającym rekordy. Integracje mają dostęp tylko do wewnętrznego konta SFTP.

    Aby zmienić domyślne parametry serwera SFTP:

    1. Wyczyść Użyj wartości domyślnej dla każdego pola.
    2. Wprowadź następujące wartości:

      Wprowadź nazwę wewnętrznego Hosta.

      Wprowadź numer Portu dla wewnętrznego konta SFTP.

      W Użytkownik wprowadź nazwę użytkownika dla wewnętrznego konta SFTP.

      W Hasło wybierz <Zaszyfrowane>. Wprowadź nowe hasło do wewnętrznego konta SFTP. Kliknij Dotknij Zastosuj.
  3. Kliknij Dotknij OK.

Output file

  • File Name: DemographicsExport_yyyyMMddHHmmss.csv
  • Format: Comma delimited
  • Frequency: On-demand or scheduled
  • Header Row: Yes, 1 row
  • Output Folder: /Outbound
Output file
Field Data type Comments or examples
Person Number or Payroll Number

String

  • Maximum length: 15 characters
 The employee's person or payroll number
EIN String

The Employer Identification Number (EIN) designates the company where the employee works for tax purposes

  • Not required
  • An employee can have multiple EINs if they work in multiple departments, locations, jobs.
Badge String The number of the badge or swipe card that employees use as identification
First Name String —
Last Name String —
MI (Middle Initial) String —
Nickname String The employee's preferred name
Gender String

Possible values:

  • M = Male
  • F = Female
  • U = Unknown
Actual Marital Status String

Can be imported from a Custom Field to Virtual Roster

Possible values:

  • Single
  • Married
  • Divorced
  • Separated
  • Widowed
  • Unknown
Employee Type String Can be imported as a Classification by Virtual Roster
Pay Type String

Possible values:

  • Salary Exempt
  • Hourly Non-Exempt
Address 1 String Street and civic number
Address 2 String (Optional) Apartment number
City String —
State/Province String —
Postal / ZIP Code (Postcode) String —
Cell Phone String —
Home Phone String —
Email String —
Reports To Name can be imported from a Custom Field to Virtual Roster String Full name of the employee's manager
Employee Status String Active
Date Birthday (Birth Date)

Date

  • Format: YYYY-MM-DD
 —
Date Hired (Hire Date)

Date

  • Format: YYYY-MM-DD
 —
Date Re-Hired (Rehire Date)

Date

  • Format: YYYY-MM-DD
 Used only if the employee was rehired
Job Last Changed String The date when the current job becomes effective; cannot be in the future.
Date Terminated (Termination Date)

Date

  • Format: YYYY-MM-DD
 Final date of work
Is Smoker String

Possible values:

  • Yes
  • blank
  • No
Default Business Structure Full Path String The full path of the business structure that is assigned to the employee. If Job History is not used, this path can be assigned as the primary job for the employee in Virtual Roster.
Employee EIN String

Designates the company where the employee works for tax purposes

  • Not required
  • An employee can have multiple EINs if they work in multiple departments, locations, jobs.
Business Structure 1 String —
Business Structure 2 String —
Business Structure 3 String —
Business Structure 4 String —
Business Structure 5 String —
Business Structure 6 String —
Business Structure 7 String —
Default Business Structure Abbreviated Path String —