Skip to content

Create Data Collection#

🔒 DataCollection.Create

Overview#

This operation is used to create a Data Collection.

Setup#

No specific setup is required other than to meet the preconditions of the transaction.

Preconditions#

  • The Data Collection does not currently exist in the system.

Sequence of Steps#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

  • Entity - in the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information, see Creating Entity Objects.
  • Revision - if you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
  • Version - if you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Step 1: Change Set#

  1. Choose an existing Change Set or select Create to create a new Change Set. If configured to support implicit Change Sets, it is also possible to check the Use Automatic Change Set option.
  2. Optionally, select an Approval Role.
  3. Optionally, set the Make Change Set Items Effective on Approval to true so that the Change Set items become effective when the Change Set is approved.

Info

For more information, see Create Change Set.

Step 2: General Data#

  1. Provide a name for the Data Collection.
  2. If you are creating a new Version, the Revision that was selected when you started the process will be the Revision to which this Version will be associated. If you are creating a new Entity or Revision (with a new Version associated to it), provide a name for the Revision or it will be automatically generated for you. For more information, see Revision Naming.
  3. Optionally, provide a description of the Data Collection.
  4. Select the Data Collection type. The list of possible values is taken from the DataCollectionType lookup table.

  5. Select the scope of the Data Collection:

    • General
    • Inspection

  6. Select the mode through which data will be sent to Statistical Process Control (SPC):

    • On Close Per Sample: each sample will be sent individually to SPC as its own data point, but only when the Data Collection is closed.
    • On Close Per Parameter: all samples of the same parameter will be sent together to SPC as one data point, when the Data Collection is closed.
    • On Post Per Sample: every time a new sample is posted, it is posted to SPC as a data point.

  7. Choose the user interface you want to use when performing the Data Collection:

    • Classic - separate fields to input different values
    • Modern - grid-based editing

    Info

    For more information, see the User Interfaces section.

  8. Select Next to edit the Parameters.

Screenshot showing a form for creating new data with fields including "Caeate New Data Colleton" and "amatoNm".

User Interfaces: Classic vs Modern#

The Modern user interface brings grid-based editing similar to several popular spreadsheet software, along with keyboard shortcuts to allow easier data entry. You can also decide to only show mandatory Parameters for entry.

You can get a glimpse of the changes in the two images below, using the exact same Data Collection with the different user interfaces:

classic

modern|

Step 3: Parameters#

There are differences in the Parameter selection depending on the Data Collection scope. Review the instructions according to the desired scope.

