RequirementResults
A requirement's result configuration determines the information that displays on OIPA's Requirement Results screen. Note that requirement results are not configured in a business rule, but rather in the XML Results pane of a requirement.
The requirement results on the Requirement Result screen may be formatted as a collection of fields, a text document or a table depending on the type of information contained within the result.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<RequirementResults> |
Required element: The opening and closing tag of the requirement results configuration. |
|
|
<Result> |
Required, repeatable element: This element defines a section of the results screen. |
TITLE |
Optional attribute: This attribute assigns a title to the result. |
<Fields | The container element for the configuration of the screen's search criteria fields. |
|
|
<Field> |
Optional, repeatable element: This element defines an individual field on the screen. See the Fields Element page for more information on configuring this element. |
|
|
<Result> |
Required, repeatable element: This element defines a section of the results screen. |
TITLE |
Optional attribute:
This attribute assigns a title to the result. |
<Text> | This element specifies that the results returned should be in text format. |
|
|
<Name> | This element specifies the name of the AsRequirementResults column that corresponds to the requirement criterion. |
|
|
<Result> | Required, repeatable element:
This element defines a section of the results screen. |
||
<Table> | This element specifies that the results returned should be in tabular format. | TYPE | |
VALUE | |||
FIELD | |||
<Column> | This element defines the width of columns in the results table, the alignment of the column's data and the format of the column's data. | WIDTH | An integer |
ALIGN | Left: The information in the column will be left-aligned. Right: The information in the column will be right-aligned. Center: The information in the column will be centered. |
||
FORMAT | Text: The information in the column will be formatted as simple text. Currency: The information in the column will be formatted as currency. Date: The information in the column will be formatted as a date. |
||
<Display> | This element defines the display name of the column. | The desired display name for the column. | |
<Name> | This element specifies the exact name of the column as used in the database. | The exact name of the column as used in the database. | |
<Datatype> | This element specifies the datatype of the data within the column. | The datatype of the data within the column. | |
<Index> | This element defines the order in which the columns are displayed. | An integer. Column indices are zero-based. Columns will display left-to-right with respect to the <Index> value. |
XML Example
<ResultScreen>
<Result TITLE="MVR Results">
<Fields>
<Field>
<Name>ResultNumber</Name>
<Display>Result Number</Display>
<DataType>Text</DataType>
<Disabled>Yes</Disabled>
</Field>
<Field>
<Name>LabName</Name>
<Display>Lab Name</Display>
<DataType>Text</DataType>
<Disabled>Yes</Disabled>
</Field>
<Field>
<Name>ReceivedGMT</Name>
<Display>Received</Display>
<DataType>Date</DataType>
<Disabled>Yes</Disabled>
</Field>
</Fields>
</Result>
<Result TITLE="Text Report">
<Text>
<Name>ResultText</Name>
</Text>
</Result>
<Result TITLE="Verify MIB Codes">
<Table TYPE="0" FIELD="RelationCode" VALUE="TRY">
<Column WIDTH="10" ALIGN="LEFT">
<Display>Reply Type</Display>
<Name>RelationCode</Name>
<DataType>Text</DataType>
<ColumnIndex>0</ColumnIndex>
</Column>
<Column WIDTH="10" ALIGN="LEFT">
<Display>Report Date</Display>
<Name>SubmitDate</Name>
<DataType>Text</DataType>
<ColumnIndex>1</ColumnIndex>
</Column>
<Column WIDTH="10" ALIGN="LEFT">
<Display>Name</Display>
<Name>Name</Name>
<DataType>Text</DataType>
<ColumnIndex>4</ColumnIndex>
</Column>
<Column WIDTH="10" ALIGN="LEFT">
<Display>Date Of Birth</Display>
<Name>BirthDate</Name>
<DataType>Text</DataType>
<ColumnIndex>5</ColumnIndex>
</Column>
</Table>
</Result>
</ResultScreen>