Creating Extension Parameters, Properties, and Preferences

You can use the Variables tab to create parameters, properties, and preferences in your Isight extension. These items, known collectively as “variables” in Isight, each have a specific role in defining the structure of an extension.

  1. Click the Variables tab on the right side of the Isight Developer perspective.

  2. Add a new parameter or property to the extension.

    1. If necessary, expand the appropriate area and display the available variable options by clicking the Parameters or Properties label.
    2. Click Add.

      The New Variable dialog box appears.

    3. Specify the following information for the variable:

      Name The name of the new variable.
      Description A description of the new variable (optional).
      Mode The variable's mode:
      • local,
      • input,
      • output, or
      • input/output.
      Structure The variable's structure:
      • scalar,
      • array, or
      • aggregate.

      All of these variable settings can be changed directly in the variables list after the variable is created with the exception of the Structure setting.

    4. Click OK.

      The new variable is added to the appropriate list on the Variables tab.

    5. Edit any of the following additional variable settings displayed in the variables list:

      Tag Specify the tag of the variable. This tag behaves as the constant name of the variable that is accessible only on the API level. You can change a variable name but never a variable tag.
      Display name If desired, specify a name for the variable that will appear on graphs, tables, and other visual tools. This setting is typically not used unless your extension will be dynamically creating long parameter names. If you leave this setting blank, the name defined by the Name setting is used throughout Isight.
      Type Specify if the variable is a Real number, a String, an Integer, or a Bool (Boolean) value.
      Save To DB Specify whether or not values for this parameter are saved to the results database (local or SIMULIA Execution Engine). If the option is not selected, parameters that are not saved will not be displayed on the Runtime Gateway during and after execution. For more information on this option, see Specifying Database Options in the Isight User’s Guide.

  3. Add a new preference to the extension.

    1. If necessary, expand the associated area and display the available preference options by clicking the Preferences label.
    2. Click Add.

      A new variable is added to the preferences list.

    3. Edit any of the following preference settings displayed in the preferences list.

      Name Specify the name of the preference. A default setting is provided.
      Tag Specify the tag of the preference. This tag behaves as the constant name of the preference that is accessible only on the API level. You can change a preference name but never its tag. A default setting is provided.
      Type Specify if the preference is a Real number, a String, an Integer, or a Bool (Boolean) value. A default setting (String) is provided.
      Value Specify the default, initial value of the preference.

  4. Click to save your changes to the extension.

  5. Define the additional settings for your new extension as described in Editing an Extension.