General Data Collection#

  1. On the left side panel, add as many Source Parameters as desired (select in the top right of the grid to add, and to remove), and specify the following for each Data Collection Parameter:

    • The name of the parameter.
    • Whether the parameter is optional in the Data Collection.
    • If object-level security is enabled, it is possible to set a data group for a particular parameter within the Data Collection.
    • Optionally, the name of the parameter group to which the parameter belongs. All parameters from a parameter group are displayed in a table form, and share the same sample ID. All parameters within the same parameter group must have the same:
      • SampleCountPercentage
      • SampleCountPercentageSource
      • MinimumSamples
      • MaximumSamples
      • SampleKeySource
      • SampleKeyType
    • The capture behavior for the Instruments to record the Parameter values:
      • None
      • Always (Instrument Type must be defined, using values from the InstrumentType Lookup Table)
    • The sample type, used for the sample names, which can be:
      • Free text.
      • List - in this case the sample names must be entered in the Sample List.
      • Material ID (the sample names must refer to valid material names in the hierarchy of the Material for which the data is being collected).
      • Sample Size (for integration with SPC attribute Charts).

    • If Material ID is selected as the Sample Type, the Sample ID Material Property must be selected from these three possible values:

      • Container And Position - the sample id/name will be given by the name of the container, together with the position where the Material is.
      • Container Position - the sample id/name is given by the position within the container where the Material is. To ensure that the sample id/name is always unique, this option does not allow duplicated positions. That is, to use this option, Materials cannot be in the same position, even if they are in different containers, because the position where the Material is within the container will be used to identify the sample.
      • Name (Default) - the name of the material.

      Note

      When using Material ID as Sample Type, it is mandatory to configure the system to allow the visibility of sub-material IDs. To do this, navigate to Administration > Configuration. Locate the PreSelectSampleID property, select Edit, and set the Value flag to true. This ensures that sub-materials are displayed and can be selected during sample collection. For more information, see Configuration Entries.

    • The sample source, depending on the sample type:

      • None for sample type Free text, Sample Size or List.
      • Optionally, a Material Form for sample type Material Id (if no Material Form is specified, any Material Form will be accepted).
      • A Lookup Table Name for sample type Lookup Table.
    • Whether the sample count is a percentage (referring to the material quantity or number of sub-materials). If the sample count is a percentage, it is also necessary to specify:
      • Percentage value
      • Percentage source, which can be:
        • Primary Quantity
        • Secondary Quantity
        • Materials Count. If Materials Count is specified, the percentage value will be applied to the count of all Materials and Sub-materials of the specified form (if a form is specified) or simply to all Materials and Sub-Materials (if no form is specified).
    • The minimum and maximum number of samples (not applicable if the sample count is a percentage).
    • Regarding the sample readings, it is necessary to specify whether the reading names come from a list or not (if yes, the reading names must be entered in the Reading List).

    • Optionally, a default value for the parameter. The default values are only applied to mandatory readings of mandatory samples.

      Warning

      A default value can only be defined when calculation is set to None.

    • The minimum and maximum number of readings per sample.

    • If the reading names come from a list, it is necessary to enter the reading names in the Reading List.
    • Optionally, a calculation to be applied to the readings and samples:
      • Average
      • Expression
        • The expression must be properly formatted using JSONata ⧉ expressions (see below)
      • Maximum
      • Minimum
      • None (default)
      • Range (the difference between the maximum and the minimum)
      • Rule
      • Standard Deviation
      • Sum

    • The calculation Expression - only if the calculation is Expression, you must provide a well formed expression.

      Note

      Examples of well formed expressions:

      • Accessing a Material property and multiplying it: Material.PrimaryQuantity * 100
      • Accessing a Material attribute: Material.Attributes.RetailPrice
      • Accessing a Material custom property: Material.Attributes.MyCustomProperty01
      • Accessing a Material Characteristic: Material.MaterialCharacteristic.Characteristic01
      • Accessing a Resource property with navigation: Material.LastProcessedResource.Name
      • Accessing current data collection parameters: (specifying the sample and reading) Parameters.Thickness.Samples[0].Readings[0].Value * Parameters.EtchRate.Samples[0].Readings[0].Value
      • Average of all samples and readings of parameter Thickness: (using double wildcard) $average(Parameters.Thickness.**.Value); (specifying the JSONata structure) $average(Parameters.Thickness.Samples.Readings.Value)
      • Maximum of all readings for sample 1 of parameter Thickness: $max(Parameters.Thickness.Samples[0].*.Value)
      • Value of the first reading of first sample of parameter Thickness: Parameters.Thickness.Samples[0].Readings[0].Value
      • For grouping functions the system supports: Average, Maximum, Minimum, Range, Standard Deviation, and Sum:
        • Average - $average(Parameters.Thickness.Samples.Readings.Value)
        • Maximum - $max(Parameters.Thickness.Samples.Readings.Value)
        • Minimum - $min(Parameters.Thickness.Samples.Readings.Value)
        • Range - $range(Parameters.Thickness.Samples.Readings.Value)
        • Standard Deviation - $stddev(Parameters.Thickness.Samples.Readings.Value)
        • Sum - $sum(Parameters.Thickness.Samples.Readings.Value)
      • Referencing external data collections: DC(CP_DC01).Parameters.Samples[0].Parameters.Value

      For more information, see Calculated Parameters.

      ![Screenshot showing a data collection parameter with the value "Le Sép Marrererers a3] y Coane Vewnareract ~~ Parnes tor" in DC(CPDC01).Parameters.Samples[0].Parameters.Value.](images/dc_expression.png)

    • The calculation Rule - only if the calculation is Rule, in which case it must refer to a valid Rule object with the scope Electronic Data Collection (EDC).

    • The calculation grouping mode to which the calculation is applied:
      • None - only if the calculation is None or Rule.
      • Sample - only if calculation is different from None.
      • Parameter - only if calculation is different from None.
    • Limit checking mode, in case that limits are defined for the parameter:
      • Individual value (limits apply for individual readings).
      • Calculated value (limits apply to the calculated value).
    • Optionally, a warning and error protocol to be opened when a warning limit or error limit is violated. Note that if an error limit is exceeded, and an error protocol is defined, the error protocol will be opened, but the warning protocol will not.

    Info

    Protocols are only available if the Exception Management module is licensed.

    • The instruction set, at the bottom of the page, for the proper handling of the Parameter measurement, with a WYSIWYG text editor that allows custom text formatting and highlighting as well as the displaying of images that can be helpful for the process.

