How to Setup Usage Identifiers

Overview
Usage Identifiers are labels that will allow you to link usage products to Usage Collector profiles. This will enable the platform to know what products and pricing information to be used whenever usage is received/collected using one of the active usage identifiers in the system.

Think of Usage Identifiers as labels that get associated to products and then referenced by usage collectors when processing usage data. Furthermore, the application of these labels can be done in different levels of the pricing hierarchy. For example, it can be associated to a base product, a package product, an account product, etc.

Usage Identifiers can be leveraged by performing the following high-level activities.

  1. Setup a Usage product.
  2. Setup a Usage Identifier (label).
  3. Update the Usage product with a Usage Identifier.
  4. Setup the collector mapping for the Usage Identifier.

Procedures

Step 1.Setup a Usage product.

Refer to the How To Create A Usage Product help page for the steps needed to create a new Usage product.

Step 2. Setup a Usage Identifier (label).

Navigate to the Usage Identifier section of the UI by going to Setup > Metered Usage > Usage Identifier.

Usage_Identifier_List.png 

From here, click New to create a new Usage Identifier or click Edit beside an existing label to edit it. A window similar to the screenshot below will be displayed.

New_Usage_Identifier.png

Here, you can update/create a new Usage Identifier. When done, click Submit to save the new/updated label.

Step 3. Update the Usage product with a Usage Identifier.

Now, the label can be associated to a usage product. As mentioned in the overview, a Usage Identifier label can be associated to different levels of the pricing hierarchy. For the purpose of this example, we will associate it to a base product, particularly one that was created in Step 1.

Navigate to the product that was created in Step 1. A screen similar to the one below will be displayed.

Product_Details.png

Open the product for editing and scroll down to the Usage Identifiers section.

Product_Details_Edit.png

Here, you can add one or more usage identifiers by clicking the + icon and then the magnifying glass icon to select from the list of available usage identifiers in the app using the pop-up window. 

Usage_Identifier_Pop-up.png

Select a usage identifier by clicking it and it will then be added to the list of Usage Identifiers of the product similar to the screenshot below. Repeat the procedure for the usage identifiers that you need to associate to the product.

Added_Usage_Identifiers.png

When multiple usage identifiers are associated to a single product in the hierarchy, it means that pricing information for the product will be sourced whenever any of the associated usage identifiers are invoked by the collector.


Step 4. Setup the collector mapping for the Usage Identifier.

Create the Usage Identifier Mapping

This high-level step will now allow you to configure a Usage Collector profile to invoke the Usage Identifier that was created previously when receiving data. Navigate to an existing Usage Collector Profile by going to Setup > Metered Usage > Usage Collectors and then select a usage profile. With a usage collector profile opened, click the Collector Usage Identifier child node on the left navigate pane.

Collector_Usage_list.png 

This will display a list of existing usage identifier mapping or if there is only one existing mapping, its details. From here, click the New button to create a new mapping.

New_Mapping.png

On the first page of the wizard, select the label/Usage Identifier that was created earlier. Click Next to continue.

Collector_Usage_Mapping_Details.png

On this page, populate the necessary configuration as described in the terms table below. Click Save when done to save the first part of the mapping.

Terms Defined

Table 1
Field Name Description
Collection Rule

Defines how to handle the usage data that is fed through the collector. Available options are:

  • COMPUTED DURATION OF "ENDED - STARTED": This is used if the collector provides date/time data that can be used to compute the usage data in seconds.
  • EXISTENCE OF RECORD AS QUANTITY 1: The usage data is incremented whenever there is a record existing that is mapped to the billing identifier and product combination. For instance, if the usage data contains 3 records, the quantity will be rated as 3 regardless of whether the record has a quantity field.
  • QUANTITY: This is used when a column/field in the usage data has the actual usage quantity to be rated. Assuming that it was mapped in the usage collector's configuration, the collector will look at this column/field for the quantity to be rated.
Rounding Rule

This is a formula  field that is applied to the quantity that is obtained by the collector (ie. the result of the application of the Collection Rule logic).

