Configuring Commands

Each object type, request type, validation, workflow step source, or report type can have many commands, and each command can include many steps. You can think of a command as a particular function for an object. Copying a file can be one command, and checking that file into version control can be another. For these functions to operate, a series of events must take place. You define these events in the command steps. To define the events, you must configure commands using the Commands tab.

You configure commands using the Commands tab in the following PPM entity windows:

  • Object Type

  • Request Type

  • Report Type

  • Validation

  • Workflow Step Source

  • Special Command

Commands consist of command information and command steps. In the examples presented in this section, commands are accessed through the Deployment Management Object Type window. However, the controls are the same in the other entity windows that you can use to configure commands.

To configure commands associated with an object type:

  1. Log on to PPM.

  2. From the menu bar, select Open > Administration > Open Workbench.

    The PPM Workbench opens.

  3. From the shortcut bar, select Deployment Mgmt > Object Types.

    The Object Type Workbench window opens.

  4. Open an existing object type.

  5. In the Object Type window, click the Commands tab.

  6. Click New Cmd.

    The New Command window opens.

  7. Complete the fields described in the following table.

    Field Name

    Description

    Command

    Command name.

    Condition

    Specific conditions under which the command steps are to be executed. This step is optional. For more information, see .

    Description

    Command description. This step is optional. For more information, see .

    Timeout(s)

    Length of time (in minutes) to run the command before stopping. This setting is useful if a command hangs or takes too long to execute.

    Enabled

    Use the Yes and No option buttons to enable and disable the command.

    Steps

    Specify at least one command step.

    • Click Tokens to open the Token Builder window and find a token to add to the command step. For information about tokens, see Using Tokens.

    • Click Special Cmds to open the Special Command Builder and find a special command to add to a command step. For information about special commands, see Using Special Commands.

    • To show or hide a Descriptions field in the Steps field, click Show Desc or Hide Desc.

  8. Do one of the following:

    • To add the command to the Commands tab and close the New Command window, click OK.

    • To add the command to the Commands tab and leave the New Command window open, click Add.