Screen flows

• Submit—Validate and save the changes.
• Refresh—Reload the original data. Any changes made since the last submit are lost.

Primary Criteria Tab

The primary criteria for sample scheme/analyte search.

• Job Names

  Search by one or more names of a job associated with a sample. Wildcards can be used when entering a job name. Click the field hyperlink to display the CCREGN—Search Job screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Client Names

  Search by one or more names of a client associated with a sample. Wildcards can be used when entering a client name. 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.

• Not Activated

  Indicates whether to include samples that are not activated when searching for samples:

  • Unchecked—Operates on the sample's Last Activated Date being null, which correlates with a Workflow Status of Registered.

  • Checked—Operates on the sample's Last Activated Date being stamped.

  Note on the selection of inactive samples:
  Laboratory batch job creation proceeds only where all of the samples selected for inclusion in the laboratory batch job are activated, however, a subcontract batch job creation is different, in that, it can proceed where inactive samples are selected. Other possible uses of searching for inactive samples is report generation (laboratory report or labels), the assignment or re-assignment of instruments, and re-activation (an extension of searching for inactivated samples is to add a personalised flow to the form that launches the Sample.Activate service to operate on selected samples).

• Project Code

  The code of the project to match when searching for samples. Wildcards can be used when entering a project name.

• Date Search Scope

  The scope on which the date filter is applied, for the field specified by Date Search Field, on the date range specified by Date Search Range:

  • Sample—Date criteria is applied at sample level.

  • Job—Date criteria is applied at job level.

• Date Search Field

  The field on which the date filter is applied, for the scope specified by Date Search Scope, across the date range specified by Date Search Range:

  • Registered

  • Samples

  • Received

  • Required

  • Analysed

  • Received.

• Date Search Range

  The date range on which the date filter is applied, for the scope specified by Date Search Scope, for the field specified by Date Search Field:

  • Between

  • Any

  • Null

  • Delta.

  Select start and end dates from the calendars, and a date range option. If Between is selected, then the end date is optional, and if not specified, then searches up to the current system date-time.

  If the Sample Sort Order criteria on the Sample Criteria tab is selected as Expiry Date ASC, or the CCBTCH_DATE_SEARCH_MANDATORY application preference is checked, then a date search range must be entered (as a Between or Delta date range only), where the date range cannot exceed the number of days specified by the CCBTCH_DATE_SEARCH_INTERVAL_DAYS application preference.

• Analyte Types

  Search by one or more primary analytical types of a sample:

  • All

  • Unknown

  • Duplicate

  • Replicate

  • Standard

  • Blank

  • Spike.

  This field provides multiple entry support. Select one of the options from the drop down list and click the icon to display all the selected options. Where no analytical types are selected, then all analytical types are included in the search.

Scheme Criteria Tab

The analysis criteria for sample scheme/analyte search.

• Section Code

  The code of the section to match when searching for samples of schemes. The match is made through a scheme's section. Wildcards can be used when entering a section code. A section may be selected from the drop-down list that contains active sections in scope, as configured in the CCSECT—Section application. Click the field hyperlink to display the CCSECT—Search Section screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  Note: A Section Group Code and a Section Code criteria cannot be both entered.

• Scheme Code

  The code of the scheme to match when searching for samples for batching. Wildcards can be used when entering a scheme code.

  If the Group Schemes By Instrument criteria is checked on the Sample Criteria tab, then at least one scheme code must be entered, otherwise an error is returned upon submit to search.

  A miscellaneous scheme may be selected from the drop-down list that contains active schemes in scope with a Scheme Type of Analytical Preparation and Analytical, as configured in the CCSCHM—Scheme application. Click the field hyperlink to display the CCSCHM—Search Scheme screen, select the appropriate value and click Select and Return to populate the field with the selected value. An org-scope scheme must be enabled by a laboratory, such that, that enabled-scope scheme is available for use.

  Note: The Section Group Code and the Section Code criteria cannot be both entered.

