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 job.
• Save As—Create a job based on the information provided by an existing job.
• Delete—Confirm and delete the current job.
• Open—Display a dialog box to enter an existing job to display its detail.
• New Search—Return to the Search screen and clear the search results and the search criteria.

• Activate Job—Activate the job which updates a job's Workflow Status from Registered to Not Started. If the AUTO_ACTIVATE_JOBS application preference is cleared, use the Activate Job flow to manually activate the job.

• Change Job Owner—Change the owner of the job.

• Unlock Job—Change the job lock record to have an unlocked state. Note that this does not actually remove the job lock record itself.

• Show Audit—Open the audit trail for the job.

• Generate Estimated Cost—Generate an estimated cost invoice for the job.

• Generate Work In Progress Cost—Generate a work-in-progress invoice for the job.

• Cancel—Cancel a job, which sets a job's Workflow Status to Cancelled. Only applicable if a job's Job Type is Production, Internal, Proposal or Template.

• Reinstate—Reinstate a cancelled job, in which a job's Workflow Status is recalculated from its samples.

• Create Draft—Create a draft job from the schedule job. Only applicable if a job's Job Type is Schedule.

• Execute—Execute the schedule job in the scheduler which results in the creation of samples from the stream samples defined in the schedule job at the defined points in time. Only applicable if the job's Job Type is Schedule.

• Terminate—Terminate the scheduled sample creation from a schedule job in the job batch queue. Only applicable if the job's Job Type is Schedule.

Header

• Job Code

  The system-generated, organisation-wide, unique identification code of the job. Refer to Working with Scope and Codes. This field is mandatory

  Note: Irrespective of the access level of the user, a code field cannot be changed during update. It can be set only on create.

  For job creation:

  • A Job Code is generated by the syntax that is in scope and has a Syntax Type of Job Code and a Syntax Code of JOB_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 job's Job Code is not unique within scope, then an error is raised.

  • Where the generated job's Job Code does not satisfy code validation, then an error is raised.

  Where the CODEVALIDATION_JOBCODE application preference is:

  • Defined and contains a list of visible ASCII characters—A valid job code only contains characters from this list.

  • Not defined—A valid job code only contains characters from the 'ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789' character set.

• 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 job's scope upon successful creation depends upon the user's security level for the CCJOB:CREATE resource, and upon the value of the CAN_CREATE_ORG_JOB_TEMPLATE application preference. 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 ful—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.

• Job Type

  The type of job:

  • Production—A production job is a collection of samples and their tests submitted from a client, from which a certificate report of results is generated for the client.

  • Lab Batch—A laboratory batch job is a collection of samples for common testing, gathered together to save on costs and for time-based efficiencies of preparation and analysis.

  • Internal—An internal job is a collection of samples and tests registered for internal purposes, for example, analysis of instrument calibration.

  • Proposal—A proposal job is a collection of proposed samples and tests for a client, so that the client can be given an example of a typical report and invoice if real samples were submitted for testing.

  • Template—A template job is used to create other jobs and can contain a collection of template samples and their tests that are optionally included when creating a job from it.

  • Schedule—A schedule job is similar to a template job except that it has a registration frequency, and contains a collection of stream samples and their tests, that may be used interactively to draft a job, update the draft job content, and from that create or update a production job, or that may be used by the batch queue at the scheduled time to create or update a production job with stream samples. A stream sample is a sample of a known product that is taken a particular location in the production process, or a standard sample that is inserted into the analytical stream of samples from the production process.

  • Draft—A draft job is a transient job that is created interactively from a schedule job, upon which its registration details, samples and tests can be modified prior to it being enacted to create samples in a production or internal job.

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

• Job Name

  The name of the job.

  Note: The job name cannot be changed during update. It can be set only on job create.

• Production Job Name

  The name of the job. Display only. This field is relevant only for a draft job.

Primary Details Tab

The primary details of the job. If the CAN_UPDATE_JOB_CLIENT preference is cleared then the client code, project code and contact code fields are disabled and cannot be updated. If the CAN_UPDATE_JOB_CLIENT preference is checked then these fields can be updated. At the minimum, a client code must be selected.

• Description

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

• Job Category

  A category assigned to the job. Selected from categories with a Category Type of JOBS.

• Client Code

  The code of the client associated with the job. It is mandatory for a job to be associated with a client. Client Code can be updated only if the CAN_UPDATE_JOB_CLIENT application preference is checked (the default setting is cleared). If the job's ERS Code is populated, then the Client Code comes from this and cannot be updated. If Client Code is updatable, then a client may be selected from the drop-down list that contains active clients in scope, as configured in the CCCLNT—Client application. Click the field hyperlink to display the CCCLNT—Search Client screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Project Code

  The code of the project associated with the job. If the MANDATORY_PROJECT application preference is checked, then it is mandatory for a job to be associated with a project. Project Code can be updated only if the CAN_UPDATE_JOB_CLIENT application preference is checked (the default setting is cleared). If the job's ERS Code is populated, then the Project Code comes from this and cannot be updated. If Project Code is updatable, then a project may be selected from the drop-down list that contains active projects for the client, as configured in the CCCLNTPROJ—Client Project application.

• Contract Submission #

  The contract submission number.

• Contact Code

  The code of the contact associated with the job. If the MANDATORY_CONTACT application preference is checked, then it is mandatory for a job to be associated with a contact. Contact Code can be updated only if the CAN_UPDATE_JOB_CLIENT application preference is checked (the default setting is cleared). If the job's ERS Code is populated, then the Contact Code comes from this and cannot be updated. If Contact Code is updatable, then a contact may be selected from the drop-down list that contains active contacts for the client, as configured in the CCCLNTCONT—Client Contact application.

• Contract

  The contract associated with the job.

• Client Submission #

  The client submission number associated with the job.

• Cost Centre Code

  The code of a cost centre associated with the job. Defaults to the client project's Cost Centre Code if one is defined, or to the client's Cost Centre Code if one is defined, in this order of application. A cost centre may be selected from the drop-down list that contains active cost centres in scope, as configured by the CCCOST—Cost Centre application. Click the field hyperlink to display the CCCOST—Search Cost Centre screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Auto-receive Job

  Indicates whether a draft or production job created from a template or schedule job has the job's Received Date set or left empty. Only applicable only for template or schedule jobs.

• 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).

  It is possible to sort samples prior to batching by the job's or sample's Priority. This process takes the different priority units into account, for example, 1W (week) is equivalent to 7D (days), 60S (seconds) is equivalent to 1N (minute), or 30D (days) is equivalent to 1M (month).

• Quote Code

  The client quote associated with the job. A quote may be selected from the drop-down list that contains active quotes for the client, as configured in the CCQuote—Quote application.

• Received On

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

• Received By

  The code of the user who marked the job as received.

• Required On

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

• Possible On

  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 On

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

• Auto Append QC

  Indicates whether, after a production or internal job is created by executing a schedule job or enacting a draft job, then the destination job has an append QC process run automatically. Default is cleared.

  If this automatic append QC process is run, then it acts upon all registered samples including any registered QC sample. That is, those that have a QC Source of 1 (because they were registered along with the unknown samples or added by duplicating unknown samples since the schedule or draft sample's No. of Duplicates > 0 or sample scheme's No. of Replicates > 0).

  The QC samples created from an append QC process have a QC Source of 2.

