Cross Module - KRMS Validation Setup

Overview

The KRMS system can be used to create a number of different actions in the Kuali Research module.  One of the most common uses is building business logic to drive the creation of Validations.  A validation checks the data in a research document, and then when the validation system is turned on, either manually, or when the user tries to finalize the document will display various errors and warnings to avoid finalizing inappropriate data in the system.  Errors will prevent a document from being completed, while a Warning will display for the user indicating they may need to make revisions to their document, but will not prevent them from completing their document.

Setting up a Basic KRMS Validation

The first step of setting up a KRMS Validation is to complete the initial Agenda and Proposition setup described here. Once you have your proposition setup the next step is to build out your validation. There are two types of validation in the system.  The Institutional Proposal, Award, and Subaward documents use the basic validation. To create a basic validation in the system, scroll down to the Actions tab below the proposition in your KRMS rule and select the Validation Action Option, then complete the following fields.

• Error Action: This drives the type of validation that displays for the user.
  • Error Action: This validation will prevent a user from submitting a document if the logic defined in the rule above is true.
  • Warning Action: This validation will not prevent a user from submitting a document if the logic defined in the rule above is true, but it will display a warning, so they are aware they may need to revise the data in their document.
• Action Message: This is the text that will display for the user. This must be plain text.
• Name: This is the name of this action. It must be unique within the Namespace of your Agenda.
• Description: This is an optional field where you can add details about the purpose of this action for future administrators.

Once you have entered all the information for your Action press the Add Rule button.  This will take you back to the Agenda. You can now finalize your Agenda by pressing Submit, or build additional rules.

Setting Up a Proposal Development Validation

If you are setting up your Validation action in the Proposal Development namespace there are some additional fields that are required. In addition to displaying the validation in the system the way the other modules do the Proposal Development module allows you to build  a "fix it" button that will direct a user to the specific portion of the Proposal Development document where data changes need to be made to clear their validation.  When setting up a Validation in Proposal Development namespace scroll down to the Actions tab below the proposition in your KRMS rule and select the KC Validation Action Option, then complete the following fields.

• Error Action: This drives the type of validation that displays for the user.
  • Error Action: This validation will prevent a user from submitting a document if the logic defined in the rule above is true.
  • Warning Action: This validation will not prevent a user from submitting a document if the logic defined in the rule above is true, but it will display a warning, so they are aware they may need to revise the data in their document.
• Action Message: This is the text that will display for the user. This must be plain text.
• Area Name: The value you want to display in the Validation Lightbox for Proposal Area on this validation.
• Section Name: The value you want to display in the Validation Lightbox for Proposal Section on this validation.
• Page Id: The ID associated with the Page you want this validation to link to in the Proposal.  The Page IDs are listed at the bottom of the article.
• Section Id: The ID associated with the Section of the Page you want this validation to link to in the Proposal.  The Section IDs are listed at the bottom of the article.
• Name: This is the name of this action. It must be unique within the Namespace of your Agenda.
• Description: This is an optional field where you can add details about the purpose of this action for future administrators.

Once you have entered all the information for your Action press the Add Rule button.  This will take you back to the Agenda. You can now finalize your Agenda by pressing Submit, or build additional rules.

Proposal Development FixIt Mapping Values 

Tab	Section Name	Page Id	Section Id
Proposal Details	N/A	PropDev-DetailsPage	PropDev-DetailsPage-Section
S2S Opportunity Search	Opporunity	PropDev-OpportunityPage	PropDev-OpportunityPage-General
	Forms	PropDev-OpportunityPage	PropDev-OpportunityPage-Forms
	Submission Detail	PropDev-OpportunityPage	PropDev-OpportunityPage-SubmissionDetails
	User Attached Forms	PropDev-OpportunityPage	PropDev-OpportunityPage-UserAttachedForms
Delivery Info	N/A	PropDev-DeliveryInfoPage	PropDev-DeliveryInfoPage-Section
Sponsor & Program Info	N/A	PropDev-SponsorProgramInfoPage	PropDev-SponsorProgramInfo-DefaultDetailsSection
Organization and Location	Applicant Organization	PropDev-OrganizationLocationsPage	PropDev-ApplicantOrganizationPage-Section
	Performing Organization	PropDev-OrganizationLocationsPage	PropDev-PerformingOrganizationPage-Section
	Performance Site Locations	PropDev-OrganizationLocationsPage	PropDev-PerformanceSitesPage-Section
	Other Organizations	PropDev-OrganizationLocationsPage	PropDev-OtherOrganizationsPage-Section
Personnel	Details	PropDev-PersonnelPage	PropDev-PersonnelPage-Details
	Organization	PropDev-PersonnelPage	PropDev-PersonnelPage-Organization
	Extended Details	PropDev-PersonnelPage	PropDev-PersonnelPage-ExtendedDetails
	Degrees	PropDev-PersonnelPage	PropDev-PersonnelPage-Degrees
	Unit Details	PropDev-PersonnelPage	PropDev-PersonnelPage-UnitDetails
	Person Training Details	PropDev-PersonnelPage	PropDev-PersonnelPage-TrainingDetails
	Proposal Person Certification	PropDev-PersonnelPage	PropDev-PersonnelPage-Questionnaire
Credit Allocation	N/A	PropDev-CreditAllocationPage	PropDev-CreditAllocation-Section
Compliance		PropDev-CompliancePage	PropDev-CompliancePage-Section
Attachments	Proposal Attachments	PropDev-AttachmentsPage	PropDev-AttachmentsPage-ProposalSection
	Personnel Attachments	PropDev-AttachmentsPage	PropDev-AttachmentsPage-PersonnelSection
	Abstracts	PropDev-AttachmentsPage	PropDev-AttachmentsPage-AbstractsSection
	Internal Attachments	PropDev-AttachmentsPage	PropDev-AttachmentsPage-InternalSection
	Notes	PropDev-AttachmentsPage	PropDev-AttachmentsPage-NotesSection
Questionnaire	N/A	PropDev-QuestionnairePage	PropDev-QuestionnairePage-Section
Preproposal Forms*	N/A	PropDev-PreproposalFormsPage	PropDev-PreproposalFormsPage-Section
Budget	N/A	PropDev-BudgetPage	PropDev-BudgetPage-Collection
Supplemental Information	N/A	PropDev-SupplementalPage	PropDev-Supplemental-Section

*requires additional configuration to enable; more information found here.

Section Codes for Supplemental Data

To point a Fix It button at a specific Supplemental Data Section right click on the tab in Chrome and select Inspect.

This will open the browser console with the code relating to your Custom Data tab.  Select the data-tabfor value from the <li> tag at the top of the code snippet and list it in the Section ID of your KRMS validation. 

FYI, to set up a validation rule around Custom Data that allows for multiple entries via a multi-select Arg Value field you can set it up with certain formatting.  If nothing is selected, the value in the field should be [null], including the brackets. And if something is selected, you reference it with the brackets and quotes .  For example [“Selected Item”].