• Section Group Code

  The code of the section group to match when searching for samples (sample schemes) for batching. The match is made through a scheme's section. Where the Section Group Code Inclusion or Exclusion is selected as:

  • Include—Returns sample schemes whose scheme's section is contained within the specified section group.

  • Exclude—Returns sample schemes whose scheme is not linked to a section, or whose scheme's section is not contained within the specified section group.

  A section group may be selected from the drop-down list that contains active section groups in scope, as configured in the CCSEGP—Section Group application. Click the field hyperlink to display the CCSECP—Search Section Group screen, select the appropriate value and click Select and Return to populate the field with the selected value. Scope rules apply. % wildcards are not supported.

• Section Group Code Inclusion or Exclusion

  Indicates whether to place context on the Section Group Code criteria when searching for samples.

• Subcontract Laboratory Code

  The code of the subcontract laboratory from the current organisation to match when searching for samples, excluding the current laboratory. Wildcards can be used when entering a laboratory code. 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.

• Display Analytes

  Indicates whether to apply the search at sample scheme or sample scheme analyte level when matching on workflow statuses:

  • Unchecked—The search is applied at sample scheme level. Sample counts in the grid are by scheme.

  • Checked—The search is performed at sample scheme analyte level. Sample counts in the grid are by scheme analyte.

Sample Scheme Analyte Criteria Tab

The status criteria for sample scheme/analyte search.

• Workflow Status

  The sample scheme analyte Workflow Status to match when searching for samples for batching:

  • Not Started

  • Repeat

  • Analysed

  • Released

  • Check

  • Completed

  • Insufficient Sample

  • Not Analysed

  • No Result,

  or a combination of these. This field provides multiple entry support, with each item applied as an 'or' filter. Select one of the options from the drop down list, and click the icon to display all the selected options. If left empty, then the match is made where the sample scheme analyte's Workflow Status is Not Started. Refer to Appendix—Job Life-cycle and the Status Cascade Engine.

• User Workflow Status

  Search for samples for batching by one or more user workflow statuses associated with a sample scheme analyte. Wildcards can be used when entering a user workflow status. A user workflow status may be selected from the drop-down list that contains items from the table type CC30—User Statuses, as configured in the MSETBL—Table Code Service application. This field provides multiple entry support, with each item applied as an 'or' filter. Select one of the options from the drop down list, and click the icon to display all the selected options.

• Lab Batch Status

  Include samples based upon whether they are or are not currently included in a batch, when searching for samples for batching. This can be:

  • Not Lab Batched—Only includes samples if they are not currently included in a batch, that is, if at least one related sample scheme analyte, in the set of selected schemes or analytes for batching, is not associated with a laboratory batch job.

  • Lab Batched—Only includes samples if they are currently included in a batch, that is, if at least one related sample scheme analyte, in the set of selected schemes or analytes for batching, is associated with a laboratory batch job.

  • All—Includes samples regardless of whether they are currently included in a batch or not.

• Precursor Status

  If a precursor sample scheme is registered for a sample scheme, include samples based upon the precursor sample scheme's Workflow Status or precursor sample scheme's Ready Date:

  • <empty>—Includes all samples that have no precursor sample scheme, and all samples that have a precursor sample scheme regardless of the precursor sample scheme's Workflow Status or Ready Date.

  • Started—Include all samples that have no precursor sample schemes, and only include samples that have a precursor sample scheme if the precursor sample scheme's Workflow Status is Started.

  • Completed—Include all samples that have no precursor sample schemes, and only include samples that have a precursor sample scheme if the precursor sample scheme's Workflow Status is Completed.

  • Ready—Include all samples that have no precursor sample schemes, and only include samples that have a precursor sample scheme if the precursor sample scheme's Ready Date is before the current system date-time.

  This field provides multiple entry support, with each item applied as an 'or' filter. Select one of the options from the drop down list, and click the icon to display all the selected options.

