This article describes how to configure data is integrated integration between nSPECT and nCORE.

Configuring

nCORE/nSPECT Integration

The nCORE "Evaluation Type" and the nSPECT "Inspection Type" drive the initial data integration between the two systems. Inspections are scheduled in nSPECT via the Evaluation Type provided by nCORE. first step in configuring inspection integration between nCORE and nSPECT is setting up one or more nCORE Evaluation Types to integrate with nSPECT.

When a new Evaluation Type is added to nCORE, a new Inspection Type will be added to nSpect nSPECT when the user clicks the checkbox "Enable nSPECT Integration" and saves the record:

Image Modified

Once the "Enable nSPECT Integration" checkbox is clicked, a number of additional settings are displayed, as shown in the image above:

1. Set Inspection Report to "Final" Status when nSpect Inspection is Completed - the Inspection Report Document will be set to "Final" status in nCORE automatically

2. nSPECT Inspection Report File Type - Can be set to "docx" or "pdf". Default file type is set in APP_DEPLOY_SETTING where CODE = 'NSPECT_RPT_EXT'

3. Default

1. Follow-up Evaluation Type -  If an Inspection Form in nSPECT is configured to schedule a

1. follow-up evaluation, it will be created with the type specified. If no type is specified, the

1. follow-up will be created as the same type as the current inspection. See section Outbound Tags for more information on configuring

1. Follow-up Evaluations.

Configuring Integration Tags in nSPECT

Integration tags are configured on nSPECT questions , and during form design. Integration tags can be used to pass data from nCORE into nSPECT (CME Prefill), and for new inspections and back from nSPECT to nCORE to perform various actions. There are four flavors of data transfer:

when an inspection is complete.

There are three aspects of data integration between nSPECT and nCORE:

1. Using Data Integration Tags to prefill nSPECT Forms with data from nCORE and to update nCORE data from completed nSPECT inspections

2. Using Data Integration Context to populate the nCORE "Inspection Results" tab

Inbound: nCORE Evaluations to nSPECT

Image Removed

Data can be prefilled into nSPECT forms using nCORE data. Data elements are defined in the nSpectImport.CME_INSPECTION_% database views:

1. nSpectImport.CME_INSPECTION_MASTER - base view required for Prefill, defines any non-repeating data elements

2. nSpectImport.CME_INSPECTION_EVAL_CONTCT - prefills repeating contact sections. Pulls all contacts related to the source evaluation (EVAL) record

3. nSpectImport.CME_INSPECTION_PRMT_FEATR - prefills repeating feature sections using features referenced on the source permit. Useful for sampling inspections

Additional repeating or custom views can be developed on client request.

See below for tag definitions for each of the above views:

nSpectImport.CME_INSPECTION_MASTER (non-repeating data)

nSPECT Data Integration Tag

nCORE Database Field Name

Comments

SITE_NUM

SITE.SITE_NUM

Site Number

SITE_SITE_NAME

SITE.SITE_NAME 

Site Name, non-standard tag as SITE_NAME is reserved by nSpect

SITE_ADDR

SITE.ADDR_1, SITE.ADDR_2, SITE.CITY, SITE.REF_STATE_CODE, SITE.ZIP_CODE

Concatenated Site Address fields

SITE_ADDR_1

SITE.ADDR_1 

SITE_ADDR_2

S.ADDR_2 

SITE_CITY

SITE.CITY 

SITE_STATE

SITE.REF_STATE_CODE 

SITE_ZIP_CODE

SITE.ZIP_CODE 

SITE_ADDR_CMNTS

SITE.ADDR_CMNTS

SITE_CNTY

REF_CNTY.DESCR 

PARCEL_NUM

SITE.TAX_PARCEL_NUM

EVAL_NUM

EVAL.EVAL_NUM 

PRMT_NUM

PRMT.PRMT_NUM

Permit information is pulled from corresponding EVAL.PRMT_ID record

PRMT_VERSN

PRMT.PRMT_VERSN

REF_PRMT_CATG_DESCR

REF_PRMT_CATG.DESCR

REF_PRMT_STAT_DESCR

REF_PRMT_STAT.DESCR

REF_PRMT_TYPE_DESCR

REF_PRMT_TYPE.DESCR

PRMT_ISSUE_DATE

PRMT.ISSUE_DATE

PRMT_EFCTV_DATE

PRMT.EFCTV_DATE

PRMT_EXPR_DATE

PRMT.EXPR_DATE

PROJ_NAME

SUBM.RESRC_PROJ_NAME

ICONT_CONTCT_NAME

CONTCT.CONTCT_NAME

Pulled from EVAL.ICONT_CONTCT_ID

ICONT_CONTCT_FIRST_NAME

CONTCT.FIRST_NAME

