CCRPTR—Report Request Detail

Processes associated with this form
Screen flows
  • Submit—Validate and save the changes.
  • Refresh—Reload the original data. Any changes made since the last submit are lost.
  • New—Create a new item related to the application.
  • Save As—Create a new item based on the information provided by an existing item.
  • Delete—Confirm and delete the current item.
  • Open—Display a dialog box to enter an existing item to display its detail.
  • New Search—Return to the Search screen and clear the search results and the search criteria.
Header
  • Organisation Scope

    Indicates whether this entity is available organisation-wide or laboratory-wide.

    • Checked—The entity is available to users who are logged into any laboratory within the organisation.
    • Unchecked—The entity is only available to users who are logged into the current laboratory.

    Setting the report request's scope upon successful creation depends upon the user's security level for the CCREPORTREQUEST:CREATE resource. The only possible security level for the resource is full—full.

    A user can have multiple roles, and each role can contain different rights. Any of these role-right combinations may contain the resource.

    If the resource does not exist across all role-right combinations for the user, then the user has no access to the resource. Otherwise the user's security level for the resource is full—full.

    The selection in this field can determine the visibility for other fields in this form, and the content of various drop-down selection lists.

  • Report Request Code

    The unique code assigned to the report request.

    For report request creation:

    • A Report Request Code is generated by the syntax that is in scope and has a Syntax Type of Report Request and a Syntax Code of REP_REQ_CODE_SYNTAX.

    • Where the syntax is not found, or the syntax is found but the syntax cannot generate a code, then an error is raised.

    • Where the generated report request's Report Request Code is not unique within scope, then an error is raised.

    • Where the generated report request's Report Request Code does not satisfy code validation, then an error is raised.

  • Report Request Category

    A category assigned to the report request. Selected from categories with a Category Type of REPORT_REQUESTS.

  • Name

    The name of the report request. For report request creation, either Name Syntax Code or Name must be entered.

  • Name Syntax Code

    The code of the syntax used to generate the report request's Name. For report request creation, either Name Syntax Code or Name must be entered. A syntax may be selected from the drop-down list that contains active syntaxes in scope with a Syntax Type of Report Request, as configured in the CCSNTX—Syntax application. Click the field hyperlink to display the CCSNTX—Search Syntax screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  • Workflow Status

    The status of the report request indicating the stage it is at in its life-cycle. Display only. This can be:

    • Draft

    • Active

    • Cancelled

    • Suspended

    • Reported

    • Finalised.

  • Description

    The description of the entity. Maximum length of 400 characters. Multi-language support.

  • Is Template

    Indicates whether the report request is a template, allowing it to be searched by this when creating a report request from a template, usually for creating analysis report requests for instrument run list uploads. Default is cleared.

  • Amendment Name

    The name of the amended report.

  • Report Type

    The type of report associated with the report request:

    • Certificate

    • Paperwork

    • Labels

    • Analysis.

    Note: Paperwork and labels report requests associated with a job can be seen in the Paperwork & Labels tab in the CCREGN—Job application.

  • Report Number

    The unique report number assigned to a certificate report upon generation, generated from the that has a Code of REPORT_NUMBER where the report has a Report Status Type of Preliminary or Final.

  • Client Code

    The code of the client for whom the report is generated.

  • Contact Code

    The code of the client's contact for whom the report is generated. Defaults to the client's Primary Contact Code.

  • Signatory User Group Code

    The code of the user group that contains signatories for the report.

    When the report is generated, the details, including the signatory images and photos, of the users in the selected user group can be added to the report.

  • Instrument Code

    The code of the instrument associated with the report request, allowing it to be searched by this when creating a report request from a template, typically for creating analysis report requests for instrument run list uploads. An instrument may be selected from the drop-down list that contains active instruments in scope, as configured in the CCINST—Instrument application. Click the field hyperlink to display the CCINST—Search Instrument screen, select the appropriate value and click Select and Return to populate the field with the selected value.

Jobs Tab

