Configuring Special Commands

To configure a new special command:

  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 Configuration > Special Commands.

    The Special Command Workbench opens.

  4. Click New Special Command.

    The Special Command window opens.

  5. Complete the fields as specified in the following table.

    Field Name

    Description

    Command Name

    The name of the special command. This can only be updated when generating or editing a user-defined special command.

    Enabled

    Determines whether or not the special command is enabled for use in workflows, object types, report types, request types, and validations.

    Description

    A description of the special command. This can only be updated when generating or editing a user-defined special command.

  6. Configure a new parameter, as follows:

    1. Click the Parameters tab.

    2. Click New.

      The Parameter: New window opens.

    3. Complete the fields as specified in the following table.

      Field Name

      Description

      Name

      The name of the new parameter.

      Description

      A description of the new parameter.

      Default Token

      The default token name. Type the token name, or click Tokens to open the Token Builder and select the name.

    4. In the Name field, type a name for the new parameter.

    5. To add the field to the Parameters tab, click OK.

  7. Click the Commands tab.

    1. Click New Cmd.

      The New Command window opens.

    2. Complete the fields as specified 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)

      Amount 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

      Yes and No option buttons enable or disable the command

      Steps

      Specify at least one command step.

      • Click Tokens to open the Token Builder window. Use this window to 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. Use this tool to find a special command and add it to the command step. For information about special commands, see Using Special Commands.

      • Click Show/Hide Desc to show or hide a Descriptions field in the Steps field. If the Descriptions field is visible, you can add a description to the command step.

    3. To save the command, 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 window open, click Add.

  8. Click the Ownership tab.

  9. Under Give ability to edit this Special Command to, select Only groups listed below that have the Edit Special Commands Access Grant.

  10. Click Add.

    The Add Security Groups window opens.

  11. Select the security groups.

  12. Click OK.

    The security groups are listed on the Ownership tab.

  13. To add the security group to the special command:

    • To save the security group and close the Special Command window, click OK.

    • To save the security group and leave the window open, click Save.

  14. To see a list of entities that reference the selected special command, click the Used By tab.

  15. To save the special command, click OK.