ICONT_CONTCT_LAST_NAME

CONTCT.LAST_NAME

ICONT_CONTCT_ORG_NAME

CONTCT.ORG_NAME

ICONT_CONTCT_ADDR

CONTCT.ADDR_1, CONTCT.ADDR_2, CONTCT.CITY, CONTCT.REF_STATE_CODE, CONTCT.ZIP_CODE

Concatenated Contact Address fields

ICONT_CONTCT_ADDR_1

CONTCT.ADDR_1

ICONT_CONTCT_ADDR_2

CONTCT.ADDR_2

ICONT_CONTCT_CITY

CONTCT.CITY

ICONT_CONTCT_STATE

CONTCT.REF_STATE_Code

ICONT_CONTCT_PHONE

PHONE.PHONE

PERMT_CONTCT_NAME

CONTCT.CONTCT_NAME

Pulled from PRMT.PERMT_CONTCT_ID

PERMT_CONTCT_FIRST_NAME

CONTCT.FIRST_NAME

PERMT_CONTCT_LAST_NAME

CONTCT.LAST_NAME

PERMT_CONTCT_ORG_NAME

CONTCT.ORG_NAME

PERMT_CONTCT_ADDR

CONTCT.ADDR_1, CONTCT.ADDR_2, CONTCT.CITY, CONTCT.REF_STATE_CODE, CONTCT.ZIP_CODE

Concatenated Contact Address fields

PERMT_CONTCT_ADDR_1

CONTCT.ADDR_1

PERMT_CONTCT_ADDR_2

CONTCT.ADDR_2

PERMT_CONTCT_CITY

CONTCT.CITY

PERMT_CONTCT_STATE

CONTCT.REF_STATE_CODE

PERMT_CONTCT_PHONE

PHONE.PHONE

nSpectImport.CME_INSPECTION_EVAL_CONTCT (repeating data)

nSPECT Data Integration Tag

nCORE Database Field Name

Comments

EVAL_CONTCT_NAME

CONTCT.CONTCT_NAME

EVAL_CONTCT_FIRST_NAME

CONTCT.FIRST_NAME

EVAL_CONTCT_LAST_NAME

CONTCT.LAST_NAME

EVAL_CONTCT_TITLE

CONTCT.TITLE

EVAL_CONTCT_ORG_NAME

CONTCT.ORG_NAME

EVAL_CONTCT_ADDR

CONTCT.ADDR_1, CONTCT.ADDR_2, CONTCT.CITY, CONTCT.REF_STATE_CODE, CONTCT.ZIP_CODE

Concatenated Contact Address fields

EVAL_CONTCT_ADDR_1

CONTCT.ADDR_1

EVAL_CONTCT_ADDR_2

CONTCT.ADDR_2

EVAL_CONTCT_CITY

CONTCT.CITY

EVAL_CONTCT_STATE

CONTCT.REF_STATE_CODE

EVAL_CONTCT_ZIP_CODE

CONTCT.ZIP_CODE

EVAL_CONTCT_PHONE

PHONE.PHONE

EVAL_CONTCT_PHONE_EXT

PHONE.PHONE_EXT

EVAL_CONTCT_EMAIL

CONTCT.EMAIL

EVAL_CONTCT_AFFIL_CONCAT

REF_AFFIL_TYPE.DESCR

Concatenated Contact Evaluation Affiliation (Role) Types separated by commas

nSpectImport.CME_INSPECTION_PRMT_CONTCT (repeating data)

Pulls any contacts related to parent Permit record and populates data into a repeating nSPECT section

nSPECT Data Integration Tag

nCORE Database Field Name

Comments

PRMT_CONTCT_NAME

CONTCT.CONTCT_NAME

PRMT_CONTCT_FIRST_NAME

CONTCT.FIRST_NAME

PRMT_CONTCT_LAST_NAME

CONTCT.LAST_NAME

PRMT_CONTCT_TITLE

CONTCT.TITLE

PRMT_CONTCT_ORG_NAME

CONTCT.ORG_NAME

PRMT_CONTCT_ADDR

CONTCT.ADDR_1, CONTCT.ADDR_2, CONTCT.CITY, CONTCT.REF_STATE_CODE, CONTCT.ZIP_CODE

Concatenated Contact Address fields

PRMT_CONTCT_ADDR_1

CONTCT.ADDR_1

PRMT_CONTCT_ADDR_2

CONTCT.ADDR_2

PRMT_CONTCT_CITY

CONTCT.CITY

PRMT_CONTCT_STATE

CONTCT.REF_STATE_CODE

PRMT_CONTCT_ZIP_CODE

CONTCT.ZIP_CODE

PRMT_CONTCT_PHONE

PHONE.PHONE

