Scribd
Upload
56 views9 pages

Whitepaper - Enable Bank Name and Acount Holder Fields Using REST API and Load Employees' PPM Using HDL

The document outlines a solution for enabling 'Bank Name' and 'Account Holder' fields in personal payment methods for Australia legislation using REST API and HDL. It details the steps required to create lookup values, set up country-specific rules, and load necessary banking information into the system. Limitations regarding data loading and validation are also discussed, emphasizing the importance of the correct sequence in data loading.

Uploaded by

simondsilva01
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
56 views9 pages

Whitepaper - Enable Bank Name and Acount Holder Fields Using REST API and Load Employees' PPM Using HDL

The document outlines a solution for enabling 'Bank Name' and 'Account Holder' fields in personal payment methods for Australia legislation using REST API and HDL. It details the steps required to create lookup values, set up country-specific rules, and load necessary banking information into the system. Limitations regarding data loading and validation are also discussed, emphasizing the importance of the correct sequence in data loading.

Uploaded by

simondsilva01
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 9

Oracle HCM Cloud - Whitepaper

Enabling “Bank Name” and “Account Holder”


fields in personal payment method using REST
API and load data using HDL

Author : Samyak Jain

Reviewer : Subhrasish Kantha

Creation Date : 13th October 2022

Updated Date : 17th May 2024

Updated By : Vivek Band

Version Number : 2.0

1
Problem Statement
To enable “Account Holder” and “Bank Name” fields for Australia legislation in the personal
payment methods as well as load and associate banking information with the employee.
Navigation:
Login > Me > Pay > Payment Methods

2
Proposed Solution
The Bank and Bank Branch fields are system provided; however, they cannot be enabled
using Sandbox, we have to use REST API for enabling these fields for the required country.
Action Plan:
1. First, we have to create a lookup value of the field names.
2. Then we need to use the REST API to create a country specific rule.
3. Load the details of bank, bank branch in the repository using HDL.
4. Associate the bank and bank branch details with employees using HDL.
5. Load personal payment methods of employees using HDL.

3
Steps to achieve the proposed solution
Step1: Go to Setup and Maintenance > Search> Manage Cash Management Lookups
Search for the Lookup code: ‘ORA_EXTERNAL_ACCOUNT_LABELS’ and add the values which we
want to be visible on Bank account details.

Step2 To enable the required fields in the system we need to use the REST API functionality,
by using the POSTMAN software to create a country specific rule.
The URL should be <server>/fscmRestApi/resources/11.13.18.05/bankAccountUserRules

Note: <server> value should populate the instance URL.

API : https://fa-<pod_name>-saasfaprod1.fa.ocs.oraclecloud.com/fscmRestApi/resources/
11.13.18.05/bankAccountUserRules

"CountryCode": "AU",

"BankAccountFieldName": "BANK_NAME",

"DisplayFlag": "Y",

"RequiredFlag": "Y",

"LabelCode": "BANK_NAME",

"PageName": "FUSE"

4
}

Step 3 Select Action: POST

Step 4 Enter Content-Type: application/vnd.oracle.adf.resourceitem+json

Step 5 Now, pass the payload structure as:


For our requirement for Australia Legislation of “Bank” and “Bank Branch” fields payload
structure:
{

"CountryCode": "AU",

"BankAccountFieldName": "BANK_NAME",

"DisplayFlag": true,

"RequiredFlag": Y

"PageName": "FUSE"

Response:
The user will get a response like the below screenshot, based on the values passed in the
payload structure.

5
Step 6 Now login to the system as a payroll manager and navigate to Me >Payà Payment
Methods

Step 7 Search for any employee of Australia legislation and the user will be able to see the
fields enabled via REST API while adding the bank account details.

6
Step 8 Now to associate personal payment method with the employees, the sequence to be
followed for loading the data is as follows:
1. Load Bank.dat file for loading the bank details in the repository.
2. Load BankBranch.dat for loading the Bank Branch details into the repository.
3. ExternalBankAccount.dat for associating the bank and bank branch details with
employees.
4. Load PersonalPaymentMethod.dat to load the personal payment method of
employees in the system.
Please make sure that the above sequence is followed, and the first 3 data are loaded
before loading Personal Payment Method.

Step 9 Load Bank.dat using the sample METADATA.

7
Step 10 Load BankBranch.dat using the sample METADATA.

Step 11 Load ExternalBankAccount.dat using the sample METADATA.


Step 12 Load PersonalPaymentMethod.dat using the sample METADATA.

Limitations
1. It is necessary to load Bank.dat and BankBranch.dat files in the system first as this
gets stored in the system repository, and by loading the ExternalBankAccount.dat file
into the system, the bank and bank branch details are fetched from the repository
and associated with employees. Please note that without loading Bank.dat and
BankBranch.dat files in the system, bank details of employees cannot be loaded.

2. If the bank branch names for two different branches are the same and the only
distinction is between the BSB number or the bank branch number, then we cannot
load that type of data into the system through HDL. This is because validation occurs
at Bank and Bank Branch level and not the BSB level. In this case we would have to
add this data from front-end.

References
1. https://support.oracle.com/epmos/faces/DocumentDisplay?
_afrLoop=71643862297716&id=2571680.1&_afrWindowMode=0&_adf.ctrl-
state=18rgrhauew_4
(Oracle support DOC ID- 2571680.1)

2. https://mastekgroup-my.sharepoint.com/personal/tanya152507_mastek_com/
Documents/Documents/Get__Create__Update_bank_account_country-
specific_rules.docx

8
9

You might also like