Open with table of contents

Responses

You must also configure Response Codes in the Run External Command clause. Response codes are unique mappings for an executable program's return codes.

To add a response code:

  1. Click New in the Responses table. The Add response code dialog appears.

  2. Configure the following fields:

    • Response Code: The details for mapping the numerical return codes of an executable program to the Gateway using the Action field.

        If you are using a third-party executable program, please refer to their relevant documentation for details about the appropriate return code values.

    • Action: Action type determines how the Gateway interprets the value specified in the associated Response Code field.

      Action Description
      None Executable program completed successfully
      Modified Executable program found the condition and made changes
      Detected Executable program found the condition
      Failure Executable program did not complete successfully
       

      You must enter at least one response code for the None action.

      You must enter at least one response code for either the Detected or Modified actions.

    • Description: The description associated with the Detected or Modified actions. This text is displayed in the Structure tab on the View Message page. See Analyze and manage held messages for instructions on accessing the View Message page.

       

      If you have specified the %LOGNAME% token in the Command line parameters field of the Run External Command clause, you can use the %LOGTEXT% token in the Description field of a Response Code. The Gateway replaces the %LOGTEXT% token with the text from the log file as specified in the Log Extract section of the Run External Command clause.

  3. Click Add. Your response code appears in the Responses table.

To edit a response code:

  1. Select the response code you want to change.
  2. Click Edit. The Edit Response Code dialog appears.
  3. Modify the Response Code, Action and Description parameters.
  4. Click Update.

To delete a response code:

  1. Select the response code you want to remove.
  2. Click Delete. The Confirm Delete? dialog appears.
  3. Confirm that you want to delete the selected response code.

© 1995–2018 Clearswift Ltd.