Skip to content

Create Parameter#

🔒 Parameter.Create

🔒 Parameter.CreateTemplate

🔒 Parameter.CreateFromTemplate

Overview#

This operation is used to create a Parameter. A template can also be created using a similar procedure and there is also the possibility of using a template to create the new object as well. This selection can be done in the main entity menu.

Setup#

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

Preconditions#

  • The Parameter does not currently exist in the system.

Sequence of Steps#

Step 1: General Data#

  1. Provide a name for the Parameter.
  2. Optionally, provide a description of the Parameter.
  3. Select the Parameter type. The list of possible values is taken from the lookup table ParameterType.

Step 2: Information#

  1. Specify the display name - the display name if present will be displayed in the data collection screens.

  2. Select the scope of the Parameter:

Scope EDC SPC Recipe Management KPI Management
EDC_SPC x x
EDC_SPC_Recipe x x x
Recipe x
KPI x

Table: Parameter Scope possible values

  1. Select the data type of the Parameter (if scope is KPI, the data type must be numeric):

    • Boolean
    • DateTime
    • Decimal
    • Duration
    • Long
    • String
    • URL

  2. Specify the format of the Parameter - used for input and display purposes:

    • Numeric

      • 0 - Zero placeholder, replaces the zero with the corresponding digit if one is present; otherwise, zero appears in the result string (example: 1234.5678 ("00000") -> 01235)
      • # - Digit placeholder, replaces the "#" symbol with the corresponding digit if one is present; otherwise, no digit appears in the result string (example: 1234.5678 ("#####") -> 1235); no digit appears in the result string, if the corresponding digit in the input string is a non-significant 0 (example: 0003 ("####") -> 3)
      • . - Decimal point, determines the location of the decimal separator in the result string (example: 0.45678 ("0.00") -> 0.46)

      • e - Scientific notation, the number that follows e is the number of decimal places of the base of the result; the exponent of the result will always have three digits (example: 1052.0329112756 ("e2") -> 1.05e+003)

        Note

        You can also configure the following format: 0.##E00 (example: 5430 ("0.##E00") -> 5.43E03)

      • c - Currency pattern (example: 111.23 ("c3") -> $111.230)

      • f - Fixed-point pattern (example: 50123.36 ("f3") -> 50123.360)
      • g - General, the number that follows g is the maximum number of digits the number will have (example: 100 ("g3") -> 100); if the number has more digits than the configured digits in the format, it is displayed in scientific notation (example: 10000 ("g3") -> 1e+04)
      • n - Number pattern, this adds the thousand separator whenever necessary (example: 50123.36 ("n3") -> 50,123.360)
      • p - Percentage (example: 0.523 ("p2") -> 52.30%)

      • A-Z - Alphanumeric character (example: 1200 ("AB 000") -> AB 1200)

        Note

        If the chosen alphanumeric character is reserved to be used to define a pattern, it is necessary to escape it (example: 1200 ("\n000") -> n1200)

        Info

        For more information, see Custom numeric format strings and Exponential format specifier (E) ⧉.

    • Text

      • d - Digit pattern, required (example: d3 111.234->111)
      • \# - Digit pattern, optional. If this position is blank in the mask, it will be rendered as the character in the Placeholder property. You can add and delete signs (example: #3.1 111.234->111.2)
      • A - Alphanumeric, required
      • a - Alphanumeric, optional
      • L - Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions
      • l - Letter, optional
      • \\ - Escapes a mask character, turning it into a literal. "\" is the escape sequence for a backslash.
      • < - To lower token
      • \> - To upper token

  3. Specify the units of the Parameter.

  4. Optionally, define a scale for the Parameter in terms of powers of 10.

    ℹ This field is typically used for reporting purposes with no functional effect on the system. As an example, you can create a Megawatt parameter and set the scale to 6 representing 10^6; or a Picoampere and set the scale to -12 representing 10^-12.

  5. Optionally, define a minimum value for the Parameter (only for numeric parameters).

  6. Optionally, define a maximum value for the Parameter (only for numeric parameters).
  7. Optionally, define a lookup table to be used as a source of values for the Parameter (note that depending on the type the lookup table must contain values that match that type).
  8. Select Create to complete the operation and the new Parameter will be created.

create_parameter