The jobs associated with the report request.

  • Tab flows

    • Add Job—Search for jobs to add to the report request, optionally with all samples, schemes and analytes, or with samples only.

  • Row Number

    The row number in the grid. Display only.

    Hidden on the grid by default, but added by showing individual grid items.

  • Reportable

    Indicates whether the job is included in any reportable result set generated from the report request. Defaults to checked when a job is added to the report request.

  • Job Code

    The code of a job associated with the report request.

  • Name

    The name of the job.

  • Description

    The description of the job.

  • Client Code

    The code of the client associated with the job.

  • Client Contact Code

    The code of the contact associated with the job.

  • Client Project Code

    The code of the project associated with the job.

  • Client Submission #

    The client submission number associated with the job.

  • Last Reported

    The date-time at which the job was first included in a preliminary or final certificate report. Display only.

  • # Samples

    The number of samples, including QC samples, in the job. Display only.

  • # Unknown Samples

    The number of unknown samples in the job. Display only.

  • Owner

    The code of the user who owns the job. Display only.

  • Priority

    The priority of the job with respect to other jobs in the system. Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

  • Received

    The date-time at which the job was received by the laboratory.

  • Required

    The date-time at which the job's results must be reported.

  • Possible

    Although this should be the possible date-time at which the job's results can be reported, based on the longest duration of job analysis, currently this is the same as Required On. Possible On can be updated if the date-time provided is valid and the date-time is later than the Received On (or Received On is not defined), otherwise an error message displays upon submit. If Required On is changed, Possible On changes to match it.

  • Agreed

    The date-time at which it is agreed with the client that the report of the job's analysis is available.

  • Authorised

    The date-time at which the job was authorised. Display only.

  • Finalised

    The date-time at which the job was finalised. Display only.

  • Validated

    The date-time at which the job was validated. Display only.

  • Workflow Status

    The status of the job indicating the stage it is at in its life-cycle. Display only. This can be:

    • Registered

    • Not Started

    • Started

    • Analysed

    • Released

    • Completed

    • Finalised

    • Cancelled.

    Note: Job validation is not indicated by a workflow status, but by the stamping of its Validated Date.

Primary Job Notes

These are notes from the production job. Should there be more than one production job in the report request, then the notes are from the primary (first) job on the row. If the primary changes by pushing the primary up and down, then notes in the report request changes to the current primary.

  • Registration Notes

    Notes regarding the registration of the job. Registration notes are populated automatically with the job client's and job project's job notes, but only when the job's registration notes are initially empty. The drop-down list of available canned comment codes is filtered by active canned comments with a Canned Comment Type of JOB, a Canned Comment Subtype of REGISTRATION, and the Category Code that defaults to the value of the NOTES_JOB_REGISTRATION_CATEGORIES application preference. 

  • Preparation Notes

    Notes regarding the preparation requirements of the job's samples. The drop-down list of available canned comment codes is filtered by active canned comments with a Canned Comment Type of JOB and a Canned Comment Subtype of RECEIPT, and the Category Code defaults to the value of the NOTES_JOB_PREPARATION_CATEGORIES application preference.

  • Analysis Notes

    Notes regarding the analytical requirements of the job's samples. The drop-down list of available canned comment codes is filtered by active canned comments with a Canned Comment Type of JOB and a Canned Comment Subtype of ANALYSIS, and the Category Code defaults to the value of the NOTES_JOB_ANALYSIS_CATEGORIES application preference.

  • Report Notes

    Notes regarding the reporting requirements of the job. The drop-down list of available canned comment codes is filtered by active canned comments with a Canned Comment Type of JOB and a Canned Comment Subtype of REPORT, and the Category Code defaults to the value of the NOTES_JOB_REPORT_CATEGORIES application preference.
Email Tab

