Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Back to Usage Service Catalogs Main Page

Excerpt
hiddentrue

Learn how you can to configure Usage Service Catalogs Catalog Business Definition Definitions that will dictate determine the overall behavior behaviour of the Usage Service Catalogs

What does this section cover?

Catalog

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Usage Service Catalog Definitions

Info
What are Usage Service Catalogs Definitions

 CONFIGURATION > BILLING APPLICATION > USAGE SERVICE CATALOGS > SET UP USAGE SERVICE CATALOG DEFINITIONS

What are Usage Service Catalog Definitions?

Usage Service Catalogs definitions is Catalog Definitions are a set of business rules used to control the behavior behaviour of Usage Service Catalogs throughout their whole life cycle. 

Through the definition you can define values of related allowed entities, as well as provide Default Rates for service types. These rates will be automatically selected when creating new Catalogs using the specific services, however you will still have the option to update.

Creating, Editing & Deleting Validations & Restrictions

 

ActionValidationsRestrictionsGeneral
  • Multiple Usage Service Catalogs definitions can exist in the system, but each one should have a unique name and alternative code
  • Only one active Usage Service Catalogs definition can exist at any given time
If no active Usage Service Catalogs definition exists, then no Usage Service Catalogs can be created

Catalogs throughout their Life Cycle. Using the Definitions, the Allowed Usage Service Types and the Provisioning Providers available when creating a Usage Service Catalog can be defined, and default billing rates for each Type of Service added to the Catalogs can be provided.

Usage Service Catalog definitions can be edited, deleted and have their Life Cycle State changed.

  • Navigate to Usage Service Catalog Definitions and explore existing entries via the Summary page
  • Click on the link (Name or Number) of the entry of your interest to access the Data Entry page and see more detail.

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition. 

  • Click on the Audit Log button to view a log of changes performed on the displayed Usage Service Catalog Definition.

Check the Validations & Restrictions Table below for a list of available Actions when working with Usage Service Catalogs, including each Action's related validations and restrictions.  View the Attributes Table for a comprehensive description of the Usage Service Catalog fields.

USAGE SERVICE CATALOGS DEFINITIONSImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictions
Create
  • Mandatory Fields must be defined.
  • Name and alternative code Alternative Code must be unique.
  • Not Applicable
Edit
  • Mandatory Fields must be defined.
  • Name and alternative code Alternative Code must be unique.
  • Not Applicable
Delete
  • Not Applicable
  • Cannot be deleted if its the active definition
Usage Service Catalogs Definition attributes 
  • it is the 'Active' Definition.

 

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory.

Name

Description

Main Information
NumberAn auto-generated number that uniquely identifies the usage service catalog definitionthe Usage Service Catalog Definition.
Name*The name of the usage service catalog definitionthe Usage Service Catalog Definition.
Alternative codeCode*

An alternative code for

the usage service catalog definition. On creating a new usage service catalog definition it should default to the first letter of each word included in the name (in Capitals), if nothing else is specified

the Usage Service Catalog Definition. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters.

DescriptionA description for the usage service catalog definitionthe Usage Service Catalog Definition.
StateThe state of the usage service catalog definition the Usage Service Catalog Definition which can be active or inactive'Active' or 'Inactive'. Only one active usage service catalog definition 'Active' Usage Service Catalog Definition can exist at any point.

Allowed Attributes

Defines the attributes which are allowed to that can be used on for creating or modifying usage service catalogsUsage Service Catalogs.

Provisioning ProvidersIt defines the provisioning providers which are allowed to Defines the Provisioning Providers who can be used to provision services supply the Services included in usage service catalogsUsage Service Catalogs. The default provisioning provider Provisioning Provider is also specified through in this section. The default provisioning provider Provisioning Provider is automatically selected on creating a new usage service catalogUsage Service Catalog.
Usage Service TypesIt defines the product types which are allowed to Defines the Product Types which can be included in usage service catalogsUsage Service Catalogs. Only product types Product Types which are classified as usage services Usage Services can be specified in this section. The default product type Product Type is also specified through this section. The default product type Product Type is automatically selected on creating a new usage service catalog productUsage Service Catalog Product.
Default Rates per Usage Service Type

Defines the default rates

per each usage service type. Multiple usage services type

for each Usage Service Type. Multiple Usage Services Type rates can be specified, but each

usage service type

Usage Service Type can be included just once. Default rates are automatically set on

usage service catalog services

Usage Service Catalog Services whenever a

usage service

Usage Service is added

in

to a

usage service catalog

Catalog, although users

are allowed to

can adjust those rates.

Usage Service Type*

The usage service or usage service type Usage Service or Usage Service Type which is available through the specific usage service catalogUsage Service Catalog.

Pre-Rated

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

