Parameter batch definition
The Parameter list file allows to modify parameters in a model by using a list instead of a set of parameter checks. With the help of this file you can perform all update operations like with a normal Parameter check:
  • Create a new parameter of a given type and value
  • Edit name, value, type, designation, and description of an existing parameter
  • Delete a parameter
The parameter list file uses a table to define the properties of the parameters to be updated. The header line contains the names of the properties, and each line describes a single parameter.
You can use comments within the file by starting each comment line with the sign ”!”. Example for a comment:
!This is the parameter list file to edit all parameters in one run
For most values you can use the setting <ignore>. This instructs the program to ignore that specific value by not checking or not updating it.
For each column in the header line you must set a value in the parameter line, otherwise the program will not work. If there is no value to set, then use the setting <ignore>.
The columns in the header line are:
  1. MODEL_NAME
    • Defines the model within the parameter operation shall be performed. This allows to add dedicated values of a parameter to different models.
  2. PARAM_NAME
    1. Specifies the full name of the parameter
    2. doesn’t support wildcards or regular expressions
    3. cannot be empty
  3. ACTION
    1. Specifies the action to take on the parameter
    2. valid values: CREATE, EDIT, REMOVE
    3. no other values are supported
  4. PARAM_VALUE
    1. specifies the value of the parameter which needs to be changed
    2. can be any valid parameter value or <ignore> if the parameter value shouldn’t be checked
  5. PARAM_VALUE_TYPE
    1. specifies the type of the parameter value which needs to be changed
    2. valid values:
      1. STRING — a string: “This string has 29 characters”
      2. DOUBLE — a real number: 0.42, 3.14159, etc.
      3. INTEGER — an integer number: 2, —7, 2018
      4. BOOLEAN — one of the values YES and NO
      5. <ignore> — ignore checking the value type
  6. PARAM_DESIGNATION
    1. specifies the designation value of the current parameter, which needs to be changed
    2. valid values:
      1. DESIGNATE — designate the parameter to be visible to Windchill
      2. NOT_DESIGNATE — remove the designation of the parameter, to avoid displaying it in Windchill
      3. <ignore> — ignore checking the parameter designation
  7. PARAM_DESCRIPTION
    1. the parameter description that should be changed
    2. can be any valid parameter description or <ignore> to ignore checking the parameter description.
  8. NEW_PARAM_NAME
    1. the new parameter name which should be used instead of the value from the setting PARAM_NAME
    2. can be any valid parameter name or <ignore> to skip changing the name of the parameter
  9. NEW_PARAM_VALUE
    1. the new parameter value which should be used to replace the value from the setting PARAM_VALUE
    2. can be any valid parameter value or <ignore> to leave the value of the parameter as it is
  10. NEW_PARAM_VALUE_TYPE
    1. the new parameter value type which should be set instead of the one specified in the setting PARAM_VALUE_TYPE
    2. can be any valid parameter value type like described previously or <ignore> to leave the parameter value type as it is
  11. NEW_PARAM_DESIGNATION
    1. the new parameter designation which should be set instead of the one specified in the setting PARAM_DESIGNATION
    2. can be one or the valid parameter designation values described previously or <ignore> to leave the parameter designation as it is.
  12. NEW_PARAM_DESCRIPTION
    1. the new parameter description which should be set instead of the one specified in the setting PARAM_DESCRIPTION
    2. can be any valid parameter description or <ignore> to leave the parameter description as it is.
For use cases, see the Batch Use Case chapter