The email addresses and information enabling users to directly email reports. The initial values in some fields are populated from preference settings or syntax values set up by laboratory managers.

  • Email To

    The recipient/s of the emailed report, entered as a semi-colon delimited list of email addresses. Maximum length of 1000 characters. Defaults to the client contact's Email on the CCCLNTCNCT—Client Contact Details screen.

  • Email CC

    The recipient/s of the carbon copies of the emailed reports, entered as a semi-colon delimited list of email addresses. Maximum length of 1000 characters. Defaults to the additional report methods of type email, as entered on the Additional Report Method tab of the CCCLNTCNCT—Client Contact Details screen.

  • Email BCC

    The recipient/s of the blind carbon copies of the emailed reports, entered as a semi-colon delimited list of email addresses. Maximum length of 1000 characters. Defaults to the value of the EMAIL_BCC application preference.

  • Subject

    The text inserted in the subject of emailed certificate reports. Defaults to the string generated by the syntax that is in scope and has a Syntax Type of Report Request and a Syntax Code of EMAIL_SUBJECT_TEXT.

  • Message

    The text inserted in the message body of emailed certificate reports. Defaults to the string generated by the syntax that is in scope and has a Syntax Type of Report Request and a Syntax Code of EMAIL_MESSAGE_TEXT.

Tests Tab

