Requirement Definition
The requirement definition contains the XML configuration needed to process a single requirement.
Note: A requirement definition can be configured partially or entirely through CopyBooks.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<Requirement> |
Required element: The opening and closing tags for the requirement. |
||
<States> |
Optional element: The container element for state configuration. |
||
<State> | Optional element:
Defines how the system should process the requirement when in a given status. |
||
STATUS |
Optional attribute: Defines the state by assigning it a requirement status. Value should be a code from AsCodeRequirementStatus. |
||
SCHEDULE | Optional attribute:
While in a state, a requirement can undergo multiple rounds of processing. This attribute specifies the amount of time, in minutes, that should be dedicated to each round of processing. |
||
EXPIRE | Optional attribute:
Specifies an amount of time, in minutes, after which the requirement will expire. Value should be an integer. |
||
<WorkflowTask> | Optional: Identifies the workflow task definition to be generated. This element is ignored if the workflow feature is "turned off" (system property). | Values: Workflow task name | |
<Math> |
Optional element: See the Math Element page for information on configuring this element. Math configuration for a requirement definition can access all critical requirement- and application-specific fields, define conditions and initiate external calls. |
||
<Rules> | Optional element:
The container element for rules configuration. |
||
<Rule> | Optional element:
Identifies attached rules that are to be processed in the state. |
The name of an attached rule that is to be processed in the state. | |
<Transitions> | Optional element:
The container element for transition configuration. |
||
<Transition> | Optional element:
Defines the conditions for transitioning a requirement to another state. |
||
IF | Optional attribute:
Defines a condition that, if satisfied, will cause the requirement to move to the state specified in the TO attribute. Value should be an expression that resolves to a Boolean value. |
||
TO | Optional attribute:
Specifies the status to which the requirement should move if the IF condition is satisfied. Value should be a code from AsCodeRequirementStatus. |
||
WORKFLOWTASKSTATUS |
Optional: When the transition's condition is true and the requirement is updated to the new requirement status, the associated workflow task is updated to the attribute's status value. This attribute is required when the requirement is associated to generates a workflow task. It would be used to close the workflow task when the associated requirement is considered closed, waived or fulfilled. Values: Workflow task status - AsCodeWorkflowTaskStatus |
XML Schema
<Requirement>
<States>
<State STATUS="[code value]" SCHEDULE="[integer]" EXPIRE="[integer]">
<Math>. . . </Math>
<Rules>
<Rule>[rule name]<Rule>
</Rules>
<Transitions>
<Transition IF="[conditional statement]" TO="[code value]" WORKFLOWTASKSTATUS="[code value]"/>
</Transitions>
<WorkflowTask>[workflow task name]</WorkflowTask>
<State>
</States>
</Requirement>
XML Example
<Requirement>
<States>
<State STATUS="00" SCHEDULE="5">
<Transitions>
<Transition IF="1=1" TO="02"/>
</Transitions>
</State>
<State STATUS="02" SCHEDULE="5" EXPIRE="1440">
<Math>
<MathVariables>
<MathVariable VARIABLENAME="ResultsReceivedIndicator" TYPE="VALUE" DATATYPE="INTEGER">0</MathVariable>
<MathVariable VARIABLENAME="RequirementResultGuidMV" TYPE="VALUE" DATATYPE="TEXT">E72BE25B-7AA0-4B89-AA40-03944F1913FD</MathVariable>
<MathVariable VARIABLENAME="MatchedCount" TYPE="SQL" DATATYPE="INTEGER">SELECT COUNT(*) FROM ASMATCHEDREQUIREMENTRESULT WHERE RequirementResultGuid=[RequirementResultGuidMV]</MathVariable>
</MathVariables>
</Math>
<Rules>
<Rule>MatchRequirementResult</Rule>
</Rules>
<Transitions>
<Transition IF="MatchedCount > 0" TO="03"/>
</Transitions>
</State>
<State STATUS="03"/>
<State STATUS="99"/>
</States>
</Requirement>