Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Requirements - Completing the Requirement tab

Updated on January 18, 2022

This tab is divided into two parts. The first part defines the rules pertaining to the overall Requirement work object. The second part defines the rules pertaining to the Document Requirement instances. The topics below provide a more detailed explanation:

Part 1: Defines the rules of the Overall Requirement work object

Verification SectionTheRule-HTML-Section rule used at runtime to display the section rule that is used to verify the overall validation for the Requirement.
ValidationTheRule-Obj-Validate rule used at runtime to perform the overall validation of the Requirement.
Processing Flow ClassIf theRequirement is a flow-based Requirement, this field defines the class in which the flow resides.
Processing Flow NameIf the Requirement is a flow-based Requirement, this field defines the flow name.
Days Until Stale

Once the requirement is satisfied, this optional parameter indicates the number of days that the satisfied state is still considered valid. Used to calculate a Stale Date for the requirement; that is, the date when it should no longer be considered valid.

Processing InstructionsInstructions to be displayed to the operator processing the requirement at runtime.

Part 2: Defines the rules of the Requirement Document instances (there could be multiple)

Document ID

TheDocumentID from the Document Library that is to be used to generate this line item. Pressing the Down Arrow key (smart prompt) lists the various Document Requirements from the Document Library. The class of these Document Library instances is picked up at runtime from the Declare_Doc_Settings Rule-DeclarePages rule.

DescriptionThe name used for display purposes on various harnesses – more user- friendly than DocumentID.
CompletionIndicates whether the runtime validation of this document entry is successful.
RequiredMandatory for the satisfaction of this requirement.
Applies When

If not blank, names a When rule that is applied to determine if the document type is applicable to a particular parent case at runtime based on properties in the

parent case. The When rule typically is defined on the same class or an ancestor class of the parent case class.

Attachment CategoryIf not blank, determines the Attachment Category to which the generated document form is attached on the Requirement work object at runtime.
Separate Doc for Each PartyIf checked,indicates that this Document Requirement is created as a separate instance for each of the work parties on the Requirement work object. For example, if the Document Requirement is PayStub, selecting this check box creates a separate instance of the PayStub Document Requirement for each of the work parties associated with the Requirement work object.
Party Applies WhenThis field becomes visible only when the check box is selected for the Separate Doc for Each Party field. It points to the Rule-Obj-When rule used to evaluate whether the Document Requirement is applicable to each party based on certain conditions. For instance, if you select Separate Doc for Each Party, then the Applies When might indicate that the Document Requirement is applicable only when the party (that is workParty) is from the State of Massachusetts.
Reuse Existing

If selected, looks for existing Document Item instances to re-use instead of creating a new one. The criteria used to look for existing document instances is a combination of DocumentID, PartyID, and Detailed Description on the Document instances.

Verification SectionTheRule-HTML-Section rule used at runtime to display the section rule, which is used to verify the Document Requirement.
ValidationThe Rule-Obj-Validate rule used at runtime to validate the document entry.
Valid DaysNumber of days the document is considered valid before it expires.
Image Sys ParmsFor implementation use in integration with image repository systems.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us