The schemes and analytes for the report request. If a scheme or analyte is used in multiple selected jobs, only one instance displays.

  • Report Request Scheme Analyte Grid

    The schemes and analytes associated with the report request.

    • Grid flows

      • Change Reporting Details—For selected analytes, the ability to update reporting unit, factor report detection limits, apply a new rounding table, and update reportability, for all samples in the report request.

  • Scheme row—Report Sequence

    No functional use in CCLAS. Represents the sequence of the report request scheme in a certificate report, with respect to other report request schemes, to override registered scheme sequence, from the job scheme. For use by SQL scripts when using DSC reporting.

    Where empty, the script should follow default report request scheme sequence.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Scheme row—Reportable

    Indicates whether the scheme is included in any reportable result set generated from the report request. Defaults to true for a paperwork or labels report request, when a least one related scheme analyte's Include on Worksheets is selected, that is, when there is at least one related report request sample scheme analyte as reportable.

    Defaults to the job scheme's Reportable check box for a certificate report request.

  • Scheme row—Scheme Code

    The code of a scheme associated with the report request.

  • Scheme row—Scheme Name

    The name of the scheme associated with the report request.

  • Scheme row—Scheme Description

    The description of the scheme associated with the report request.

  • Scheme row—Version Number

    The version of a scheme associated with the report request. If the report request contains tests from multiple jobs where the same scheme is associated with a different version number then the report request scheme is associated with the highest version number.

  • Scheme row—Scheme Version Name

    The name of the scheme version associated with the report request.

  • Scheme row—Scheme Version Description

    The description of the scheme version associated with the report request.

  • Scheme row—Report Description

    The reportable description of the scheme associated with the report request. Inherited from the job scheme's Report Description when related sample schemes are to added to the report request.

  • Scheme row—Report Name

    The reportable name of the scheme associated with the report request. Inherited from the job scheme's Report Name when related sample schemes are to added to the report request.

  • Scheme row—Report Request Code

    The code of the report request. Display only.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Analyte row—Reportable

    Indicates whether the analyte is included in any reportable result set generated from the report request. Defaults to true for a paperwork or labels report request, when a least one related sample scheme analyte's Include on Worksheets is selected, that is, when there is at least one related report request sample scheme analyte as reportable. Defaults to the job scheme analyte's Reportable check box for a certificate report request.

  • Analyte row—Analyte Code

    The code of an analyte associated with the report request.

  • Analyte row—Analyte Name

    The reportable name of the analyte associated with the report request. Inherited from the job scheme analyte's Report Name. Defaults to the job scheme analyte's Report Name.

  • Analyte row—Analyte Description

    The reportable description of the analyte associated with the report request. Defaults to the job scheme analyte's Report Description.

  • Analyte row—Report Unit Code

    The report unit code for placing on the report.

    When the report request scheme analyte's Report Unit Code is updated, it is pushed down to each related report request sample scheme analyte's Report Unit Code. A unit may be selected from the drop-down list that contains active units in scope, as configured in the CCUNIT—Unit application. Click the field hyperlink to display the CCUNIT—Search Unit screen, select the appropriate value and click Select and Return to populate the field with the selected value.

    • SVA.reportUnitCode * --> SSA.reportUnitCode

      A sample scheme analyte's Report Unit Code defaults to the scheme version analyte's Report Unit Code and can be updated.

    • SVA.reportUnitCode * --> RRSA.reportUnitCode

      A report request scheme analyte's Report Unit Code defaults to the scheme version analyte's Report Unit Code and can be updated to subsequently push down to report request scheme version analytes, or as a header in a report.

    • SSA.reportUnitCode --> RRSSA.reportUnitCode

      A report request sample scheme analyte's Report Unit Code defaults to the sample scheme analyte's Report Unit Code, and is used to generate the report request sample scheme analyte's Formatted Final Value, defaults to the sample scheme analyte's Report Unit Code. It is only possible to see a report request sample scheme analyte's Report Unit Code when the sample is selected as the first sample in a multiple report request sample update.

    • RRSSA --> Used when rounding results for the report.

      When a report is generated for a report request, the sample scheme analyte's Numeric Final Value undergoes unit conversion if the report request sample scheme analyte's Report Unit Code is different to the sample scheme analyte's Unit Code, to determine the reportable numeric value, which is then rounded to produce the report request sample scheme analyte's Formatted Final Value.

    * From the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

  • Analyte row—Rounding Method Type

    The type of rounding that is applied to determine sample scheme analyte's Formatted Final Result associated with the analyte. Display only. This can be:

    • None—No further rounding is performed, and the final numeric values are placed as a string into the formatted final result.

    • Table—The results are rounded using the rounding table mechanism for the given Rounding Table Code, with the Numeric Final Value and Internal Unit Code, or Text Value, or Boolean Value, or Date Value or Date Time Value, and the Report Unit Code, Report Lower DL and Report Upper DL passed in as parameters to the mechanism, and placed as a string into the formatted final result. A rounding table defines the rules and display masks that are applied to rounding analytical results for display on reports, and includes the ability to convert to other units, as required. Refer to Appendix—Producing Final Results and Uncertainty.

    • Mask—The results are placed as a string into the formatted final result using the Report Display Mask.

    • Script—The script defined by the Rounding Script Code script is used to create the formatted final result string.

  • Analyte row—Rounding Table Code

    The rounding table code for placing on the report. Only applicable when Rounding Method Type is Table or Script (for use in the script). A rounding table may be selected from the drop-down list that contains active rounding tables in scope, as configured in the CCRNDT—Rounding Table application. Click the field hyperlink to display the CCRNDT—Search Rounding Table screen, select the appropriate value and click Select and Return to populate the field with the selected value.

    A rounding table defines the rules and display masks that are applied to rounding analytical results for display on reports, and includes the ability to convert to other units, as required. Refer to Appendix—Producing Final Results and Uncertainty.

    When the report request scheme analyte's Rounding Table Code is updated, it is pushed down to each related report request sample scheme analyte's Rounding Table Code.

    • SVA.roundingTableCode * --> SSA.roundingTableCode

      A sample scheme analyte's Rounding Table Code defaults to the scheme version analyte's Rounding Table Code and can be updated.

    • SVA.roundingTableCode * --> RRSA.roundingTableCode

      A report request scheme analyte's Rounding Table Code defaults to the scheme version analyte's Rounding Table Code and can be updated to subsequently push down to report request scheme version analytes, or as a header in a report.

    • SSA.roundingTableCode --> RRSSA.roundingTableCode

      A report request sample scheme analyte's Rounding Table Code defaults to the sample scheme analyte's Rounding Table Code, and is used to generate the report request sample scheme analyte's Formatted Final Value, defaults to the sample scheme analyte's Rounding Table Code. It is only possible to see a report request sample scheme analyte's Rounding Table Code when the sample is selected as the first sample in a multiple report request sample update.

    • RRSSA --> Used when rounding results for the report when the sample scheme analyte's Rounding Method Type is Table.

    * From the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

  • Analyte row—Report Lower DL

    The report lower detection limit for placing on the report. When the report request scheme analyte's Report Lower DL is updated, it is pushed down to each related report request sample scheme analyte's Report Lower DL.

    • SVA.reportLowerDL * --> SSA.reportLowerDL

      A sample scheme analyte's Report Lower DL defaults to the scheme version analyte's Report Lower DL and can be updated.

    • SVA.reportLowerDL * --> RRSA.reportLowerDL

      A report request scheme analyte's Report Lower DL defaults to the scheme version analyte's Report Lower DL and can be updated to subsequently push down to report request scheme version analytes, or as a header in a report.

    • SSA.reportLowerDL --> RRSSA.reportLowerDL

      A report request sample scheme analyte's Report Lower DL defaults to the sample scheme analyte's Report Lower DL, and is used to generate the report request sample scheme analyte's Formatted Final Value, defaults to the sample scheme analyte's Report Lower DL. It is only possible to see a report request sample scheme analyte's Report Lower DL when the sample is selected as the first sample in a multiple report request sample update.

    • RRSSA --> Used when rounding results for the report.

    * From the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

  • Analyte row—Report Upper DL

    The report upper detection limit for placing on the report. When the report request scheme analyte's Report Upper DL is updated, it is pushed down to each related report request sample scheme analyte's Report Upper DL.

    • SVA.reportUpperDL * --> SSA.reportUpperDL

      A sample scheme analyte's Report Upper DL defaults to the scheme version analyte's Report Upper DL and can be updated.

    • SVA.reportUpperDL * --> RRSA.reportUpperDL

      A report request scheme analyte's Report Upper DL defaults to the scheme version analyte's Report Upper DL and can be updated to subsequently push down to report request scheme version analytes, or as a header in a report.

    • SSA.reportUpperDL --> RRSSA.reportUpperDL

      A report request sample scheme analyte's Report Upper DL defaults to the sample scheme analyte's Report Upper DL, and is used to generate the report request sample scheme analyte's Formatted Final Value, defaults to the sample scheme analyte's Report Upper DL. It is only possible to see a report request sample scheme analyte's Report Upper DL when the sample is selected as the first sample in a multiple report request sample update.

    • RRSSA --> Used when rounding results for the report.

  • * From the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

  • Analyte row—Report Description

    The reportable description of the analyte for the report request. Inherited from the job scheme analyte's Report Description when related sample scheme analytes are to added to the report request, but may be updated in the report request.

  • Analyte row—Report Name

    The reportable name of the analyte for the report request. Inherited from the job scheme analyte's Report Name when related sample scheme analytes are to added to the report request, but may be updated in the report request.

  • Analyte row—Report Sequence

    No functional use in CCLAS. Represents the sequence of the report request scheme analyte in a certificate report, with respect to other report request scheme analytes, to override registered scheme analyte sequence, from the job scheme analyte. For use by SQL scripts when using DSC reporting.

    Where empty, the script should follow default report request scheme analyte sequence.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Analyte row—Scheme Code

    The code of the related scheme in the report request. Display only.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Analyte row—Report Request Code

    The code of the report request. Display only.

    Not displayed on the grid by default but can be added via showing individual grid items.

