CCTPLR—Report Template Detail
Processes associated with this form
Screen flows
- Submit—Validate and save the changes.
- Refresh—Reloads the original data. Any changes made since the last submit are lost.
- New—Create a new item related to the application.
- Save As—Creates 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 report template 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 template's scope upon successful creation depends upon the user's security level for the CCTCCREPORTTEMPLATE: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 Template Code
The unique code assigned to report template.
-
Name
The name of the report template. Maximum length of 200 characters. Multi-language support.
-
Description
The description of the report template. Maximum length of 400 characters. Multi-language support.
-
Report Template Category
-
A category assigned to the report template. Selected from categories with a Category Type of REPORT_TEMPLATES.
-
Is Active
Indicates whether the entity is available in drop-down lists. An inactive entity cannot be selected for use.
-
Type
The type of report template 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.
-
-
File
The file uploaded to CCLAS that is the actual template file to be used to generate a report.
To generate a custom report, a DSC file can be uploaded with the data sources, so that it is used for querying specific CCLAS tables. In this case, the generated report reflects the result set created using the DSC file and the script associated with the report template's Script Code.
-
Device Code
The code of the device associated with the report template. A device may be selected from the drop-down list that contains active devices in scope, as configured in the CCDEVI—Device application. Click the field hyperlink to display the CCDEVI—Search Device screen, select the appropriate value and click Select and Return to populate the field with the selected value.
When a report request report is created but the report request report's Printer is empty, then on submit, it defaults to the report template's Device Code.
-
Report Engine
The report engine used to generate reports:
-
Crystal Reports—Crystal Report templates can contain sub-reports and have parameters used in report scripts.
-
Jasper (not supported)
-
Text—Text report templates can access and use external data sources as well as insert additional content such as headers and footers. Typically this report engine is used to print bar code labels, instrument run files and worksheets.
-
Other—Other templates are used by non-core report engines to generate other types of reports, for example, Microsoft Word or Excel outputs.
-
-
Application Object
The application associated with the grid report. Only applicable where Type is Grid.
If the selected object has a biofield or biofields attached to it, when the report is generated, then the Biofield Value is included and rendered according to the applicable report mask. If the object has more than one biofield then the biofields are printed in the sequence in which they exist on the job or sample.
-
Default Output Format
The default format for the output of the report template. The output option selections are common, regardless of the report engine selected, but each report engine can only support specific output formats.
-
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.
-
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.
-
-
Output File Name
The default name of the generated report when the template is used. Either Output File Name Syntax or Output File Name can 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.
-
Output File Name Syntax
The default code of the syntax used to generate the report when the template is used. Either Output File Name Syntax or Output File Name can 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.
-
Script Code
The code of the script run during report generation to perform custom logic based on the report template. A script may be selected from the drop-down list that contains active scripts in scope with a Script Type of Report Template, as configured in the CCSCRT—Script application, click the field hyperlink to display the CCSCRT—Search Script screen, select the appropriate value and click Select and Return to populate the field with the selected value.