• Subcontract Laboratory Code

  The code of the laboratory to which the laboratory batch job was subcontracted for analysis. This field is applicable only for laboratory batch jobs.

• Auto-validate Job

  No functional use in core CCLAS. Represents whether jobs are auto validated, however, the AUTO_VALIDATE_JOBS and AUTO_VALIDATE_LAB_BATCH_JOBS application preferences control this.

• Authorise Job

  No functional use in CCLAS. Represents whether the job requires authorisation.

• Authorisation User Group Code

  The code of the user group whose members can authorise the job. A user group may be selected from the drop-down list that contains active user groups in scope, as configured by the CCUSGP—User Group application. Click the field hyperlink to display the CCUSGP—Search User Group screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Signatory User Group Code

  No functional use in CCLAS. Represents the code of the user group whose members can sign the job. A user group may be selected from the drop-down list that contains active user groups in scope, as configured by the CCUSGP—User Group application. Click the field hyperlink to display the CCUSGP—Search User Group screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Is Fixed Price

  No functional use in core CCLAS. Represents whether the job has a fixed price.

• Fixed Price

  No functional use in core CCLAS. Represents the fixed price that applies to the job.

• Discount

  No functional use in core CCLAS. Represents the discount applicable to the job.

• Price Book Code

  No functional use in core CCLAS. Represents the code of the price book applicable to the job.

• ERS Code

  The code of the electronic request sheet (ERS), if one was used to register the job. Display only.

• Is Auto Paperwork

  Indicates whether, after a production or internal job is created by executing a schedule job or enacting a draft job, then the destination job has paperwork generated automatically. Default is cleared. This process involves the following steps:

  • If the related paperwork or labels report requests exists, then all reports are cleared from it. (This does not include the clearing of previously generated reports.) If the related paperwork or labels report request does not exist, then it is created.

  • Where the production or internal job contains at least one paperwork entry where the Reportable is selected, then a report request is created for the job and the report request's Type is set to Paperwork, then each paperwork entry is added as a report request report, and each sample in the job is added as a report request sample and the report request sample's Reportable flag is inherited from the sample's Generate Paperwork flag.

  • Where the production or internal job contains at least one labels entry where the Reportable is selected, then a report request is created for the job and the report request's Type is set to Labels, then each labels entry is added as a report request report, and each sample in the job is added as a report request sample and the report request sample's Reportable flag is inherited from the sample's Generate Paperwork flag.

  • The reports are generated for the related paperwork and labels report requests.

• Is Active

  Indicates whether a template job is active for use. Default is checked.

• Archive Status

  The archive status of the job indicating the location in which the job is stored. Display only. This can be:

  • Online—The job is located in the Live Production Environment.

  • Archived—The job is located in the Archive Repository.

  • Offline—The job is located in the Offline Storage.

Reporting Tab

The stakeholders associated with the job, used to create report requests from which certificate reports are generated. Many of the fields on the grid can be edited.

When report requests are created for a job, one report request is created for each job stakeholder where the Scope Type is Report. The language for each job stakeholder's report can be set so that when the reporting result sets are constructed and populated, then any field that has language content matching the report's language had the field content for that language extracted and placed into the reporting result set.

• Is Active

  Indicates whether the job stakeholder is active. A report request can only be generated from an active job stakeholder.

• Name

  The name of the report, to indicate its use.

• Description

  The description of the job stakeholder and the report to which it relates.

• Category Code

  A category assigned to the job stakeholder, used determine which job stakeholder's reports are placed into the same report request. Selected from categories with a Category Type of JOB_STAKEHOLDERS.

  Example:

  Given a job has the following job stakeholders where the Scope Type is Report:

  Client	Contact	Report Template	Active	Category Code
  CLIENTA	CONTACTA	REPORT	Y	GROUP1
  CLIENTA	CONTACTB	REPORT	Y	<empty>
  CLIENTA	CONTACTB	REPORT	Y	<empty>
  CLIENTA	CONTACTA	XLS_FILE	Y	GROUP1
  CLIENTB	CONTACTB	REPORT	Y	GROUP2
  CLIENTB	CONTACTB	REPORT	Y	GROUP2
  CLIENTC	CONTACTC	XLS_FILE	Y	<empty>

  Then the following report requests are created from these job stakeholders:

  1. Contains the report request reports from rows 1 and 4 for client CLIENTA and contact CONTACTA.

  2. Contains the report request report from row 2 for client CLIENTA and contact CONTACTB.

  3. Contains the report request report from row 3 for client CLIENTA and contact CONTACTB.

  4. Contains the report request reports from row 5 and 6 for client CLIENTB and contact CONTACTB.

  5. Contains the report request report from row 7 for client CLIENTC and contact CONTACTC.

• Client Code

  The code of the client who is the job stakeholder, for whom the report is generated. The contact and report template default from the client. The language used to generate the report default from the client where the report template does not have a language defined.

• Client Name

  The name of the client.

• Contact Code

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

• Contact Name

  The short name of the contact.

• Contact Full Name

  The full name of the contact.

• User Code

  The code of the user who is the job stakeholder, for whom the report is generated.

• User Name

  The short name of the user.

• Scope Type

  The type of report request. This can be:

  • Report—When the job is used to create a report request automatically, or the job is added to a report request, then only these job stakeholders are used to create a report request report within the report request.

  • Other—For these types of job stakeholders, there is no real purpose for a report template. These types of job stakeholders are just used as search criteria when searching for jobs.

  Note: This functionality was to apply where Scope Type is set to Report, not Other. A current defect exists where if Scope Type is set to Other but the template's Type is not Report, then an error is raised upon submit.

• Report Template Code

  The code of the report template to be used to generate the report. Defaults 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. A report template may be selected from the drop-down list that contains active report templates in scope with a Type of Certificate, as configured in the CCTPLR—Report Template application. 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.

  The job stakeholder's Report Template Code becomes the default for the report request report's Report Template Code.

• Report Template Name

  The name of the report template.

• File Name

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

  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 to check this.

• File Name Syntax Code

  The code of the syntax used to generate the report's File Name. Either File Name 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 to check this.

• File Name Syntax Name

  The name of the syntax. Display only.

• Language

  The language in which the report is generated. Defaults to the job stakeholder's Language, which, in turn, defaults to the report template's Language if it is defined, otherwise to the client's Locale if it is defined, otherwise to the language defined by the DEFAULT_REPORT_LANGUAGE application preference, in this order. A language/locale may be selected from the drop-down list that contains active system languages.

• Already Exists

  Only displayed for a draft job. Indicates whether the job stakeholder already exists in the destination job, and if so, then the job stakeholder is displayed read-only.

Invoicing Tab

Client invoices to be raised for the job, only displayed when the Job Type is Proposal, Production or Template. Client invoices cannot be created for internal jobs. A job invoice is always raised for a selected client, and optional project and contact. When a job is created, a job invoice is created automatically based on the job client's Invoice To Client Code, provided that the client has a Currency, Price Catalogue Group and Locale. Sub-tabs allow surcharges, rebates, samples and tests to be maintained for the invoice. Taxes associated with the client can be viewed.