Samples Tab

The samples associated with the report request. All samples of a selected job display on this tab, regardless of their reportable status. Multiple contiguous or non-contiguous samples can be edited using the Update Multiple Samples button on the grid.

  • Tab flows

    • Add Samples—Search and add samples to the report request.

    • Resequence Samples—Order samples by registration sequence.

    • Add Batch QC—Add the QC samples from all batch jobs associated with sample scheme analytes related to the report request.

  • Grid row flows

    • Open Sample—Launch the CCSAMP—Sample Detail screen for the selected sample.

  • Grid flows

    • Update Multiple Samples—Launch the CCRPTRMULTIEDIT—Update Multiple Samples screen to update the selected samples in the report request.

  • Row Number

    The row number in the grid. Display only.

    Hidden on the grid by default, but added by showing individual grid items.

  • Reportable

    Indicates whether the sample is included in any reportable result set generated from the report request.

    • Defaults to the sample's Generate Paperwork check box for a paperwork report request.

    • Defaults to the sample's Generate Label check box for a labels report request.

    • Defaults to the sample's Reportable check box for a certificate report request.

  • Sample Code

    The code of a sample associated with the report request.

  • Job Code

    The code of the job associated with the sample.

  • Agreed On

    The date-time at which it is agreed with the client that the report of the job's analysis is available.

  • Primary Analytical Type

    The primary analytical type of the sample that denotes the type of QC assessment that the sample primarily undergoes:

    • Unknown

    • Duplicate

    • Replicate

    • Standard

    • Blank

    • Spike.

  • Client Code

    The code of the client associated with the job.

  • Contact Code

    The code of the contact associated with the job.

  • Contact Name

    The name of the contact associated with the job.

  • Client Name

    The name of the client associated with the job.

  • Project Code

    The code of the project associated with the job.

  • Client Sample Name

    The client's name for the sample.

  • Submission Number

    The client submission number associated with the job.

  • Description

    The description of the sample.

  • Finalised On

    The date-time at which the sample was finalised.

  • Job Name

    The name of the job.

  • Last Reported On

    The date-time at which the sample was last reported.

  • Name

    The name of the sample.

  • Possible On

    Although this should be the possible date-time at which the sample's results is reportable, based on the longest duration of sample analysis, currently the possible date-time is the same as Required On.

  • Reporting Spec

  • The code of the specification for including in the Report record set, selected from the set of specifications on the sample.

  • Product Code

  • The code of the product associated with the sample.

  • Primary Product Spec Code

  • The code of the specification that is flagged as the primary product specification on the sample.

  • Primary Product Spec Status

    The status of the sample's specification, for the specification that is flagged as the primary product specification on the sample:

    • Not Tested

    • Not Required

    • Pass

    • Warning

    • Lower Warning

    • Upper Warning

    • Trend Warning

    • Failure

    • Lower Failure

    • Upper Failure

    • Trend Failure

    • Ignore Failure

    • Ignore Lower Failure

    • Ignore Upper Failure

    • Ignore Trend Failure.

  • Priority

    The priority of the sample with respect to other samples in the system.

  • QC Type Code

    The code of the primary QC type that is a sub-classification of the Primary Analytical Type.

  • Received On

    The date-time at which the sample was received by the laboratory.

  • Registered On

    The date-time at which the sample was registered, upon which in the sample's Workflow Status was set to Registered. Display only.

  • Registration Sequence

    The sequence in which the sample was registered in the job.

  • Required On

    The date-time at which the sample's results must be reported.

  • Sampled On

    The date-time at which the sample was taken.

  • Standard Code

    The code of the standard associated with the sample. Applicable only where the Primary Analytical Type or Secondary Analytical Type is Blank, Standard or Spike.

  • Standard Lot Code

    The code of the current standard lot for the standard associated with the sample. Applicable only where the Primary Analytical Type or Secondary Analytical Type is Blank, Standard or Spike.

  • Validated On

    The date-time at which the sample was validated.

  • Workflow Status

    The status of the sample indicating the stage it is at in its life-cycle. Display only. This can be:

    • Registered

    • Not Started

    • Listed Not Received

    • Insufficient Sample

    • Not Analysed

    • No Result

    • Started

    • Analysed

    • Released

    • Completed.

    Note: Sample validation is not indicated by a workflow status, but by the stamping of its Date Validated.

