Create Payment Report Template

Explanation

This activity is used to create a payment report template. Report templates are used to create employee payment reports. This activity is used only to load a default set of report parameters (that determine contents of a report). It will be a fully functioning template, but some adjustments will probably be necessary (like adding default parameter values, parameter access, mandatory parameters). Most template elements defined in this activity are impossible to change once the template has been created. The exception is the Save Definition Only check box, which is only a suggested setting and can be changed during report generation.

Prerequisites

There are no prerequisites.

System Effects

As a result of this activity, a payment report template will be created, allowing for generation of payment reports.

Window

Payment Report Definition

Related Window Descriptions

Payment Report Definition

Procedure

  1. Open the Payment Report Definition window and add a new record.
  2. In the Definition ID, enter a unique identifier for the payment report template.
  3. In the Definition Name field, enter the name/description for the payment report template.
  4. In the Report ID field, enter the identifier of a parameter set that you want to use for the template. You can use the list of values. Parameter set determines what parameters will be included in the template, and it's impossible to add or remove any parameters. The Report Title field indicates the intended purpose of a parameter set.
  5. In the Output Form field, enter what should be the output form of the report. Following values are available:
    • Printout - the report will be generated as a PDF file.
    • Email - an e-mail will be sent to selected employees with a report included as a PDF attachment.
    • Report Archive - an e-mail will be sent to selected employees with information that the report is available in the Report Archive window.
    • Personal Portal - an e-mail will be sent to selected employees with information that the report is available on their Personal Portal via the My Payment Overview portlet.

      Email notifications will be automatically sent to employees included in the payment list.
      Note: It is impossible to change this setting once the template definition is saved.
  6. You have the option to use the Save Definition Only check box.
    • If selected, the Payment Report dialog box will initially have this check box selected. Unless changed, it will save the report as a definition only and no output file or mail will be generated.
    • If cleared, the Payment Report dialog box will initially have this check box cleared. Unless changed, it will cause the report to be generated in form of an output file or mail.
  7. Save the information.