• Row flows

  • Append Unassigned Samples and Tests—Add samples, schemes and analytes to a job invoice after job activation and invoice creation. The flow finds samples, job schemes and job scheme analytes that are not yet included in any job invoice in the job, and adds them to the selected job invoice's samples and tests, in the same order as their registration provided at least one scheme version analyte's Is Invoiceable is selected.

    Only enabled where the job's Job Type is Production or Proposal, the job is activated, and one or more job invoices are selected.

    The Is Invoiceable check box of all the newly added schemes and analytes is checked.

  • Save As—Create a new item based on the information provided by an existing item.

  • Generate Estimated Invoice—Generate an estimate invoice for the job invoice.

  • Generate Work In Progress Invoice—Generate a work-in-progress invoice for the job invoice.

  • View Invoices—View invoices associated with the job invoice.

  • Open Invoice Sample Grid—Open the invoice sample grid for all samples that are flagged as invoiceable in the job invoice, to flag the job invoice sample schemes and job invoice sample scheme analytes that are invoiceable, allowing a customer to be charged based on those granular levels.

  • Open Invoice Sample Grid (All)—Open the invoice sample grid for all samples in the job invoice, to flag the job invoice sample schemes and job invoice sample scheme analytes that are invoiceable, allowing a customer to be based on those granular levels.

  • Change Locale—Change the locale of the invoice.

• Grid flows

  • Append All Samples and Tests—Add all samples, schemes and analytes to a job invoice after job activation and invoice creation. The flow finds all samples, job schemes and job scheme analytes that are not yet included in any job invoice of the job, and adds them to the selected job invoice's samples and tests, in the same order as their registration provided at least one scheme version analyte's Is Invoiceable is selected.

    Only enabled where the job's Job Type is Production or Proposal, the job is activated, and one or more job invoices are selected.

    The Is Invoiceable check box of all the newly added schemes and analytes is checked.

  • Clear Samples and Tests—Remove one or more selected samples, job schemes and job scheme analytes from a proposal or production job invoice, for job invoices that that have an Invoice Status of Initial or Draft.

    Only enabled where the job's Job Type is Production or Proposal, the job is activated, and one or more job invoices are selected.

    If the Samples and Tests Locked for Update is selected, then the samples and tests cannot be removed.

• Client Code

  The code of the client to receive the invoice. A client may be selected from the drop-down list that contains active clients in scope that have Currency and Price Catalogue Group defined. Click the field hyperlink to display the CCCLNT—Search Client screen, select the appropriate value and click Select and Return to populate the field with the selected value. Ensure that the selected client is in scope and has Currency and Price Catalogue Group defined.

  When a client code is selected, then the quote code, price book code, project code and contact code are cleared.

• Client Name

  The name of the client. Display only.

• Project Code

  The code of the project associated with the job invoice, selected from one of the invoice client's projects. A project may be selected from the drop-down list that contains active projects for the client, as configured in the CCCLNTPROJ—Client Project application.

• Project Name

  The name of the project. Display only.

• Discount

  The discount applied to an invoice at the end of all line items prior to any tax, applicable where the invoice contains this job invoice only (single-job invoice), or where the invoice contains multiple job invoices and this job invoice is the primary job invoice (merged-job invoice).

• Contact Code

  The code of the contact associated with the job invoice, selected from one of the invoice client's contacts. A contact may be selected from the drop-down list that contains active contacts for the client, as configured in the CCCLNTCONT—Client Contact application.

• Contact Name

  The short name of the contact. Display only.

• Contact Full Name

  The full name of the contact. Display only.

• Description

  The description of the job invoice. Text fields on an invoice are retained only in the language associated with client's Locale.

• Invoice Status

  The status of the invoice. Display only.

  A production or proposal invoice can have one of the following states:

  • Initial

  • Draft

  • Edited

  • Released

  • Cancelled

  • Authorised

  • Production invoices:

  A production invoice can also have one of the following statuses:

  • Accepted

  • Rejected

  • Transmitted

  • Booked

  • Paid

  • Credited

  • Rejected.

• A proposal invoice can also have one of the following statuses:

  • Sent

  • Accepted

  • Rejected.

• Client Quote Code

  The code of the client's quote used to determine the pricing of line items. A quote can be selected from the drop-down list that contains active quotes for the client where the quote's Quote Currency matches the job invoice's Currency, the quote's Start Date and End Date range matches the job's Date Received, and the quote's Client Code + Project Code + Contact Code matches the job invoice's Client Code + Project Code + Contact Code, that is, all of these fields must match.

  When the job invoice's Currency is selected, where the job invoice's Quote Code is populated and the quote's Currency does not match the job invoice's Currency, then the job invoice's Quote Code is cleared.

• Quote Generic Discount

  The generic discount applied to a line item raised for any scheme or analyte NOT covered by the quote.

  Only applied when the job invoice is linked to a quote (that is, either the job invoice's Generic Discount is applied or the quote's Generic Discount is applied).

• Locale

  The code of the locale used to extract the invoice line item notes in the required language. This may be updated only using the Change Locale row flow. Locale is mandatory.

  When a job invoice is linked to a client then the job invoice's Locale defaults to the client's Locale.

• Currency

  The code of the currency used to determine the pricing of items on an invoice generated from the job invoice. This may be updated only where the invoice's Invoice Status is Initial. A currency may be selected from the drop-down list that contains active currencies, as configured in the MSECUR—Currency application.

  When a currency is selected, where the job invoice's Price Book Code is populated and the price book's Currency does not match the job invoice's Currency, then the job invoice's Price Book Code is cleared, and where the job invoice's Quote Code is populated and the quote's Currency does not match the job invoice's Currency, then the job invoice's Quote Code is cleared.

  When currency is cleared, then the price book is cleared also.

  When a job invoice is linked to a client then the job invoice's Currency defaults to the client's Currency.

  When a quote is selected on a job invoice:

  • Where the job invoice's Currency is not empty, then only quotes with a matching currency is selectable.

  • Where the job invoice's Currency is empty, then the job invoice's Currency is populated from the quote.

• Exchange Rate

  The exchange rate to convert from the invoice's Currency to the laboratory's Currency, based on the creation date-time of the initial invoice, and updated based on the date-time of invoice release. (Note that a service exists in the Invoice API to bring Exchange Rate up to date.)

• Generic Discount

  The generic discount applied to a line item raised for any scheme or analyte.

  Only applied when the job invoice is NOT linked to a quote (that is, either the job invoice's Generic Discount is applied or the quote's Generic Discount is applied).

• Price Book Code

  The code of the price book used to determine the pricing of items, where book price is used (as opposed to quote pricing) on an invoice generated from the job invoice. A price book can be selected from the drop-down list that contains active price books that match the job's Date Received and job invoice's Currency, in the price catalogues in the job invoice's Client Price Catalogue Group.

  When the job invoice's Currency is selected, where the job invoice's Price Book Code is populated and the price book's Currency does not match the job invoice's Currency, then the job invoice's Price Book Code is cleared. Refer to Conditions for Defaulting Job Invoice Price Book.