Reports Tab

All reports that can be generated for the report request.

This tab includes a list of the printer queues in the laboratory including the default preference setting value, enabling different printers to be set up as the default printers for certificates, reports and labels.

  • Tab flows

    • Generate Report—Generate the reports from the report request.

  • Row Number

    The row number in the grid. Display only.

    Hidden on the grid by default, but added by showing individual grid items.

  • Reportable

    Indicates whether the report output is created when reports are generated for the report request.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Report Template Code

    The code of the report template to be used to generate the report. A report template may be selected from the drop-down list that contains active report templates in scope with a Type of either Certificate, Paperwork, Labels, SummarySheet, Worksheet, JobSheet, Report or Other, as configured in the CCTPLR—Report Template application. (There is no filtering or implication based on the report request type.) Click the field hyperlink to display the CCTPLR—Search Report Template screen, select the appropriate value and click Select and Return to populate the field with the selected value. Defaults to the job stakeholder's Report Template Code. A report request not created from a job stakeholder has its report request report's Report Template Code default to the client's Report Template if it is defined, otherwise to the cost centre's Report Template if it is defined, otherwise to the laboratory's Report Template if it is defined, in this order.

    The report template also defines the default printer for the report.

  • Report Template Name

    The name of the report template. If the report template is linked to a job stakeholder, a preferred language can be selected and stored. When the report request is created from a job, the selected language (for the stakeholder report) is stored in the report request and used in the population of the reportable result sets. A report request report can be linked to one language only (for example, a report request can contain two reports, each with different languages).

  • Output Format

    The type of output to be generated using the report template. A default suffix is only applied to those report documents where no extension is specified by the report request, report template, or script. The default output format specifies (to the reporting engine) the format for the report document. For example, the output could be a PDF, DOC, XLS, XLS_DATA, RFT, TXT, CSV or RPT file. Defaults to the template's Default Output Format.

    • Text Report Engine

      • TXT—Text

    • Crystal Reports

      • PDF—PDF Files

      • XLS—Excel (with formatting preserved)

      • XLS_DATA—Excel Data Only

      • CSV—Comma Separated Values

      • RPT—Crystal Report

    • Other report engines

      • Only select the report engine supported output formats. Other selected choices might generate erroneous outcomes.

  • Report Name

    The name of the generated report as shown in the report repository.

  • Report Description

    The description of the generated report as shown in the report repository.

  • File Name

    The name of the generated report file. Defaults to Report Template Name. Either Filename Syntax Code or File Name must be entered.

    Defining a file name enables the saving of reports into folders. One use for this is to group reports for each client into separate folders for ease of use, or security. The file name can include a directory path for the generated path, relative to the EFS root node. The file name (including the network paths) has a 1000 character maximum.

    A default suffix is only applied to those report documents where no extension is specified by the report request, report template, or script. The default output format specifies (to the reporting engine) the format for the report document. For example, the output could be a PDF, DOC, XLS, XLS_DATA, RFT, TXT, CSV or RPT file.

    Note: If the file name is not unique, that is, a file already exists in the report repository with the same nam, then there can be issues downloading the file that you think you have created. Refer to Maintaining Generated Reports.

    The entered or generated file name is accessible to scripts and can be passed to a non-core report engine (by writing into a file) and the script can update and use the new location further on in the script.

  • Filename Syntax Code

    The code of the syntax used to generate the report's File Name. Either Filename Syntax Code or File Name must be entered. A syntax may be selected from the drop-down list that contains active syntaxes in scope with a Syntax Type of Report Filename, as configured in the CCSNTX—Syntax application. Click the field hyperlink to display the CCSNTX—Search Syntax screen, select the appropriate value and click Select and Return to populate the field with the selected value.

    Note: If the file name is not unique, that is, a file already exists in the report repository with the same name, then there can be issues downloading the file that you think you have created. Refer to Maintaining Generated Reports.

    The entered or generated file name is accessible to scripts and can be passed to a non-core report engine (by writing into a file) and the script can update and use the new location further on in the script.

  • Language

    the language used to generate the report. Where the language is different to the default language used in CCLAS screens, when Generate Report is clicked, then the report displays the content for that language when placing multi-lingual text fields on the report.

    A report request that is created from scratch, and not from a job stakeholder, has its report request reports' Language default to the client's Locale if it is defined, otherwise to the language defined by the DEFAULT_REPORT_LANGUAGE application preference, in this order.

  • Email

    Indicates whether to email the report to the pre-defined email recipients.

  • Printer

    The printer on which to print the report. The printer drop-down displays values from the following preferences, depending upon the type of report template:

    Reports are printed in the order in which they are listed in the report request reports.

  • Print Copies

    The number of copies of the report to be printed.

  • Copy to Folder

    Indicates whether to copy the generated report 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.

  • Last File Name

    The name of the last file generated from the report request report.

