Generate job paperwork or labels from a report request

  1. Search for paperwork and labels report requests by setting the Report Request Type as Paperwork or Labels on the Report Request Criteria tab.
  2. Open the required report request to display the CCRPTR—Report Request Detail screen.
  3. Select the Reports tab to see the report request reports in the grid.
  4. Where a report is produced in an alternate language, double-click the report to display the details, and select the appropriate language from the Language drop-down list.
  7. Click Generate Reports to display the Generate Report dialog box.

    8. The job paperwork or labels documents are generated.

    If the report request contains multiple jobs, and the report's File is generated from the report request report's Filename Syntax Code, and that syntax references a job, then the first job in the report request is used to derive the report file name.

    A paperwork or label report document generated in this way is displayed on the Generated Reports tab, and can be downloaded and re-printed at any time.

    Report document generation history showing the status of the related system batch job is displayed on the History tab.

    The report generation event is audited, with the audit record's Field set to 'Report Filename' and the From Description set to the output filename. Where multiple reports are generated from a report request in a single session, then each created filename is audited separately upon creation.

    Note: If an error is raised on emailing or printing a generated report, then any subsequent reports are NOT generated in the session. If this occurs, then each report needs to be generated individually by changing the Reportable check box so that only one report is generated at a time. This allows for the generation of the report even where there are emailing or printing issues.

Process used to generate job paperwork and labels from a report request

Report requests are used to create job-based reports, including certificate reports (internal, preliminary or final), job paperwork and labels.

To generate job paperwork and labels from a report request, the processing involves the following stages:

  1. Reports are generated without checking the job's Workflow Status nor Validated Date.
  2. The template is read to determine the required core result sets.
  3. If the template is a ZIP file that contains a DSC (direct source connection) file, then the DSC locates the additional data source/s and creates extra result sets from there.
  4. Both the core and DSC-based result sets are populated.
  5. Both the core and DSC-based result sets are packaged up and sent to the report engine along with the template, and the format required for the output.
  6. The report engine extracts text from multi-lingual fields in the language defined by the DEFAULT_REPORT_LANGUAGE application preference.
  7. The report engine rounds numeric final values to produce formatted final values in the result sets. The USE_CORRECTED_LOWER_DET_LIMIT and USE_CORRECTED_UPPER_DET_LIMIT application preferences are used by the rounding algorithm. Refer to the Rounding and Formatting Results and Calculating Uncertainty appendix.
  8. The report engine returns the output file.
  9. Report distribution takes place, if specified.

During this report generation process:

  1. If the REPORT_SCRIPT application preference exists and is linked to a report script code then at each hook point in the report generation process, the related event in the script is run.
  2. If the template is linked to a report script code then at each hook point in the report generation process, the related event in the script is run.
  3. The system batch queue is used to perform the processing, including the distribution. The result of the batch job execution can be seen on the History tab of the CCRPTR—Report Request application.

Conditions for distributing reports

If Copy to Folder is checked on the Reports tab, the generated reports are copied to the folders defined by the additional reporting method's Detail, for each client contact's additional reporting methods where the additional reporting method's Report Method Type is Folder.

If the REPORT_FROM_EMAIL_ADDRESS application preference is defined and contains a valid email address, when the generated reports are emailed, then the Email To email address is set to this email address.

If the EMAIL_BCC application preference is defined and contains a valid email address, when the generated reports are emailed, then the BCC email address is set to this email address.

If a syntax exists that is in scope and has a Syntax Type of Report Request and a Syntax Code of EMAIL_SUBJECT_TEXT preference, when entering distribution details for a report, then the email subject body contains the text generated by the syntax. Note that this syntax should evaluate only to a single-line subject.

If a syntax exists that is in scope and has a Syntax Type of Report Request and a Syntax Code of EMAIL_MESSAGE_TEXT preference, when entering distribution details for a report, then the email message body contains the text generated by the syntax.

If there are multiple reports on a report request, and email and print is requested for all of them, during report generation, only one CCBRGEN batch job execution is created, and emailing and printing occurs as part of that task. If there are errors in connecting to the email server or the printer, then the reports are still created but they are not emailed or printed. The event is audited.

If the EMAIL_REPORTS_SEPARATELY application preference is defined and selected, when generated reports are emailed, then each individual report is sent in a separate email to the contact. If the EMAIL_REPORTS_SEPARATELY application preference is not defined, or is defined and is cleared, when generated reports are emailed, then each individual report is sent in the same email to the contact.

If the EMAIL_ZIP_ATTACHMENTS application preference is defined and selected, when the generated reports are emailed, then one zip file containing all of the generated reports is emailed as an attachment to the email. If the EMAIL_ZIP_ATTACHMENTS application preference is not defined, or is defined and cleared, when the generated reports are emailed, then multiple attachments are added to the email/s.

If the report request report's number of Print Copies is greater than zero, then that number of copies of the report is printed on the Printer device if it is defined.

If the report request report's number of Print Copies is greater than zero, then that number of copies of the report is printed on the Printer device if it is defined.

Refer to Maintaining Schedules and Batch Job Executions.