• Split Code

  The code of the split price adjustment applied to the pricing of items on an invoice generated from the job invoice, allowing for the invoicing of a proportion of the full price for the invoice client. A split can be selected from the drop-down list that contains active price adjustment in scope with a Price Adjustment Type of Split, as configured in the CCPRCADJ—Price Adjustment application. Click the field hyperlink to display the CCPRCADJ—Search Price Adjustment screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Samples and Tests Locked for Update

  Indicates whether samples and tests on the job invoice are locked for update, that is, whether the job invoice sample and test list can be change with the Append Unassigned Samples and Tests, Append All Samples and Tests, or Clear Samples and Tests services.

• Invoice Number

  The unique number for the invoice. Refer to Conditions for Defaulting Job Invoice Status and Number on Drafting.

  When the job invoice is used to create a draft invoice or merged with other job invoices to create a draft invoice, the invoice is changed to a permanent form of invoice with an Invoice Status of Draft and given a unique permanent invoice number that is generated from the laboratory's Invoice Number Pattern where the job's Job Type is Production, or from the laboratory's Proposal Invoice Pattern where the job's Job Type is Proposal.

  When a production invoice is credited, a credit invoice is created with an Invoice Status of Released and given a unique permanent invoice number that is generated from the laboratory's Credit Note Pattern.

• Linked Invoice Number

  Where the invoice is a production invoice and the invoice is credited, then this is the invoice number of the credited invoice. Where the invoice is a credit invoice, then this is the invoice number of the original production invoice.

• Update Latest Pricebook

  Only applicable if the job's Job Type is Template or Schedule. Indicates whether each job invoice associated with the job has its price book updated when a production, proposal or draft job is created from a template or a schedule job.

  When a price book is updated: If the price book is not expired, or the price book is expired and the Update Latest Pricebook check box is NOT checked on the source job invoice, then the source price book is applied to the destination job invoice. If the price book is expired and the Update Latest Pricebook check box IS checked on the source job invoice, then the destination job invoice's price book is determined regular rules to apply a price book, and if no such price book is found, then none is applied to the destination job invoice.

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

Invoicing > Surcharges Tab

The surcharges applicable to the job invoice. The grid is refreshed when a different row is selected in the job invoice grid. The surcharges default to the client's surcharges.

• Surcharge Code

  The code of the surcharge applied to the invoice line items. A surcharge may be selected from the drop-down list that contains active price adjustment in scope with a Price Adjustment Type of Surcharge, as configured in the CCPRCADJ—Price Adjustment application. Click the field hyperlink to display the CCPRCADJ—Search Price Adjustment screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Name

  The name of the surcharge.

• Description

  The description of the surcharge.

• Percentage Adjustment

  The percentage adjustment applied to the invoice line items for the surcharge.

• Applies to Sample Prep Schemes

  Indicates whether the surcharge is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Sample Preparation.

• Applies to Analytical Prep Schemes

  Indicates whether the surcharge is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Analytical Preparation.

• Applies to Analytical Schemes

  Indicates whether the surcharge is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Analytical.

• Applies to Miscellaneous Schemes

  Indicates whether the surcharge is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Miscellaneous.

Invoicing > Rebates Tab

The rebates applicable to the job invoice. The grid is refreshed when a different row is selected in the job invoice grid. The rebates default to the client's rebates.

• Rebate Code

  The code of the rebate applied to invoice line items. A rebate may be selected from the drop-down list that contains active price adjustment in scope with a Price Adjustment Type of Rebate, as configured in the CCPRCADJ—Price Adjustment application. Click the field hyperlink to display the CCPRCADJ—Search Price Adjustment screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Name

  The name of the rebate.

• Description

  The description of the rebate.

• Percentage Adjustment

  The percentage adjustment applied to the invoice line items for the rebate.

• Applies to Sample Prep Schemes

  Indicates whether the rebate is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Sample Preparation.

• Applies to Analytical Prep Schemes

  Indicates whether the rebate is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Analytical Preparation.

• Applies to Analytical Schemes

  Indicates whether the rebate is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Analytical.

• Applies to Miscellaneous Schemes

  Indicates whether the rebate is applied to invoice line items raised from sample schemes associated with a scheme that has a Scheme Type of Miscellaneous.

Invoicing > Taxes Tab

The taxes applicable to the job invoice. The grid is refreshed when a different row is selected in the job invoice grid. The taxes default to the client's rebates.

• Tax Code

  The code of the tax applied to the invoice line items. A tax may be selected from the drop-down list that contains active taxes in scope, as configured in the CCTAX—Tax application. Click the field hyperlink to display the CCTAX—Search Tax screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Name

  The name of the tax.

• Description

  The description of the tax.

• Tax Rate

  The percentage rate of taxation applied to the invoice.

Invoicing > Samples Tab

The samples associated with the selected job invoice. The grid is refreshed when a new row is highlighted in the parent grid.

Multiple rows in a grid are marked/unmarked for selection or deletion by checking/unchecking the far-left check box or the red deletion icon, respectively, on the first row in the selection and holding the Control key and checking/unchecking the far-left check box or red deletion icon, respectively, on the last row in the selection. Multiple rows in a grid can have any Boolean property that is common to all rows (for example, Active or Reportable check box) marked/unmarked for selection by checking/unchecking the Boolean's check box on the first row in the selection and holding the Control key and checking/unchecking the Boolean's check box on the last row in the selection.

Samples can only be added to a job invoice if Job Invoice Samples and Tests Locked for Update check box is cleared.

• Row Number

  The sequence number of the sample in the job invoice. Display only. Hidden on the grid by default, but added by showing individual grid items.

• Is Invoiceable

  Indicates whether the sample is invoiceable for the job invoice.

• Use Package Price

  Indicates whether the sample's tests are priced as packages where a sample scheme's and sample scheme analyte's Package Price Code is defined, or whether the sample's tests are priced according to the job scheme's and job scheme analyte's Price Code.

• 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.

• Sample Code

  The code of the sample associated with the job invoice.

• Sample Name

  The name of the sample.

• Client Sample Name

  The client's name for the sample.

• Description

  The description of the sample.

• Product Code

  The code of the product associated with the sample.

Invoicing > Tests Tab

The schemes and analytes associated with the selected job invoice. The grid is refreshed when a new row is highlighted in the parent grid.

You can use this tab to add tests to a job invoice so that they can be included in a generated invoice. Tests can only be added to a job invoice if the Job Invoice Samples and Tests Locked for Update check box is cleared.

• Code

  The code of the scheme or analyte associated with the invoice test.

• Is Invoiceable

  Indicates whether the scheme or analyte is invoiceable. Even though a scheme or analyte is included in a job invoice, it is only included in invoice line items where it is invoiceable.

• Scheme Code

  The code of the scheme associated with the invoice test.

• Scheme Name

  The name of the scheme.