create_data_collection_step_two

Note

The vertical ellipsis on the top-right of the Instruction editor, Documentation section, provides a variety of documentation and attachment possibilities.

create_data_collection_instruction

Inspection Data Collection#

  1. On the left side panel, add as many Source Parameters as desired (press in the top right of the grid to add, and to remove), specifying for each Data Collection Parameter:

    • The name of the parameter.
    • Whether the parameter is a reference in the Data Collection.
    • Optionally, the name of the parameter group to which the parameter belongs. All parameters from a parameter group are displayed in a table form, sharing the same sample ID. All parameters within the same parameter group must have Sample Value Type equal to Variable or Result.
    • The capture behavior for the Instruments to record the Parameter values:
      • None
      • Always (Instrument Type must be defined, using values from the InstrumentType Lookup Table)
      • On Change (Instrument Type must be defined, using values from the InstrumentType Lookup Table)
    • The Frequency for the Inspection:
      • Any
      • AQL
      • Centering
      • CounterBased
      • First
      • FirstAndLast
      • Fixed
      • Last
      • Percentage
    • The configuration mode for the inspection, which specifies if the information is set:
      • Manual - as part of the Data Collection
      • Dynamic - from the Step Inspection Severity Instance (option only available for Inspection Frequency values: AQL, Fixed, Percentage or CounterBased)

    • The value for Maximum Acceptable Defects mode:

      • AutomaticFixed
      • Fixed - must specify the value for Maximum Acceptable Defects.
      • None

      Info

      If the Sample Value Type is different from Variable or Result, the Inspection Frequency can only be Fixed, Percentage or AQL.

    • The sample type, used for the sample names, which can be:

      • Attribute
      • Defect Count
      • Result
      • Variable - define Sample Key Type:
        • Material ID
        • Sample Number
    • If the Inspection Frequency is Fixed and Inspection Frequency Configuration Mode is Manual, a value for the Sample Size must be defined (larger than zero). In addition, regardless of the Configuration Mode, a Sample Count Source must be defined from the following options:
      • Primary Quantity
      • Secondary Quantity
      • Materials Count
    • If the Inspection Frequency is Percentage and the Inspection Frequency Configuration Mode is Manual, the Percentage Value must be defined (between 0 and 100), with the value being expressed and displayed as a percentage. In addition, regardless of the Configuration Mode, a Sample Count Source must be defined from the following options:
      • Primary Quantity
      • Secondary Quantity
      • Materials Count
    • If the Inspection Frequency is Counter Based and the Inspection Frequency Configuration Mode is Manual, a value for Counter Frequency must be defined (larger than one). Also, if needed, you can define whether two extra options:
      • Use First Piece Measurement Strategy
      • Measure Last Piece
      • In addition, regardless of the Configuration Mode the actor must specify a Sample Count Source:
      • Primary Quantity
      • Secondary Quantity
      • Materials Count
    • If the Inspection Frequency is AQL and Inspection Frequency Configuration Mode is Manual, the following values must be defined:
      • AQL Inspection Level
      • AQL Severity Mode
      • Manual (AQL Severity must be must be defined, using values from the AQL Severity Lookup Table)
      • Automatic
      • AQL Acceptance Limit (using values retrieved from the AQL Acceptance Limit Lookup Table).
      • In addition, regardless of the Inspection Frequency Configuration Mode, the Sample Count Source must also be defined:
      • PrimaryQuantity
      • SecondaryQuantity
      • MaterialsCount
    • If the Sample Value Type is Attribute and the Inspection Frequency is Percentage or Fixed, you can decide to test all the pieces on fail.
    • If the Sample Value Type is Variable or Result and the Sample Key Type is PieceNumber, user can decide to test all pieces since the last pass result.
    • The instruction set for the proper handling of the Parameter measurement, with a WYSIWYG text editor that allows custom text formatting and highlighting while display images that can be helpful for the process.

    create_data_collection_step_two_inspection

    Info

    You can copy the Parameters from another Data Collection with the same scope by using the Options button on the top, selecting the Data Collection followed by the Copy Parameters button. The valid Parameters will be copied and inserted into the table.

    Copy Data Collection Parameters

    Warning

    After the creation of a version, the version will be in the state Created. To make it Active, the associated Change Set must be approved. To make it effective, the version must be Set Effective.

  2. Select Create to complete the transaction.