• Analyte Scope

  Scope applied to determine whether a sample scheme is available for batching, based upon the analytes:

  • Any—Any analyte needs to match.

  • All—All analytes need to match.

• Scheme Scope

  Scope applied to determine whether a sample is available for batching, based upon the schemes:

  • All—All schemes need to match.

  • Any—Any scheme needs to match.

Sample Criteria Tab

The sample criteria for sample scheme/analyte search.

• Minimum Samples

  The minimum number of sample schemes when Display Analytes is cleared, or the minimum number of sample scheme analytes when Display Analytes is checked, for any samples to be returned from the search.

• Maximum Samples

  The maximum number of sample schemes when Display Analytes is cleared, or the maximum number of sample scheme analytes when Display Analytes is checked, to be returned from the search. The samples returned from the search load in to the sample grid without paging applied. Note that samples are returned based upon the Sample Sort Order.

• Sample Sort Order

  The order in which samples are returned from the search, and subsequently placed into the batch:

  • Job Name ASC—If one scheme is selected or analytes are selected from one scheme, then samples are ordered by Job Name and the sample scheme's Profile Sequence; if more than one scheme is selected or analytes are selected from across more than one scheme, then samples are sorted by Job Name and Sample Name.

  • Expiry Date ASC—If one scheme is selected or analytes are selected from one scheme, then samples are ordered by Expiry Date, Job Name and the sample scheme's Profile Sequence; if more than one scheme is selected or analytes are selected from across more than one scheme, then samples are sorted by Expiry Date, Job Name and Sample Name. Note that where this option is selected, then a Date Search Scope, Date Search Field and Date Search Range must be entered (as a Between or Delta date range only) on the Primary Criteria tab.

  • Received Date ASC—If one scheme is selected or analytes are selected from one scheme, then samples are ordered by Received Date, Job Name and the sample scheme's Profile Sequence; if more than one scheme is selected or analytes are selected from across more than one scheme then samples are sorted by Received Date, Job Name and Sample Name.

  • Required Date ASC—If one scheme is selected or analytes are selected from one scheme then, samples are ordered by Required Date, Job Name and the sample scheme's Profile Sequence; if more than one scheme is selected or analytes are selected from across more than one scheme then samples are sorted by Required Date, Job Name and Sample Name.

  • Job Priority ASC—Samples are sorted by the job's Priority, with any samples with no job priority being displayed at the top of the result set grid.

  • Sample Priority ASC—Samples are sorted by the sample's Priority, with any samples with no sample priority being displayed at the top of the result set grid.

• Instrument Group Code

  The code of the instrument group linked to the scheme associated with sample schemes, to match when searching for samples for batching. An instrument group may be selected from the drop-down list that contains active instrument groups in scope, as configured in the CCINGP—Instrument Group application. Click the field hyperlink to display the CCINGP—Search Instrument Group screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Group Schemes by Instrument

  Indicates whether to group schemes by instrument when they are returned from the search to the sample scheme grid. If checked, then at least one Scheme Code must be entered, otherwise an error is returned when searching for samples for selected schemes or scheme analytes.

Available Schemes/Analytes Grid

The list of sample schemes or sample scheme analytes, depending upon the Display Analytes mode, that are returned from a search based upon the specified criteria.

The following sample scheme or sample scheme analyte fields display on the grid, though some of them are hidden by default. All fields are display only.

• Grid flows

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

  • Search Samples—Click to search for samples based upon the entered criteria and display the output in the lower grid.

• Row Number

  The row number in the grid. Hidden by default, but can be added via showing individual grid items.

• Scheme

  The code of the scheme returned from a sample scheme count search for batching.

• Number of Samples

  The number of samples located for the scheme from a sample scheme count search based upon the selected criteria.

• Instrument Group Code

  The code of the instrument group associated with the scheme returned from a sample scheme count search for batching.

