Site Types and Site Alternative Name Types
Overview
A site, person, or organization can be assigned one or more Site Types. Site Types provide the ability to classify records for use when filtering reporting.
Managing Site Types
Site Types can be added to a site either manually by an internal user from the Site Details screen, or by configuring a form to add the site type automatically as part of form integration configuration.
Adding or Editing a Site Type
On the Site Type list page, either click the Add New Site Type button or click a row to view and/or edit an existing project type. The Edit Project Type page opens:
The following fields are displayed on the Site Type page:
Field | Description |
|---|---|
Site Type Code | A unique code for the site type. |
Site Type Description | A descriptive name for the site type. |
Applicable Category | The applicable category is used to restrict the availability of site types when a user is creating a new site. Select the category for which the site type can be specified (e.g., Organization, Site, Person), or if the site type is valid for all site categories, leave it unspecified (blank). For example, if a user is creating a new Organization site, the site types they can select are limited to those with Applicable Category of Organization or unspecified. |
Saving Changes
To save changes, click the Save button. A message box opens, prompting the user to confirm the save. To cancel saving or to return to the list after saving, click the Cancel button.
Site Alternative Name Types
Site Alternative Name Types are used to classify alternative names for a site. For example, a Site Alternative Name Type of "National Inventory of Dams (NID) Number" where the value is the Assigned NID dam number.
Site Alternative Name Types are administered directly in the database. There is no screen for managing this data.
Column | Description |
|---|---|
CODE | A unique code for the site alternative name |
DESCR | The site alternative name description
|
PREFIX_CODE | Specifies the prefix used on the automatic number to be generated. For use when Alternative Names are auto-generated. See the following section for more information. |
TTL_NUM_CHARS | Specifies the total number of characters to be used when auto-generating a site alternative name. For use when Alternative Names are auto-generated. See the following section for more information. |
SEQ_LAST_USED | Stores the last number used in an auto-generated site alternative name. For use when Alternative Names are auto-generated. See the following section for more information. |
IS_UNIQUE | Indicates that the site alternative name can only be added once to a site. Once added, the same alternative name cannot be added again to the same site. |
IS_SYS_GNRTD | Indicates that the site alternative name is system-generated. Users cannot manually add system-generated site alternative names |
IS_DISP_SITE_SEARCH | Indicates that the site alternative name is indexed as part of the Site Search |
IS_NFORM_LOOKUP | Indicates that the site alternative name should be available as a lookup in nFORM form design for display in drop down and type-ahead boxes. |
Automatically Generate a Site Alternative Name when a Site Type is added to a Site
Site Alternative Names can be created automatically when a Site Type is added to a site. The Site Type can be added manually by an internal user or via nFORM Submission integration (which requires the correct use of integration tags).
If PREFIX_CODE, TTL_NUM_CHARS, and SEQ_LAST_USED are populated in the REF_SITE_ALT_NAME_TYPE table, it is considered to be a system generated alternative name using the prefix and total number of digits specified.
For example, an agency wants to automatically generate a National Inventory of Dams (NID) number when a site type of "Dam" is added to a site. The dam number should be in the format "D-1000," where 1000 is a sequence number that should be incremented with each new dam.
The following steps would be performed to enable this capability:
Add a Site Type with a code "DAM" and description "Dam".
Add a Site Alternative Name Type to the database with code "NID" and description "NID Number". Set the prefix code to "D-", set the total number of characters to 6, and set the sequence last used to 1000.
Link the Site Type(s) to the Site Alternative Name by adding a linking record to REF_SITE_ALT_NAME_TYPE_TO_REF_SITE_TYPE (this must be performed in the database).