• Scheme Price Type

  The type of pricing structure associated with the scheme:

  • Not Priced—The scheme and its analytes are not costed nor invoiced.

  • Sample-Based—The scheme is charged on a ’per sample’ basis with underlying granularity to allow for sliding scale charging based on sample numbers associated with the invoice, regardless of the scheme type or the number of invoiceable analytes in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Sample-Based.

  • Scheme-Based—The scheme is charged on a ’per Scheme’ basis with underlying granularity to allow for sliding scale charging based on the number of costed or invoiceable analytes in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Scheme-Based.

  • Unit-Based—The scheme is charged on a ’per unit’ basis, where a unit is typically a measure of duration (for example, based on the number of hours taken to perform a job scheme, or the number of kilometres travelled for preparation), with underlying granularity to allow for sliding scale charging based on the number of invoiceable units in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Unit-Based.

  • Analyte-Based—The scheme is charged based on the presence of a result on a ’per analyte’ basis with underlying granularity to allow for sliding scale charging based on the magnitude of the analytical result. The invoiceable analytes within the scheme must be linked to a Price Code where the price code's Price Type is Analyte-Based.

• Scheme Price Code

  The price code associated with the scheme.

• Number of Units

  The number of units on the job scheme, used to determine the job scheme's price where the scheme has a Price Type of Unit-Based.

• Analyte Code

  The code of the analyte associated with the invoice test.

• Analyte Name

  The name of the analyte.

• Analyte Price Code

  The price code associated with the analyte.

Biofields Tab

The biofields associated with the job.

• Grid flows

  • Lookup CCBFLD—Open the CCBFLD—Search Biofield screen to perform a search.

• Biofield Code

  The code of the biofield associated with the job. A biofield may be selected from the drop-down list that contains active job biofields in scope, and linked to no line of business or to a line of business associated with the laboratory, as configured in the CCBFLD—Biofield application. Click the field hyperlink to display the CCBFLD—Search Biofield screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  Scope rules apply. If the scope of the entity is org-scope then the drop-down list for the linked entity contains org-scope entities only, and the entity can be linked to org-scope entities only. If the scope of the entity is lab-scope then the drop-down list for the linked entity contains both org-scope and lab-scope entities, and the entity can be linked to either org-scope or lab-scope entities.

  Line of business rules apply. The drop-down list for the linked entity is filtered further to contain only those org-scope entities that have no associated line of business or a line of business that matches one of the laboratory's lines of business. The entity can be linked to an org-scope entity only where the org-scope entity has no associated line of business or a line of business that matches one of the laboratory's lines of business.

• Name

  The name of the biofield.

• Description

  The description of the biofield.

• Biofield Value

  The value of the biofield on the job.

• Reportable

  Indicates whether the biofield is reportable, that is, whether it is included in reporting data result sets.

• Already Exists

  Only relevant for a draft job, and indicates whether the job biofield already exists in the destination job, and if so, then the job biofield is displayed read-only.

Notes Tab

Notes associated with the job.

Rich text formatting can be used to control the appearance of the information, with basic formatting ribbon and hyperlink entry field. For example, the name of a contact can be entered in bold, the telephone number in italics, and hyperlinks can be used. The formatting is saved along with the actual content. Canned comment functionality is accessed via the F2 function key and is used to insert chunks of text from the selected Canned Comment Code whose drop-down selection list is populated with canned comments filtered by Canned Comment Type, Canned Comment Subtype and Category Code. The following preferences are used to default the category codes available in the Category Code drop-down selection list, based upon the particular notes field being updated:

If any of these preferences are updated, they are applied on application launch or refresh.

If the respective preference is not defined, then the drop-down list of available canned comment codes comprises ALL active canned comments with a Canned Comment Type of GLOBAL, JOB, SAMPLE or SCHEME and a Canned Comment Subtype of GLOBAL, REGISTRATION, RECEIPT, ANALYSIS, RELEASE, VALIDATION, AUTHORISATION, REPORT or INVOICE.

As soon as a canned comment code is entered or selected from the drop-down list, the canned comment long form content is embedded into the note field. Note that Cancel can be clicked at any time to exit canned comment selection.

• 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.

Samples Tab

The samples registered for the job.

Some sample grid properties are not displayed on the grid by default, but can be added via showing individual grid items. Also refer to Conditions for Registration Sample Biofield Display.

New sample groups can be added, composite samples created, samples maintained or deleted.

• Tab flows

  • Create Sample—Create a new sample.

  • Create Sample from Template—Create a new sample from a template sample.

  • Import Schedule Sample—Search for another schedule sample and import it into the job.

• Row Number

  The row number within the grid.

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

• Row flows

  • Copy Sample—Create one or more copies of the sample.

  • Open Worklists—Launch the CCWKOPTRAN—Workbook Open Transposed Detail screen containing the worklist for the selected sample. This displays a transposed worksheet in worklist mode which allows data entry for one sample at a time, typically the mode used to perform instrument data entry.

• Grid flows

  • Export to Report—Report selected records from the search display grid. The report templates are specified using the SEARCH_REPORT_<ApplicationName> application preference.

  • Update Multiple Samples—Update the selected samples in the job.

  • Mark Received—Mark a sample as received by the laboratory, for a specified date-time, to update the sample's Received On date-time.

  • Apply sample template pricing—Apply the package price to the sample schemes and sample scheme analytes that are associated with the template sample for the selected samples.

  • Remove sample template pricing—Remove package price from the sample schemes and sample scheme analytes that are associated with the template sample for the selected samples.

  • Activate—Activate the sample, thereby updating the sample's Workflow Status from Registered to Not Started.

  • Deactivate—Deactivate the sample.

  • Create Composite Samples—Create a composite sample from selected samples. Only available for jobs that have a Job Type of Production or Internal.

    The composite sample displays on the Samples tab. Open the composite sample to display the constituent samples on the Linked Samples tab.

• Is Auto Reg

  Indicates whether the stream sample is included in automatic registration when the schedule job is used to creates a sample within a production job. Only relevant when this screen is opened for a stream sample within a schedule job.

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

• Is Manual Reg

  Indicates whether the stream sample is included in manual registration when the schedule job is used to creates a sample within a draft or production job. Only relevant when this screen is opened for a stream sample within a schedule job.

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

• 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.

• Sample Code

  The system-generated, organisation-wide, unique identification code of the sample.

• Sample Name

  The name of the sample.

• Client Sample Name

  The client's name for the sample.

• Contract Submission Number

  The contract submission number.

• Description

  The description of the sample.

• Product Code

  The code of the product associated with the sample.

• Is Composite

  Indicates whether the sample is a composite sample. Display only.

• Priority

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

• No. of Duplicates

  The number of duplicate QC samples to be created for the sample. The default is 0. Only applicable for stream samples within a schedule job, where the sample's Primary Analytical Type is Unknown.

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

• Dup Qc Type Code

  The code of the primary QC type that is a sub-classification of the duplicate primary analytical type, for duplicate QC samples that are created for the stream sample. A QC type may be selected from the drop-down list that contains active QC types in scope, as configured in the CCQCTP—QC Type application. Click the field hyperlink to display the CCQCTP—Search QC Type screen, select the appropriate value and click Select and Return to populate the field with the selected value.

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

• Laboratory Code

  The code of the laboratory associated with the primary duplicate QC type.

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

• Reportable

  The default setting for a report request sample's Reportable check box in a certificate report request.

  Note: that unknown samples are always included in a certificate report request, but a duplicate, replicate, blank, standard or spike QC sample is only included in a report request if the sample's Reportable is selected.

