Setting Up Custom BI Publisher Templates for Payroll

Oracle Payroll supports the use of custom BI Publisher templates for the following Year - End (and other) reports:

arrow icon   Creating Custom BI Publisher Templates :

This functionality may be used after performing the following procedures:

  1. Registering Custom Templates: Register the custom templates using the XML Publisher Administrator responsibility.

  2. Grouping Related Templates: After registering the custom templates, you must group them so that all the related templates can be seeded at the same time using the new concurrent program.

  3. Registering the Custom Template Group: Once a template group has been created, it needs to be registered in the Payroll tables in order to make use of the custom templates. For this purpose, use the concurrent program Register BI Publisher Templates for Payroll. This program will accept two parameters: the XML based Payroll report name for which registering is to be done and the template groups that have been created based on the custom templates. This concurrent program will seed the template details in the Payroll tables after which the template group can then be selected when running the applicable report.

  4. Using the Template Group: Select the applicable template group from the list of all available template groups when running a report in order to produce the output in the desired format.

    Note: Custom Employee W-2 and W-2cTemplate Supportt: Custom Template Support: While Oracle provides the flexibility of using custom W-2 PDF and W-2c templates when printing or viewing Online Employee W-2s and W-2cs, any customizations are the customer's responsibility to develop and maintain. If any errors are encountered or there is unexpected output using your custom template, you are recommended to try running the Employee W-2 and W-2c PDF reports or viewing the Online W-2 and W-2c using one of the seeded templates first to confirm the issue is reproducible prior to logging a service request with Oracle Support.

arrow icon   Creating Custom BI Publisher Templates for Local Year End Interface Extract Reporting:

To register custom BI Publisher templates for Local Year End Interface Extract reporting:

The following example can be used to create custom templates for producing the magnetic file (mf), the audit report (.a01) and the Employee Exception report (.a02). However, other templates can be created if necessary for use with the Local Year End Interface Extract. Using the XML Publisher Administrator responsibility, navigate to Templates.

  1. Click on Create Template.

  2. Enter the following fields:

  3. Click on Apply.

  4. Again, click on Create Template.

  5. Enter the following fields:

  6. Click on Apply.

  7. Again, click on Create Template.

  8. Enter the following fields:

  9. Click on Apply.

To group related templates for Local Year End Interface Extract reporting:

Use the following steps to group the custom templates created earlier for use with the Local Year End Interface Extract so that all the necessary output is generated using the applicable templates and the correct format. Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

  1. Enter the following fields:

  2. Create another record.

  3. Enter the following fields:

  4. Click Save.

To register the custom template group for Local Year End Interface Extract reporting

Use the following steps to register the template group comprised of the custom templates created earlier with the Payroll tables. Using the US HRMS Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Select Register BI Publisher Templates for Payroll.

  3. Enter the parameters as follows:

  4. Click on OK and submit the request.

To use the template group for Local Year End Interface Extract reporting

The template group comprised of the custom templates created earlier can now be used with the Local Year End Interface Extract to produce the desired magnetic (and other) output files. Using the US HRMS Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Select Local Year End Interface Extract.

  3. In the parameters form select the applicable Template Group created earlier.

arrow icon   To register custom BI Publisher templates for Employee W-2 PDF reporting and Online W-2:

Oracle Payroll delivers the following predefined template to produce custom Employee W-2 PDF and Online Employee W-2 PDF:

To register custom BI Publisher templates for Employee W-2 PDF reporting and Online W-2

The following example can be used to create custom templates for producing the Employee W-2 PDF report and for the Online Employee W-2. Using the XML Publisher Administrator responsibility, navigate to Templates.

  1. Click on Create Template.

  2. Enter the following fields:

  3. Click on Apply.

To group related templates for Employee W-2 PDF reporting

Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

Note: These steps do not apply to the custom Employee Online W-2.

  1. Enter the following fields:

  2. Click Save.

To register a template group for Employee W-2 PDF reporting

