Filter (FILTER)

Filter objects search for the presence or absence of a specific string in one or more text files. Based on the results of the search, Filter objects return an overall true or false value. As a developer and object designer you create Filter objects and assign them to the Output-Scan Page of the following objects:

• File Transfers (JOBF)
• Jobs (JOBS)
• Remote Task Manager (JOBQ)

The Filter object scans the output files of these objects, searching for a string or combination of strings in them.

Object class: Passive object

Object type: FILTER

Object template: OUTPUT

The Automation Engine is supplied with one Filter object, namely FILTER.OUTPUT.

Notes:

• When you read about Filter objects in the documentation, the FILTER.OUTPUT object is meant
• System administrators set the memory size for reading reports in the DEFAULT_REPORT_SCAN_MEMORYandMAX_REPORT_SCAN_MEMORY options in the UC_SYSTEM_SETTINGS - Systemwide Settings. For more information, see REPORT_SCAN Parameters.
• Filter objects that are created in Client 0 can be used system-wide.

To Define a Filter Object

1. In the Process Assembly perspective click Add Object. On the Add Object dialog, select Filter.

   A Filter object definition is made up of the following pages:

   • Standard pages that are always available, no matter what type of object you are defining:
   • General Page
   • Version Management Page
   • Documentation Page

   • The object-specific page described here.

   Note: You can also create Filter objects directly from the Combo Boxes that serve to select objects.

2. In the Filter Logic section specify whether one or all the search criteria must be met for the overall result to be true.

3. Define the search criteria for the different types of file:

   • Report

     Use this option to search for strings in reports

     Reports that are generated by and stored in the Automation Engine database when a task is executed, for example logging (LOG) or activation (ACT) files

   • Registered Job Output

     Use this option to search for strings in output files from external Jobs

     Enter a file path and name.

   • File

     Use this option to search for strings in any other kind of text file that you want to check

     Enter a file path and name.

4. In the Condition dropdown list select the operator.

5. In Filter String enter a search string.

   Standard wildcard characters (*, ?) are allowed. You can also use variables.

   This field is not case-sensitive.

6. Click Add. A search filter statement appears under the input fields.

   To remove an added search criterion, click the x on the criteria box. To edit an added search criterion, click on the search filter statement to activate it and modify its contents.

7. Repeat these steps for all the search criteria and save the object.

8. Assign the Filter object to the object in which you want to search for strings in their output files.

Notes:

(Filter objects of type Registered Job Output or File)

• Define the output files that you want to register as external for the Job. They are transferred to and stored on the Agent. This way, they can be accessed from the User Interface and by the Filter object. You do this on the Output Pages when defining the Job, File Transfer or Remote Task Manager objects.
• When the object is executed, the system scans for the strings defined in the Filter object considering the conditions specified there. The results are published to the task report.

See also:

• Example of a Filter Object
• Output Pages
• Registered Job Output
• Read Example: Getting Data, Updating the Database, and Sending a Report for a further example of how to use Filter objects.