How to Configure the Payslip Report Template
Use the predefined payslip template and edit it to include legislative requirements as mandated by your country or territory. For example, you may want to add your company logo or add additional fields to the template.
Configuring the delivered payslip template includes these tasks:
-
Create a copy of the delivered payslip report
-
Edit a copy of the payslip sub template to include additional components as per your requirements
-
Add the changed template to the report
-
Set the priority of the payslip report as Critical
-
Test the configured payslip report in BI Publisher
Create a Copy of the Delivered Payslip Report
You can use the Customize function (if available) to create an editable copy of the delivered report in the Custom folder.
-
The copied report has the same privileges as original report.
-
Creates the necessary folder structure and keeps the same name as the original Payslip report.
-
Ensures that the copied report is placed in the same folder structure under the 'Custom' folder and the BI Publisher automatically chooses to use this modified report and you don't have to add the delivery option changes.
-
If you choose to copy the template, you must manually add the delivery options.
You must have BI Publisher Developer or BI Publisher Administrator role to create or edit reports from the BI Publisher.
If the Customize option isn’t available, manually copy the report or template into the Custom folder.
Complete these steps to copy the delivered report template.
-
Sign in to the Oracle BI Publisher using an environment link or URL that ends with ‘xmlpserver’.
-
Click Catalog to open BI analytics.
Navigate to /Shared Folders/Human Capital Management/Payroll/Regulatory and Tax Reporting/Country Name folder to open the delivered Payslip for a country.
For example, for Canada, you can find the Canada Payslip Report at /Shared Folders/Human Capital Management/Payroll/Regulatory and Tax Reporting/Canada folder.-
Select More > Customize for the payslip report.
- Navigate to /Shared Folders/Custom/Human Capital Management/Payroll/
Regulatory and Tax Reporting/Country Name folder and check if you can
see the customized report in the folder.
It is recommended that you save all user-defined or configured reports in the Custom catalog folder under Shared Folders. Any reports created outside of the Custom folder will not be migrated and will be lost during patching or upgrade.
A BI report can have multiple layouts. Find the template or layout you’re trying to change. For example, edit the delivered Payslip Sub Template and include the legislative and statutory changes you want to incorporate.
-
Navigate to /Shared Folders/Human Capital Management/Payroll/Payment Distribution/Payslip Sub Templates.
-
Click Edit. Select the layout you want to edit, Payslip Sub Template.
-
Click Property.
-
Download the layout template (RTF), make required changes, and upload the revised template into the Custom folder.
- Create and Edit RTF Report Layout Templates
- How can I change the logo in the layout template?
Add the Revised Template to the Copied Report
Use these steps to add the revised template to the report you created in the first task.-
Navigate to /Shared Folders/Custom/Human Capital Management/Payroll/Payment Distribution/Payslip Sub Templates.
-
Click Edit.
-
Click Add New Layout.
-
Select Upload and enter these details in the Upload Template File page.
Field
Value
Layout Name
Name of the report you created in the first task.
Template Name
Select the template you just modified in the second task.
Type
RTF
Locale
English
-
Click OK to upload and overwrite the current template.
- Click Return to review all the layouts. Use the Save icon to save all the
changes.
The Priority of payslip report on the BI server is by default set as Normal and hence is processed on first in, first out basis. To avoid interruptions, set the priority of the payslip report as Critical, so that it is executed on priority.
-
Navigate to the copied report in the /Shared Folders/Custom/Human Capital Management/Payroll/ Regulatory and Tax Reporting folder.Note:
You should make any revisions only to the copied version of the report.
- Click Edit and then click Properties.
-
On the Report Properties window, under the General tab, select Critical in the Job Priority field.
-
Click OK.
Note:Setting the report as critical reduces chances of failure when there is an issue with the BI server or a performance issue with a previous report job in the process.
-
Test the Configured Payslip Template in BI Publisher
To test the configured template, you must first run the delivered template and generate the payslip.
- Navigate to /Shared Folders/Human Capital Management/Payroll/ Regulatory and Tax Reporting/Country Name folder to open the delivered Online Payslip for the country.
- Select Job History for the delivered report.
- Clear the value of the fields Start Processing and Owner.
- Click Search and choose first row with success status.
- Click Report Job Name link.
- Record the value of these fields: Archive Action Identifier, Delivery Option Identifier, and Payroll Action Identifier.
- Follow these steps to test your configured report template in the custom
folder.
-
Navigate to /Shared Folders/Custom/Human Capital Management/Payroll/ Regulatory and Tax Reporting/Country Name folder and open the report you created.
-
Enter values for Archive Action Identifier, Delivery Option Identifier, and Payroll Action Identifier fields you noted.
-
Click Apply.
-
Verify that the payslip is generated successfully.
Note:If the payslip didn't generate successfully, check your configured report and template for errors.
-