Exchange protocol via SFTP file transfer¶

Exchange protocol¶

The protocol used for file exchanges is SFTP (SSH File Transfer Protocol).
This service uses the SSH-2 protocol version.

Sessions must be established from the client to UKG HR Service Delivery, whether it involves sending or receiving data.
The company has a single account used for identification.

UKG HR Service Delivery verifies that the login request originates from the company using an identification/authentication mechanism, which is performed using an encryption key provided by the company.

SFTP server address¶

UKG HR Service Delivery provides different SFTP servers for data transfer.

This section details the information required for SFTP data transfer from customer IS to UKG HR Service Delivery (ingress) and from UKG HR Service Delivery to customer IS (egress).

SFTP account¶

SFTP Security¶

File deposit and withdrawal¶

cdmat_{client}_tra_{flux}_{timestamp}.xml

<?xml version='1.0' encoding='utf-8'?>
<transfert_report version="1">
  <file>
    <file_name>ndmat_198538752_2011091610440841_sal_rhw_930_20130206113837.csv</file_name>
    <file_timestamp>2013-01-16T14:20:00+01:00</file_timestamp>
    <file_fingerprint algorithm="SHA1">9849a4d500126203a099aca0cd7017cb8748fb2a</file_fingerprint>
    <file_size>238</file_size>
  </file>
</transfert_report>

File naming conventions¶

The naming format of the uploaded files is as follows:

{dest}_{partner}_{client}_{flux}_{appemet}_{version}_{timestamp}.{extension}
or {dest}_{client}_{client}_{flux}_{appemet}_{version}_{timestamp}.{extension}
or {dest}_{client}_{client}_{flux}_{timestamp}.{extension}

With:

• dest: destination application, may take the values:

  • ndmat: For files from the IS client to UKG HR Service Delivery

  • cdmat: For UKG HR Service Delivery files to the IS client

• partner or client: unique identifier of the partner in the case of indirect clients.
  In the case of a direct client, provide the client identifier

• client: unique identifier of the client

• flux: type of the file. May take the values:

  • dis: batched distribution files (payslip, etc.)

  • usr: document management user (user updates)

  • usa: people assist user (user updates)

  • sal: employee (employee updates)

  • ins: registration status

  • sir: company updates

  • bil: billing report

  • dse: data sets

• appemet: (optional) Sending application.
  Used in particular when multiple different applications must communicate with UKG HR Service Delivery

  • From client: application name (ex. SAP)

  • From UKG HR Service Delivery: UKG HR Service Delivery application name (ex. ndmat)
    

    For data sets synchronization, the appemet is used to pass the code of the dataset to synchronize.
    The code of the dataset is unique and available in the administration interface of UKG HR Service Delivery

• version: (optional) If possible, use the exact version of the application, following the character set.
  Used in particular when multiple different applications must communicate with UKG HR Service Delivery

  • Note: For test files to be integrated into the client acceptance platform, indicate « tst »

• timestamp: Timestamp, corresponding to the creation of the file, in yymmddhhmmss format

• extension: zip, pdf, csv, xml, sig

  • Note: The sig extension corresponds to the signature file for each report file generated by UKG HR Service Delivery

For example, an employee file (flux = sal), for a direct client named macrosoft using an HRIS named hrmanager in version 6 would be named as follows:

ndmat_macrosoft_macrosoft_sal_hrmanager_v6_15486131891569.csv