Importing Metered Services

This topic provides additional details related to importing metered services from a customer information system into Digital Asset Management / Digital Asset Cloud Service.

Metered Services Import File Format

Metered service import files use the following tab-separated values format:

Field Name

Optional/Required

Notes

External Reference Id

Optional

The metered service's reference ID in the CIS application.

Change Date Time

Optional

The date and time on which the metered service was changed.

Applicable only for Incremental Uploads

Will be used to sequence processing in case there are multiple changes to the same metered service point.

Initial Load Sync Flag

Required

A value that indicates the type of upload. Valid values are:

  • F1IL - Initial Load

  • F1IC - Incremental

External Id

Required

The metered service's ID in the CIS application.

When importing data from Customer to Meter or Customer Cloud Service this is the Service Agreement External ID.

Metered Service Type

Required

The type of metered service. When importing data from Customer to Meter or Customer Cloud Service this comes from the Service Agreement Type.

If the provided metered service point type has not been defined as a Metered Service Type in Digital Asset Management / Digital Asset Cloud Service an extendable lookup is used to map this value to the Metered  Service Type used in Digital Asset Management / Digital Asset Cloud Service.

External Contact ID

Optional

The ID of the contact associated with the metered service in the CIS application.

When importing data from Customer to Meter or Customer Cloud Service this is the Contact External ID.

External Account ID

Optional

An ID used to identify the account associated with the metered service record in the CIS application.

Start Date Time

Required

The date and time on which the metered service record started.

End Date Time

Optional

The date and time on which the metered service record ended or will end (if applicable).

Division

Optional

The metered service's division.

If the provided division has not been defined as a Division in Digital Asset Management / Digital Asset Cloud Service an extendable lookup is used to map this value to the Division used in Digital Asset Management / Digital Asset Cloud Service.

SA Status

Optional

The metered service's status.

If the provided status has not been defined as a Division in Digital Asset Management / Digital Asset Cloud Service an extendable lookup is used to map this value to a Status defined in Digital Asset Management / Digital Asset Cloud Service.

Rate Schedule List

Optional

A concatenated list of rate schedules and effective dates associated with the metered service.

Each row in this list is composed of the following:

  • Rate Schedule

  • Effective Date

Each element in the row will be delimited by comma ( , ).

Each row in the list will be delimited by semi-colon ( ; ).

For example:

ERES-1,2022-01-01ERES-2,2021-01-01

Metered SP List

Optional

A concatenated list of metered service points associated with the metered service.

Each row in this list is composed of the following:

  • External Metered SP Id (Required)

  • Start Date Time (Required)

  • End Date Time (Optional)

Each element in the row will be delimited by comma ( , ).

Each row in the list will be delimited by semi-colon ( ; ).

Example:

6800401571,2022-12-13T14:30:00-05:00,1703304223,2022-12-13T14:30:00-05:00,

Is Erased

Optional

A flag that indicates if the customer has been obfuscated (if supported) in the CIS application. Valid values are Y/N (Default)

Applicable only to Incremental Uploads

This should be set to "N" if Object Erasure is not supported in the CIS application.

Sample Record

Below is a sample file:

EXTREFMS11    2023-06-15T13:02:00-08:00    F1IC    EXTMS1    CA!ZZMTRDST    EXTCONTACT1    EXTACCT1    2022-10-15T09:23:00-08:00    2023-06-14T13:45:00-08:00    ZZEDV    20    ERESRBOH,2022-11-09;    EXTMSP1,2022-11-09T13:14:55-08:00,2023-04-14T08:25:44-08:00;    Y

Upload Batch Process

Metered service import files are uploaded using the Metered Service File Upload (X1-MSUPL) batch process. Use the Batch Control portal to view the parameters used by this batch process. This process should be run as needed for the initial import, as well as subsequent incremental updates.

This process creates inbound sync requests in the "Pending" state (see below).

The Metered Service File Upload - DACS (X1_​LEGMSUPLD) algorithm used by this batch process uses the following extendable lookups to map data in the import file to values defined in Digital Asset Management / Digital Asset Cloud Service:

  • CCB SA Type Mapping (D2-CCBSATypeLookup)

  • CCB SA Status Mapping (D2-CCBSAStatusLookup)

  • CIS Division Mapping (D1-CCBDivisionLookup)

Values must be defined for these extendable lookups before import files can be uploaded into Digital Asset Management / Digital Asset Cloud Service.

Inbound Sync Request Business Object

Metered service inbound sync requests are based on the Metered Service Inbound Sync Request (X1-DASyncReqMeteredService) business object.

Inbound sync requests are created in the "Pending" state. The Sync Request Monitor (F1-SYNRQ) batch process is used to transition these to the "Transform/Validate" state where the data is validated and transformed as needed for import. What happens next is based on the type of sync request:

  • Initial Load sync requests then move to the "Validated" state (or "Validation Error" if an error is encountered). These are processed by an "Initial Sync Request Load" batch process (see below) .

  • Incremental sync requests move to the "Add/Update" state in which algorithms add or update records as appropriate and then to the "Synchronized" state.

  • The Create Acknowledgement (X1-CRESRACK) algorithm on the "Synchronized" state can be configured to send an acknowledgement to the system from which the imported data originated. This requires specifying the "Send Sync Request Acknowledgement" (X1-SYNREQACK) outbound message type for the Outbound Message Type parameter on the algorithm.

Initial Sync Request Load Batch Process

Metered services imported as part of an Initial Load upload are created from Initial Load inbound sync requests using the Initial Sync Request - Load Metered Service (X1-SILMS) batch process. Use the Batch Control portal to view the parameters used by this batch process. This process should be run as needed for the initial import, as well as subsequent incremental updates.

This process transitions the inbound sync requests to the "Loaded" state.