• Primary Specification Code

  The primary specification on the sample whose sample specification's Status is rolled into the sample's Composite QC Status. Display only.

• 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.

• Sampled On

  The date-time at which the sample was taken.

• Sampling Started On

  The date-time at which the sampling started. This must be on or before the Sampled On date-time.

• Received On

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

  When a sample's Received On date-time is updated, then Received By is set to the current user.

  When a sample's Received On date-time is cleared, then Received By is cleared also.

• Required On

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

• Completed On

  The date-time at which the sample was completed, upon which the sample's Workflow Status was set to Completed.

• First Reported On

  The date-time at which the sample was first included in the generation of a preliminary or final certificate report.

• Last Reported On

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

• Released On

  The date-time at which the sample was released, upon which the sample's Workflow Status was set to Released.

• Sequence

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

• Generate Label

  The default setting for a report request sample's Reportable check box when a report request is created for labels, which indicates whether the sample is included in the generated labels by default.

  Note : Unknown samples are always included in a labels report request, but a duplicate, replicate, blank, standard or spike QC sample is only included in a labels report request if the sample's Generate Label is selected.

• Generate Paperwork

  The default setting for a report request sample's Reportable check box when a report request is created for paperwork, which indicates whether the sample is included in the generated paperwork by default.

  Note: Unknown samples are always included in a paperwork report request, but a duplicate, replicate, blank, standard or spike QC sample is only included in a paperwork report request if the sample's Generate Label is selected.

• Include in Job QC

  No functional use in core CCLAS.

• Invoiceable

  The default setting for a job invoice sample's Invoiceable check box when a job invoice is created, which indicates whether the sample is included in invoice line items by default.

• Include in costs

  Indicates whether the sample is included in job cost line items.

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

• Agreed On

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

  A sample's Agreed Date defaults to the sample's Required On date-time. A sample's Agreed Date can be updated manually.

• Analysed On

  The date-time at which the sample was analysed, upon which the sample's Workflow Status was set to Analysed.

• Finalised On

  The date-time at which the sample was finalised.

• Last Activated On

  The date-time at which the sample was last activated, upon which the sample's Workflow Status was set to Not Started.

• Last Invoiced On

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

• 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.

  An update to Possible On is persisted where the date-time provided is valid, and later than the Received On date-time where one is defined, otherwise an error message displays upon submit.

• Workflow Status

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

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

• Composite QC Status

  The composite QC status of the sample indicating the status of the underlying analytical results. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

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

• Composite Specification Status

  The composite specification status of the sample indicating the status of the underlying analytical results against all sample specifications. Display only. This can be:

  • Not Tested

  • Not Reported

  • Pass

  • Failure.

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

• Auto-validate

  No functional use in core CCLAS. Represents whether jobs are auto validated, however, the AUTO_VALIDATE_SAMPLES and AUTO_VALIDATE_LAB_BATCH_SAMPLES application preferences control this.

• Number of Schemes in Sample

  The number of schemes registered for the sample.

• #Sch STA

  The number of sample schemes associated with the sample where the sample scheme's Workflow Status is Started.

• #Sch CPL

  The number of sample schemes associated with the sample where the sample scheme's Workflow Status is Listed Not Received, Insufficient Sample or Completed.

• Sample Type Code

  The code of the sample type associated with the sample.

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

• Job Code

  The code of the job linked to the sample.

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

• Start from New Rack

  Indicates whether to start a new rack when placing the samples for this new sample group (so only applicable to interim samples), or whether to fill up the last rack if it still has slots available. If the job has a Workflow Status of Started, then the only option is to start a new rack.

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

• Archive Status

  The archive status of the sample indicating the location in which the sample is stored. Display only. This can be:

  • Online-The sample is located in the Live Production Environment.

  • Archived-The sample is located in the Archive Repository.

  • Offline-The sample is located in the Offline Storage.

Tests Tab

The composite schemes and analytes registered on the samples in the job. Some job scheme and job scheme analyte fields are visible on the grid, some of which may be directly updated there; other properties are only visible or updatable by opening the job scheme or job scheme analyte. The job scheme's workflow status can be reset here, or analytes can be re-sequenced within a job scheme. Missing analytes can be added to QC samples to ensure that, when the analytes are added to a sample scheme, they are added to any related QC samples also.

• Tab flows

  • Append QC—Append QC samples to the job for those job schemes where the job scheme's Include in Job QC is selected.

  • Overwrite QC—Overwrite existing QC samples for the job, for each related job scheme where the job scheme's Include in Job QC is selected.

• Row flows

  • Open Sample Grid—Launch the CCSGRD—Update Sample Gridding screen for the selected job.

  • Update Lab-batched Sample Analytes—Add missing analytes to laboratory batch samples, if for some reason analytes were added to the related production samples and they are now required in the laboratory batch.

• Grid flows

  • Set Scheme Workflow Status—Update the workflow status of one or more job schemes, where the job scheme has no associated job scheme analytes.

  • Remove Scheme— This will remove the selected schemes from all the samples in the job if it satisfies defined conditions.

  • Update QC Sample Analytes—Add missing analytes to QC samples, if for some reason analytes were added irregularly, that is, to one sample scheme but not to other linked or sequel sample schemes.

• Scheme row—Scheme Code

  The code of the scheme on the job. Display only. Expand the job scheme to display its job scheme analytes.

• Scheme row—Name

  The name of the scheme.

• Scheme row—Version Number

  The version number of the scheme on the job.

• Scheme row—Subcontract Laboratory Code

  The code of the laboratory subcontracted to prepare/analyse the sample schemes. A subcontract laboratory may be selected from the drop-down list that contains active laboratories that are members of the laboratory group defined by the SUBCONTRACT_LABS application preference, excluding the current laboratory. Click the field hyperlink to display the CCLBRT—Search Laboratory screen, select the appropriate value and click Select and Return to populate the field with the selected value. Note, however, that the selected value is validated against the laboratories contained in the drop-down list on submit. Defaults to the scheme version's Default Sub Contract Lab Code, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

  When the subcontract laboratory code is changed on the job scheme, then the change is pushed down to all related sample schemes in the current job, for the same scheme.

  When a sample scheme is created, then the subcontract laboratory code is inherited from the related scheme version, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample, that is, it is NOT inherited from the related job scheme.

• Scheme row—Subcontract Laboratory's Org Code

  The code of the organisation associated with the Subcontract Laboratory Code.

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

• Scheme row—Auto-validate

  No functional use in core CCLAS. Represents a default for the same flag for scheme version analytes. The flag on the scheme version analyte is used by the cascade engine.

• Scheme row—Include in Job QC

  Indicates whether the job scheme is included in an update or overwrite QC process. Defaults to the inverse of the scheme version's Batch Across Jobs flag, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample. Note that a sample scheme's Include in Job QC check box always defaults to checked.

  For a sample to be included in an update QC process on a job scheme, the job scheme's Included in Job QC must be selected and the sample scheme's Include in Job QC must be selected. Note that a sample scheme's Include in Job QC check box is cleared by the system once the sample scheme is included in a update QC process.

  For a sample to be included in an overwrite QC process on a job scheme, the job scheme's Included in Job QC must be selected and the job's Workflow Status must be Registered or Not Started. In this process, existing QC samples are deleted, and the sample scheme's Include in Job QC check boxes are all re-checked, then the same process as update QC runs.

• Scheme row—Report Description

  The reportable description of the job scheme. Defaults to the scheme version's Report Description, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Scheme row—Report Name

  The reportable name of the job scheme. Defaults to the scheme version's Report Name, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Scheme row—Price Code

  The price code that links a costed or priced scheme to a price schedule, where the scheme's Price Type is Scheme-Based, Sample-Based or Unit-Based. That is, they are the master codes for invoiced or costed entities. A price code may be selected from the drop-down list that contains active price codes in scope with a Price Type of Scheme-Based, Sample-Based or Unit-Based, as configured in the CCPRCCODE—Price Code application. Click the field hyperlink to display the CCPRCCODE—Search Price Code screen, select the appropriate value and click Select and Return to populate the field with the selected value. Defaults to the scheme's Price Code, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Scheme row—Fixed Base Price

  The optional fixed base price for the job scheme, thereby overriding any price determined from a price book when invoiced. Only applicable where the scheme's Price Type is Scheme-Based, Sample-Based or Unit-Based. Entered as a real number that can be a portion of the currency, for example, $10.636.

  If a fixed price is added to any job scheme or job scheme analyte, then each related sample scheme's Package Price Code and sample scheme analyte's Package Price Code is cleared.

• Scheme row—Fixed Block Price

  The optional fixed block price for the job scheme, thereby overriding any price determined from a price book when invoiced. Only applicable where the scheme's Price Type is Scheme-Based, Sample-Based or Unit-Based. Entered as a real number that can be a portion of the currency, for example, $10.636.

  If a fixed price is added to any job scheme or job scheme analyte, then each related sample scheme's Package Price Code and sample scheme analyte's Package Price Code is cleared.

• Scheme row—Number of units

  The number of units for the job scheme, used to determine the job scheme pricing, for example, number of hours a particular task took, or number of kilometres travelled. Only applicable where the scheme's Price Type is Unit-Based.

• Scheme row—Workflow Status

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

  • Not Started

  • Started

  • Analysed

  • Released

  • Completed.

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

• Scheme row—Composite QC Status

  The composite QC status of the job scheme indicating the status of the underlying analytical results.

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

• Scheme row—Composite Specification Status

  The composite specification status of the job scheme indicating the status of the underlying analytical results against all sample specifications.

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

• Analyte row—Scheme Code

  The code of the scheme on the job. Display only.

• Analyte row—Analyte Code

  The code of the analyte on the job scheme. Display only.

• Analyte row—Name

  The name of the analyte.

• Analyte row—Report Description

  The reportable description of the job scheme analyte. Defaults to the scheme version analyte's Report Description, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Analyte row—Report Name

  The reportable name of the job scheme analyte. Defaults to the scheme version analyte's Report Name, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Analyte row—Price Code

• The price code that links a costed or priced analyte to a price schedule, where the scheme's Price Type is Analyte-Based. That is, they are the mater codes for invoiced or costed entities. A price code may be selected from the drop-down list that contains active price codes in scope with a Price Type of Analyte-Based, as configured in the CCPRCCODE—Price Code application. Click the field hyperlink to display the CCPRCCODE—Search Price Code screen, select the appropriate value and click Select and Return to populate the field with with the selected value. Defaults to the scheme version analyte's Price Code, from the enabled-scope scheme when an org-scope scheme is registered on a lab-scope sample.

• Analyte row—Fixed Base Price

  The optional fixed base price for the job scheme analyte, thereby overriding any price determined from a price book when invoiced. Only applicable where the scheme's Price Type is Analyte-Based. Entered as a real number that can be a portion of the currency, for example, $10.636.

  If a fixed price is added to any job scheme or job scheme analyte, then each related sample scheme's Package Price Code and sample scheme analyte's Package Price Code is cleared.

• Analyte row—Fixed Block Price

  The optional fixed block price for the job scheme analyte, thereby overriding any price determined from a price book when invoiced. Only applicable when the scheme's Price Type is Analyte-Based. Entered as a real number that can be a portion of the currency, for example, $10.636.

  If a fixed price is added to any job scheme or job scheme analyte, then each related sample scheme's Package Price Code and sample scheme analyte's Package Price Code is cleared.

• Analyte row—Workflow Status

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

  • Not Started

  • Started

  • Analysed

  • Released

  • Completed.

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

• Analyte row—Composite QC Status

  The composite QC status of the job scheme analyte indicating the status of the underlying analytical results. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

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

• Analyte row—Composite Specification Status

  The composite specification status of the job scheme analyte indicating the status of the underlying analytical results against all sample specifications. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

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

Job Tracking Tab

The job-level sample tracking details, only displayed if the JOB_LEVEL_TRACKING application preference is defined and selected and if the job has a Job Type of Production or Internal.

• Location Code

  The code of the location of the containerised job. Defaults to the location referenced in the SAM_TRACK_REG_LOCATION application preference. A location may be selected from the drop-down list that contains active locations in scope, as configured in the CCLCTN—Location application. Each location's hierarchy precedes its location code. Click the field hyperlink to display the CCLCTN—Search Location screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Checked In On

  The date-time at which the containerised job was checked into the location.

• Checked In By

  The code of the user who checked the containerised job into the location.

• Multi Capacity Container Type Code

  The code of the container type that has a Capacity Type of Multiple, used to hold the containerised job. Defaults to the multiple capacity container type referenced in the SAM_TRACK_REG_MULTI_CONTAINER_TYPE application preference. A container type may be selected from the drop-down list that contains active container types in scope with a Capacity Type of Multiple, as configured in the CCCNTP—Container Type application. Click the field hyperlink to display the CCCNTP—Search Container Type screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Multi Capacity Container Type Code

  The name of the multi-capacity container type.

• Sample Handling Code

  The code of the sample handling associated with the containerised job. Defaults to the Location Default Sample Handling Code associated with the Location Code. A sample handling action may be selected from the drop-down list that contains active sample handling actions in scope, as configured in the CCSHND—Sample Handling application. Click the field hyperlink to display the CCSHND—Search Sample Handling screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Started On

  The date-time at which the sample handling on the containerised job started.

• Started By

  The code of the user who started the sample handling on the containerised job.

• Due On

  The date-time at which the sample handling on the containerised job is due for completion. Calculated as Started On + Sample Handling Code > Sample Handling Duration.

Status Tab

The current status of the job.

• 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: A job does not actually have a Workflow Status of Validated. Job validation is indicated by the Validated Date being stamped.

• Composite QC Status

  The composite QC status of the job indicating the status of the underlying analytical results. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

• Composite Specification Status

  The composite specification status of the job indicating the status of the underlying analytical results against all sample specifications. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

• Registered On

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

• Registered By

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

• Owner Changed On

  The date-time at which the owner of the job was changed. Display only.

• Owned By

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

• Last Activated On

  The date-time at which the job was last activated, upon which the job's Workflow Status was set to Not Started. Display only.

