Usage

Gotransverse provides a flexible, powerful rating engine for rating and evaluating customer activity. For example, Gotransverse could support a subscription service that includes an initial start-up price and an adjustable fee based on the amount of data used.

To learn more about how to setup usage rules in Gotransverse, please see Usage Rule Creation Overview and Product-specific Usage Rules.

Creating a Usage Event

A new usage event can be created manually through UI 2.0. This is useful when you want to create a usage event conveniently without uploading a usage file. Once the usage event details are entered, you can simulate how the usage event will be rated to ensure the rating will be successful and the final amount is as expected. In some cases, copying an existing usage event may be easier than entering a new usage event.

Before creating the usage event you will want to know the Service Resource ID (SRID) and which fields will be required for the usage rule(s) to rate successfully. An SRID is a unique ID assigned to a recurring service. The service the SRID is assigned to contains usage rules that can be found in the service details. Those rules will require specific fields to be populated for GTV to rate the usage event successfully. Simulating the rating before creating the usage event will allow you to check that all fields required for the usage rule(s) are entered.

To create a new usage event:

  1. Select Customer Billing from the Gotransverse action menu .
  2. Select Usage in the left pane.
  3. Select the Usage Events tab.
  4. Click Create Usage Event.
  5. Enter the usage event details in the Create Usage Event window.

    FieldDescription
    Service Resource Identifier (SRID)*Enter the SRID. This determines which service the usage event relates to and which usage rules will be used to rate the event.
    Reference IDEnter the reference ID. This is a client defined field.
    Sequence IDEnter the sequence ID. This is a client defined field.
    Start Time*Enter the start time of the usage event. You must enter in a MM/DD/YYYY HH:mm:ss format.
    End TimeEnter the end time of the usage event. You must enter in a MM/DD/YYYY HH:mm:ss format.
    Unit of Measure*Enter the unit of measure (UOM) of the usage event. The UOM must match the UOM of the usage rule used for the SRID.
    Amount*Enter the amount of the usage event. This may be a dollar amount or a quantity, depending on the unit of measure.
    DescriptionEnter a description for the usage event.

    *Indicates required field.

    Note: The four required fields listed above are the minimum required for all usage events. Additional fields may be needed to successfully rate the usage event, depending on the usage rules configured for the service, and are not indicated with an asterisk.

  6. Add additional fields not found in the top portion of the Create Usage Event window by selecting the field name from the drop-down menu and entering a value. If you need more additional fields, click Add New Field to selecting a new field from the drop-down menu. The additional fields available, listed below, are the same fields found when uploading a usage file.

    Text 01Number 01Boolean 01Date 01
    Text 02Number 02Boolean 02Date 02
    Text 03Number 03Boolean 03Date 03
    Text 04Number 04Boolean 04Date 04
    Text 05Number 05Boolean 05Date 05
    Text 06—This field is populated with the original usage event ID when a new usage event is a copy of an existing event.

    Note: The fields required for the usage rule(s) to rate the usage event successfully will not be indicated with an asterisk.

  7. Simulate the rating of the usage event when all required fields are entered by selecting Simulate. GTV will simulate the rating of the usage event using the usage rule(s) associated with the SRID and display the results.

    Note: The simulated rating that occurs when creating a new usage event is a point-in-time rating. If you attempt to simulate rating a usage event with the same data at a later point in time, the returned charges may be different. This is due to rating being a highly dynamic process dependent on the complexity of the usage rules (tapers, tiering, allowances, multiple stacked rules), potential updates to the lookup tables referenced by these rules, and overall usage volumes.

    When a simulated rating fails, an error message from the rating attempt is returned. You will need to review the usage rules for the service to determine how to best edit the usage event details so that the usage rule can successfully simulate a rating. You cannot create a usage event if it failed the simulated rating.

  8. Select Create to finish creating the new usage event. The event will be rated, assigned a new Usage Event ID, and added as a pending charge for the related Billing Account.

Copying a Usage Event

You can create a new usage event by copying an existing usage event. Copying a usage event will open a window to create a new usage event with fields are prepopulated with the same values found in the original usage event. You can edit the prepopulated fields before creating the event.

Copying an existing usage event is useful when you want to create a new usage event for a customer. By copying an existing usage event that was already successfully rated, you can see which fields were entered and use that as a guide to ensure any required fields are entered for the new usage event.

Note: As part of the copy process, the original event’s Usage Event ID, by default, is written to one of the Text fields of the new usage event as a way to connect the original and copied event. The system setting “Copied usage event id is written to the following additional usage event field” determines which text field is populated with the original usage event ID and defaults to the Text 06 field. This field is indicated as Source Usage Event ID in the drop-down menu for Additional Fields. Any data found in this field in the original usage event will be overwritten when the usage event is copied.