The template group comprised of the custom template created earlier can now be registered to produce the Employee PDF report output. Using the US HRMS Manager responsibility, navigate to View > Request.

Note: These steps do not apply to the custom Employee Online W-2.

  1. Submit a New Request and click on OK.

  2. Name: Select Register BI Publisher Templates for Payroll.

  3. Enter the parameters as follows:

  4. Click on OK and submit the request.

To use a template group for Employee W-2 PDF reporting

The template group comprised of the custom template created earlier can now be used to produce the Employee PDF report output. Using the US HRMS Manager responsibility, navigate to View > Request.

Note: These steps do not apply to the custom Employee Online W-2.

  1. Submit a New Request and click on OK.

  2. Name: Employee W-2 PDF.

  3. In the parameters form select the applicable Template Group created earlier.

To configure the custom Online Employee W-2 template in Self Service Preference at Business Group or HR Organization level

  1. Log into the application for the desired responsibility.

  2. Navigate to Work Structures > Organization > Description and query the applicable Business Group or HR Organization.

  3. In the 'Organization Classifications' section, click on Business Group (or HR Organization) > Others > Self Service Preference.

  4. Add the configuration for W-2. Set the following:

  5. Click OK, save your changes and close the form.

To configure the custom Online Employee W-2 template in Self Service Preference at the Location EIT level

  1. Login into the application using the desired responsibility.

  2. Navigate to Work Structures > Location. Query the location.

  3. Click on Extra Information.

  4. For 'Type' click on 'Self Service Preference for Location'.

  5. Click on Details, and for the Self Service Preference setup for the W-2, select:

  6. Click on OK, save your changes and close the form.

If necessary, set the Self Service Preference at the Person EIT level so the employee is able to view their W-2 online via Employee Self Service.

arrow icon   Creating Custom BI Publisher Templates for Employee W-2c PDF and Online W-2c:

You can run the Employee W-2c PDF concurrent program, which is XML based to generate the W-2c PDF.

Oracle Payroll delivers the following predefined template to produce custom corrected Employee W-2s for use with the Employee W-2c PDF report and the Online Employee W-2c:

You can use the Template Group parameter to select from a list of custom template groups comprised of delivered and custom templates in order to meet specific local statutory requirements.

The following example can be used to create a custom template for Employee W-2c PDF and Online W-2c.

This is accomplished by the following procedures:

To register a custom BI Publisher template for Employee W-2c PDF and Online W-2c

  1. Using the XML Publisher Administrator responsibility, navigate to Templates.

  2. Click Create Template.

  3. Enter the following fields:

  4. Subtemplate: Select No.

  5. Description: Enter a description.

  6. File: Browse to select the desired template file. Make sure this is the correct file to be used for PDF file generation.

    Language: Select English.

    Territory: Select United States.

  7. Click on Apply.

To group related templates for Employee W-2c PDF

Note: These steps do not apply to the custom Employee Online W-2c.

  1. Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

  2. Enter the following fields:

  3. Click Save.

To register a template group for Employee W-2c PDF and Online W-2c

  1. Using the US HRMS Manager responsibility, navigate to View > Request.

  2. Submit a New Request and click on OK.

  3. Name: Select Register BI Publisher Templates for Payroll.

  4. Enter the parameters as follows:

    Payroll Process Name: Employee W-2c PDF.

    Template Group: Enter the template group name to be registered, e.g., Custom

    Template for Employee W-2c PDF for 2013.

  5. Click OK and submit the request.

To use a template group for Employee W-2c PDF and Online W-2c

The template group comprised of the custom template created earlier can now be used to to produce the Employee W-2c PDF output.

  1. Using the US Payroll Manager responsibility, navigate to View > Request.

  2. Submit a New Request and click on OK.

  3. Enter Name: Employee W-2c PDF.

  4. Select the Template Group created earlier in parameter 'Check Style'.

  5. Click OK and submit the request.