For example, if the Collection Rule uses the "ENDED - STARTED" logic and results to a quantity in seconds to be returned, the Rounding Rule field can be used to apply an operation on the quantity to return the minutes equivalent: {!FIELD} / 60

Where:

  • {!FIELD} is a variable that contains the quantity that was received by the collector.

Typical MS Excel functions can be used here such as TRUNC, MOD, etc.

In the example above, if the collector obtains a quantity of 120, the rated amount that will be used is 2 ({!FIELD} / 60 = 2).

Leaving this field blank will allow the collector to use the raw quantity as the rated amount.

Prevent split on multiple billing identifiers Check this box if usage data coming from this identifier mapping should not be sent to multiple accounts/customers if more the billing identifier is associated to multiple accounts. 

Define the mapping trigger/conditions

This section will allow you to configure the conditions when the usage identifier will be invoked and its associated pricing information sourced. Here, you can define conditions based on the collector data received.

Click the Collector Usage Mapping child node on the left navigation pane as illustrated in the screenshot below:

Collector_Field_Mapping.png

This will bring up the list of existing mappings or a blank list if no mapping is existing yet. From here, click New to create a new trigger condition. The wizard below is then displayed:

Collector_Details_Entry.png


From this page define a descriptive title in the "Name" field. Then under the Billing Component Map section is where you are going to actually map the data. Click the field under COLLECTOR FIELD to open the pulldown menu where you will select which field you would like to tie the value to. This will most likely be a field for holding a code from your usage collector. Once you have this selected click the field under COLUMN VALUE to define what code coming from the usage collector will be tied to your field you just defined. After this select save to confirm your entries.

You can save multiple triggers for different conditions that will invoke the usage identifier if needed.

At this point, whenever the conditions are met based on the collector data that is captured/received by the platform, the usage identifier is invoked and any pricing information for associations made for that identifier with usage products (e.g. product, package product, etc.) will be sourced and added to the customer's invoice.

Flexibility Of Use

Usage Identifiers, once defined, can be attached to multiple products within the pricing hierarchy. This includes:

  1. Product (as shown in the example above)
  2. Package Product when a product is added to the package.
  3. Account Product when a product is provisioned to a customer.
  4. Account Package Product when a package product is provisioned to the customer.

The same steps described above when adding usage identifiers to products can be used when adding identifiers to the other domains in the pricing hierarchy, except that you will be opening the domain's record for editing (e.g. editing an account product, a package product, etc.).

In addition, products that have usage identifiers associated to them, when added to a package, can have these identifiers overridden to either use a different identifier, use additional identifiers or not use any identifier at all. This can be done by ticking the Override checkbox. When this is done, the Usage Identifier table becomes editable and you can add or delete usage identifiers as needed.

Click Submit to save the changes.

After adding the collector mappings, you can leverage a consolidated view of all the collector usage mappings as well as the associated products using the Usage Mapping View feature. To access tis, click the Usage Mapping View child node under the collector profile as described by the screenshot below.

Usage_Mapping_View.png

This will give you an overview of the products that are associated with the usage identifiers that are included in this collector profile, the field values that trigger them, as well as simple information on the usage records that were fed into the system using the collector.

Step 5. Load usage data.

Refer to the How To Load Usage Data for details on the various ways to load data into collector profiles.

Have more questions? Submit a request

Comments

  • Avatar
    Abinash John

    What do we need to input in the "Column Value" field? For e.g. if the "System Field" value is 'Quantity' what do I need to specify in the corresponding "Column Value" field?

  • Avatar
    Andrew Ryan

    This is for mapping, so all you are doing here is telling the system what column to look in for a unique product value, then providing that value in the right column. A common example, if you have a product column in your usage data, use the drop down to select the field you mapped to that column, then in the right column provide the value that corresponds with the product you chose.

  • Avatar
    Abinash John

    Ok. So in that case assuming the usage data has several records under the product column, can any record value be input in the corresponding value field?

  • Avatar
    Andrew Ryan

    Several records as in multiple records in the same column, or multiple records in multiple rows?

  • Avatar
    Abinash John

    multiple records in multiple rows

  • Avatar
    Andrew Ryan

    Then yes, any record value can be used

Powered by Zendesk