PRMT_CONTCT_PHONE_EXT

PHONE.PHONE_EXT

PRMT_CONTCT_EMAIL

CONTCT.EMAIL

PRMT_CONTCT_CMNTS

CONTCT.ADDR_CMNTS

PRMT_CONTCT_AFFIL_CONCAT

REF_AFFIL_TYPE.DESCR

Concatenated Contact Permit Affiliation (Role) Types separated by commas

nSpectImport.CME_INSPECTION_PRMT_FEATR (repeating data)

These tags populate features for the permit specified in the evaluation record.

nSPECT Data Integration Tag

nCORE Database Field Name

Comments

FEATR_LOC

FEATR_LOC_GEOG.LAT, FEATR_LOC_GEOG.LONG

Concatenated feature latitude, longitude separated by a comma

PRMT_FEATR_DESCR

FEATR.DESCR

PRMT_FEATR_ID_TXT

FEATR.FEATR_ID_TXT

PRMT_FEATR_TYPE

REF_FEATR_TYPE.DESCR

Outbound: nSPECT Inspections to nCORE Evaluations

Image Removed

Data integration tags can also be used to populate data in nCORE, and perform various actions. See below for configured tags and integration descriptions:

nSPECT Data Integration Tag

nCORE Field Tag

Description

START_DATE (valid on nSPECT "Date" control)

EVAL.START_DATE

In conjunction with START_TIME, Will fill in nCORE Evaluation Field "Start Date" when inspection is completed in nSPECT. APP_DEPLOY_SETTING for code NSPECT_OVRRD_START_DATE must be set to "1".

START_TIME (valid on nSPECT "Time" control)

EVAL.START_TIME

In conjunction with START_DATE, Will fill in nCORE Evaluation Field "Start Date" when inspection is completed in nSPECT. APP_DEPLOY_SETTING for code NSPECT_OVRRD_START_DATE must be set to "1".

END_DATE (valid on nSPECT "Date" control)

EVAL.END_DATE

In conjunction with END_TIME, Will fill in nCORE Evaluation Field "End Date" when inspection is completed in nSPECT. APP_DEPLOY_SETTING for code NSPECT_OVRRD_START_DATE must be set to "1".

END_TIME (valid on nSPECT "Time" control)

EVAL.END_TIME

In conjunction with END_DATE, Will fill in nCORE Evaluation Field "End Date" when inspection is completed in nSPECT. APP_DEPLOY_SETTING for code NSPECT_OVRRD_START_DATE must be set to "1".

FOLLOWUP_DATE (valid on nSPECT "Date" control)

See Description

Creates a new Evaluation (EVAL) record in nCORE using the date specified in the control and the Evaluation Type (REF_EVAL_TYPE_CODE) specified as the followup inspection type.

EVAL_DCSN

EVAL.REF_DCSN_CODE

Matches values from nSPECT control to REF_DCSN.DESCR, and populates Evaluation Decision (EVAL.REF_DCSN_CODE) with the matching value.

n/a

EVAL.RPT_TRANSMT_DATE

If Application Deployment Setting flag NSPECT.SET_RPT_TRANMIT_DATE is set to true (1), the Report Transmittal Date will be set to the date the inspection was marked complete in nSPECT. This flag affects  all inspections performed in nSPECT, regardless of type or program area.

nCORE Evaluation Results from nSPECT 

Image Removed

1. from a completed nSPECT Inspection

2. Using Reference / Citation to create violations in nCORE from questions marked as a violation in nSPECT

These three topics are discussed in the sections below.

Using Data Integration Tags to move data between nCORE and nSPECT

When designing an nSPECT form, the Data Integration Tags field is used to to prefill nSPECT Forms with data from nCORE and to update nCORE data from completed nSPECT inspections.

Image Added

For a complete list of the available data integration tags, see the nCORE / nSPECT Data Integration Tags page.

Using Data Integration Context to populate nCORE Evaluation Results from Completed nSPECT Inspections

The nCORE Evaluation Details page can show a list of questions and answers configured on an nSPECT form for completed inspections. To enable this feature, entering "AREA" into the Data Integration Context field in an nSPECT inspection question.

Image Added

Questions configured with the text "AREA" in the Data Integration Context will appear along with the answer in the Inspection Results tab in nVIRO 

nVIRO. 

Using Reference/Citation to Create Violations in nCORE from Completed nSPECT Inspections

Questions marked as Violations violations in nSPECT can be configured to create violation records in nCORE, but must be configured to do so.

1. In nSPECT, edit the form question that should result in a violation

2. In the Reference / Citation field, enter a unique value for the violation reference. This value will be used in the next section to map to an nCORE Violation Type/Category

   Image Modified

3. Ensure that the radio button is selected that indicates the user is allowed to mark the inspection as a violation

