Hierarchy Analytics

Hierarchy information changes over time, for example subscriptions can move to different accounts, or accounts to a different corporate. While CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. stores only the current hierarchy, it is important that a historical view of the hierarchy is also available. This job gathers the 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. hierarchy information (subscriptionClosed A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription, accountClosed In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices., corporate and groupClosed In the Customer Manager Platform hierarchy, the highest level of the structure. The group level can be used to group corporates. Groups can hold financial information.) that was in effect at the time of the most recent billing process.

This extract file interface handles records for each organisation to be created or updated in the CXPClosed Customer Experience Platform, or CXP, is MDS Global's self-service app that allows business customers to manage their own accounts and subscriptions. database.

A request to create a Hierarchy Extract takes the following optional parameter:

- invoice.run.number

This allows the userClosed A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. to specify the invoice run that is to be extracted. If no invoice.run.number is specified, the latest invoice run is used.

Please note that the Hierarchy Extract for a particular invoice run should always be requested prior to the equivalent Invoice Extract for that run to ensure that any account hierarchies which have not been previously invoiced are loaded into CXP prior to their invoices. Failure to do this will result in an error when loading the invoice extract into CXP.

When the job completes successfully, extract files have been sent via FTPClosed File Transfer Protocol. A standard network protocol used for the transfer of files between a client and server on a computer network. to CXP servers.

This job is typically scheduled to run once per day after a billing process.

 

