Configure the Universal People Import Integration

This topic describes how to configure this integration.

This integration pack imports employee records from a flat file.

Universal integration packs exchange data by way of flat files, either to export data to the file or import data from the file. Other systems access the data in these flat files to complete the import or export integration. The default settings allow rapid configuration and runs of the integration process, while the exposure of the data maps and cross-reference tables in the extensions allows overrides and customizations of the default data mappings or values.

Before you start

Deploy the PeopleImport integration pack; see Deploy Integrations.

Configure the integration

  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.
  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: Universal People Import > PeopleImport.

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.

  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.
  1. Select Process Properties.

  2. Przestroga :Nie edytuj wartości domyślnych Właściwości uwierzytelniania. Domyślnie pliki cookie są włączone i ustawiają wartości właściwości uwierzytelniania.

    Only while you test or design integration templates, should you edit the properties to connect to the authentication server and get the access token to execute APIs.

    1. From the Process Property dropdown list, select AuthenticationProperties.
    2. In GatewayDefaultPort, clear Use Default. Enter the path to the port for the API gateway.
    3. In AppKey, clear Use Default. This disables cookies to set the access token such as to test or debug the integration. Enter an external AppKey. To generate an app key, see Generate and Access App Keys.
  3. From the Process Property dropdown list, select PeopleImport-v1_CRTConfig to define headers in cross-reference tables.

    Tabele odsyłaczy (CRT) to tabele wyszukiwania używane przez integracje do tłumaczenia wartości parametrów. Co najmniej jedna wartość danych z systemu źródłowego może zostać użyta do przypisania co najmniej jednego parametru w systemie docelowym.

    Przestroga :The Boomi™ application does not return default values for cross-reference table headers. You have to enter the headings in Value.

    Uwaga: For details, see Configure cross-reference tables.

    For each of the tables:

    1. Clear Use Default. 
    2. In Value, enter the header column names, separated by commas (,) but no spaces, exactly as shown below the Value field. You can select and copy the headers from the screen, then paste them in the Value field.
    3. Repeat for the other tables.

  4. From the Process Property dropdown list, select PeopleImport_ProcessProperties to set process properties that must be configured before the integration can run.

    Process Properties
    Property Required Actions
    DisqualifyActive Not required

    To not process person records of active employees:

    1. Clear Use Default. 
    2. Select Value.
    DisqualifyInactive Not required

    To not process person records of inactive employees:

    1. Clear Use Default. 
    2. Select Value.
    DisqualifyTerminated Not required

    To not process person records of terminated employees:

    1. Clear Use Default. 
    2. Select Value.
    DisqualifyNew Not required

    To not process person records of new employees:

    1. Clear Use Default. 
    2. Select Value.
    DisqualifyExisting Not required

    To not process person records of current employees:

    1. Clear Use Default. 
    2. Select Value.
    AssignLicenses Not required

    Default = Hourly Timekeeping, Scheduling

    To change the value:

    1. Clear Use Default.
    2. Select Value.
    3. Enter a comma-separated list of licenses to assign during the import or update of records.
    EnableTransactionAssistant Not required

    Default = true

    To not submit import errors to Transaction Assistant:

    1. Clear Use Default. 
    2. Select Value.
    BatchName Not required

    Default = Generic People Import

    To change the value:

    1. Clear Use Default.
    2. Select Value.
    3. Enter the batch name to group the failed records in Transaction Assistant.

    _EnableCustomMapping

    		Not required

    To use a custom map:

    1. Clear Use Default.
    2. Select Value.

    _DisableReportsToMapping

    		Not required

    Przestroga :If the people records include new managers, the Reports To field for their employees can be wrong and cause errors because the manager records may be imported after the employee records. To prevent these errors, the person who imports the people records must run the integration twice: the first time with DisableReportsTo selected, and the second time with DisableReportsTo not selected.

    Default = True, do not send employee-record reports to reporting manager.

    To send the reports to the reporting manager:

    1. Clear Use Default.
    2. Leave Value blank. 
    Delimiter Not required

    Default = comma (,)

    To change the character that separates data values in the flat file:

    1. Clear Use Default. 

    2. Enter the character.
    UnassignLicenses Not required

    To remove licenses during the import:

    1. Clear Use Default.
    2. Enter the licenses, separated by commas (,).
    Roles Not required

    Default = Employee,Manager

    Przestroga :Managers can have multiple roles. In most cases, People Import integrations update only the attribute values of the default role if the source of record has changed, and do not import data for other roles that are assigned to the managers. However, integrations can be modified to support imports of multiple manager roles.

    To change the roles to assign during the import or update:

    1. Clear Use Default. 
    2. Enter the licenses separated by commas (,).
    Hyperfind Wyszukiwarka, która filtruje i wybiera grupy pracowników przy użyciu zapytań określających warunki lub lokalizacje (kryteria). Not required

    Wartość domyślna = 1 (wyświetlana jako pusta), co oznacza Wszyscy na miejscu Zapytanie, którego wynikiem jest lista pracowników powiązanych z grupą pracowników menedżera. Zapytanie Wszyscy na miejscu znajduje osoby, które są aktywnymi pracownikami lub aktywnymi użytkownikami według stanu na dzisiaj. i obejmuje wszystkich aktywnych pracowników.

    Aby użyć zapytania HyperFind dla innej grupy pracowników:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź identyfikator HyperFind.
      Uwaga:
      • Funkcja HyperFind ad hoc nie jest obsługiwana.
      • Wszyscy na miejscu nie obejmuje zwolnionych i nieaktywnych pracowników, nawet jeśli posiadają oni sumy w tym okresie. Aby uwzględnić te sumy, skonfiguruj funkcję HyperFind obejmującą zwolnionych i nieaktywnych pracowników oraz wybierz tę funkcję HyperFind w tej właściwości procesu.
      • Maksymalna liczba pracowników w wyszukiwaniu Hyperfind wynosi 3500. Aby przetworzyć więcej rekordów pracowników, podziel populację na mniejsze zapytania HyperFind w celu uruchomienia sekwencyjnego.
    PayPeriod Not required

    Default = 13 (Today)

    Aby zmienić okres wypłaty wynagrodzenia:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź jedną z następujących wartości dla okresu wypłaty wynagrodzenia:

      0 = Poprzedni okres wypłaty wynagrodzenia

      1 = Bieżący okres wypłaty wynagrodzenia

      2 = Następny okres wypłaty wynagrodzenia

      3 = Poprzedni okres harmonogramu Powtarzający przedział dni w harmonogramie zdefiniowany do celów administracyjnych, takich jak okresy wypłaty wynagrodzenia.

      4 = Bieżący okres harmonogramu

      5 = Następny okres harmonogramu

      6 = Tydzień do dnia

      7 = Zeszły tydzień

      8 = Wczoraj

      10 = Zakres dat względnych

      11 = Określona data

      12 = Określona data względna

      13 = Dzisiaj
    _PayPeriodSpan Not required

    To define a fixed span for which to get data:

    1. Clear Use Default.
    2. Enter the date span in MM/DD/YYYY MM/DD/YYYY format.
    _Threshold Not required

    Default = 5000

    To define a larger or smaller maximum number of people for which to get data:

    1. Clear Use Default.
    2. Enter the maximum number without decimals.
    _ProcessExtendedDataMap1 Not required

    To enable processing by way of an extended data map:

    1. Clear Use Default.
    2. Select Value.
    _ProcessExtendedDataMap2
    _ProcessExtendedDataMap3

    _ProcessExtendedDataMap4

    EnableLogging Not required

    Tip: By default the logs for API responses are created in the atom cloud. To view the logs for process errors, select Manage > Process Reporting.

    To create log files of data map output:

    1. Clear Use Default.
    2. Select Value.
    _EnableFixedLengthMapping Not required

    To set data transformation to fixed-length profile mapping:

    1. Clear Use Default.
    2. Select Value.

  5. From the Process Property dropdown list, select PeopleImport_RehireProcessProperties to set process properties for the integration to process data for rehired employees.

    Rehire Process Properties
    Property Required Actions
    _EnableCustomMappingForRehire Not required

    To define custom mapping and not use the default data map for rehired employees:

    1. Clear Use Default.
    2. Select Value.
    _ProcessRehires Not required

    To enable processing of rehired employees:

    1. Clear Use Default.
    2. Select Value.
    _ProcessExtendedMapForRehire1 Not required

    To enable processing by way of an extended data map:

    1. Clear Use Default.
    2. Select Value.
    _ProcessExtendedMapForRehire2
    _ProcessExtendedMapForRehire3
    _ProcessExtendedMapForRehire4
    HyperfindTypeForRehire Not required

    Default = Hyperfind

    Do not change this property.
    HyperfindForRehire Not required

    Wartość domyślna = 1 (wyświetlana jako pusta), co oznacza Wszyscy na miejscu i obejmuje wszystkich aktywnych pracowników.

    Aby użyć zapytania HyperFind dla innej grupy pracowników:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź identyfikator HyperFind.
      Uwaga:
      • Funkcja HyperFind ad hoc nie jest obsługiwana.
      • Wszyscy na miejscu nie obejmuje zwolnionych i nieaktywnych pracowników, nawet jeśli posiadają oni sumy w tym okresie. Aby uwzględnić te sumy, skonfiguruj funkcję HyperFind obejmującą zwolnionych i nieaktywnych pracowników oraz wybierz tę funkcję HyperFind w tej właściwości procesu.
      • Maksymalna liczba pracowników w wyszukiwaniu Hyperfind wynosi 3500. Aby przetworzyć więcej rekordów pracowników, podziel populację na mniejsze zapytania HyperFind w celu uruchomienia sekwencyjnego.
    PayPeriodForRehire Not required

    Default = 13 (Today)

    Aby zmienić okres wypłaty wynagrodzenia:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź jedną z następujących wartości dla okresu wypłaty wynagrodzenia:

      0 = Poprzedni okres wypłaty wynagrodzenia

      1 = Bieżący okres wypłaty wynagrodzenia

      2 = Następny okres wypłaty wynagrodzenia

      3 = Poprzedni okres harmonogramu

      4 = Bieżący okres harmonogramu

      5 = Następny okres harmonogramu

      6 = Tydzień do dnia

      7 = Zeszły tydzień

      8 = Wczoraj

      10 = Zakres dat względnych

      11 = Określona data

      12 = Określona data względna

      13 = Dzisiaj
    _PayPeriodSpanForRehire Not required

    To define a fixed span for which to get data:

    1. Clear Use Default.
    2. Enter the date span in MM/DD/YYYY MM/DD/YYYY format.
    _ThresholdRehire Not required

    Default = 5000

    To define a larger or smaller maximum number of people for which to get data:

    1. Clear Use Default.
    2. Enter the maximum number without decimals.
    EmploymentStatusEffDateForRehire Not required

    To set a default effective date for the employment status of rehired employees to change to hired:

    1. Clear Use Default. 
    2. Enter the date in MM/DD/YYYY format.
    _EnableFixedLengthProfileMapping Not required

    To set data transformation to fixed-length profile mapping:

    1. Clear Use Default.
    2. Select Value.

  6. From the Process Property dropdown list, select PeopleImport_SFTPProperties.

    SFTP Properties
    Property Required Actions
    SourceDirectory Required

    Ścieżka katalogu na serwerze SFTP, z którego proces integracji odczytuje plik.

    Wartość domyślna = Użyj katalogu /Przychodzące.

    Aby zdefiniować inną ścieżkę katalogu:

    1. Wyczyść Użyj wartości domyślnej.
    2. Wprowadź ścieżkę do katalogu.

      Przestroga :Upewnij się, że ten katalog jest skonfigurowany na serwerze SFTP.
    _OutputDirectory Not required

    Directory on the SFTP server where the destination file is archived after processing.

    Default = use the default /outbound directory.

    To define a different directory path:

    1. Clear Use Default.
    2. Enter the path to the directory.

      Przestroga :Make sure that this directory is configured on the SFTP server.
    _MoveProcessedFileToDirectory Not required

    The directory on the SFTP server to move the destination file after data is successfully uploaded.

    Default = true, use the default directory.

    To define a different directory path:

    1. Clear Use Default.
    2. Enter the path to the directory.

      Przestroga :Make sure that this directory is configured on the SFTP server.
    _DeleteSourceFileAfterReading Not required

    Default = false; do not delete the source file after processing.

    To delete the source file but archive it to _DestinationDirectoryPath:

    1. Clear Use Default.
    2. Select Value.

    SourceFileName

    		Not required

    The name of the file that contains the data to import.

    Default = true, use the default file name.

    To define a different file name:

    1. Clear Use Default. 

    2. Enter the filename. Use a .csv extension.

      You can use the asterisk (*) or question mark (?) as wildcard characters to enter patterns of file names so that the integration reads only files that have names that match this filter.

    Default = Baseline_PeopleImport_univ.csv.

