KNS parameters are used throughout Rice. They reside in special system tables that are used for configuring the system during runtime. Parameters control whether certain features are turned on or off. They also establish default values within the Rice system or by a process such as validation.
To access the Parameter Lookup screen:
Go to the Rice Main Menu screen
Locate the KNS Maintenance Documents section of the page
Click Parameter Lookup
There are two ways to search for information on specific parameters:
Enter information about the parameter in one or more fields on the Parameter Lookup screen, then click the Search button. This displays a list of parameters that match the information you entered, similar to the list in the screen print below.
Leave the fields on the Parameter Lookup screen blank and click the Search button. This displays a list of all available KNS parameters, similar to this:
You can sort the list of parameters in ascending or descending order by one column by clicking the appropriate column heading. If you want to save the list, you can export the entire list in CSV, spreadsheet, or XML format.
Click a Namespace Code in the list of parameters to display more information about that code.
You arrive at this screen by clicking a Parameter Name on the Parameter Lookup list.
In Rice, Parameters control key aspects of how the system operates.
Getting to the Parameter Maintenance screen requires that you have permission to use the Administration screens in KRice. You can go directly to the Parameter Maintenance screen by:
Click the Administration tab
Look under Configuration
Click Parameter
KNS Parameters can be created and edited by selecting the Parameter option on the Rice Administration screen.
After selection you will be presented with the Parameter Maintenance Document screen. The picture below is the complete screen with all tabs hidden. By default the Document Overview and Edit Parameter tabs are shown (i.e. open) when this screen is first accessed.
The system will automatically assign a new document number every time this screen is accessed. The Initiator, Status and Created information will also automatically be filled in.
The Notes and Attachments tab, the Ad Hoc Recipients tab, the Route Log tab, and the buttons at the bottom of this screen perform standard functionality as described in the Common Features and Functionality document found in the Global section of the User Guide.
The following descriptions apply to the fields in the upper right hand corner of the screen.
Table 5.1.
| Field Name | Description |
|---|---|
| Doc Nbr | The document id is generated by the workflow environment and is unique to each installation of Kuali. It is system generated. |
| Initiator | The user name of the person who created the document. |
| Status | This represents the status of this document. (Initiated, Enroute, Final) |
| Created | The date and time that this document was created. It is system generated. |
Table 5.2.
| Field Name | Description |
|---|---|
| Description | Required. A description of the request itself, not the parameter. This text should briefly describe why the request is being made. |
| Org Doc # | Also sometimes simply referred to as document number. A unique system assigned number used to identify each document. |
| Explanation | Free form text which provides a detailed description of the request. |
Table 5.3.
| Field Name | Description |
|---|---|
| Namespace Code | Required. This value is used to categorize parameters by namespace. |
| Parameter Component | Required. Code identifying the parameter Component. |
| Parameter Name | Required. This will be used as the identifier for the parameter. Parameter values will be accessed using this field and the namespace as the key. Note – spaces are not allowed in this field |
| Parameter Value | Required. This field houses the actual value associated with the parameter. This is what's returned by the KualiConfigurationService. |
| Parameter Description | Required. This field houses the purpose of this parameter. |
| Parameter Type code | Required. Code identifying the parameter type. Parameter Type Code is the primary key for its table. |
| Parameter Constraint Code | Required. Code identify the constraints that apply. |
There are eight mandatory fields on the Document Overview and Edit Parameter tabs that must be filled in before pressing the submit button. If the system finds any errors it will return the screen with the fields in error identified, otherwise the system will respond with the Parameter Maintenance Document screen showing that the:
document was successfully submitted
new document number for the document
status is now ENROUTE
actual creation date and time
You’ll also notice that the screen has changed and now has different buttons at the bottom. Click the close button to close the current screen and return to your starting point.