Extract files in this set and their use are shown below.

  • 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 load control interface table

    This extract file interface is used to control various elements of the customer hierarchy loading process. There is only a single record in this file per extract. The record format includes an effective date for use when building organisation unit snapshots and a series of extract file record counts for validation purposes. Data loaded via this interface is primarily bound for the HIERARCHY_LOAD and DATA_LOAD CXP Admin schema tables.

    Organisation load control interface table fields

    Column Heading

    Unique?

    Type

    Length

    Description

    EXTERNAL_DATA_SOURCE_ID

    Y

    VarChar

    40

    An identifier for the instance of the CRM database from which the hierarchy data has been extracted.
    EXTRACT_ID   VarChar 40 A unique identifier for the current extract. This value will usually be derived by the CRM from a sequence that it controls and tracks.
    ORG_LOAD_CONTROL _COUNT   Integer   Number of records in the Org_Load_Control extract file. Used to confirm that the contents of that extract file have been successfully delivered without truncation.
    ORGANISATION_COUNT   Integer   Number of records in the Organisation extract file. Used to confirm that the contents of that extract file have been successfully delivered without truncation.
    ORGANISATION_STRUCTURE_COUNT       Number of records in the organisation_structure extract file. Used to confirm that the contents of that extract file have been successfully delivered without truncation.
    ORG_NODE_ATTRIBUTE_COUNT       Number of records in the org_node_attribute extract file. Used to confirm that the contents of that extract file have been successfully delivered without truncation.
    HIERARCHY_EFFECTIVE_DATE  

    Numeric

    		   Date on which the hierarchy structure described within the current extract is true. YYYY-MM-DD HH:MM:SS format
    EXTRACTION_TIMESTAM   Numeric   Date and time that the extract file set was generated. YYYY-MM-DD HH:MM:SS format

  • organisation.dat

    Contain a record for each organisation to be created or updated in the CXP database.

    Organisation interface table

    This extract file interface handles records for each organisation to be created or updated in the CXP database.

    Data loaded via this interface is primarily bound for the ORGANISATION and ORGANISATION_DATA_SOURCE CXP Admin schema tables.

    Organisation interface table fields

    Column Heading

    Unique?

    Type

    Length

    Description

    EXTERNAL_ORGANISATION_ID

    Y

    VarChar

    40

    (40 CHAR) Identifier signifying the owner of an organisation unit hierarchy. The organisation provides a way to collectively group organisation units together to allow the sharing of such things as filter sets and address books. It is important to note that EXTERNAL_ORGANISATION_ID is considered to apply universally, spanning all potential data source feeds. That is to say that if the same EXTERNAL_ORGANISATION_ID value is fed in to a Lavastorm Spend Analyzer environment for customers from two different data sources, then those two customers and their hierarchies will be considered to be part of the same organisation and by assigned the same ORGANISATION_ID. Membership of an organisation then grants users that can access hierarchy nodes belonging to that organisation, the ability to share public resources such as address books that are stored against the organisation. If you are running an environment where customers from different data sources will never need to be associated under a common organisation, then it is highly recommended that you ensure that the EXTERNAL_ORGANISATION_ID values sent to Lavastorm Spend Analyzer are truly unique (by appending the EXTERNAL_DATA_SOURCE_ID to them for example).
    ORGANISATION_NAME   VarChar 100 User friendly name for the current organisation.
    CURRENCY_CODE   VarChar 40 A code indicating the currency used by all of the invoices associated with the current organisation and data source combination (where the data source for all of the data in the extract is held in the 'org_load_control.dat' extract file).

  • org_structure.dat

    Contain 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.

    Organisation structure interface table

    This extract file interface handles records for each organisation hierarchy node to be added or updated in the Lavastorm Spend Analyzer database. Each child node record contains the ID of its parent node allowing hierarchies to be described as a series of parent /child relationships. Data loaded via this interface is primarily bound for the ORGANISATION_UNIT and ORGANISATION_UNIT_SNAPSHOT Lavastorm Spend Analyzer Admin schema tables.

    Organisation structure interface table fields

    Column Heading

    Unique?

    Type

    Length

    Description

    EXTERNAL_ORGANISATION_I

    Y

    VarChar

    40

    The Identifier of the organisation to which the organisation unit depicted by the current record belongs.
    EXTERNAL_ORGANISATION_UNIT_ID   VarChar 40 Unique identifier denoting an organisation unit element within a customer's organisation unit hierarchy.
    ORGANISATION_UNIT_LEVEL   Integer   The level within the organisation unit hierarchy, at which the current organisation unit resides. There is an assumption that EXTERNAL_ORGANISATION_ID values are only unique at the level within the hierarchy indicated. Therefore a level 1 node with an identifier of 'ABC' is considered to be a different node to a level 2 node with identifier 'ABC'.
    EXTERNAL_ORG_UNIT_TYPE   VarChar 40 Denotes the sub type of the current customer hierarchy element, within its level. This value allows The various types of organisation unit to be differentiated from one another for the purposes of icon assignment in tree views and reporting.
    EXTERNAL_PARENT_ORG_UNIT_ID   VarChar 40 dentifier denoting the parent organisation unit of the current organisation unit within the organisation unit hierarchy. Note: Every EXTERNAL_PARENT_ORG_UNIT_ID referenced here must also be represented as an EXTERNAL_ORGANISATION_UNIT_ID on a different record in the 'org_structure.dat' extract file associated with the current extract file set. This effectively means that organisation hierarchies must be shown complete from the Lowest node represented by an 'org_structure.dat' extract file upwards.
    PARENT_ORG_UNIT_LEVEL   Integer   The level within the organisation unit hierarchy, at which the parent organisation unit resides.
    ORG_UNIT_ DEACTIVATION_DATE  

    Numeric

    		   Used to differentiate between active and inactive (disconnected/deactivated) organisation units. Active organisation units are those with a NULL deactivation date. Inactive organisation units are those with an actual date value, representing the date of deactivation. Whilst it is generally assumed that once an organisation unit has deactivated, then it will not reactivate, the deactivation date can be reset by passing a NULL value here to remove the deactivation date stored in the database.
    ALIAS_1   AlphaNumeric 40 Alternative description or code used to identify the current organisation hierarchy element. Used in displays to help the user more readily identify organisation unit elements.
    ALIAS_2   AlphaNumeric 40 Alternative description or code used to identify the current organisation hierarchy element. Used in displays to help the user more readily identify organisation unit elements.

  • 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.

    Organisation node attribute interface table

    This extract file interface handles records that contain descriptive attributes for each hierarchy node. Each record contains a single attribute for a node and the number of attributes that any one hierarchy node can have is potentially unlimited. It is only necessary to pass in data via this interface when an organisation unit has attributes that need to be added or changed. Data loaded via this interface is primarily bound for the ORG_UNIT_ATTRIBUTE_SNAPSHOT Lavastorm Spend Analyzer Admin schema tables.

    Organisation node attribute interface table fields

    Column Heading

    Unique?

    Type

    Length

    Description

    EXTERNAL_ORGANISATION_UNIT_ID

    Y

    VarChar

    40

    Unique identifier denoting the organisation unit element to which the attribute information on this record belongs.
    ORGANISATION_UNIT_LEVEL   Integer   The level within the organisation unit hierarchy, at which the organisation unit resides.
    ATTRIBUTE_NUMBER   Integer   Identifier for the current attribute. Used by the application when retrieving the attribute value for display.
    ATTRIBUTE_TYPE   VarChar 40 The type of data represented by the attribute value (TEXT or NUMERIC).
    ATTRIBUTE_VALUE     100 A piece of custom data associated with an organisation unit.

 

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