Setting up parameter environment variables

This section describes how to set a parameter alarm using the PATROL Developer Console for Windows and UNIX. 

Parameter environment variable properties

The following table describes the environment variable properties of a parameter.

Parameter environment properties

Property

Default

Description

Name/Value List

None

If environment variables are defined for this parameter, each variable and its assignment are listed.

Name

None

The name of the environment variable.

Value

None

The value assigned to the variable.

Setting up parameter environment variables on Windows

In this task, you will add an environment variable to a parameter.

To set up parameter environment variables

  1. Click the Environment tab on the Parameter Properties dialog box for the appropriate parameter as shown in the following figure. 

    Parameter Properties dialog box, Environment tab
  2. Select, add, or modify the appropriate options that appear on the Environment tab.
    • To add an environment variable, type its name and its value in the Name and Value text boxes.
    • To change an existing environment variable, choose the variable from the Name/Value list and make the changes in the Name and Value text boxes. Parameter environment properties summarizes the available options.
  3. Click Apply to save the changes to the PATROL KM.

Setting up parameter environment variables on UNIX

In this task, you will add an environment variable to a parameter.

To set up parameter environment variables

  1. Choose Edit>Modify from the List of Parameters window menu bar to change the selected parameter. A Parameter Definition dialog box appears, similar to the one shown in Parameter Definition dialog box, General.
  2. Click the Environment button as shown in the following figure. 

    Parameter Definition dialog box, Command

    The List of Environment Variables window for the selected parameter appears as shown in the following figure. 

    List of Environment Variables window


    The environment variables displayed in this window are only those defined at this object level. The environment variables for a command are inherited from the command's parent object classes.
  3. Choose Edit > Add from the List of Environment Variables window menu bar to add a new environment variable. The Environment dialog box is displayed as shown in the following figure. Use the dialog box to add a variable. 

    Environment dialog box

  4. Type the name of the environment variable in the Name field and its assigned value in the Value field.
  5. Click OK to add your new variable to the environment variable list, exit the dialog box, and return to the Command Environment List window.
  6. Choose File> Exit when you are finished to apply any changes and close the Environment List window. If you do not want to save any of your changes, click Cancel.

KM output-parameter environment variable

The following figure shows sample output created by the PATROL Developer Console when you add a parameter environment variable. 

 KM output-application class parameter environment variable 

Was this page helpful? Yes No Submitting... Thank you

Comments