warning

This page is intentionally hidden from navigation but remains accessible via direct link. It is retained for internal reference purposes only and may contain outdated or transitional content.

Filtrator

The filtrator (openit_filtrator) is an application responsible for converting the raw data into a suitable format for generating reports. It runs in the background of the Open iT server by default, but it can be run manually with the following instructions if needed.

danger

You need support's assistance to do this. Please coordinate with them to make sure everything goes smoothly.

Requirements

• Open iT Core Server
• Administrative rights

Running the Filtrator

Windows

1. Open a command prompt with Administrator level privileges.

2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

   Example

   cd "C:\Program Files\OpeniT\Core\bin"

3. Run the command:

   Command Syntax

   openit_filtrator <parameter 1> <parameter 2> ... <parameter n>

   Required Parameters:

   Parameter	Description
   <filter process>	Use this to specify the corresponding filter process of the data type you want to filter.
   <period start>	Use this to specify the date (YYYY-MM-DD) for which to start the processing.
   <period end>	Use this to specify the date (YYYY-MM-DD) for which to end the processing.
   <interval>	Use this to specify the maximum period to process in one go Must be a divisor of 24 hours, (e.g., P1H, P2H, P3H, P4H, P6H, P8H, P12H, P1D).

   Required Parameters for Running Filtrator
   
   

   Optional Parameters:

   Parameter	Description
   --filter <details>	Format: <field1> = <value1> | <value2> & <field2> = <value3> By default, the filtrator processing includes all the records read from the archive. Use this parameter to specify fields that records should match to be processed. Globbing is allowed. Note that: You can filter specific products, features, daemons, applications, and/or license managers A field can only appear once but can have several alternate values You can specify multiple fields, but all fields must match at least one value. To do this, enclose the entire option value in double quotes (e.g., "product = p1;d1 | p2,d* & feature = fn??xt")
   --progress <on/off>	Progress logging is on if debug is on. Use this to specify on to log progress even if debug is off and off to not log when debug is on.
   --delete <progress/debug/all>	Use this to delete old files before run. Specify which of the following to delete: progress - delete progress log files debug - delete debug files all - delete both
   --output dir <path>	Use this to specify the path where the output will be sent instead of the configured incoming directory.

   Optional Parameters for Running Filtrator
   
   
   Example

   openit_filtrator olap-license-total-usage 2023-05-02 2023-05-03 P1D --filter product="gal7*" --delete all

   This example deletes pre-existing progress and debug log files, and processes data on products with names starting with gal7 in the olap-license-total-usage records from May 2, 2023 to May 3, 2023.

Unix

1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

   Example

   cd /opt/openit/bin

2. Run the command:

   Command Syntax

   ./openit_filtrator <parameter 1> <parameter 2> ... <parameter n>

   Required Parameters:

   Parameter	Description
   <filter process>	Use this to specify the corresponding filter process of the data type you want to filter.
   <period start>	Use this to specify the date (YYYY-MM-DD) for which to start the processing.
   <period end>	Use this to specify the date (YYYY-MM-DD) for which to end the processing.
   <interval>	Use this to specify the maximum period to process in one go Must be a divisor of 24 hours, (e.g., P1H, P2H, P3H, P4H, P6H, P8H, P12H, P1D).

   Required Parameters for Running Filtrator
   
   

   Optional Parameters:

   Parameter	Description
   --filter <details>	Format: <field1> = <value1> | <value2> & <field2> = <value3> By default, the filtrator processing includes all the records read from the archive. Use this parameter to specify fields that records should match to be processed. Globbing is allowed. Note that: You can filter specific products, features, daemons, applications, and/or license managers A field can only appear once but can have several alternate values You can specify multiple fields, but all fields must match at least one value. To do this, enclose the entire option value in double quotes (e.g., "product = p1;d1 | p2,d* & feature = fn??xt")
   --progress <on/off>	Progress logging is on if debug is on. Use this to specify on to log progress even if debug is off and off to not log when debug is on.
   --delete <progress/debug/all>	Use this to delete old files before run. Specify which of the following to delete: progress - delete progress log files debug - delete debug files all - delete both
   --output dir <path>	Use this to specify the path where the output will be sent instead of the configured incoming directory.

   Optional Parameters for Running Filtrator
   
   
   Example

   ./openit_filtrator olap-license-total-usage 2023-05-02 2023-05-03 P1D --filter product="gal7*" --delete all

   This example deletes pre-existing progress and debug log files, and processes data on products with names starting with gal7 in the olap-license-total-usage records from May 2, 2023 to May 3, 2023.