Generating an Internal Report of Results

• Generating an Internal Report of Results
  • Overview
  • Process
    • Dependencies and Restrictions for Generating an Internal Reports of Results
    • Report Request Creation
    • Configuring Report Content
    • Configuring Result Rounding
    • Configuring Report Output
    • Customising the Report Generation
    • Emailing Report Documents

Overview

Internal reports are generated by data entry operators or job/sample validation users to assist them in their data entry or validation work.

Reports are generated in CCLAS 6 for use by the organisation or laboratory to monitor data, analysis and processing, from the search results of any entity, task or grid in the system. These reports are classed as internal reports.

Internal reports are effectively a report of the contents of a workbook, and can contain unvalidated data so that results that are in progress can be included on the report, even though the job might not yet be validated. The generation of an internal report does not update reported dates on the job.

Common uses for internal reports of results include to collate and review:

• Results of sample testing, including interim results.
• Jobs underway, or of a particular status.
• Search results for a particular entity (such as a client, sample type, sample scheme analyte, report requests and so on).
• Financial results, including invoices and associated status.

For internal reports, stakeholders should be internal clients such as QA Managers, Financial Administrators and other users in the laboratory.

Process

Create an internal report of results

Report Request Scope

Report requests are created either with org-scope or lab-scope, depending upon the scope of the primary job upon which they are based. An organisation or laboratory can contain multiple report requests.

Report requests are classified by Report Type:

• Certificate- Certified reports of job results, the final product of the laboratory service.
• Paperwork- Job paperwork, including summary sheets, worksheets, prep sheets, job sheets and internal reports.
• Labels- Job and sample labels.

Properties of a Report Request

A report request can have:

• A report status for certificate reports, to indicate whether it is an internal, preliminary or final report. Where a final report is generated, associated jobs have their report dates updated.
• A manually controlled workflow status to indicate the stage at which it is in its life-cycle.
• A syntax to generate the name of a report generated from it.
• Client.
• Signatory user group.
• Multiple jobs—A report request can be created to report on single or multiple jobs. For example, a client may submit three jobs, but only require a report on the outcome of testing for all three jobs. A flag indicates whether a job is reportable.
• Email details.
• Multiple tests, and a flag on each scheme and analyte to indicate its reportability.
• Multiple samples, potentially from multiple jobs. A sample or test can exist in more than one report request, thereby making it possible to report the same sample and test to multiple job stakeholders. For example, one client may only be interested in (and pay for) results for some samples or tests in the job, whilst another client may be interested in (and pay for) results for other samples or tests in the job. The laboratory supervisor, or another third party, may be interested in receiving a report containing all samples and tests in the job. All of these requirements can be specified in the report request created to report on the details of the job. A flag indicates whether a sample is reportable.
• Multiple reports, with each report detailing the report template, language and output file format, location and name, and distribution details. The supported report engines are Crystal Reports and Text.
• Multiple generated reports and associated details.
• A history of the report generation process for each submitted generation.

The generation of an internal report does not update reported dates on a job.

Dependencies and Restrictions for Generating an Internal Reports of Results

Report preferences are maintained using the CCPREF—Preference application.

Report Request Creation

A syntax with a code of REP_REQ_CODE_SYNTAX and type of Report Request must exist and contain a syntax expression to create a code for each new a report request.

One or more syntaxes with a type of Report Request must exist and contain a syntax expression so that a syntax can be selected for the new report request's Name Syntax Code.

Configuring Report Content

For samples and tests to be made available for reporting, jobs must be added to the report request, and some or all of those samples and tests made reportable.

The reportability of each report request sample, sample scheme and sample scheme analyte depends upon whether the entity is flagged as reportable.

A job's and sample's Reportable must be selected to be included in any report.

QC samples from a job are included in a report request if they have a Primary Analytical Type matching the analytical types defined by the QCSAMPLE_REPORTABLE preference: REP, BLK, STD and/or SPK.

The report request scheme's Reportable must be selected to be included in any report, and defaults to the sample scheme's Reportable.

A report request scheme analyte's Reportable must be selected to be included in any report, and defaults to the sample scheme analyte's Reportable.

The CCREGN—Job and CCSAMP—Sample applications are used to configure job and sample reportability, respectively.

Scheme, scheme version and scheme version analyte report details (report names, notes, etc.) are maintained using the CCSCHM—Scheme application.

Configuring Result Rounding

Result detection limit and ceiling limits using the USE_CORRECTED_LOWER_DET_LIMIT and USE_CORRECTED_UPPER_DET_LIMIT application preferences.

The uncertainty calculation using the ALLOW_REPORTING_UNCERTAINTY_OVERRIDE application preference.

The CCSCHM—Scheme application is used to configure scheme version analyte result rounding and uncertainty calculation details.

Rounding tables, with ranges of result detection limits and ceiling limits, are maintained using the CCRNDT—Rounding Table application.

Range tables, used for the calculation of uncertainty values, are maintained using the CCRNGT—Range Table application.

For further information, refer to the Rounding and Formatting Results and Calculating Uncertainty appendix.

Configuring Report Output

One or more reports must be defined within the report request for reports to be generated.

A report template must exist that has a report type of Certificate. It is recommended to use a report template that contains 'Internal Report' in the template name to make it obvious that the report should not be distributed externally.

When a report is created within the report request, the language defaults to that defined by the DEFAULT_REPORT_LANGUAGE application preference.

If template-based scripting is required for laboratory-wide reporting, ensure the report template script code links to a script with a Script Type of Report Template.

Report templates are maintained using the CCTPLR—Report Template application.

Customising the Report Generation

If laboratory-wide scripting is required, ensure a lab-scope REPORT_SCRIPT application preference contains the code of a script with a Script Type of Report Template.

During the generation of reports from a report request, events contained within these scripts are run.

Scripts are maintained using the CCSCRT—Script application.

Emailing Report Documents

If reports generated from the report request are to be emailed, email details must be entered. The REPORT_FROM_EMAIL_ADDRESS, EMAIL_REPORTS_SEPARATELY and EMAIL_ZIP_ATTACHMENTS application preferences control the emailing of the the report.