Integration tags are defined in the following database views:
- nFORMExport.VW_SITE_EXPORT - Imports data from nFORM into nCORE SITE details.
- nFORMExport.VW_SUBM_EXPORT - Imports data from nFORM into nCORE SUBM details (applications, complaints, etc.).
- nFORMExport.VW_FEATR_EXPORT - Imports data from nFORM into nCORE FEATR details.
- nFORMExport.VW_CONTCT_EXPORT - Imports data from nFORM into nCORE CONTCT details.
Document attachments are always imported from an nFORM submission and attached to the Submission record in nCORE. If a description has been provided for the document within the nFORM attachment control, the description will be carried forward into nCORE.
Site Integration into nCORE (including Person and Organization)
nFORMExportnFORM Target IDThis is used in conjunction with SITE_RLNSHP_TYPE_DESCR below.
Mapping will only be inserted if both SITE_RLTD_SITE_NUM and SITE_RLNSHP_TYPE_DESCR are supplied and are valid.
Permits
Section Tag Value = PRMT
A section tagged PRMT should only be included on Permit Change forms or Compliance Schedule forms. Since Permit Change forms (e.g., modifications, renewals) and Compliance Schedules (e.g., annual reports, notifications) are typically used in the context of an existing, in-effect permit, including a PRMT section on these forms provides a convenient way of automatically displaying information about that permit on the form. For example, the permit number and issue date can be displayed at the beginning of the form so that the applicant can confirm that they are filling out the form for the correct permit.
A maximum of one permit can be specified on a form using these tags. The PRMT section should never be marked repeatable. Information about other permits can be collected on the form but the controls for these permits should be given tag values that are not in the reserved list below.
Permit Change forms and Compliance Schedules can also contain site information, but this should be done by using a section tagged SITE containing the appropriate SITE tagged controls.
Tag Name
Data Type
Length
Description
Submission Import Behavior
PRMT_ID
bigint
n/a
Internal Permit unique identifier. Not user editable
If specified, indicates the permit (and site) to which the submission will be related
PRMT_NUM
nvarchar
50
Permit Number
NOT SUPPORTED
PRMT_VERSN
int
n/a
Permit Version
NOT SUPPORTED
REF_PRMT_CATG_DESCR
nvarchar
255
Permit Category
NOT SUPPORTED
REF_PRMT_STAT_DESCR
nvarchar
255
Permit Status
NOT SUPPORTED
ISSUE_DATE
text
10
Permit Issue Date. Read-only. Only available for prepopulation.
Not imported from a submission into nVIRO
NOT SUPPORTED
EFCTV_DATE
text
10
Permit Effective Date. Read-only. Only available for prepopulation.
Not imported from a submission into nVIRO
NOT SUPPORTED
EXPR_DATE
text
10
Permit Expiration Date. Read-only. Only available for prepopulation.
Not imported from a submission into nVIRO
NOT SUPPORTED
PERMT (contact control)
n/a
n/a
Permittee
Yes. The contact will be created with affiliation type “Permittee” on the application record in SCEP
Submission Integration into nCORE
nFORM control tag mapping is defined in nFORMExport.VW_SUBMFeature Integration into nCORE
nFORM control tag mapping is defined in nFORMExport.VW_FEATR_EXPORT. Integration logic is defined in dbo.SP_nFORM_STG_TO_SUBM_FEATR.
Feature information is gathered from nFORM sections tagged either SITE or FEATR.
For FEATR-tagged sections, the section can be repeating to create multiple features. A feature will be created for every instance of the section if one does not exist and an nFORM location control has been placed on the form.
If an existing Feature is found with a matching FEATR_ID_TXT, the feature will be updated with all fields. If a feature is not found with a matching FEATR_ID_TXT, a new feature will be created upon import.
Feature Identifier business key (e.g. "001")
Contact Integration into nCORE
nFORM control tag mapping is defined in nFORMExport.VW_CONTCT_EXPORT. Integration logic is defined in dbo.SP_nFORM_STG_TO_SUBM_CONTCT_AFFIL.
Contacts are always created from nFORM Contact Controls.
The Affiliation Type assigned to the contact upon import is determined when either
The Label value on the nFORM contact control matches a Description from REF_AFFIL TYPEOnly one SUBM record is ever associated with a given nFORM submission.
This value is mapped to the Description column from REF_APP_REQST_ACTN_TYPE.
If not supplied, import will fall back to Form's Action/Deadline setting for mapped nFORM Reason Type.
- If multiple contact controls need to map to a single affiliation type in the same section, use the "+" sign to add text at the end of the tag to retain uniqueness. For example, a contact control with tag CMPLNT+TEST1 will yield a contact with affiliation type CMPLNT.
A single contact can be assigned multiple affiliations by adding a separate single or multi-select nFORM control with the tag AFFIL in the same section as the contact control.
When the Applicant is also the Site, the contact control may be used to create both (Contact control Label "Applicant" and Contact control Tag = "SITE"). Note: The Site Name comes from contact Company Name / Organization field. Do not use first name/last name.
Saves the tag mapped to "phone" as the REF_PHONE_TYPE_CODE = "OFFICE" phone. Appears to be for legacy form use only.
Uses FN_FORMAT_PHONE to format the phone number.
Saves phone_0, phone_1... phone_3 to distinct phone records of different phoneType.
Uses FN_FORMAT_PHONE to format the phone number.
Saves the phoneType of phone_0, phone_1... phone_3 to distinct phone records of different phoneTypes.
- WHEN phoneType = "BUSINESS" THEN "OFFICE"
- WHEN phoneType = "MAIN" THEN "OTHER"
- ELSE phoneType END
Integration from nCORE into nFORM (prepopulation)
Prepopulation form nCORE into nFORM is accomplished through nFormImport.SOURCE_* views where the view name suffix indicates the section tag to populate.
| Info |
|---|
To prepopulate forms, Pre-fill → Import from External Source (SQL) must be checked, the section must have Enable Form Pre-Fill (via Context ID) checked, and the Section Tag should be set to view name suffix of the source name eg. (SITE, PRMT, or FEATR, ) |
Available sources are:
Sites
Populated from view: nFormImport.SOURCE_SITE
This view may also pre-populate a contact control (e.g., for a Person or Org) by using "SITE" as the contact control taban Affiliation Type Code (e.g. “APPLCNT”)
If no matching Affiliation Type Code or Description is found for the contact, nCORE will assign the generic Affiliation Type “Contact” to the submission contact.
Allowing a User to Assign One or More Affiliation Types to a Contact
Often a form needs to allow the user to select one or more roles to assign a contact. To achieve this:
Add a Contact control to the section. The Tag value is not important.
Add a single or multi-select nFORM control. Set the Tag to ‘AFFIL’ and set the values to one or more Affiliation Type descriptions.
When this configuration is used, the section may only contain one contact control. Otherwise, the system would not know which contact to assign the selected Affiliation Types to. The section can be set to repeating if multiple contacts with different Affiliation Types are needed.
Configuring Multiple Contact Controls with the Same Affiliation Type
Form design rules require that all tags in a form are unique, but this could cause a challenge if two or more contact controls need to be tagged with the same Affiliation Type Code. To overcome this limitation, use the + sign to add text at the end of the tag to create a unique tag value. For example, a contact control with tag CMPLNT+TEST1 will yield a contact with affiliation type CMPLNT.
Configuring a Contact Control to Update Site (Person) Details
A common scenario for license forms will require that a Contact control be used to update the Site (Person) Details. When the Applicant is also the Site, the contact control may be used to create both. To achieve this, the Contact control Label can be set to "Applicant" and Tag can be set to "SITE".
Note: The Site Name comes from contact Company Name / Organization field. The first name/last name fields are only used for updating Person sites.
Creating Submission Contacts and Site Relationships from a Site Lookup
See the Relating Sites in a Submission article for more information on configuring form controls to reference a list of other sites, organizations, or persons, and then create submission contacts or site relationships based on the selection in a submission.
Contact Control Field to nCORE Contact Database Field Mapping
The following table provides a mapping from individual fields on the nFORM contact control to nCORE Contact fields.
Control Tag | nCORE Target Field | Description |
|---|---|---|
Type | AFFIL.REF_AFFIL_TYPE_CODE | After contacts are added to CONTCT, affiliations are inserted into the AFFIL table linking each contact record with 1..many affiliation types matching the REF_AFFIL_TYPE_CODE. |
Title | CONTCT.TITLE | |
prefixNames | CONTCT.PREFIX | |
formula | CONTCT.CONTCT_NAME | Complex formula using either the company name or a concatenation of first and last names. |
firstName | CONTCT.FIRST_NAME | |
lastName | CONTCT.LAST_NAME | |
companyName | CONTCT.ORG_NAME | |
CONTCT.EMAIL | ||
phone | PHONE.PHONE | Saves the tag mapped to "phone" as the REF_PHONE_TYPE_CODE = "OFFICE" phone. Appears to be for legacy form use only. Uses FN_FORMAT_PHONE to format the phone number. |
phone_0..3 | PHONE.PHONE | Saves phone_0, phone_1... phone_3 to distinct phone records of different phoneType. Uses FN_FORMAT_PHONE to format the phone number. |
phoneType_0..3 | PHONE.REF_PHONE_TYPE_CODE | Saves the phoneType of phone_0, phone_1... phone_3 to distinct phone records of different phoneTypes.
|
extension_0..3 | PHONE.PHONE_EXT | Saves the extension of phone_0, phone_1... phone_3 to distinct phone records of different phoneTypes. |
extension | PHONE.PHONE_EXT | Saves the tag mapped to "extension" as the REF_PHONE_TYPE_CODE = "OFFICE" phone. Appears to be for legacy form use only. |
fax | PHONE.PHONE | Saves with REF_PHONE_TYPE_CODE = "FAX". |
street | CONTCT.ADDR_1 | |
street2 | CONTCT.ADDR_2 | |
locality | CONTCT.CITY | |
areaCode | CONTCT.REF_STATE_CODE | |
countryCode | CONTCT.REF_CNTRY_CODE | |
postalCode | CONTCT.ZIP_CODE | |
county | unmapped | |
description | CONTCT.ADDR_CMNTS | Labeled as “Location Description” on screen |
Document Integration from nFORM into nCORE
Submission PDF
nFORM produces a PDF document containing the information provided in the submission form. The naming convention of the PDF is configurable in the Form Details screen.
Submission Attachments
Document attachments are always imported from an nFORM submission and attached to the Submission record in nCORE. If a description has been provided for the document within the nFORM attachment control, the description will be carried forward into nCORE.
Integration from nCORE into nFORM (prefill)
Prepopulation from nCORE into nFORM is accomplished through nFormImport.SOURCE_[SUFFIX] views where the view name suffix indicates the section tag to populate.
Prerequisite
To prepopulate forms, Pre-fill → Import from External Source (SQL) must be checked:
For each Section that will require prefill, the Enable Form Pre-Fill (via Context ID) field must be checked and the Section Tag should be set to view name suffix of the source name eg. (SITE, PRMT, or FEATR, )
Available sources are:
nCORE - nFORM Integration Tags#Sites
nCORE - nFORM Integration Tags#Submissions
nCORE - nFORM Integration Tags#Permits
nCORE - nFORM Integration Tags#Features
Other sources can exist depends on clients needs.
Site Prefill into nFORM
Populated from view: nFormImport.SOURCE_SITE
Available standard data for pre-population in a section tagged SITE are:
Tag | Name | Control Type | Notes |
|---|---|---|---|
SITE_NUM | Site Number | Text Control | |
SITE_NAME | Site Name | Text Control | |
SITE | Site Location | Location Control | This will populate a location control with site coordinates |
SITE_ADDR | Site Address | Contact Control | This will populate contact control or Address control tagged SITE_ADDR |
SITE_CNTY | Site County | Text Control | |
SITE_ADDR_CMNTS | Site Address Comments | Paragraph Control | |
TAX_PARCEL_NUM | Tax Parcel Number | Text Control | |
REF_OWNRSH_TYPE_DESCR | Ownership Type | Text Control | |
SITE_LUG_NAME | Site Lug Name | Text Control | |
SITE_WATERBODY_NAME | Site Waterbody Name | Text Control | |
SITE_SIC | Site SIC Codes | Text Control | Any control that supports binding to dynamic datasource. Set up the control to use the SIC_CODES datasource. The binding assumes dbo.REF_SIC.CODE = nform.LOOKUP_VALUE.NAME |
SITE_NAICS | Site NAICS Codes | Text Control | Any control that supports binding to dynamic datasource. Set up the control to use the NAICS_CODES datasource. The binding assumes dbo.REF_NAICS.CODE = nform.LOOKUP_VALUE.NAME |
SITE | Contact | Contact Control | For modifying PERSON records, the Contact control can be used. |
Submission prefill into nFORM
Populated from view: nFormImport.SOURCE_SUBM
This view is primarily used for:
Populating data about the submission's parent Schedule
Populating the Alternate Identity in the Submission Header
Schedule Due Date (that should typically be set to Read Only when populated)
Schedule Name (see Notes below on what it contains)
Available standard data for pre-population in a section tagged SUBM are:
Tag | Name | Control Type | Notes |
|---|---|---|---|
SUBM_REF_NUM | Submission Number | Text Control | |
SCHD_DUE_DATE | Schedule Due Date | Date Control | |
SCHD_NAME | Schedule Name | Text Control | If there is a Custom name then that takes the priority over Schedule type name. |
SCHD_EXTRNL_DISP_TXT | Schedule External Display Text | Text Control | Instructions provided by the agency to the external user for a schedule. |
SCHD_CNTXT_FUNC_AREA | Schedule Context Functional Area | Text Control | Returns |
Populating the Alternate Identity with the nCORE-generated submission number
| Warning |
|---|
MiWaters - Do Not Use! - This paradigm should not be used in MiWaters forms that require a fee, as the Alternative Identity stores the Hotkey for fee receipt |
The nCORE source view nFormImport.SOURCE_SUBM can be used to populate the nCORE-generated submission number into the nFORM Alternate Identity, making this available on the Submission Wizard Header and Submission Summary screen:
Create a new section (or use an existing section), and tag it SUBM, and enable it for prefill
Create a new short-text control tagged SUBM_REF_NUM and make it "Read Only"
At the form version level in the "Details" Section, check box "Activate Display of Alternate Submission Identifier"
Check newly-displayed box "Override Display Label", and enter label of your choice
Permit prefill into nFORM
Populated from view: nFormImport.SOURCE_PRMT
Sections must have a Tag set to ‘PRMT’ in order to prefill permit data into the section.
Since permit information is never updated in nCORE upon submission receipt, any controls tagged for Permit data prefill controls should set to read-only.
A maximum of one permit can be specified on a form using these tags. The PRMT section should never be marked repeatable. Information about other permits can be collected on the form but the controls for these permits should be given tag values that are not in the reserved list below.
A section tagged PRMT should only be included on Permit Change forms or Compliance Schedule forms. Since Permit Change forms (e.g., modifications, renewals) and Compliance Schedules (e.g., annual reports, notifications) are typically used in the context of an existing, in-effect permit, including a PRMT section on these forms provides a convenient way of automatically displaying information about that permit on the form. For example, the permit number and effective date can be displayed at the beginning of the form so that the applicant can confirm that they are filling out the form for the correct permit.
Permit Change forms and Compliance Schedules can also contain site information, but this should be done by using a section tagged SITE containing the appropriate SITE tagged controls.
Available standard data for pre-population in a section tagged
Permits
Populated from view: nFormImport.SOURCE_PRMT
Available standard data for pre-population in a section tagged PRMT are:
Features
Populated from view: nFormImport.SOURCE_FEATR
Available standard data for pre-population in a section tagged FEATR are:
On this page
| Table of Contents |
|---|
Sub-Topics