Generated Reports Tab

The reports generated to date for the report request.

  • Tab flows

    • Add report—Add an externally generated report to the report request.

  • Grid row flows

    • Add report—Add an externally generated report to the report request, and link it to an existing generated report.

  • Grid flows

    • Email Reports—Email generated reports to the recipients specified in the Email tab.

    • Email Reports—Print generated reports to the recipients specified in the Reports tab.

  • Row Number

    The row number in the grid. Display only.

    Hidden on the grid by default, but added by showing individual grid items.

  • Report Template Code

    The code of the report template used to generate the report. Display only.

  • Report Template Name

    The name of the report template.

  • Output Format

    The type of output format of the generated report.

  • Report Code

    The code of the generated report, used in the Report Code search criteria in the CCREPT—Report application. Display only.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Report Status Type

    The status type of the generated report when the report request's Report Type is Certificate, and empty otherwise. Display only. This can be:

    • Internal

    • Preliminary

    • Final

  • Name

    The name of the generated report.

  • Description

    The description of the generated report.

  • Is Uploaded

    Indicates whether the report is an uploaded report, that is, it was not generated via the report request. Display only.

  • Original Report Code

    Where the report is an uploaded report, this is the code of the original report to which it relates. Display only.

  • File

    The icon to click to download the report document.

  • File Name

    The name of the generated report document. Display only.

  • Language

    The language used to generate the report. Display only.

  • Is Active

    Indicates whether the entity is available in drop-down lists when selecting a category for an entity. An inactive entity cannot be selected for use.

  • Report Type

    the type of report, denoting its use:

    • 00—Grid

    • 01—Certificate

    • 02—Paperwork

    • 03—Labels

    • 04—Invoices

    • 05—Summary Sheet

    • 06—Worksheet

    • 07—Prep Sheet

    • 08—Job Sheet

    • 09—Report

    • 10—Credit Note

    • 11—Instrument Upload

    • 12—Financial

    • 13—Status

    • 14—Cost Invoice

    • 15—Proposal Invoice

    • 16—Other.

  • Is Exclusive

    No functional use in core CCLAS.

  • Date Created

    The date-time at which the report was created. Display only.

  • Creation User Code

    The code of the user who generated the report. Display only.

  • Report Number

    The number of the generated report. Where a syntax with a Code of REPORT_NUMBER is defined with lab-scope, then every certificate report with a Report Status Type of Preliminary or Final has a unique report number assigned to it upon generation. Display only.