4. Click Save at the top of the screen to ensure the changes are saved.

5. Navigate to the nCORE Admin → Lookups → Violation Types to Categories screen
   

Image Removed

1. Image Added

2. Either create a new Violation Type to Category Association or edit an existing Violation Type to Category Association that the violation will map to.

3. In the nSPECT

1. Reference / Citation Integration Tag field, enter the same value as entered in step 2 above.
   

Image Removed

1. Image Added

2. Click Save to save the changes.

Note that after saving, beneath the nSPECT Data Integration Tag field, a message will indicate whether the mapping is successful or not by display either one of the following messages:

• "No nSPECT questions use this integration tag'Reference / Citation' text", or

• "Integration tag Success! 'Reference / Citation' value exists in nSPECT"

When a violation is created in nCORE from nSPECT, the violation comment is set to the following:

Question: (question from nSPECT form); Answer: (answer from nSPECT form); Comments: (comments from nSPECT form, or “(No Comments)” if none)

Technical Aspects of nSPECT to nCORE integration

Steps performed for integration:

1. On a regular interval, nCORE invokes the Integration - Process Completed nSpect Inspections scheduled task.

1. This process performs the following steps:

   1. WSL queries VW_EVAL_NSPECT_CMPL to find inspections marked Complete in nSPECT but are not staged in EVAL_NSPECT_SUB

   2. WSL iterates through each completed inspection and performs the following steps:

      1. Invokes the nSPECT GetCompletedInspection API to fetch inspection data

      2. Inserts inspection data into the data is staged to EVAL_NSPECT_

1. 1. 1. SUB

      2. Inserts inspection question answers into NSPECT_EVAL_SUB_DTL

1. 2. WSL invokes Stored

1. 1. procedure SP_IMPORT_NSPECT_DATA

1. 1. to move data from the staging tables back to nCORE

1. 1. . Specific steps include:

      1. Fetch all records from EVAL_NSPECT_SUB where PRCSS_DT IS NULL. For each record found:

         1. Insert into NSPECT_EVAL_FILE_PRCSS for the inspection report

         2. Insert new EVAL if evaluation does not exist in nCORE (for ad-hoc inspections)

         3. Synchronize nCORE Evaluation Start Date, End Date, Report Transmittal Date, Assigned User, and set evaluation status to “Processed”

         4. Insert question/answers into EVAL_NSPECT_SUMM where questions are tagged ‘Area’

         5. Insert violations

         6. Schedule follow-up inspections

2. On a separate schedule, nCORE invokes the Integration - Import nSPECT Submission Files scheduled task. This process

1. performs the following steps:

   1. WSL queries NSPECT_EVAL_FILE_PRCSS for any records that are active (IS_ACTIVE=1) and have not yet been moved to nCORE (DOC_MGMT_ID is null)

   2. For each file found, invokes the nSPECT client API to fetch either the PDF or DOCX inspection report and saves to nCORE DOC_MGMT table

      1. The inspection report DOC_CREATE_TYPE_ID, DOC_STATUS_TYPE_ID and DOC_CATG_ID are fetched from Deployment Settings ncore.documentCreateTypeId, ncore.documentStatusTypeId and ncore.documentCategoryId respectively.

   3. For each file successfully copied to nCORE, the DOC_MGMT_ID and PRCSS_DATE are set in NSPECT_EVAL_FILE_PRCSS

1. 2. Then, procedure SP_ADD_NSPECT_REQST_FILE performs finalization tasks

1. 1. :

      1. Sets NSPECT_EVAL_FILE_PRCSS records to Inactive that were copied to nCORE successfully or are over two weeks old and WSL has not generated a PDF.

      2. Sets document status from “Draft” to "Final" of configured to do so based on Evaluation Type lookup setting.

      3. Sets document security status based on Deployment setting NSPECT.DOC.DEFAULT_SEC_TYPE_CODE (default is “Public”)

         1. ^^^ This may be moved to an Evaluation Type setting pending enhancement ALVIRO-6865

      4. Processes inspection media files (photos):

         1. Inserts any inspection media (photos) from nSPECT into nCORE DOC_MGMT, sets document status to “Final”, sets document name and description, sets Security type to “Internal”.

         2. Sets the nSPECT binary media (photo) data to NULL

      5. Performs final cleanup, deleting NSPECT_EVAL_FILE_PRCSS records where IS_ACTIVE=0 and no errors were recorded in the import process

Removing an Inspection from nSPECT

In nSPECT, an authorized user can choose "Remove Inspection" from the main Inspections list. When this is done, the inspection is removed from the nSPECT database. A nCORE nightly batch update procedure (SP_BATCH_UPDATE) will set the inspection back to "Planned" that evening.