• Section Code

  The code of the section associated with the scheme returned from a sample scheme count search for batching.

• Version

  The version number associated with the scheme returned from a sample scheme count search for batching. Hidden by default, but can be added via showing individual grid items.

• Scheme Name

  The name of the scheme returned from a sample scheme count search for batching.

• Scheme Description

  The description of the scheme returned from a sample scheme count search for batching.

• Method Code

  The code of the method associated with the scheme returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Method Name

  The name of the method associated with the scheme returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Method Description

  The description of the method associated with the scheme returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Analyte Code

  The code of the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Analyte Name

• The name of the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Analyte Description

• The description of the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Unit Code

  The code of the unit associated with the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Unit Name

  The name of the unit associated with the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

• Unit Description

  The description of the unit associated with the analyte returned from a sample scheme count search for batching. Hidden by default for Display Analytes mode, but can be added via showing individual grid items.

Samples Grid

The list of samples that are returned from a search based upon the selected schemes or analytes.

The following sample scheme fields display on the grid, though some of them are hidden by default. All fields are display only.

• Grid flows

  • Export to Report—Report selected records from the search display grid. Available report templates are defined by the SEARCH_REPORT_<ApplicationName> application preference.

  • Create Batch—Use the selected samples in the lower grid to create a laboratory batch job. The CCBTCH—Create Batch Dialog Box displays, allowing you to select the batch job template, QC and paperwork options.

  • Create Subcontract Batch—Use the selected samples in the lower grid to create a subcontract batch job for the designated subcontractor. The CCBTCH—Create Subcontract Batch Dialog Box displays, allowing you to select the subcontract laboratory code, batch job template and paperwork options.

  • Assign Instrument Code—Assign an instrument to sample schemes selected in the lower grid. The Assign Instrument Code dialog box displays, allowing you to select the instrument.

  • Move—Move the selected samples in the lower grid to a specific row in the lower grid, so that samples are batched in the desired sequence.

  • Remove—Remove the selected samples from the lower grid, so that the remaining samples can be selected for inclusion in the batching process.

• Button flow

  • Stop Search—Stop further paginations of the Sample Grid.

    Note that this button does not stop the Search Samples Grid flow on the Available Schemes/Analytes Grid or the Retrieve All grid flow on the Samples Grid from continuing to populate the Samples Grid.

    An example of how it is used is, where Maximum Samples is not defined on the Sample Criteria tab and a sample search is actioned to return the first fifty records, followed by a pagination down the Sample Grid to return the next fifty records, when Stop Search is clicked, then further paginations to retrieve more records are not possible unless another Search Samples action is undertaken. Limiting the search result set this way allows the current results in the grid to be sorted, or to easily move to the top or bottom of the result set.

• Row Number

  The row number in the grid. Hidden by default, but can be added via showing individual grid items.

• Is Available For Batching

  Indicates whether sample scheme is available for batching, for the selected schemes or analytes.

  • Checked—Where the sample scheme or sample scheme analyte does not have a precursor sample scheme, or where the Precursor Status search criteria is selected as Started and the precursor sample scheme's Started Date is set, and/or the Precursor Status search criteria is selected as Completed and the precursor sample scheme's Completed Date is set, and/or the Precursor Status search criteria is selected as Ready and the precursor sample scheme's Ready Date is at or earlier than the current system date-time.

  • Unchecked—Where the sample scheme or sample scheme analyte has a precursor sample scheme, and the Precursor Status search criteria is selected as Started and the precursor sample scheme's Started Date is not set, and/or the Precursor Status search criteria is selected as Completed and the precursor sample scheme's Completed Date is not set, and/or the Precursor Status search criteria is selected as Ready and the precursor sample scheme's Ready Date is later than the current system date-time.

  When samples are selected to be batched, and the Create Batch or Create Subcontract Batch grid flow is selected (or the service is run), then the selected samples are only included in the batch if all samples have the Is Available for Batching check box checked, otherwise an error is raised: Samples XXX, XXX, XXX are not available for Batching. Batch is not created.

