ICIS-NPDES and ICIS-Air Data Viewer

Owned by Will Rensmith
Last updated: Jun 03, 2024
6 min read

Overview

Two dashboards are available to manage submissions to both ICIS-NPDES and ICIS-Air. The functionality is the same for either dashboard, however each controls flows to either ICIS-NPDES or ICIS-Air and shows the payloads available for the respective flows.

For clarity, this page will simply refer to either as the ICIS Dashboard. The images shows are from the ICIS-NPDES dashboard, but concepts and usage is the same for both.

The ICIS Data Viewer allows for staging new submissions to ICIS and for viewing staged and historically submitted data.

Permissions

  • The ICIS-NPDES Dashboard is only available if the current user belonging to a Security Group containing the “ICIS-NPDES Administrator” security role.

  • The ICIS-Air Dashboard is only available if the current user belonging to a Security Group containing the “ICIS-Air Administrator” security role.

Submissions Tab

ICIS-NPDES Dashboard - Submissions Tab

Staged/Queued Submission

The first section allows for manually staging a new submission for transmittal to ICIS. One one submission can be staged at a time. This area has three modes:

  • No Queued/Staged Submission

  • Queued - A submission has been created and is ready to send to ICIS.

  • Submitted - A submission has been sent to ICIS and is awaiting a processing report to be sent back from ICIS.

Staging a New Submission to ICIS

When no queued/staged submission exists, a new submission can be created using the Stage New Submission button.

ICIS-NPDES Dashboard - Submissions Tab - No Staged Submissions

Clicking Stage New Submission displays a dialog where the user can select which payload(s) to stage for submission and optionally, to filter for a specific permit number. The available payloads are based on whether the payload is enabled. Payloads can only be enabled or disabled directly in the database and will require technical assistance to update.

If the Discharge Monitoring Report payload is selected, the user can optionally supply a DMR report period start/end date range. After clicking Save, the new submission will be loaded. A spinner will appear while the staging process is running.

 

Viewing a Staged Submission

If a new submission has been staged, it will display in the Staged/Queued Submission section of the screen. Expanding the submission using the arrow icon will display the number of records staged for each payload in the submission.

Click the Open button to view the business key identifiers for the records staged in the submission. The screen will change to the Data Viewer tab with the filters applied for just the staged submission data.

Clearing a Staged Submission

If a submission has been staged and it is decided that the data should not be sent to ICIS, click the Clear Submission button.

Sending a Staged Submission to ICIS

To send a staged submission to ICIS, navigate to the OpenNode2 instance and use the “Run Now” button to execute the PerformICISSubmission schedule. See OpenNode2 and ICIS-NPDES and ICIS-Air Plugin documentation for more details.

Submitted List

The Submitted section of the page displays the 30 most recent submissions to ICIS in order of most recent to oldest.

Click the Open button to view the records for a given submission.

Note: Detailed data for historical submissions may be incomplete. This is due to how transaction history is tracked in the ICIS OpenNode2 plugin. Only the most recent transaction for a given business key is stored. For example, a rejection from an older submission will be deleted if that error was resolved with the data in a newer submission.

Data Viewer Tab

The data viewer tab allows for searching historical transactions to ICIS. Each record is uniquely identified by the combination of Submission Type and business key. The business key for each submission type is defined by the ICIS data flow. Please see the ICIS batch data flow documentation for more information.

Resolving ICIS Data Flow Errors using “Set as Flowed” Button

If a record is being repeatedly rejected from ICIS and it is determined that the flow should not be attempting to flow that record to ICIS, the record can be set to be ignored for future submissions. It goes without saying that caution should be taken when using this option!

The “Set as Flowed” button is only shown for “Unsent” records with (N)ew and (R)eplace transaction types.

  1. Using the data viewer, identify the Submission Type and Business key that is receiving the error

  2. Navigate to the Submissions tab and stage a new submission for just the Submission Type and Permit that will result in staging a submission containing the bad record.

  3. Open the staged submission from the Queued/Staged list.

  4. Locate the bad record in the Data Viewer tab. It should have a result status of Pending and a Set as Flowed button should appear.

  5. Click Set as Flowed. The row disappears from the list and a confirmation appears.

  6. If desired, clear the staged submission from the Submissions tab.

The record will no longer be staged to flow to ICIS.

How “Set as Flowed” Works

When Set as Flowed is clicked, the staged data for that record is copied to the tracking table of successfully flowed data. Essentially, you are telling the flow tracking tables that the record has successfully flowed which prevents it from being picked up from future submissions.

Note that the data viewer will now incorrectly reflect that the data was sent successfully to ICIS for this record. There is currently no way to differentiate records that were actually successfully flowed from those where “Set as Flowed” was used, which can create audit challenges later on.

ICIS-NPDES Flow Process Business Rules

The information below describes the behavior of a stock nVIRO implementation. The logic below may have been customized for the specific business requirements of a given agency.

Basic/General Permit flow logic:

The permit version to flow to ICIS is determined by the following criteria:

  • The permit effective date is greater than or equal to today

  • The permit version status is active (e.g. In Effect, Extended, or Expired)

  • The permit’s Permit Category is mapped to an ICIS Permit Type Code (see Permit Categories)

  • The permit number is exactly nine alpha-numeric characters long

  • The permit is version 1.0 OR the permit version is the most recent submission flowed to ICIS (as determined by the ICS_FLOW_ICIS.ICS_PRMT_REISSU SRC_SYSTM_IDENT = to the PRMT.PRMT_ID above)

Reissuance Flow Logic:

A permit will be reissued in ICIS when the following criteria are met:

  • A newer active version of the permit exists in nVIRO compared to the most recent flowed version to ICIS-NPDES (as determined by the SRC_SYSTM_IDENT equal to the PRMT.PRMT_ID of the new, active version in nVIRO, as stored in the ICS_FLOW_ICIS Basic Permit, General Permit, and Master General Permit flow tracking tables)

  • There are no flow errors for the current permit version in ICIS

  • The issue, effective, and expiration date are present

  • The permit has not already been terminated in ICIS

  • The flow payload relating to the permit type is enabled (e.g. Basic, General and Master General Permit)

Permitted Feature Flow Logic:

Permitted Features are sent in ICIS when the following criteria are met:

  • The Basic, General, or Master General Permit version has successfully flowed to ICIS

  • The feature has at least one effluent limit added to it that is valid for flowing to ICIS-NPDES (e.g. maps to a valid ICIS parameter code, etc.)

  • The feature identifier is either 3 or 4 characters long

  • The feature’s Feature Type Code has been mapped to and ICIS Permitted Feature Type code (see Feature Types).