Configuration management for DI applications

DI edge applications can be configured with a Configuration Change Request (CCR). The overall process for CCRs is:

  1. A user creates a CCR (defining the application, the devices being targeted, and the parameters being changed) and publishes it for approval. For more information, see Creating a configuration and Publishing a configuration for review. Roles that can perform this step include:

    • ItronDIAppDeveloper

    • UtilityManager

    • UtilityTester

    • UtilitySupport

    • ThirdPartyDIAppDeveloper

    • ItronSupport

    • ThirdPartySupport

  2. A user reviews the CCR and either approves it or rejects it. For more information, see Reviewing (approving or rejecting) a configuration. Roles that can perform this step include:

    • UtilityManager

    • UtilityTester

    • UtilitySupport

  3. If the CCR was approved, it is automatically deployed to the target devices.

Accessing the configuration management UI

  1. Go to portal.itron.com and sign in with your credentials.

  2. In the menu, navigate to DI Administration > DI Configuration.

This page contains the following tabs:

Active tab (default)

The Active tab displays all configuration requests that are in the process of being created, approved, or deployed. The information is presented as a table with a row for each configuration and the following columns:

  • ID. The unique identification number for the configuration.

  • Status. The status of the configuration.

    • New. The configuration is still being worked on and has not been submitted for approval.

    • Published. The configuration has been submitted for approval.

    • Approved. The configuration has been approved and is in the queue to be sent to the head end system.

    • Running. The configuration has been sent to the head end system for deployment.

  • Description. The user-entered description for the configuration.

  • Level. Either Endpoint (for configurations targeted at specific devices) or Global (for configurations targeting all devices).

  • Application Name. The DI application associated with the configuration.

  • Created Date. The UTC time stamp when the configuration was created.

To view more information about a configuration, click the > at the start of the row. The following additional fields and actions appear:

  • Requester. The username that created the configuration.

  • Last Updated. The UTC time stamp when the configuration was last updated.

  • CorrelationId. The configuration correlation ID. Click Copy () to copy this value.

  • Log. Click to view the history of the configuration.

  • View. Click to view the configuration details and how they differ from the currently deployed configuration.

  • ESN List. Click to view all the ESNs targeted by the configuration.

  • Actions. Click to perform additional actions, such as editing or deleting your in-progress configurations that have not been published.

  • Create Copy. Click to create a copy of the configuration to serve as the starting point for a new configuration.

The table supports the following options:

  • To reorder the columns, drag a column header to the new location.

  • To change the sort order, click any column header to sort by that attribute. An up arrow appears in the column header, indicating that the sort is in ascending order. Click the column header again to switch to descending order, indicated by a down arrow.

  • To filter the items within a column, click the column header's Filter () and type all or part of a value in the Search field. Only matching results appear in the list.

  • To filter the entire table, click Filters on the side and adjust as needed.

  • To adjust the width of any column, hover over the edge of the column header to reveal the resizing arrow icon, and then drag the icon as needed.

Completed tab

The Completed tab displays configuration requests that have ended, either because they were rejected and not deployed, or because they were approved and deployed. The information is presented as a table with a row for each configuration and the following columns:

  • ID. The unique identification number for the configuration.

  • Status. The status of the configuration.

    • Deployed. The configuration deployed successfully on all target devices.

    • Deployed With Errors. The configuration deployed successfully on some target devices, but failed on other target devices.

    • Failed. The configuration tried to deploy but failed on all target devices.

    • Rejected. The configuration was rejected during review and never deployed.

  • Description. The user-entered description for the configuration.

  • Level. Either Endpoint (for configurations targeted at specific devices) or Global (for configurations targeting all devices).

  • Application Name. The DI application associated with the configuration.

  • Created Date. The UTC time stamp when the configuration was created.

To view more information about a configuration, click the > at the start of the row. The following additional fields and actions appear:

  • Requester. The username that created the configuration.

  • Last Updated. The UTC time stamp when the configuration was last updated.

  • CorrelationId. The configuration correlation ID. Click Copy () to copy this value.

  • Log. Click to view the history of the configuration.

  • View. Click to view the configuration details and how they differ from the currently deployed configuration.

  • ESN List. Click to view all the ESNs targeted by the configuration.

  • Actions. Click to perform additional actions.

  • Create Copy. Click to create a copy of the configuration to serve as the starting point for a new configuration.

The table supports the following options:

  • To reorder the columns, drag a column header to the new location.

  • To change the sort order, click any column header to sort by that attribute. An up arrow appears in the column header, indicating that the sort is in ascending order. Click the column header again to switch to descending order, indicated by a down arrow.

  • To filter the items within a column, click the column header's Filter () and type all or part of a value in the Search field. Only matching results appear in the list.

  • To filter the entire table, click Filters on the side and adjust as needed.

  • To adjust the width of any column, hover over the edge of the column header to reveal the resizing arrow icon, and then drag the icon as needed.

Discrepancies tab

The Discrepancies tab displays all configuration discrepancies identified in the system. A configuration discrepancy occurs when the expected configuration version for the meter differs from the configuration version reported by the meter. The information is presented as a table with a row for each discrepancy and the following columns:

  • ID. The unique identification number for the discrepancy.

  • Electronic Serial Number. The ESN of the device.

  • Application Name. The DI application associated with the configuration.

  • Date Of Report. The UTC time stamp when the discrepancy was identified.

The table supports the following options:

  • To reorder the columns, drag a column header to the new location.

  • To change the sort order, click any column header to sort by that attribute. An up arrow appears in the column header, indicating that the sort is in ascending order. Click the column header again to switch to descending order, indicated by a down arrow.

  • To filter the items within a column, click the column header's Filter () and type all or part of a value in the Search field. Only matching results appear in the list.

  • To adjust the width of any column, hover over the edge of the column header to reveal the resizing arrow icon, and then drag the icon as needed.

Scheduled Jobs tab

The Scheduled Jobs tab displays configuration request jobs that are in progress (either running or in the queue waiting to be sent). The information is presented as a table with a row for each configuration and the following columns:

  • ID. The unique identification number for the configuration.

  • Operation ID. The unique identification number for the configuration job.

  • Description. The user-entered description for the configuration.

  • ESN Count. The number of ESNs targeted by the configuration.

  • Status. The status of the configuration job.

    • Proposed. The configuration job is in the queue waiting to run.

    • Running. The configuration job is running.

    • Complete. The configuration job completed.

  • Created Date. The UTC time stamp when the configuration was created.

  • Last Updated. The UTC time stamp when the configuration was last updated.

The table supports the following options:

  • To reorder the columns, drag a column header to the new location.

  • To change the sort order, click any column header to sort by that attribute. An up arrow appears in the column header, indicating that the sort is in ascending order. Click the column header again to switch to descending order, indicated by a down arrow.

  • To filter the items within a column, click the column header's Filter () and type all or part of a value in the Search field. Only matching results appear in the list.

  • To adjust the width of any column, hover over the edge of the column header to reveal the resizing arrow icon, and then drag the icon as needed.