If checked then UDRs submitted for the specific Usage Service Type will be processed as Pre-Rated, in which case the amount used to bill the UDR will be defined when the UDR is imported in CRM.COM through the WEB API, thus the 'Base Rate' and 'Tiered Rates' fields will not be available to be set.
By default this option is disabled.

Base Rate*

The base rate of the specified

usage service type.

Usage Service Type.

Note

Status
colourBlue
titleAvailable from CRM.COM R12.0.0
Not available if Pre-Rated setting is checked

Tiered Rates

The tiered rates of the specified usage service typeUsage Service Type. Multiple rates can be specified, but the specified conditions should not be overlappingoverlap. At least one condition should must be specified if a rate is specified. Tiered rates consist of the following:

  • UDR related information

    • Usage
    method
    • Method: The usage method that will be used to provision the
    usage service
    • Usage Service
    • Device: The device that will be used to provision the
    usage service
    • Usage Service
    • Source Category: The source category that will
    be used to
    • initiate the provisioning of the
    usage service
    • Usage Service
    • Destination Category: The destination category that will
    be used to
    • receive the provisioning of the
    usage service
    • Usage Service
    • Usage Start Time (inclusive): The time of the day that the usage started
    • Usage End Time (inclusive): The time of the day that the usage ended
    • Minimum Usage (Inclusive): The minimum usage of the
    usage service
    • Usage Service
    • Maximum Usage (Inclusive): The maximum usage of the
    usage service
    • Usage Service
  • Rate: The rate that will be applied if the conditions above are fulfilled

    per usage unit

Log Information

Includes the standard log information

Defining your own Usage Service Catalogs Definition tailored to your company's needs

  • Navigate to CONFIGURATION > BILLING APPLICATION > USAGE SERVICE CATALOGS > SET UP USAGE SERVICE CATALOG DEFINITIONS
  • Either search for an existing one or from the Top Menu click on NEW
    USAGE SERVICE CATALOGS DEFINITIONSImage Removed
  • MAIN INFORMATION

    1. Provide information for the following fields 

      1. Name: Provide a name for the definition

      2. Alternative Code: Provide an alternative code for the definition
      3. Description: Provide a description for the definition
  • ALLOWED ATTRIBUTES

    1. USAGE SERVICE TYPES

      1. Click on ADD  and search for Usage subscription service types that can be included in the usage service catalogs
      2. Default: Once all of the service types are added, click in the radio button to select the default service type
    2. PROVISIONING PROVIDERS

      1. Click on ADD and select from the drop down list the Provisioning providers that will be allowed to be included in Usage Service Catalogs
  • DEFAULT RATES PER USAGE SERVICE TYPE

    1. Click on ADD to add the service type from the search modal

    2. Click on the service type you added to the Item List, to start adding related information
    3. For each record you can define the following
      1. Base Rate: Select from the drop down list a subscription type
      2. Tiered Rates: Define the conditions for which the Rate defined in each Tiered Rate record row, will be applied (if conditions are met)
        1. Usage Method: Select from drop down list the Usage Methods
        2. Device: Select from drop down list the devices
        3. Source CategorySearch for the category
        4. Destination CategorySearch for the category
        5. Usage Start Time: Select hours and minutes from the drop down lists
        6. Usage End Time: Select hours and minutes from the drop down lists
        7. Minimum Usage: Provide a value to be considered as the minimum usage
        8. Maximum Usage : Provide a value to be considered as the maximum usage
        9. Rate: Provide an integer/decimal for the rate to be applied if conditions are met

          Info

          • Tiered Rates conditions should not be overlapping each other. i.e Defining same conditions in 2 different rows and providing different Tiered Rate

          • Repeat step 5 to add all the service types for which you would like to define default rates

  • From the Top Menu click on SAVE

  • LOG INFORMATION

    Include PageLog Information - GlobalLog Information - Global

    Deleting Usage Service Catalogs Definitions

    Include PageDeleting a record - GlobalDeleting a record - Global

    Changing the Life Cycle State of Usage Service Catalogs Definition

    Include PageChanging the Life Cycle State of a Definition - GlobalChanging the Life Cycle State of a Definition - Global

     

    • .

    Note

    Tiered Rates conditions should not overlap. e.g. You cannot define the same condition in two different rows with a different Tiered Rate.

    Note

    Status
    colourBlue
    titleAvailable from CRM.COM R12.0.0
    Not available if Pre-Rated setting is checked

    Log Information
    Log DetailsThe standard set of Log Details information available in all entities.
    Note

    View Understanding Usage Service Catalogs for business examples related to Usage Service Catalog Definitions.

    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalseexcerpttrue
    labelsusage-service-basics-r7,usage-service-advanced-r7,usage-service-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    labelsglobal