This article describes how data is integrated between nFORM and nCORE for the purposes of both (1) prepopulation of new submissions and (2) population of nCORE data elements from new nFORM submissions (round-tripping)

Integration from nFORM into nCORE

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)

nFORM control tag mapping from nFORM to nCORE is defined in nFORMExport.VW_SITE_EXPORT. Integration logic is defined in dbo.SP_nFORM_STG_TO_SUBM_SITE.

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.

Submission Integration into nCORE

nFORM control tag mapping is defined in nFORMExport.VW_SUBM_EXPORT. Integration logic is defined in dbo.SP_nFORM_STG_TO_SUBM.

Only one SUBM record is ever associated with a given nFORM submission.

Feature Integration into nCORE

Anchor
FormFeatureIntegration FormFeatureIntegration

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 whose control tags are prefixed with the text SITE or FEATR, or contains a Location control. For example, if a control in a section is tagged `FEATR_CARWASH`, the import process will attempt to insert or update a feature. There are no requirements around section tag names for data import; it is based entirely on the section's control data.

The integration logic can only create or update one feature record per section. 

Sections can be repeating to import multiple features.

Inserting versus Updating Features

nCORE will only create new features if a Feature Type is specified in the submission data. The Feature Type can be specified using any of the following methods:

1. Include a Location control whose label matches an existing Feature Type Description, or
2. Include a Location control whose tag matches an existing Feature Type Code, or
3. Include a pre-populated, hidden text control whose default value matches a Feature Type Code or Description, or
4. Include a single select control whose dropdown values match an existing Feature Type Description.

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.

Control Tagging Rules

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 usually created from nFORM Contact Controls.

The Affiliation Type assigned to the contact upon import is determined when either

1. The Label value on the nFORM contact control matches a Description from REF_AFFIL TYPE, or 
2. The nFORM contact control's Tag matches a Code from REF_AFFIL_TYPE
   1. If multiple contact controls in the same section need to map to a single affiliation type, 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.  

Site Alternate Name Contact Creation

Anchor
Site_Alt_Name_Contact Site_Alt_Name_Contact

Submission contacts can also be created from a control referencing an nFORM lookup populated from nCORE Site Alternate Name Types. In order for the contact to be created:

1. The nFORM control must reference an nFORM lookup where the lookup name matches a valid Site Alternate Name Type Code
   1. See the following page for more info on populating an nFORM lookup from Site Alternate Names: Populating nFORM Lookups from nCORE 
2. The control must map to a valid nCORE Affiliation Type via:
   1. The Label value on the nFORM contact control matches a Description from REF_AFFIL TYPE, or 
   2. The nFORM contact control's Tag matches a Code from REF_AFFIL_TYPE
      1. If multiple contact controls in the same section need to map to a single affiliation type, 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.

Integration from nCORE into nFORM (prepopulation)

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:

Section Tag should be set to view name suffix of the source name eg. (SITE, PRMT, or FEATR, )

Available sources are: 

• 574127851
• 574127851
• 574127851
• 574127851
• Other sources can exist depends on clients needs. 

Sites

Anchor
Sites 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 tab.

Available standard data for pre-population in a section tagged SITE are:

Submissions

Anchor
Submissions Submissions

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:

Populating the Alternate Identity with the nCORE-generated submission number

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:

1. Create a new section (or use an existing section), and tag it SUBM, and enable it for prefill
2. Create a new short-text control tagged SUBM_REF_NUM and make it "Read Only"
3. At the form version level in the "Details" Section, check box "Activate Display of Alternate Submission Identifier"
4. Check newly-displayed box "Override Display Label", and enter label of your choice 

Permits

Anchor
Permits Permits

Populated from view:  nFormImport.SOURCE_PRMT

Available standard data for pre-population in a section tagged PRMT are:

Features

Anchor
Features Features

Populated from view:  nFormImport.SOURCE_FEATR

Feature data can be filtered for prefill/autofill into nFORM Submissions by using a special Tag syntax on the Section where the feature type code to filter for is suffixed onto the tag after a dollar sign. For example Tag FEATR$FOO would filter only for features of feature type code FOO. 

Available standard data for pre-population in a section tagged FEATR are: