Configure Dynamic File Names for ADP Global View

Configure Dynamic File Names for ADP Global View

The name of the output file generated dynamically corresponds to this format:

ORC_Pxxzzz_YYYYMMDDHHMMSS_USOGPI_HRMD01_DUT8G2I.XML

Configure lookup types, value sets, and fast formula to generate ADP Global Payroll Interface files with this file name.

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_GPY_OUT_FILE NAME_COMP

    Meaning

    File name component values

    Description

    Holds values for components in the ADP Global Payroll Interface output file name.

    Module

    Oracle Fusion Middleware Extensions for Applications

  4. In the Lookup Codes section, click New.

  5. Enter these values:

    Parameter

    Value 1

    Value 2

    Lookup Code

    ADP_GPY_SYSTEM_NUMBER

    ADP_SAP_CLIENT_NUMBER

    Enabled

    Yes

    Yes

    Meaning

    Actual value

    Actual value

    Description

    ADP Global View System Number

    ADP Global View 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

FROM Clause

ID Column Name

WHERE Clause

Legislation Code

PER_LEGISLATIVE_DATA_GROUPS_VL

LEGISLATION_CODE

LEGISLATIVE_DATA_GROUP_ID=:{PARAMETER.LEGISLATIVE_DATA_GROUP_ID}

File Name Component

HCM_LOOKUPS

MEANING

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

Date and Time

dual

to_char(systimestamp,'YYYYMMDDHHmiss')

NA

Random number to serve as a sequence number when generating multiple files on the same day

dual

lpad(round(DBMS_Random.Value(1.99)),2,'0')

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_GPY_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_GPY_SYSTEM_NUMBER'''
l_system_id = GET_VALUE_SET('ADP_GPY_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='ORC_P'+l_instance_name+l_system_id+'_'+l_date+'_'+l_leg_code+'OGPI'+'_'+'HRMD'+'01'+'_'+'D'+'UT8'+'G2I'+'.XML'+'.pgp'
RULE_VALUE = l_final_value
RETURN RULE_VALUE
-------Formula ends------------------------------------------------------------------------------------------ 

Ensure that the formula returns the value through variable RULE_VALUE.

Save and compile this formula.

Configurations on Extract Definition

An additional attribute called ADP Global Payroll 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_GPY_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 Global Payroll File Name and map it to the delivery option.

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

If you are using Payroll Interface for ADP Global Payroll to integrate with ADP Global View:

Save the generated file name in one of the attributes in the extract. 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.

  3. Create a record in the extract.

  4. Add an attribute of type Rule to this record and attach the rule formula that you created earlier.

    Note: The best approach is that you create the record under Root Block, like Payroll Group Data.
  5. Specify Type as Rule and Rule as ADP_GPY_OUT_FILENAME_FORMULA..

  6. Select the attribute created in Step 4 as the Run Time File Name for the delivery option you are creating.

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

Configure a FTP Server

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).

Adding Delivery Option

If you are using Payroll Interface for ADP Global Payroll V2 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 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 Global Payroll File Name.

  5. Click Submit.

If you are using Payroll Interface for ADP Global Payroll 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: Dynamic switch Override Template

    • Output Name: %de

    • Delivery Type: FTP

  3. In Additional Details section enter this detail

    Run Time File Name: Search for and select the Attribute you created in the Update Extract Structure section.

  4. If 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 server name as entered in BIP

    • Run Time File Name: Search for and select the attribute you created in the Update Extract Structure

    • Click Submit

  5. Click Save and Close.