Configure Dynamic File Names for ADP Celergo

You can configure Payroll Interface for ADP Global Payroll V2 to generate the output file names dynamically.

The file name for ADP Celergo clients using Payroll Interface for ADP Global Payroll V2 is:

CEL_ORC_<System Name><Client Code>_<Date Stamp><Time Stamp>_<2 Character Country ISO Code>OGPI_HRMD<SequenceNumber>
Note: Existing customers using a different filename can continue to use the same file name.

Configure lookup types, value sets, and fast formula as required, to generate the output file.

Lookup Type

Configure a new lookup type to hold implementation-specific values for few components in the dynamic file name. For example, the Client Number might vary between different customers. Create a lookup type to use it in a file name.

Here's how you can create a lookup type:
  1. On the Home page, click the Lookups quick action under the My Client Groups tab.

  2. On the Manage Common Lookups page, click New.

  3. Enter these values:

    Parameter

    Value

    Lookup Type

    ADP_CEL_OUT_FILE NAME_COMP

    Meaning

    File name component values

    Description

    Holds values for components in the ADP Celergo output file name.

    Module

    Volume Report Payroll Outbound Interface Reports

  4. In the Lookup Codes section, click New.

  5. Enter these values:

    Parameter

    Value 1

    Value 2

    Lookup Code

    ADP_CEL_SYSTEM_NUMBER

    ADP_CEL_CLIENT_NUMBER

    Enabled

    Yes

    Yes

    Meaning

    Enter the system number provided by ADP Celergo.

    Enter the client number provided by ADP Celergo.

    Parameter

    Value 1

    Value 2

    Description

    ADP Celergo System Number

    ADP Celergo Client Number

  6. Click Save.

Value Sets

Use value sets to extract various values required to form the dynamic output file name.

This table shows how to define new value sets:

To Derive

Name

FROM Clause

ID Column Name

WHERE Clause

Legislation Code

ADP_Legislation_Code

PER_LEGISLATIVE_DATA_GROUPS_VL

LEGISLATION_CODE

LEGISLATIVE_DATA_GROUP_ID=:{PARAMETER.LEGISLATIVE_DATA_GROUP_ID}

File Name Component

ADP_CEL_OUT_FILENAME_COMP

HCM_LOOKUPS

MEANING

lookup_type='ADP_CEL_OUT_FILE NAME_COMP' and lookup_code=:{PARAMETER.LOOKUP_CODE}

Date and Time

System Time Stamp

dual

to_char(systimestamp,'YYYYMMDDHHmiss')

NA

Note: If you create the value sets with same name and codes as mentioned in this table, you can use the sample formula mentioned in Fast Formula section as is. However, update the fast formula appropriately if you create different names and codes.

Fast Formula

A fast formula combines the various file name components in the correct sequence and returns the final file name.

This table shows how to create fast formula of type Extract Rule:

Note: Don't specify the LDG while creating the fast formula, so that the formula is available across LDGs.

Formula Parameter

Value

Formula name

ADP_CELERGO_OUT_FILENAME_FORMULA

Description

Formula to consolidate various file name components and return the final output file name dynamically.

Formula text

------Formula starts-------- DEFAULT FOR RULE_VALUE IS ' ' l_instance_name=GET_PARAMETER_VALUE('INSTANCE_NAME') l_param ='|=LOOKUP_CODE=''ADP_CEL_SYSTEM_NUMBER''' l_system_id = GET_VALUE_SET('ADP_CEL_OUT_FILENAME_COMP',l_param) l_date=GET_VALUE_SET('System_Time_Stamp') l_leg_id = GET_PARAMETER_VALUE_NUMBER('LEGISLATIVE_DATA_GROUP_ID') l_leg_id_param ='|=LEGISLATIVE_DATA_GROUP_ID='+to_char(l_leg_id) l_leg_code = GET_VALUE_SET('ADP_Legislation_Code',l_leg_id_param) l_final_value='CEL_ORC_P'+l_system_id+'_'+l_date+'_'+l_leg_code+'GPI'+'_'+'HRMD'+'01'+'.xml'+'.pgp' RETURN l_final_value -------Formula ends------------------------

Ensure that the formula returns the value through variable l_final_value.

Save and compile this formula.

Mapping File Name Attributes

An additional attribute called ADP Celergo File Name has been delivered to address dynamic file name requirements. You can map additional delivery options you create with this attribute to generate files with the filename returned by the formula ADP_CELERGO_OUT_FILENAME_FORMULA.

The application uses the attribute in the delivery options to generate the file with the dynamic file name.

  1. On the Home page, click the Extract Definitions quick action under the My Client Groups tab.

  2. Search for the extract definition specifying Name as Payroll Interface for ADP Global Payroll V2.

  3. Create additional delivery options corresponding to every additional delivery type you need.

  4. In the Runtime File Name attribute search for ADP Celergo File Name and map it to the delivery option.

  5. Submit the changes and ensure that the validations are successful.

Configure a FTP Server

Configure a FTP Server to post the files through BI Publisher.

To configure ADP's secured FTP server for automatic file delivery, follow the instructions provided in How to set up SFTP Server for BI Publisher (Doc ID 1526505.1).

Add Delivery Option

Perform these steps to add a new delivery option:

  1. Click Extract Delivery Options and add a new extract delivery option.

  2. Enter these details:

    • Delivery Option Name: Any name

    • Output Type: XML

    • Report: /Human Capital Management/Payroll Interface/ADP Global Payroll Interface.xdo

    • Template Name: Override Template

    • Output Name: %de

    • Delivery Type: Select as needed

  3. In the Additional Details section enter this detail:
    • Run Time File Name: Search for and select the attribute ADP Celergo File Name.

    Note: If you are configuring the filename for ADP Global Payroll, search for and select the Attribute ADP Global Payroll File Name.
  4. If the Delivery Type is FTP, , ensure that you have already configured the FTP server as mentioned in the Configure a FTP Server section. Add the server details in the Additional Details section as mentioned in the next steps.
    • Secure FTP: True.

    • Remote Directory: SFTP Destination Folder Name.

    • Server Name: SFTP servername as entered in BIP.

    • Run Time File Name: Search for the attribute ADP Celergo File Name.

      Note: For ADP Global Payroll, search for and select the Attribute ADP Global Payroll File Name.
  5. Click Submit.

Map Delivery Option to Report Categories

Perform these steps to map Delivery Option added to the Report Categories:
  • In the Report Categories section, select the Report Category Payroll Interface for ADP Celergo.

  • In the Additional Details: Payroll Interface for ADP Celergo, click Add.

  • Select the Delivery Option Name that you created.

Repeat these steps if the configuration is for being done for ADP Global Payroll, and in the Report Categories section select the Report Category: Payroll Interface for ADP Global Payroll V2 and add the Delivery Option.