History Tab

The historical generations of a report document generated from the report request. The results of the scheduled task on the system batch queue is viewed in the MSEJEX—Job Executions application.

  • Grid flows

    • Stop—Stop the job execution on the system batch queue.

  • Row Number

    The row number in the grid. Display only.

    Hidden on the grid by default, but added by showing individual grid items.

  • File

    The file associated with the system batch job.

  • Execution Id

    The identification of the system batch job.

  • Job Name

    The name of the system batch job.

  • Status

    The status of the system batch job.

  • User Id

    The code of the User who scheduled the system batch job.

  • Start Time

    The date-time the batch job started executing.

  • End Time

    The date-time the batch job finished executing.

  • Exit Message

    The message passed out from the job batch queue execution.

  • Queue Time

    The time difference between the Create Time and Start Time of the job on the batch queue, that is, the delay in starting the job due to other jobs on the batch queue having higher priority or getting there first.

  • Create Time

    The date-time the batch job was itself created on the batch time (so should be on or before Start Time).

  • Batch Queue Execution Grid

    The steps taken for the execution of the job on the batch queue.

    • Job Execution Id

      The identification of the step within the job on the batch queue.

    • Step Name

      The name of the step within the job on the batch queue.

    • Exit Code

      The code of the exit message associated with the step within the job on the batch queue.

    • Exit Message

      The exit message associated with the step within the job on the batch queue.