CXP Extracts

CustomerClosed In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement. Experience Platform, or CXPClosed Customer Experience Platform, or CXP, is MDS Global's self-service app that allows business customers to manage their own accounts and subscriptions., is a self-service app that allows you to manage your own accounts.

Data is extracted from the CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. database and made available in a format that can be directly imported into CXP. The batch jobs used to extract CMP data include Hierarchy Analytics and Invoice Analytics that are available for each bill run.

 

The SABRE Analyser Extract job is designed so that two separate Extracts are produced from CMP in a format that can be directly imported into CXP.

 

About extract files

All data extracts received by CXP are in the form of sets of variable width CSVClosed Comma Separated Values. A simple file format used to store tabular data, such as a spreadsheet or database. CSV files can collect the data from tables so that it can be input to another table-oriented application such as a relational database application. (Comma-separated value) files with TAB delimitation between record fields. Data is in a plain text format using a single encoding scheme as agreed with CXP prior to an environment deployment. For example, Unicode or ASCII.

 

Extract file set naming convention

The following naming convention applies for extract files that are delivered as individual .dat files. The naming convention uses a base name combined with a series of prefixes to create unique file names. Each element of the name is separated with a dash character (-).

This format allows the various elements of the file name to be parsed by using a dash as a delimiter.

Extract files can be delivered individually as .dat files, or they can be grouped together and delivered as a single .zip file.

Zip file naming convention

The following naming convention applies when the set of individual extract files are grouped together and delivered as one .zip file. The naming convention uses a base name combined with a series of prefixes to create unique file names. Each element of the name is separated with a dash character (-).

This format allows the various elements of the file name to be parsed by using a dash as a delimiter.

Extract file set

Extract files and their use are shown in the table below.

 

Batch Job Extract file Description
Hierarchy Analytics file set:
  org_load_control.dat Controls various elements of the customer hierarchy loading process. It is polled for by the customer hierarchy data loader when it is looking for extracts to load. It contains a single load control record.
  organisation.dat Contains a record for each organisation to be created or updated in the CXP database.
  org_structure.dat Contains a record for each organisation hierarchy node to be added or updated in the CXP database. Each node record will contain the ID of its parent node allowing whole hierarchies to be described as a series of parent /child relationships.
  org_node_attribute.dat Contains descriptive attributes for each hierarchy node. Each record will contain a single attribute for a node and the number of attributes that any one hierarchy node can have is potentially unlimited. It will only be necessary to populate this file with attributes that need to be added or changed.
Invoice Analytics file set:
  invoice_load_control.dat Controls various elements of the invoice loading process. It is polled for by the invoice data loader when it is looking for extracts to load. It contains a single load control record.
  invoice.dat Contain a header record for each invoice in the extract set.
  invoice_line.dat Contains a record for each charge line associated with an invoice in the extract set.
  usage_item.dat Contains a record for each charge line sub item (for example, a phone call) associated with invoice lines in the current extract set.
  delivery_address.dat Contains a list of the delivery addresses associated with the invoices in the current extract set.
  inc_usage_alloc.dat Contains a record for each inclusive usage allocation utilised by usage items in the current extract data set. Usage items can be discounted by inclusive usage schemes. Such schemes are known as bundles.
  inc_usage_units.dat Contains records that indicate how much of an inclusive usage allocation was consumed by a usage item.
  statement.dat Contains account statement header for selected hierarchy nodes associated with invoices in the current extract.
  statement_trans.dat Contains details of each monetary transaction that occurred between the time of the opening and closing balances on statements in the current extract.
  Hierarchy_Node_Check.dat Contains a list of all of the hierarchy nodes associated with invoice elements in the current invoice extract set. Each node record also contains the ID of its parent node. This data is used to ensure that all invoice extract data elements can be successfully attached to a valid organisation unit hierarchy within the CXP database.

 

External table definitions

The CXP database uses database objects called external tables to define a data loading interface specification.

The columns in the external table definitions map directly to the delimited data in the extract file set, one external table per extract file.

This section contains descriptions of the formats of each external table used by the invoice load interface. This information can be used to directly drive the population of the associated delimited extract files to which the external tables map.

 

For more information about these extract jobs, see the CMP Batch Jobs and JSONClosed JavaScript Object Notation. JSON is a lightweight format for storing and transporting data, often used when data is sent from a server to a web page. Schemas Guide. See also the jobs descriptions provided in the CMP Administration ConsoleClosed An operations web console that allows batch jobs to be scheduled, run manually and monitored. The console also provides for viewing and modification of business and user applicable system configuration..