Downloading Customer Settlement Transactions
Customer settlement transactions can be downloaded for import into a customer information system via a batch process which creates a delimited file containing customer settlement transaction information.
See About Customer Settlement Transactions for more information about customer settlement transactions.
Batch Control
Customer settlement transactions are downloaded using the Customer Settlements Extract (X1-CSEXT) batch process. This batch process downloads data into a delimited file, the details of which are specified by the batch control parameters.
This batch processes use the following parameters:
- File Integration Type: The file integration type (see below) used to extract customer settlement transactions (see below).
- File Name: The name of the downloaded file. File names can use wildcards (Required)
- File Path: The file location to which the file will be downloaded. This can be a file location on a local server or a location in Object Storage. See Referencing URIs in the Framework Administrative User Guide the for more information. (Required)
- File Format: The extract file format. Valid values are CSV (delimited) FIXD (fixed position output) or XML (XML document).
- File Delimiter: The delimiter to use for the CSV file format
- Start Date (optional): A date that specifies the start of the date range for which customer settlement transactions are extracted. Used with the End Date parameter.
- End Date (optional): A date that specifies the end of the date range for which customer settlement transactions are extracted. Used with the Start Date parameter.
- External Account Id (optional): An external account ID used to restrict the customer settlements transactions extracted to those for the specified account.
-
Extract Option: Flag used to re-extract previously extracted customer
settlements. Valid values include:
- Y: Used to Re-extract only previously extracted customer settlement transactions that match other criteria. This should only be used when specifying a Start/End Date.
- N: Not Re-Extract (default)
Use the Batch Control portal to view additional details about these parameters.
File Integration Type
The customer settlement transaction extract process uses the Customer Settlements Extract (X1-CustomerSettlementExtract) file integration type, defined as a parameter on the Customer Settlements Extract (X1-CSEXT) batch process.
Implementations that require a different extract format can create a custom file integration type that defines their own extract format and process. This includes creating a custom extract algorithm and a custom extract data area.
Refer to Extract Using File Integration for more information about the role of file integration types.
Extract Algorithm Parameters
The Customer Settlements Extract (X1-CustomerSettlementExtract) file integration type uses the Customer Settlements Extract (X1CUSTSETEXT) algorithm to extract customer settlement transactions. This algorithm includes a "Line Charge Option" parameter with the following options:
- A (Aggregated): The algorithm outputs a single line charge from aggregated event settlements
- D (Detailed): The algorithm outputs lines charges for each event settlement
The default setting for this parameter is "D", but this can be overridden if needed by creating a new algorithm version and changing the value of this parameter.
File Format
The file format of the extract file is defined by the Customer Settlements Extract (X1-CustomerSettlementExtract) data area (specified on the Customer Settlement Extract (X1-CustomerSettlementExtract) file integration record on the Customer Settlements Extract (X1-CustomerSettlementExtract) file integration type.
Customer settlement transaction extract files use the following format:
| Field Name | Mapping | Notes | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Start Date | Customer Settlement Start Date | |||||||||||
| End Date | Customer Settlement End Date | |||||||||||
| Account Id | Metered Service External Account Id | |||||||||||
| External Id | Customer Settlement Id | |||||||||||
| Description | This will be derived message: Customer Settlement for Period (%1 - %2) | |||||||||||
| Program Code | ||||||||||||
| Saved Consumption | ||||||||||||
| Actual Consumption | ||||||||||||
| Number of Events | ||||||||||||
|
Line Charges
|
This column contains the list of event settlement amounts. Each event settlement row is delimited by a semi-colon (;) and each row column is delimited by comma (,). Depending on the extract algorithm, this list will contain 1 row for Aggregated extract option or many for Detailed extract option (default). |
Note that this format is patterned after the format used by the Billable Charge Upload Staging Table used by Oracle Utilities Customer Care and Billing, Oracle Utilities Customer to Meter, Oracle Utilities Customer Cloud Service, and Oracle Utilities Billing Cloud Service.