Output-Scan Page

The Output Scan page determines the filters to be used to search the report of a task and/or an external output file, as well as the reaction to the search result.

The Output-Scan page is available and active for the following object types:

Background/Purpose

When executing objects, reports and output files are written and stored and, if so specified on the Output Page, they are registered as external output files by the Automation Engine. They are then transferred to the agent and can be accessed via the User Interface.

Sometimes you need to search for specific strings in those files and, depending on the search result, you might want to specify follow-up actions. They are then executed before the defined PostProcess actions, regardless of the task end status.

On this page you define the settings that scan the files and specify the actions that should take place depending on the search outcome.

Prerequisites

You must have defined the following:

The output scan always requires login information, even if the Windows or UNIX agent's password check is disabled (UC_HOSTCHAR - ANONYMOUS_FT/JOB).

ClosedTo Define the Output Scan Parameters

The table below describes the available options:

Column

Description

Filter Object

Enter or select the Filter object that contains the criteria you want to apply to scan the reports and/or external files for specific strings.

If you add more than one filter, the criteria of all selected filters are combined.
Filter Criteria Apply Activate this checkbox to indicate that the search criteria must be met. Leave it deactivated if they should not be met. Basically, this is a true/false setting.
Set Return Code

Enter the return code you want the task to specify for the result of the search.

This option is set to 0 by default, where 0 means OK; other values indicate an error.

The first entry that meets the conditions determines the return code that will be assigned to the task; successive conditions that apply do not change the return code anymore.
Status Text

Enter any user-friendly text that helps users understand the return code.

This text will be visible in the Status column of the Tasks table.
Execution of

Optionally, enter or select here the executable object that should be processed as a reaction to the search result.

This object is executed for each line in which the condition applies.

Filter definitions are checked at runtime. For example, a task has the FAULT_POST_PROCESSING status if the Filter object you specify here tries to search for a string in a report that does not exist in the task.

ClosedTo Populate the Table

  1. Click the first row to activate it and enter or select the Filter object.

  2. Fill in the remaining values according to the descriptions above.

    In the Status Text column you either type the text or click the editor icon. The Cell Editor dialog opens, where you can enter text in a clear and structured way.

    In the Execute column you either type the name of the executable object or you click the icon to open the Select Object dialog, where you can pick it.

  3. To edit a row you must first click its checkbox to activate it. You have then the following options:

    Option

    Description

    Inserts a new row at the bottom of the table

    		Deletes the row

    		Removes the entry from the list and pastes it to the clipboard. Click Paste to add it to the bottom of the table.

    		Duplicates the entry. Click Paste to add it to the bottom of the table.
    Activates all rows in the table.

Override Agent for File Scan

By default, the agent and Login object assigned to a task are used to access an external file that has been defined in a Filter object. In the case of File transfers, the destination agent is the default.

You can change both the agent and the Login object here.

The following table describes the Override Agent for File Scan options:

Option Description
Agent

The name of the operating system or a Java agent where the search should take place.
Login You need to specify the login information to be used. If you do not select the login information in this field, the one from the Attributes page is applied.

ClosedExample

Two Filter objects are assigned to the Unix job:

XXX

The list is processed bottom up, so the report is searched for first. The table below illustrates the possible outcomes:

The report does not include the term

 The external file includes the word ERROR Return code

Alarm object
  9  
  5 ALARM.CALL
9 ALARM.CALL

See also: