RequirementResults

The total configuration of a Policy, Client and Policy-Client level Requirement includes three XML sections:

  • The user's entry screen named Requirement Details,

    • This presents a screen of fields for user data entry or dynamic creation by an activity or another requirement.

    • Fields become part of the data source to perform the Requirement's logic, update entities, conditionally transition to other statuses and spawn activities.

  • The Requirement's engine processing definition name Requirement Definition.

  • The Requirement's Results screen named Requirement Result.

    • Data description that stores external results from a callout to a bureau or service.

This page describes the Requirement's Result information that can be presented in OIPA's Requirement Results screen tabs. Each tab can be define to present data from the matched result records in one of three ways: simple text display of one or more text data columns, a field presentation of one or more data columns or a table presentation of one or more data columns. The data displayed on the screen is only viewable and cannot be modified. Presentation can display one or more tabs. This rule has access to Policy data on Policy and Policy-Client level Requirements, Client data on Policy-Client and Client level Requirements, the Requirement instance's fixed and dynamic data, the Requirement's definition and the Requirement's Result information. Dynamic data for these entities are also applicable.

 

RequirementResults: Elements and Attributes
Element Attributes Parent Element Description Element / Attribute Value
<RequirementResults>     This is the root element for the rule.  
<Result>   <RequirmentResults>

Required, Repeatable:

This element's structure defines how requirement result data is presented.  A tab is presented for each <Result> structure and the tab is named for each one.

  
  TITLE <Result>

Required:

This attribute provides a name for the tab.  Each tab should have a unique value.

  • literal
<Fields>   <Result>

Optional:

This element defines a field presentation for each matched result.  This element cannot be configured with the <Text> and <Table> elements within the same <Result> structure.

See Fields Elements article under the Common Elements topic.

  
<Field>   <Fields>

Required, Repeatable:

See the <Field> element in the Fields Elements article under the Common Elements topic. 

This element is repeated to present all the desired result data.

Data is sourced from AsRequirementResult and AsRequirementResultField database table only.

  
<Text>   <Result>

Optional:

This element defines the data to present in a text format.  This element cannot be configured with the <Fields> and <Table> elements within the same <Result> structure.  This structure is especially applicable to display the ResultText column and TextArea dynamic data.

  
<Name>   <Text>

Required, Repeatable:

This element identifies the name of the column from the AsRequirementResults database table whose value will be displayed.  It is repeated to display data from multiple column data.  

  • column name

    • valid value is the name of a column from the AsRequirementResults database table
<Table>   <Result>

Optional:

This element defines the data to present in a table format.  This element cannot be configured with the <Fields> and <Text> elements within the same <Result> structure.

This element provides a filter through the TYPE attribute.  Optionally, the FIELD and VALUE attributes are additional filters.  Data available to display in the table comes from the Requirement's Result data.

  
  TYPE <Table>

Required:

This element provides a filter on the Result record that will be presented by the TypeCode value in AsRequirementResultType database table.

  • literal

    • valid value should be a TypeCode value that will exist in the AsRequirementResultType database table
  FIELD <Table>

Optional:

This element provides the name of the Result's dynamic field or database column to filter.  The VALUE attribute provides the value to compare and it is required with this attribute.

  • field name

  • column name
  VALUE <Table>

Optional:

This element provides the value of the field or column referenced by the FIELD attribute.  This completes the FIELD filter.

  • literal
<Column>   <Table>

Required, Repeatable:

This element defines a column to display in the table.  It is repeated to display multiple columns.

  
  ALIGN <Column>

Optional:

This attribute describes the data alignment in the column.

  • Left

    • default

    • data is aligned to the left of the column

  • Center

    • data is centered in the column

  • Right

    • data is aligned to the right of the column
  FORMAT <Column>

Optional:

This attribute defines a data format for the values displayed in the column.

  • Text

    • default

    • column values are formatted as simple text

  • Currency

    • column values are formatted as monetary values, currency

  • Date

    • column values are formatted as localized dates
<Display>   <Column>

Required:

This element provides the text to display as the column's header.

  • literal
<Name>   <Column>

Required:

This element provides the name of the column or dynamic field.  Valid names are restricted to the Requirement Result's database tables.

  • column name

  • field name
<DataType>   <Column>

Required:

This element defines the data type of this column's values.

  • Date

  • Decimal

  • Integer

  • Money

  • Percent

  • Text
<ColumnIndex>   <Column>

Optional:

This element defines the order the <Column> structure is displayed on the Result's screen.  A <ColumnIndex> is zero based and ordered left-to-right in an ascending order.  When this element is not provided, the configuration order will be present the columns from left-to-right.

  • integer

XML Schema

<RequirementResults>
    <Result TITLE="[literal]">
        <Text>
            <Name>[column name]</Name>
            <Name>...</Name>
        </Text>
    </Result>
    <Result TITLE="[literal]">
        <Fields>
            <Field>...</Field>
            <Field>...</Field>
        </Fields>
    </Result>
    <Result TITLE="[literal]">
        <Table TYPE="[literal]" FIELD="[field name | column name]" VALUE="[literal]">
            <Column ALIGN="[Left | Center | Right]" FORMAT="[Text | Currency | Date]">
                <Name>[column name | field name]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
                <ColumnIndex>[0...n]</ColumnIndex>
            </Column>
            <Column>...</Column>
        </Table>
    </Result>
    <Result>...</Result>
</RequirementResults>

XML Example

<RequirementResults>
    <Result TITLE="MVR Results">
        <Fields>
            <Field>
                <Name>ResultNumber</Name>
                <Display>Result Number</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>LabName</Name>
                <Display>Lab Name</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>ReceivedGMT</Name>
                <Display>Received</Display>
                <DataType>Date</DataType>
            </Field>
        </Fields>
    </Result>
    <Result TITLE="Free-Form Results">
        <Text>
            <Name>ResultText</Name>
        </Text>
    </Result>
    <Result TITLE="Verify MIB Codes">
        <Table TYPE="2" FIELD="RelationCode" VALUE="TRY">
            <Column ALIGN="LEFT">
                <Display>Reply Type</Display>
                <Name>RelationCode</Name>
                <DataType>Text</DataType>
                <ColumnIndex>1</ColumnIndex>
            </Column>
            <Column ALIGN="LEFT">
                <Display>Report Date</Display>
                <Name>SubmitDate</Name>
                <DataType>Text</DataType>
                <ColumnIndex>0</ColumnIndex>
            </Column>
            <Column ALIGN="LEFT">
                <Display>Name</Display>
                <Name>Name</Name>
                <DataType>Text</DataType>
                <ColumnIndex>3</ColumnIndex>
            </Column>
            <Column ALIGN="LEFT">
                <Display>Date Of Birth</Display>
                <Name>BirthDate</Name>
                <DataType>Text</DataType>
                <ColumnIndex>4</ColumnIndex>
            </Column>
        </Table>
    </Result>
</RequirementResults>