Configuring Program Component Forms
Overview
Program component forms allow agencies to display and edit custom fields that aren’t included on nVIRO’s standard pages. Program component forms are configured in nVIRO via the Forms page. Form sections and controls are defined using the nFORM Form Designer.
Searching Program Component Forms
To find and view a program component form, navigate to Admin > Forms.
Creating and Editing Program Component Forms
As with other form types, details for program component forms are configured on the Form Details page. Creating a new program component form requires three main steps:
Creating a new program component form
Designing the form in nFORM
Editing the form details in nVIRO
Creating a New Program Component Form
A program component form is created in the same way as any other form. To create the form:
Navigate to Admin > Forms.
Click the Add New Form button. The Add a New Form dialog box appears.
In the Create Form From field, select either the “New Blank Form” or “Copy an Existing Form” option.
Regardless of the selection in the previous field, select the “Component Form” option in the New Form Use Type field. If copying an existing form, the Component Source Form field will appear, in which the form to copy should be selected.
Click the Create Form button. New forms are created as blank nFORM forms with the name
New Form Created by [username] on [datetime]
. Form copies are namedCopy of [Component Source Form Name]
. The Form Details page opens on the current tab, and the nFORM Form Designer opens in a new tab.
Designing the Form in nFORM
Once a program component form has been created, design it using the nFORM Form Designer. For information on using the Form Designer, see the Form Design Guide.
Editing the Form Details in nVIRO
After the form has been designed, return to the tab with the Form Details page open in nVIRO. To reopen the form in the nFORM Form Designer later, click the Manage in nFORM button in the ride sidebar of this page.
The following navigation tabs appear across the top of the page:
Details: Contains form details, such as name and type.
Tags: Contains information about the form’s sections and controls and the tags associated with them.
The Details tab contains the following fields:
Field | Description | Notes |
---|---|---|
Short Form Name | An internal name for the form. | This may be helpful if the external form name is quite long. Entering a short form name may help ease readability and conserve space on list pages. If a short form name is not entered, the full form name appears in internal contexts. |
Form Type | The form type. | For program component forms, the form type will always be “Program Component.” |
Component Type | The component type to which the form relates. | A program component form must be related to a component type to be used. The component type specifies the context in which a program component form can be used and other behavioral settings. |
Along with the Manage in nFORM button, the ride sidebar also lists the publishing status of the form, the nFORM form tag, the form edit history, the Validate Form button, and the View History button. Clicking the Validate Form button runs validation rules and displays a panel with any errors or warnings that need to be addressed. Clicking the View History button displays a record of changes made to the form details over time.
See the nCORE Form Validation page for additional information related to form validations.
Form design changes are not displayed in nVIRO. nFORM offers form versioning and the ability to compare form versions.
Restricting Program Component Editing to Specific Workgroups
Program component forms are editable by default. However, an agency may take the following steps to limit the ability to edit program components to specific workgroups:
Navigate to Admin > Lookups > Component Types.
Open the desired component type and scroll to the Permissions and Security section.
In the Workgroups field, select workgroups that should have access to edit the component type. Users belonging to workgroups that are not selected will only be able to view program component forms of the selected component type. If no workgroups are selected, any internal user can edit these program component forms.
On this page
Related Content