To copy a usage event:

  1. Search for a usage event.
  2. Click the copy icon under the Actions column to open a new window.
  3. Enter or edit the usage event details in the Copy and Create Usage Event window.
  4. Add or edit additional fields not found in the top portion of the Copy and Create a New Usage Event window by selecting the field name from the drop-down menu and entering a value. If you need additional fields, click Add New Field to selecting a new field from the drop-down menu.
  5. Simulate the rating of the usage event when all required fields are entered by selecting Simulate. GTV will simulate the rating of the usage event using the usage rule(s) associated with the SRID.

    When a simulated rating fails, an error message from the rating attempt is returned. You will need to review the usage rules for the service to determine how to best edit the usage event details so that the usage rule can successfully simulate a rating. You cannot create a usage event if it failed the simulated rating.

  6. Select Create to finish creating the new usage event. The event will be rated, assigned a new Usage Event ID, and added as a pending charge for the related Billing Account.

Viewing a Lookup Table

Usage lookup tables are used to simplify usage rule specifications by moving commonly referenced information into a table accessible by the rule. A lookup table consists of lookup entries that group charge information. Each entry includes a single unique key and up to 20 data values tied to the key. Using multiple data values for a single lookup table entry can help reduce the number of lookup tables needed for usage rules.

You can view usage lookup tables created with UI 1.0 or API 2.

  1. From the Customer Billing application, select Usage in the left pane.
  2. To see a list of lookup tables available for your tenant, click the Lookup Tables tab.
  3. Select a lookup table from the list to view detailed information.
  4. On the Lookup Table Information page, you can view the following details:
    • Lookup—The ID of the lookup table.
    • Lookup Name—The name of the lookup table.
    • Status—The status of the lookup table.
    • Description—The additional information about the lookup table.
  5. To see a list of entries in the lookup table, click the Entries detail tab. You can view the following information:
    • Key—The key of the usage lookup table entry. It is unique per the usage lookup table.
    • Value—The value of the usage lookup table entry.
    • Valid From—The date and time since when the usage lookup table entry is valid.
    • Valid To—(nullable) The date and time until when the usage lookup table entry is valid. If this field is empty, the entry will not expire.
  6. Select an entry to view all of the values associated with the key. Labels for values can be customized in UI 1.0.
  7. To see the history of changes to the lookup table, go back to the Lookup Table Information page, then click the History detail tab. You can view the following information:
    • Date Time—The date and time when the change occurred.
    • Change Type—The type of change, such as INSERT, UPDATE, and so on.
    • Description—The details about the change.
    • First Name—The first name of the user who made the change.
    • Last Name—The last name of the user who made the change.
    • User Name—The name of the tenant that initiated the change.
    • Email—The email address of the user who made the change.
    • Note: You can add or remove table columns by clicking the Columns button.

Viewing a Rate Table

Rate tables contain a list of usage-based charges that can be applied to a usage event. Each rate table is made up of rate table entries which define the rate for consumed usage, effective dates, and the lookup value. Rate table entries are valid during the specified time periods which cannot overlap.

You can view the rate tables created with Gotransverse 1.0 or API.

  1. From the Customer Billing application, click the Usage tab in the left pane.
  2. To see a list of rate tables available for your tenant, click the Rate Tables tab.
  3. Click the desired rate table from the list to see the detailed information.
  4. On the Rate Table Information page, you can see the following details:
    • Rate—The ID of the rate table.
    • Rate Name—The name of the rate table.
    • Status—The status of the rate table.
    • Unit Of Measure—The unit of measure used for this rate table.
    • Description—The additional information about the rate table.
  5. To see a list of entries of the rate table, click the Entries detail tab. Here you can view the following information:
    • Lookup—The ID of the rate table entry
    • Lookup value—The lookup value to which the rate will apply. The lookup value cannot duplicate any existing lookup value in the table unless the date range for the new entry does not overlap the existing.
    • Rate—The rate that is applied to each unit of measure.
    • Valid From—The date and time since when the rate becomes effective.
    • Valid To—The date and time until when the rate is effective. If this field is empty, the rate will not expire.
  6. To see the history of changes of the rate table, click the History detail tab. It provides a way to view the following information:
    • Date Time—The date and time when the change occurred.
    • Change Type—The type of change, such as INSERT, UPDATE, and so on.
    • Description—The details about the change.
    • First Name—The first name of the user who made the change.
    • Last Name—The last name of the user who made the change.
    • User Name—The name of the tenant that initiated the change.

    Note: You can add or remove table columns by clicking the Columns button.