Tabele odsyłaczy (CRT) to tabele wyszukiwania używane przez integracje do tłumaczenia wartości parametrów. Co najmniej jedna wartość danych z systemu źródłowego może zostać użyta do przypisania co najmniej jednego parametru w systemie docelowym.

Tabela odniesień (przeglądowa) (CRT) przekłada wartości parametrów w integracji w następujący sposób:

  • Organizuje wartości danych w wierszach i kolumnach:
    • Maksimum = 20 kolumn, 10 000 wierszy.
  • Może łączyć wartości z wielu kolumn w celu określenia pojedynczej wartości wyjściowej.
  • Jeśli więcej niż jeden wiersz jest zgodny z wartością odniesienia, pierwsze dopasowanie jest wartością wyjściową.
  • Jeśli nie zostanie znalezione dopasowanie, wartość wyjściowa może mieć wartość null lub integracja może powodować błędy.

  1. Przestroga :For the cross-reference tables that you are customizing, make sure that Use Default is not selected in Process Properties > {ProcessName}_CRTConfig, and that the headers are defined.

  2. Select Cross Reference.

  3. From the Cross Reference dropdown list, select one of the following:

    You cannot change the names of the tables.

    _PeopleImport-v1_LookupTable1—5 — Column headers:

    Field1,Field2,Field3,Field4,Field5,Field6,Field7,Field8,Field9,Field10,Field11,
    Field12,Field13,Field14,Field15,Field16,Field17,Field18,Field19,Field20

    _PeopleImport-v1_PayperiodLookupTable — Column headers:

    Payperiod,Symbolicperiod

  4. Wybierz Uchyl, aby:

    • Pobrać tabele podczas uruchamiania integracji
    • Edytować komórki tabeli w Rozszerzeniach
  5. Repeat for other tables.