To configure the custom Online Employee W-2c template in Self Service Preference at Business Group or HR Organization level:

  1. Log in to the application for the desired responsibility.

  2. Navigate to Work Structures > Organization > Description and query the applicable Business Group or HR Organization.

  3. In the 'Organization Classifications' section, click on Business Group (or HR Organization) > Others > Self Service Preference.

  4. Add the configuration for W-2C. Set the following:

    Document Type: W-2C

    Online: Yes

    Template: Select the custom template defined earlier. (Note: any template selected in Self Service Preference at the HR Organization level will override the template selected at Business Group level.)

  5. Click OK, save your changes and close the form.

To configure the custom Online Employee W-2c template in Self Service Preference at the Location EIT level

  1. Log in to the application using the desired responsibility.

  2. Navigate to Work Structures > Location. Query the location.

  3. Click on Extra Information.

    For 'Type' click on 'Self Service Preference for Location'.

  4. Click on Details, and for the Self Service Preference setup for the W-2, select:

    Document Type: W-2C

    Online: Yes

    Template: Select the applicable custom W-2 template. (Note: any custom template selected here will override the template selected at either the HR Organization or Business Group level.)

  5. Click OK, save your changes and close the form.

    If necessary, set the Self Service Preference at the Person EIT level so the employee is able to view their W-2C online via Employee Self Service.

arrow icon   Creating Custom BI Publisher Templates for Check Writer (XML):

Oracle Payroll delivers the following predefined template to generate PDF:

To register a custom BI Publisher template for Check Writer (XML)

The following example can be used to create a custom template for Check Writer (XML). Using the XML Publisher Administrator responsibility, navigate to Templates.

  1. Click on Create Template.

  2. Enter the following fields:

  3. Click on Apply.

To group related templates for Check Writer (XML)

Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

  1. Enter the following fields:

  2. Click Save.

To register a template group for Check Writer (XML)

