Define System Field Labels

Prior to configuring field characteristics, the administrator should centrally define the naming conventions utilized by the system fields within forms, lists, searches, downloads and reports. As some fields are utilized in multiple locations within the Governance Portal (e.g. the system field "IndcDefName" refers to the indicator definition name and appears on a variety of forms, lists, searches, downloads, and reports), label changes made at the system field level are applied to all instances of the label as it appears on forms, lists, searches, downloads, and reports

Note: System field labels for non-configurable objects also appear in the System Fields area. For example, the organizational unit form is not configurable. However, the OrgUnitName field appears in the Systems Fields area. While OrgUnitName is not an attribute of a configurable system object (e.g. organizational unit), this field appears in searches that are configurable, and is thus represented in the System Fields area. Changes made to field labels pertaining to non-configurable system objects (e.g. organizational unit) will not be reflected on the applicable system object form (e.g. organizational unit form), but will be reflected in other configurable forms and / or searches that refer to the field.

The same name may be used for a field as it is displayed in forms, lists, searches, downloads, and reports. Or variations of the name may be used for each of the five labels. It is recommended to include a prefix for the search field to establish field context as it will be displayed with fields from other areas of the Governance Portal when creating the search (e.g. include Indic. in front of the field label rationale to indicate this field data pertains to indicator rationale and not another area of the Governance Portal). Name changes to these fields will display in searches, and they will also flow through to reporting.

  1. Access System Fields.
  2. Click Edit next to the name of the system field to change.

    Note: Click Edit All to place all listed system fields in edit mode.

  3. Apply Object Type Filter to narrow down the field list.

    System Fields - Edit

  4. Make required changes.

    Note: In Edit Mode, sorting, pagination and filter capability is disabled.

  5. Click icon- Save.

    Note: Click Save All if you utilized the edit all functionality. Once an update is saved, the screen will return to non-editable mode.

The properties of System Fields are described below:

Properties

Definition

Field ID

It is a unique ID for the field.

Object Type

It denotes the object type of a particular field.

Field Name

It displays the name of the field.

Label

It is the field name which displays across all forms.

Description

It gives a brief summary of the field.

Label List

It is the field name which displays across all list forms.

Label Report

It is the filed label which would appear in reports.

Label Search

It is the filed label which would appear in searches.

Label Spreadsheet

It is the filed label which would appear in downloaded spreadsheets.

Report Filter

It governs whether which fields would appear for filtering on reports

Security Source

It governs the field level security for an editable search.

Enabled

It denotes that the field is available throughout the portal, when set True.

Searchable

It determines if this field can be included in a search.

Note: This field becomes false automatically when Enabled is False. By Default Enable and Searchable fields are set True for all fields.

Required

It marks the field as required for an editable search.

Wrap

It wraps the field data in searches.

Max Characters

It specifies the maximum length for a field in a search.

Decimal Places

It enables user to enter/view decimal/precision to a numeric field in a search.

Time Displayed

It enables user to enter/view time as well for date fields in a search.

Notes:

  • The fields which were present in the Core Searches will have the Searchable checkbox selected by default.
  • View Definition fields are directly controlled from the System Fields.
  • Security Source, Enabled, Searchable, Required, Wrap, Max Characters, Decimal Places, and Time Displayed fields are governed through System Fields for both Editable/Non-Editable searches.

See Also

Data Model

Manage View Definitions

Configure Object Types

GP - Sec - Create a View Definition