The Production Report Batch Types screen can be accessed at the system or company level.
To access the system level screen:
Go to the Configuration tab, Documents/Reports menu section, Production Report Batch Types screen.
Select the plus (+) icon to create a new system level Production Report Batch Type. Select the pencil icon to view the details of an existing system level Production Report Batch Type.
To access the company level screen:
Go to the Companies tab, Company Configuration menu section, Production Report Batch Types screen.
Select the plus (+) icon to create a new company level Production Report Batch Type. Select the pencil icon to view the details of an existing company level Production Report Batch Type.
Production Report Batch Type Fields
Inactive
The Inactive checkbox is used to mark a Production Report Batch Type as active or inactive. An inactive Production Report Batch Type cannot be selected as the Report Batch Type when running Report Batches.
Name
The Name of the Production Report Batch Type is what is displayed in the drop-down list of available Report Batch Types when creating a new Report Batch.
Type
The Type of the Production Report Batch Type drives two processes: which production reports are available in the drop-down list of available production reports to run and which production report batch pages the type is available on. Available options are:
(None)
All production reports are in the drop-down list of available Production Reports to Run and the Production Report Batch Type will not show on either the Compensation Report Batch screen or the Cost Estimate Report Batch screen.
Compensation Report Batch
Only production reports that are marked as Compensation reports will be available in the Production Reports to Run drop-down list. Also, the Production Report Batch Type will only be shown on the Compensation Report Batch screen.
Cost Estimate Report Batch
Only production reports that are marked as Cost Estimate reports will be available in the Production Reports to Run drop-down list. Also, the Production Report Batch Type will only be shown on the Cost Estimate Report Batch screen.
Populate Data Source (User Report)
The user report selected will drive most of the production report batch process. It will provide the set of prompts, it will drive the population of the batch, and it will drive the inputs (both parameter and filename) of the production report. Also note that any Selected Data Fields within the User Report that are not marked to Hide, will be displayed in the report batch population grid.
Production Report to Run
The production report selected is the report that will be run once for each resulting row of the user report it is associated with.
Delivery Recipient
The resulting reports may optionally be delivered to no one (None), payroll (Payroll), or the applicable employees (Employee).
Default Deliver to Employee Method
The defaulting report delivery method for the Production Report Batch Type may be configured within the Report Batch Type, or left blank. This is a default only and may be changed when running a report batch. The available options are:
**Please Select**: No default set; the user will need to select a delivery method when running the batch.
Publish to Portal: Publishes report to the Employee Compensation Reports
Publish to Portal and Notify Via Email: Publishes report to the Compensation Reports screen and sends an email notification to the employee.
Email as Secure Attachment: Sends the report as a password protected PDF in an email to the employee.
Publish to Portal and Email as Secure Attachment: Publishes report to employee Compensation Reports screen and sends the report as a password protected PDF in an email to the employee.
The employee email address is determined by the following order:
Employee User ID Email
Primary Assignment Email (In Assignment Contact)
Secondary Assignment Email (In Assignment Contact)
If no email can be found a warning is displayed on the batch item record.
The password for the attached PDF report is set using the System Preference, “Assignment Report Email Attachment PDF Document Password Source” within the ‘Reports’ Category, ‘Report Security’ Sub Category. This selection can be overridden at the company level.
If an employee doesn’t have a value in the selected field or an option hasn’t been chosen on the System Preference screen, the password will be set to the Employee System Number.
Tag to Apply When Report Created
When reports are created in batch, the configured tag will be applied to each report. These tags
are visible within the Calculations Batch, the Report Batch, and the individual Compensation Calculation.
Tag to Apply When Report Delivered
When reports are delivered in batch, the configured tag will be applied to each report. These tags
are visible within the Calculations Batch, the Report Batch, and the individual Compensation Calculation.
User Report Requirements
The requirements for the supporting User Report are dependent upon the Production Report to Run selected. The User Report must have a Data Field for each parameter of the production report it is the population data source for. If any required parameters are missing a User Report field, an error will appear when running the batch with the names of any missing fields.
The data displayed within the grid of eligible calculations within the Report Batches screen is determined by the Data Fields within the user report that are not Hidden.
Additionally a Data Field should be included in the User Report with a Column Caption of ‘FileName’; this will be the name of the reports generated in the batch. Using a Custom Calc Field or Custom SQL Field with a formula such as [Last Name] + ', ' + [First Name] + ' - ' + [From Country Code] + ' to ' + [To Country Code] + ' - ' + [Compensation Calculation Description] is recommended for flexibility of naming. If no ‘FileName’ column is given, the report will receive a generic name of ‘Report’.
The following characters are not allowed and will be replaced with an underscore ‘_’ if they are included in the FileName: / ? < > \ : * | "
When creating a User Report for compensation calculations, a filter of Cost Estimate: Is Compensation equal to ‘Yes’ must be included. If not, Cost Estimates may be included in your report.
When the population should only include Compensation Calculations within a given batch, a filter of Cost Estimate Batch: ID equal to ‘0’ and Prompt checked must be included.
When the population should include all Compensation Calculations for a given Effective Date, a filter of Cost Estimate: Effective Date equal to <date> with Prompt checked must be included.
It is recommended the report be locked for publication, so no users accidentally change the report. The report can be locked from the Configuration tab, Documents/Reports menu group, User Report Publication Lock screen.