• Job Code

  The code of the job associated with the sample scheme. Hidden by default, but can be added via showing individual grid items.

• Job Name

  The name of the job associated with the sample scheme,

• Job Description

  The description of the job associated with the sample scheme. Hidden by default, but can be added via showing individual grid items.

• Job Priority

  The priority of the job associated with the sample scheme. Hidden by default, but can be added via showing individual grid items.

• Order Number

  The order number of the job associated with the sample scheme.

• Client Code

  The code of the client associated with the sample.

• Client Name

  The name of the client associated with the sample.

• Client Description

  The description of the client associated with the sample. Hidden by default, but can be added via showing individual grid items.

• Project Code

  The code of the project associated with the sample.

• Project Name

  The name of the project associated with the sample.

• Project Description

  The description of the project associated with the sample. Hidden by default, but can be added via showing individual grid items.

• Job Registered Date

• Job Received Date

• Job Required Date

• Job Possible Date

• Job Agreed Date

• Job Last Activated Date

• Job Started Date

• Job Analysed Date

• Job Workflow Status

• Sample Code

  The code of the sample. Hidden by default, but can be added via showing individual grid items.

• Sample Name

  The name of the sample.

• Sample Description

  The description of the sample. Hidden by default, but can be added via showing individual grid items.

• Client Sample Name

• Primary Analytical Type

  The primary analytical type of the sample:

  • Unknown

  • Duplicate

  • Replicate

  • Standard

  • Blank

  • Spike.

• Sample Priority

  The priority of the sample.

• Product Code

  The code of the product associated with the sample. Hidden by default, but can be added via showing individual grid items.

• Product Name

  Hidden by default, but can be added via showing individual grid items.

• Product Description

  Hidden by default, but can be added via showing individual grid items.

• Sample Registered Date

  Hidden by default, but can be added via showing individual grid items.

• Sampled Date

  Hidden by default, but can be added via showing individual grid items.

• Holding Time

  Earliest holding date-time for the sample scheme and its sample scheme analytes, for those analytes selected for batching. Hidden by default, but can be added via showing individual grid items.

• Warning Date

  Earliest warning date-time before sample expiry for the sample scheme and its sample scheme analytes, for those analytes selected for batching.

• Ready Date

  The date-time at which the sample scheme is ready for analysis to proceed, such that, any sequel sample scheme is available for batching. That is, a sequel sample scheme can only be batched where the precursor sample scheme's Ready Date is at or earlier than the current system date-time.

  If a scheme version's Waiting Time is defined, when a sample scheme's Workflow Status becomes Started, then the sample scheme's Ready Date is set to the sample scheme's Started Date + the scheme version's Waiting Time. Note that this calculation does NOT take into consideration holidays or a section's non-working time periods. If a scheme version's Waiting Time is not defined, then the sample scheme's Ready Date is left empty.

  When multiple schemes are selected, this is the latest date-time of all sample schemes' Ready Date.

• Precursor Warning Date

  Warning date-time before sample expiry for the precursor sample scheme, if one exists for the sample scheme.

• Expiry Date

  Earliest expiry date-time for the sample scheme and its sample scheme analytes, for those analytes selected for batching,

• Precursor Expiry Date

  Expiry date-time for the precursor sample scheme, if one exists for the sample scheme.

• Sample Received Date

• Sample Required Date

• Sample Possible Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Agreed Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Last Activated Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Started Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Analysed Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Released Date

  Hidden by default, but can be added via showing individual grid items.

• Sample Workflow Status

  Hidden by default, but can be added via showing individual grid items.

• Lab Batch Job Code

• Lab Batch Job Name

  Hidden by default, but can be added via showing individual grid items.

• Lab Batch Job Description.

  Hidden by default, but can be added via showing individual grid items.