(Optional)

Mapa danych tłumaczy strukturę danych z formatu źródłowego na format docelowy. Przykłady: Zamapuj „PersonID” w źródle na „Person ID” w miejscu docelowym lub „LastName” na „Last Name”.

Każdy pakiet integracji ma domyślną mapę danych. Edytowanie domyślnej mapy ogranicza się do dodawania pól, zmiany mapowań lub wstawiania funkcji. Wszelkie zmiany uchylają poprzednie wartości. Jeśli wstępnie zdefiniowane pola nie odpowiadają Twoim wymaganiom, użyj domyślnej mapy jako przewodnika podczas tworzenia niestandardowej mapy danych.

Override fields by a null output

A person record has PrimaryEmail which maps to EMailAddress1 and SecondaryEmail which maps to EMailAddress2.

If the integration imports only the SecondaryEmail address and not the PrimaryEmail address, insert a function to map EMailAddress2 to a null value as follows:

  1. Insert a String Replace function between SecondaryEmail and EMailAddress2.
  2. Map SecondaryEmail to Original String and String to Search.
  3. Map Result to EMailAddress2 > Address.

Requirements

  • All fields require the Timekeeping license.
  • Each of the templates must define record disqualification and exclusion criteria.

Customize data transformation

  1. Select Data Maps.

  2. From the Data Maps dropdown list, select one of the following:

    • Default map: PeopleImport_A_FlatFileProfile

      • Required fields are defined in the API and are indicated in the table.
      • Effective dating is defined in the API. If effective dates are not provided, the dates default to today.
      • Date fields use YYYY-MM-DD format.
    • Custom map: PeopleImport_B_CustomFlatFileProfile

      The _EnableCustomMapping process property must be set to true. The source is empty and ready for you to add and map fields.

    • The other data maps are variations for extended data maps. The corresponding _ProcessExtendedDataMap process properties must be enabled.

  3. Wybierz Rozwiń, aby rozwinąć lub Zwiń, aby zwinąć poziomy.

    Aby rozwinąć wszystkie poziomy, kliknij prawym przyciskiem myszy ikonę zielonych pól Opcje poziomu mapy. Wybierz Rozwiń wszystko

    Wiersze pokazują powiązania między polami w źródle (lewa strona), wszystkimi funkcjami pośrednimi i miejscem docelowym (prawa strona).

  4. (Optional)

    Przestroga :The default mappings are developed and tested based on best practices. If you make changes, you may get unexpected results. Modify and test carefully.

    • Change mappings — When you customize a default data map, you can add fields only to the end of the map.

      You can select and drag to change the links between the source (left column), function (middle column), and destination (right column) items. A single source field can link to multiple destination fields, but a destination field can link to only one source field.

    • Transform the data — A map can include intermediate functions that transform the data. Examples: Perform mathematical calculations on the values or get values from a cross-reference table.

      Uwaga: To override a field — for example because you cannot delete it from a default map — insert a function that has a null output.

      1. In Function, kliknij dotknij the plus button Add map function to add an intermediate function.
      2. From Category, select a category of functions:

        String — Trim, add to, concatenate, replace, remove, split, or change the case of text.

        Przestroga : Do not use special characters such as angle brackets (< or >) in data in cross-reference tables, data maps, and input files. These characters can make the integration fail.

        Numeric — Perform mathematical calculations on the data.

        Date — Change the format or get the current date.

        Lookup — Get data from a cross-reference table (CRT), document cache, SQL query, or define a key-value change.

        Connector — Call a value from a connector to an application or data source.

        Custom Scripting — Transform data by way of Groovy or JavaScript code.

        Properties — Get or set process or document properties.

      3. Select the function from the list in the selected category.
      4. Kliknij Dotknij OK.
      5. If prompted in Configure Defaults, enter the relevant values. Select a Caching. Kliknij Dotknij OK.
      6. Select and drag from a source field to an input of the function.
      7. Select and drag from the output of the function to a destination field.
      8. Repeat to add another function.
  5. When you finish, kliknij dotknij OK.

Base integrations: PeopleImport-v1 and Universal People Import (QA or NPR)

Default source file = Baseline_PeopleImport_univ.csv.