1. Inline Processing Engine User Guide
  2. Managing Evaluations
  3. Adding Highlights to an Evaluation
  4. Passing Parameters from Run Rule Framework (RRF) to IPE

Passing Parameters from Run Rule Framework (RRF) to IPE

Parameters can be passed from RRF to IPE as Parameter Groups and Parameters.

The format of Parameters and Parameter groups are as follows:

  • For Parameters, segment codes must be separated by @@ token.
  • For Parameter groups, segment codes must be separated by ~ token.

To pass parameters, the format should be as follows:

<Segment Code1>~<Segment Code2>@@x@@y

where,

  • x is the code used for the kind of query you want to execute.
  • y is the code used for the kind of records you want as the result.

Here, x can be one of the following codes that depict the kind of query you want to use for different scenarios:

  • If you want to run an Assessment query, then the code is 1.
  • If you want to run a Highlights query, then the code is 2.
  • If you want to run an Assessment and Highlights query and generate Highlights, then the code is 3.

Here, y can be one of the following codes that depict the kind of records you want to obtain as the result:

  • If you want to run Assessment or Highlights or both for FAILONLY records, then the code is 1.
  • If you want to run Assessment or Highlights or both for PASSONLY records, then the code is 2.
  • If you want to run Assessment or Highlights or both for PASSNFAIL records, then the code is 3.

Note:

For second parameter group, the default ID is FAILONLY.

For example, if you want to run both Assessment and Highlights query and generate Highlights for the segment codes FRA and ONL, then the codeline is “FRA~ONL@@3@@2”.

If you want to generate only Highlights for all segments, then the codeline is “@@2@@3”.