The template group comprised of the custom template created earlier can now be registered to produce the Check Writer (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Select Register BI Publisher Templates for Payroll.

  3. Enter the parameters as follows:

  4. Click on OK and submit the request.

To use a template group for CheckWriter (XML)

The template group comprised of the custom template created earlier can now be used to produce the CheckWriter (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: CheckWriter (XML).

  3. Select the Template Group created earlier in parameter 'Check Style'.

  4. Click on OK and submit the request.

Note

The Image rendering code is used to implement the dynamic digital signature inside the template. This code is not available in the seeded PAYUSCHKWVXML_en.rtf template. If you are using the seeded template or your own custom template, then to implement the the Digital Signature (Image) functionality, you must complete the following steps. You must copy the XSL code to render the image with the appropriate link for image.

XSL code to be added:

<xsl:attribute xdofo:ctx="block" name="background-image">URL</xsl:attribute>
  <xsl:attribute xdofo:ctx="block" name="background-position-horizontal">
  center</xsl:attribute>
  <xsl:attribute xdofo:ctx="block" name="background-position-vertical">bottom
  </xsl:attribute>

Replace the text URL in the code with a valid link as in the following example:

Example: http://valid-hostname:valid-port/valid-image.png

Steps to modify the custom template:

  1. Open the template.

  2. Inside the template search for the string "BG" (this should be at the bottom part of the template).

  3. Double-click the BG field. In the pop-up that shows up click the 'Add Help Text' button at the bottom.

  4. In the pop-up that shows up, copy the entire XSL code with the URL link embedded in it across the Text areas in the 'Status Bar' & 'Help Key (F1)'.

  5. Make sure that the whole string is copied without any truncation mainly in the 'Status Bar' text area.

  6. Save and Upload the document.

arrow icon   Creating Custom BI Publisher Template for Deposit Advice (XML):

To register a custom BI Publisher template for Deposit Advice (XML)

The following example can be used to create a custom template for Deposit Advice (XML). Using the XML Publisher Administrator responsibility, navigate to Templates.

  1. Click on Create Template.

  2. Enter the following fields:

  3. Click on Apply.

To group related templates for Deposit Advice (XML)

Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

  1. Enter the following fields:

  2. Click Save.

To register a template group for Deposit Advice (XML)

The template group comprised of the custom template created earlier can now be registered to produce the Deposit Advice (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Select Register BI Publisher Templates for Payroll.

  3. Enter the parameters as follows:

  4. Click on OK and submit the request.

To use a template group for Deposit Advice (XML)

The template group comprised of the custom template created earlier can now be used to produce the Deposit Advice (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Deposit Advice (XML).

  3. Select the Template Group created earlier in parameter 'Deposit Advice Style'.

  4. Click on OK and submit the request.

arrow icon   Creating Custom BI Publisher Templates for Third Party Check Writer (XML):

Oracle Payroll delivers the following predefined template to generate PDF for third party check payments:

To register custom BI Publisher templates for Third Party Check Writer (XML)

The following example can be used to create a custom template for Third Party Check Writer (XML). Using the XML Publisher Administrator responsibility, navigate to Templates.

  1. Click on Create Template.

  2. Enter the following fields:

  3. Click on Apply.

To group related templates for Third Party Check Writer (XML)

Using the Application Developer responsibility, navigate to Applications > Lookups > Common.

  1. Enter the following fields:

  2. Click Save.

To register a template group for Third Party Check Writer (XML)

The template group comprised of the custom template created earlier can now be registered to produce the Third Party Check Writer (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Select Register BI Publisher Templates for Payroll.

  3. Enter the parameters as follows:

  4. Click on OK and submit the request.

Now the Custom Template is available for use as the parameter 'Check Style' for the concurrent program 'Third Party Check Writer (XML)'.

To use a template group for Third Party Check Writer (XML)

The template group comprised of the custom template created earlier can now be registered to produce the Third Party Check Writer (XML) output. Using the US Payroll Manager responsibility, navigate to View > Request.

  1. Submit a New Request and click on OK.

  2. Name: Third Party CheckWriter (XML).

  3. Select the Template Group created earlier in parameter 'Check Style' (e.g. Custom Template for Third Party Check Writer (XML)).

  4. Click on OK and submit the request.

Note

The Image rendering code is used to implement the dynamic digital signature inside the template. This code is not available in the seeded PAYUSTPCHKWXML_en.rtf template. If you are using the seeded template or your own custom template, then to implement the the Digital Signature (Image) functionality, you must complete the following steps. You must copy the XSL code to render the image with the appropriate link for image.

XSL code to be added:

 <xsl:attribute xdofo:ctx="block"  name="background-image">URL</xsl:attribute>
   <xsl:attribute xdofo:ctx="block"  name="background-position-horizontal">
   center</xsl:attribute>
  <xsl:attribute  xdofo:ctx="block"  name="background-position-vertical">bottom
   </xsl:attribute>

Replace the text URL in the code with a valid link as in the following example:

Example: http://valid-hostname:valid-port/valid-image.png

Steps to modify the custom template:

  1. Open the template.

  2. Inside the template search for the string "BG" (this should be at the bottom part of the template).

  3. Double-click the BG field. Iin the pop-up that shows up click the 'Add Help Text' button at the bottom.

  4. In the pop-up that shows up, copy the entire XSL code with the URL link embedded in it across the Text areas in the 'Status Bar' & 'Help Key (F1)'.

  5. Make sure that the whole string is copied without any truncation mainly in the 'Status Bar' text area.

  6. Save and Upload the document.

arrow icon   Using Custom XML with Oracle US & Canadian Payroll Reports:

Custom XML code can be defined for the Oracle BI Publisher based Check/Cheque Writer (XML), Third Party Check/Cheque Writer (XML), Deposit Advice (XML) and PDF Payslip delivered with the US and Canadian Payroll localizations. Using the 'PAY: Disable Custom XML Code (Yes/No) profile option, users can enable or disable the custom XML code to run if there are issues with the custom code. For more information about this functionality, refer to the Using Custom XML with Oracle US & Canadian Payroll Reports document on My Oracle Support note ID 1530347.1.