• Activated By

  The code of the user who last activated the job. Display only.

• # Samples in Job

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

• # Unknowns in Job

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

• Started On

  The date-time at which the job was started, upon which the job's Workflow Status was set to Started. Display only.

• Analysed On

  The date-time at which the job was analysed, upon which the job's Workflow Status was set to Analysed. Display only.

• Released On

  The date-time at which the job was released, upon which the job's Workflow Status was set to Released. Display only.

• Validated On

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

• Validated By

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

• Authorised On

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

• Authorised By

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

• First Reported On

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

• Last Reported On

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

• Last Report

  The link to the last certificate report created for the job. Display only.

• Finalised On

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

• Finalised By

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

• Last Archived On

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

• Archived By

  The code of the user who last archived the job. Display only.

• First Invoiced On

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

• First Invoiced By

  The code of the user who first invoiced the job. Display only.

• Final Invoiced On

  The date-time at which the final invoice was generated for the job. Display only.

• Final Invoiced By

  The code of the user who generated the final invoice for the job. Display only.

• Cancelled On

  The date-time at which the job was cancelled, upon which the job's Workflow Status was set to Cancelled. Display only.

• Cancelled By

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

• Cancelled/Reinstated Reason

  The reason for cancelling or reinstating the job. Display only.

Paperwork and Labels Tab

The list of paperwork and labels to be created for the job. All paperwork is associated with a report request where the Report Type is Paperwork. All labels are associated with a report request where the Report Type is Labels.

• Tab flows

  • Generate—Generates paperwork and labels using the defined report template.

  • Edit Paperwork—Edit the paperwork report request, if it exists.

  • Edit Labels—Edit the labels report request, if it exists.

• Reportable

  Indicates whether the job can be used to create a paperwork or labels report request.

• Report Template Code

  The code of the report template used to generate the paperwork or labels. Defaults to the job paperwork and labels' Report Request Code. A report template may be selected from the drop-down list that contains active report templates in scope with a Type of Paperwork or Labels, as configured in the CCTPLR—Report Template application. 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.

• Report Template Name

  the name of the report template. Display only.

• Output Format

  The output format of the selected report template.

• Name

  The name of the paperwork or labels report.

• Description

  The description of the paperwork or labels report.

• File Name

  The name of the generated paperwork or labels file. Defaults to the Report Template Name. Either File Name 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 name, then there can be issues downloading the file that you think you have created. Refer to Maintaining Generated Reports to check this.

  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.

• File Name Syntax Code

  The code of the syntax used to generate the paperwork or labels file's File Name. Either File Name 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 to check this.

  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 code of the language for the paperwork or labels report. Defaults to the job paperwork and label's Language, which, in turn, defaults to the report template's Language if it is defined, otherwise to the language defined by the DEFAULT_REPORT_LANGUAGE application preference, in this order. A language/locale may be selected from the drop-down list that contains active system languages.

• Already Exists

• Indicates whether the paperwork and labels are already generated for the job. Only relevant for a draft job. If a paperwork and labels already exist, then the paperwork and labels is displayed read-only.

Schedule Tab

The details of when system scheduled tasks are to be created, which creates a job on the system batch queue to generate production samples from stream samples in the schedule job. Only applicable for jobs that have a Job Type of Schedule.

• Required For

  The flag to indicate the job's purpose, that is, it is used to create a job with a Job Type of Production or Internal.

• Production Job Name Syntax Code

  The code of the syntax used to generate the destination job's Job Name. A syntax may be selected from the drop-down list that contains active syntaxes in scope with a Syntax Type of Job Name, 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.

• Production Description Name Syntax Code

  The code of the syntax used to generate the destination job's Description. A syntax may be selected from the drop-down list that contains active syntaxes in scope with a Syntax Type of Job Description, 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.

• Is Active For Manual Registration

  Indicates whether a user can create a draft job interactively from the schedule job, so that the scheduled registration can be modified prior to enacting the draft job to create stream samples in a production job. Default is false.

• Is Active For Auto Registration

  Indicates whether a batch queue task can be executed for the schedule job, to create stream samples in a production job. Default is false.

• Job Name Offset

  The offset used by the syntax referenced in Production Job Name Syntax Code to derive the production job's Name from the scheduled time. This can be a positive or negative value (for example, 1D, -1H). 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).

  Invalid offsets raise an error: Invalid Job Name Offset format [XXXX]. Job name offset needs to be one of the following S,N,H,D,W,M,Y preceded by a numeric value between -999 and 999.

• Expires On

  The date-time at which the schedule expires, after which a batch queue task cannot be executed to create a production job from the schedule job.

• Schedule Status

  The status of the scheduled job on the system scheduler. Display only. This can be:

  • Unscheduled (default)

  • Scheduled

  • Terminated.

• Last Execution

  The date-time at which a batch queue task was last executed to create a production job from the schedule job.

• Scheduled Times

  the times in the day at which a batch queue task can be executed to create a production job from the schedule job. Default is blank. A valid schedule comprises the Scheduled Months and Scheduled Times, and either the Scheduled Weeks and Scheduled Days, or the Scheduled Days of Month.

• Scheduled Days

  The days of the week (All, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) at which a batch queue task can be executed to create a production job from the schedule job. Default is blank. A valid schedule comprises the Scheduled Months and Scheduled Times, and either the Scheduled Weeks and Scheduled Days, or the Scheduled Days of Month.

• Scheduled Days of Month

  The days of the month (First Day of Month, Last Day of Month, First Day of Year, Last Day of Year) at which a batch queue task can be executed to create a production job from the schedule job. Default is blank. A valid schedule comprises the Scheduled Months and Scheduled Times, and either the Scheduled Weeks and Scheduled Days, or the Scheduled Days of Month.

• Scheduled Months

  The months of the year (January through December) at which a batch queue task can be executed to create a production job from the schedule job. Default is blank. A valid schedule comprises the Scheduled Months and Scheduled Times, and either the Scheduled Weeks and Scheduled Days, or the Scheduled Days of Month.

• Scheduled Weeks

  The weeks of the month (All, FIrst, Second, Third, Fourth, Last) at which a batch queue task can be executed to create a production job from the schedule job. Default is blank. A valid schedule comprises the Scheduled Months and Scheduled Times, and either the Scheduled Weeks and Scheduled Days, or the Scheduled Days of Month.

Future Events Tab

The details of future events for the registration schedule.

• Tab flows

  • Preview—Display the next ten future events for the scheduled registration.

• Preview Until

  The date-time up to which to view scheduled future events for a schedule job.

• Future Events Grid

  The times in the future at which a task is scheduled by the system scheduler for execution on the system batch queue, to generate production samples from the stream samples in the schedule job.

  • Is Active

    Indicates whether the scheduled registration is to proceed when the Future Event Date of execution eventuates.

  • Future Event Date

    The date-time at which the scheduled registration is to take place.

History Tab

Historical runs of the scheduled job. 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.

• 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 starting time of the system batch job.

• End Time

  The ending time of the system batch job.

• Exit Message

  The message passed out from the job batch queue execution.

• Queue Time

  The time between the create time and start time of the job on the batch queue.

• Create Time

  The creation time of the system batch job.

• 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.