1. Charging Control Services Help
  2. Rating Management - Named Event Catalogues

7 Rating Management - Named Event Catalogues

This chapter explains how to configure named event catalogues.

This chapter contains the following topics.

Named Event Catalogue

Named Events Table

Event Details

Named Event Overrides Grid

Configuring Overrides

Time Periods

Importing and Exporting Named Event Catalogues

Named Event Catalogue

A named event catalogue defines a list of named events and their overrides. On the Named Event Catalogue tab you can configure:

  • The list of named events to include in the current catalogue

  • General event overrides

  • Time based event overrides, for example to cover holiday periods

Note: An override defines a period of time when the costs associated with the named event will be different or when the named event may be allowed or barred.

Tariff plan

You assign a named event catalogue to a tariff plan using the tariff plan selector. The named events included (and allowed) in the catalogue will then be available to all the product types that use this tariff plan.

When you assign a catalogue to a tariff plan, this also sets the date when the named event catalogue will become active.

For more information on the tariff plan selector, see Tariff Plan Selector.

Note: You can assign the same named event catalogue to more than one tariff plan.

Default catalogue

The default catalogue defines the default list of named events and event overrides. A product type will use the default catalogue if there is no tariff plan selector entry for the product type's tariff plan at the current time.

You can choose to include the default catalogue configuration in a named event catalogue by selecting the Include Default option.

If the current catalogue includes the default catalogue configuration, then the default configuration for the included events will be used unless specifically overridden by the configuration in the current catalogue.

Event rules

An event included in the named event catalogue can be either allowed or barred. This will depend on the overrides configured for the event.

Here are the rules used to determine whether or not an event will be allowed.

  1. If no overrides have been configured for the event then it will be allowed by default.

  2. If there is a general override in the current catalogue allowing the event then it will be allowed.

  3. If there is a general override in the current catalogue barring the event then it will be barred.

  4. If any time based overrides have been configured for the event to allow it or bar it, then the event will be either allowed or barred during the specified time period.

Here are the additional rules applying to the event if the default catalogue is included in the current catalogue:

  1. The event will be barred if there is no general override in the current catalogue and there is a default general override barring the event.

  2. A default time based override will override a general override in both the default and the current catalogue. This means that if any default time based overrides have been configured for the event to allow it or bar it, then the event will be either allowed or barred during the specified time period.

  3. If a time based override has been configured for the same period in the default catalogue and in the current catalogue, then the override in the current catalogue will take precedence.

Named Event Catalogue tab columns

This table describes the content of each column.

Field Description
Name

The catalogue name.

Note: The first catalogue in the list is the current default catalogue.

Default Catalogue Flag to indicate which is the default catalogue.
Include Default Flag to indicate if the this catalogue also includes the default catalogue.
Use Holiday Set The name of a Holiday set when one is used in this catalogue.

Setting the default named event catalogue

Follow these steps to set the default named event catalogue.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. In the table on the Named Event Catalogue tab, select the named event catalogue that you want to make into the default.

    Note: You must choose a named event catalogue which has the Include Default column set to 'No'.

  3. Click Make Default.

    Result: You see the Confirm Change Default Catalogue prompt.

  4. Click Yes to confirm.

    Result: The Named Event Catalogue table will be refreshed and the new default catalogue will be highlighted in bold at the top of the list.

Copying named event catalogues

You can copy the configuration for a named event catalogue to a new catalogue. This will copy:

  • The include default value

  • The use holiday set value

  • Included named events

  • Allow in catalogue values

  • Event override configuration

Follow these steps to copy a named event catalogue.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, select the catalogue to copy.

  3. Click Copy.

    Result: You see the Copy Existing Named Event Catalogue screen. The name of the catalogue you are copying is displayed in the screen.

  4. In the Name field, type the name you want to use for the new catalogue that will be created by the copy process.

  5. Click Copy.

    Result: The catalogue and its configuration is copied to the new name. The Named Event Catalogue tab is refreshed and you see the new catalogue listed on the tab.

Deleting named event catalogues

Follow these steps to delete a named event catalogue.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, select the catalogue to delete.

    Note: You may not delete any of:

    • The default catalogue

    • Any catalogue that has been associated with a tariff plan on the Tariff Plan Selector tab.

  3. Click Delete.

    Result: You see the Delete Confirmation prompt.

  4. Click Ok.

    Result: The catalogue is removed from any named event records included in the catalogue and the catalogue is deleted.

Named Event Catalogue fields

These tables describe the function of each field on the New and the Edit Named Event Catalogue screens.

Field Description
Name The name of the named event catalogue.
Include Default Select this check box to automatically include the named events and event overrides from the default named event catalogue in this named event catalogue.
Use Holiday Set

The Holiday Set to use for time based overrides.

This field is populated by the Holiday tab. For more information, see Holiday Tariffs.

Note: When set to "None" you will only be able to specify time based overrides for weekly and daily periods. You will not be able to specify time based overrides for holiday periods.

Display Filters
Field Description
Event Sets

Filters the named events listed in the Named Events table based on the selected event set. When "All Sets" is selected, all the event sets configured for the current service provider will be listed.

This field is populated by the Named Event tab. For more information, see Named Event.

Event Name The name of the specific event to search for in the selected event set.
Include In Catalogue

Filters the events listed in the named events table based on the selected inclusion option. Select one of:

  • Included - to list only events that have been included in the catalogue

  • Included in Current and Default - to list only events included in the current and default catalogues

  • Included & Not Included - to list all events

  • Not Included - to list only events that are not included in the catalogue

Note: This field is disabled for new named event catalogues and therefore appears grayed out in the New Named Event Catalogue screen.

Allowed In Catalogue

Filters the events listed in the Named Events table based on whether or not they have been allowed in the named event catalogue. Select one of:

  • Allowed - to list only events that have been allowed in the catalogue

  • Allowed & Barred - to list both allowed and barred events

  • Barred - to list only events that are barred in the catalogue

Note: This field is disabled for new named event catalogues and therefore appears grayed out in the New Named Event Catalogue screen.

Max Rows Defines the maximum number of rows that will be returned in the Named Events table. Defaults to 999.
Filter button

Activates the selected filters when clicked.

Result: The Named Events table is populated with the filter results.

Named Events table
Field Description
Event Set List of event set names used.
I

Included flag. Events with this check box selected will be included in the catalogue.

Note: Included events are automatically allowed in the catalogue. If you want to bar an event you must set up an override to do this.

Named Event List of events grouped by event set name.
A

Allowed flag. Events with this check box selected will be allowed in the catalogue.

Note:

This check box cannot be changed in this screen.

This check box is automatically set when either or both of the following are configured for the event:

  • General overrides

  • Time based overrides
Cash Cost

Lists the cash cost associated with each event.

Note: This value is automatically updated by general overrides configured for the event.

Time Cost (Secs)

Lists the time cost associated with each event.

Note: This value is automatically updated by general overrides configured for the event.

More Info (+) in this column indicates that time based overrides have been configured for the event.

Note: Cost values of all types (Cash, Time, Data and Unit) are automatically updated by general overrides configured for the event.

Named Event Override Configuration table
Field Description
Override Name Unique name for the event override
Cash Cost The cash amount to charge each time this named event occurs during the override period.
Time Cost (secs) The time to charge each time this named event occurs during the override period.
A Allowed flag. Events with this check box selected will be allowed in the catalogue.
General

Flag that indicates a general or time override.

  • Yes - no time based overrides are associated with this override

  • No - time based overrides have been configured

Adding named event catalogues

Follow these steps to add a new named event catalogue.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, click New.

    Result: You see the New Named Event Catalogue screen.

  3. In the Name field, type a unique name for the new catalogue.

    Warning: Data may be lost up until the Save is clicked.

  4. To include the default named event catalogue definition, select the Include Default check box.

  5. To specify time based overrides for holiday periods, select the required holiday set from the Use Holiday Set drop down list.

  6. Optionally, use the Display Filters section in the New or Edit Named Event Catalogue screen to specify the criteria to constrain the entries in the Named Events table.

    For more information on the fields in this section, see Named Event Catalogue fields.

  7. Optionally, click Filter.

    Result: All the events that match the specified filter criteria are listed on the Named Events table. For an example showing a list of filtered events, see Named Events table example.

  8. In the Named Events table, select the check box in the "I" column for the events to include in the catalogue.

    Result: The event is highlighted in bold.

  9. Add overrides to the included events as required. For more information on adding:

  10. Perform one of the following actions:

    • Click Save to save the record without closing the New Named Event Catalogue screen

    • Click Save and Close to save the record and return to the Named Event Catalogue tab

Related topic

Named Event Catalogue

Editing named event catalogues

Follow these steps to edit an existing named event catalogue.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, select the catalogue to change and click Edit.

    Result: You see the Edit Named Event Catalogue screen.

    Note: If you are editing the default catalogue you will see a warning at the top of the screen.

  3. Edit the fields in this screen to reflect the changes you need to make.

    For more information on the fields in this screen, see Named Event Catalogue fields.

  4. If you want to include some events that are not currently included in the catalogue, you will need to filter the events list.

    For details, see Filtering named events.

    Tip: Select "Included and Not Included" from the Include In Catalogue drop down list to see a full list of events for the selected Event Set.

  5. Select the check box in the "I" column for the events you want to include in the catalogue.

  6. Add, edit and delete overrides for the included events as required.

    For more information, see Configuring Overrides.

    Note: Any changes you make to the defined overrides will be shown in the Edit Named Event Catalogue screen. However, they will not be saved to the database until you save the named event catalogue record itself.

  7. Perform one of the following actions:

    • Click Save to save the record without closing the Edit Named Event Catalogue screen

    • Click Save and Close to save the record and return to the Named Event Catalogue tab

Related topic

Named Event Catalogue

Named Events Table

The table in the Named Events area of the New and the Edit Named Event Catalogue screen displays a list of named events. When you open:

  • The New Named Event Catalogue screen, all the available events are displayed

  • The Edit Named Events Catalogue screen, only the events currently included in the catalogue are displayed

You can filter the events listed to display a different set of events. For more information on filtering events, see Filtering named events.

Event display attributes

Events are displayed with the following attributes:

  • bold – If they are included in the current catalogue

  • normal font – If they are included in the default catalogue but have not been included in the current catalogue

  • italics – If they are not included in either the current catalogue or the default catalogue

Filtering named events

Follow these steps to filter the events listed in the Named Events table so that only relevant events are displayed.

  1. In the fields in the Display Filters section in the New or the Edit Named Event Catalogue screen, specify the criteria to use to filter named events.

    For more information on the fields in this section, see Named Event Catalogue fields.

  2. Click Filter.

    Result: All the events that match the specified filter criteria are listed on the Named Events table.

Event Details

You can view details for an event selected in the Named Events table. The details show the derived values for the event after applying general overrides from the default and current catalogues.

Note: The event details do not show how the event will be affected by any time based overrides that have been configured.

Event details fields

This table describes the function of each field in the Named Events table in the Event Details screen.

Field columns Description
Event Parameter Lists the names of the event parameters.
Derived Value

Lists the derived values for the event parameters after any general overrides have been applied.

Note: A general override will only be applied if the Allowed parameter for the override is set to Allowed.

Current General Override

Lists the general override values configured for this event in the current catalogue.

Note: This column will only appear if a general override has been configured for the event in the current catalogue.

Default General Override

Lists the general override values configured for this event in the default catalogue.

Note: This column will only appear if the default catalogue includes this event and a general override is configured for it.

Base Event Lists the base values configured for the event on the Named Events tab.

Click Close when you have finished viewing the event details.

Named Event Overrides Grid

The table in the Named Event Override Configuration area lists the overrides that have been configured for the currently selected Named Event in the New and the Edit Named Event Catalogue screen or defined as a default override for the default catalogue. You can:

  • Add, modify and delete non-default overrides for the event in the current catalogue

  • View the overrides configured for the event in the default catalogue

For more information about:

Override display attributes

Overrides are displayed in:

  • bold – If they have been configured for the event in the current catalogue

  • italics – If they have been configured for the event in the default catalogue

Default overrides

The overrides configured for the event in the default catalogue will be displayed in the list of overrides if the default catalogue is included in the current catalogue.

If the default catalogue is not included in the current catalogue, then only overrides configured for the event in the current catalogue will be listed.

Viewing default overrides

Follow these steps to view the override configuration defined for an event in the default catalogue.

  1. In the Named Events table select the required event.

    Result: The overrides defined for the event are listed in the table in the Named Event Override Configuration area.

  2. In the Event Overrides table, select the default override to view.

    Result: The View button replaces the Edit button.

    Note: Default overrides are displayed in the table in italics.

  3. Click View.

    Result: You see the View Named Event Override Dialog screen.

    Note: This is a non-editable screen.

  4. When you have finished viewing the override, click Cancel.

    Result: You are returned to the previous screen.

Configuring Overrides

You can configure overrides for the events included in the named event catalogue. The override values will be used instead of the base or default values defined for the event. An override can be:

  • General

  • Time based

General override

You can configure one general override only for each event included in the current catalogue. This will be active at all times except during the specific periods when a time based override is active.

Time based override

You can configure any number of time based overrides for the events included in the current catalogue. Each override can have multiple time periods associated with it. These define the time periods during which the override will be active.

Adding overrides

Follow the procedure below, to add a named event override, depending upon the override being:

Related topic

Configuring Overrides

Adding a general override

A general override is one that has no time based overrides.

Follow these steps to add a general override.

  1. On the Named Events table in the New or the Edit Named Event Catalogue screen, select the event to add a general override to.

    Note: You will not be able to add more than one general override to an event.

  2. Ensure the event is included in the catalogue.

    Tip: To include an event, select the I (included) check box for the event.

  3. In the Named Event Override Configuration section, click New.

    Result: You see the New Named Event Override Dialog.

  4. In the Override Name field, type the name of the override.

  5. To bar the event, ensure the Allowed check box is not selected.

    Note: The event will be allowed by default.

  6. In the Override Values section, select the Override check box for fields to override, then specify the required override values.

    For more information about these fields, see Named event override fields.

  7. Do not add any time period data.

  8. Click Update.

    Result: The override will be listed in the Named Event Override Configuration table and the:

    • General column for the override will be set to Yes.

    • The "A" column for the override will be selected.

Adding a time based override

Follow these steps to add a new time based override.

Note: Adding a time based override to a named event, sets the More Info column for the event in the Named Events table to (+).

  1. On the Named Events table in the New or the Edit Named Event Catalogue screen, select the event to add the override to.

  2. Ensure the event is included in the catalogue.

    Tip: To include an event, select the I (included) check box for the event.

  3. In the Named Event Override Configuration area, click New.

    Result: You see the New Named Event Override Dialog.

  4. Configure this record by entering data in the fields on this screen.

    For more information about the fields on this screen, see Named event override fields.

  5. In the Time Periods area, add the required time periods.

    For more information, see Adding time periods.

  6. Click Update.

    Result: The:

    • Override will be listed in the Named Event Override Configuration table.

    • General column for the override will be set to No, and

    • More Info column for the event in the Named Events table is set to (+).

Named event override fields

This table describes the function of each field.

Field Description
Override Name Unique name for the event override
Allowed

Sets whether the event is allowed or barred when the override is in effect.

Note: This field will be set to Allowed by default.

Free Event When selected, this event has zero charge.
Override check boxes Select these as relevant to enable the override field to be set.
Cash Cost The new cash amount to charge for this named event override.
Time Cost (secs) The new time amount to charge for this named event override.
Data Cost (data units) The new data amount to charge for this named event override.
Unit Cost

The new units amount to charge for this named event override.

Note: The Unit Cost is charged for balances that do not have cash, time, or data units (for example, SMSes).

Expenditure Plan

Sets whether this cost is included in expenditure calculations and defines the expenditure plan to use. To select an expenditure plan from the drop down list, select the Override check box.

This field is populated by the Expenditure Plan tab. For more information, see Expenditure Plan.

Contributes to Promotional Destination Sets whether this cost is included in the promotional destination calculations. To enable this field, select the Override check box.
Event Cascade

The balance type cascade that defines the order for using the balances for this named event. To enable this field, select the Override check box.

This field is populated by the records on the Balance Type Cascades tab. For more information, see Balance Type Cascades.

Use Single Balance

Sets whether the cost of the event should be taken from a single balance. To enable this field, select the Override check box.

Notes:

  • If this field is selected and there is no single balance that can cover the entire cost of an event, the event is declined with insufficient credit.

  • If this field is not selected, the event will be accepted, providing its entire cost can be satisfied with the selected cascade. The seconds and cash costs are taken pro-rata as necessary from each balance.
Time Periods table

Lists the time periods when these override values will be used instead of base, default or general override values for this event.

  • Types – The override type

  • Start Time – The start time when the override values will apply

  • End Time – The end time after which the override values will no longer apply

  • Holiday – The named event catalogue holiday set used

Note: If no time periods are defined, this override configuration will be classed as a general override.

Editing overrides

Follow these steps to modify an override for an event.

Tip: The "(+)" value in the More Info column for an event in the Named Events table indicates that one or more time based overrides have been defined for it.

  1. On the Named Events table in the New or the Edit Named Event Catalogue screen, select the event where the override to modify is defined.

    Result: The overrides that have been defined for the event will be displayed in the Named Event Override Configuration table.

    Note: You must select an event that is included in the catalogue.

  2. In the Named Event Override Configuration table, select the override to modify and click Edit.

    Result: You see the Edit Named Event Override Dialog.

  3. Edit the fields in this screen to reflect the changes you need to make.

    For information on:

  4. Click Update.

Related topic

Configuring Overrides

Deleting overrides

You can delete overrides that have been configured for events. You can delete:

  • All the configured overrides for one or more selected events

  • One or more selected overrides for a specific event

Related topic

Configuring Overrides

Deleting overrides for selected events

Follow these steps to delete all the configured overrides for a selected event or a group of events.

Tip: The "(+)" value in the More Info column for an event in the Named Events table indicates that one or more time based overrides have been defined for it.

  1. On the Named Events table in the New or the Edit Named Event Catalogue screen, select the event(s) for which to delete all overrides. To select:

    • All the events in the table, click Select All

    • A group of events in the table, select the first event in the group and then hold down the Shift key while selecting the last event in the group

    Tip: You can de-select a single event in a group by holding down Ctrl while selecting the event again.

  2. Click Delete Overrides.

    Result: You see the Delete Confirmation prompt for the selected events.

  3. Click OK.

    Result: The overrides are deleted.

    Note: If you are in the Edit Named Event Catalogue and you close it without saving, then any deletions you have made will be lost.

Deleting selected overrides

Follow these steps to delete one or more overrides for a selected event.

Tip: The "(+)" value in the More Info column for an event in the Named Events table indicates that one or more time based overrides have been defined for it.

  1. On the Named Events table in the New or the Edit Named Event Catalogue screen, select the event where the overrides to delete are configured. You must select an event that is included in the catalogue.

    Result: The overrides that have been configured for the event will be displayed in the Named Events Override Configuration table.

  2. In the Named Event Override Configuration table, select the override(s) to delete. You can select more than one. To select:

    • All the overrides, click Select All in the Named Events Override Configuration area

    • A group of overrides, select the first override in the group and then select the last override in the group while holding down the Shift key

    Tip: You can de-select an override by pressing Ctrl and selecting the override at the same time.

  3. Click Delete.

    Result: You see the Delete Confirmation prompt for the selected override(s).

  4. Click OK.

    Result: The selected overrides are removed from the Named Events Override Configuration table.

    Note: If you are in the Edit Named Event Catalogue screen and you close it without saving, then any deletions you have made will be lost.

Time Periods

Time period fields

This table describes the function of each Time Period field.

Field Description
Type

Lists the available time period types. Only relevant fields will be enabled for the selected type. Available types are:

  • Daily

  • Weekly

  • Holiday

Note: Holiday type time periods will only be available if a holiday set has been specified in the named event catalogue definition.

Holiday fields

Field Description
Holiday

Lists the available holiday periods.

This field is populated from the holidays defined for the named event catalogue's holiday set.
Start Time (Local TZ) Sets the start time on the first day of the holiday period when the override will become active.
End Time (Local TZ) Sets the end time on the last day of the holiday period after which the override will no longer be active.

Weekly fields

Field Description
Start Day Defines the first day of the week that the override will apply on.
End Day Defines the last day of the week that the override will apply on.
Start Time (Local TZ) Sets the start time on the first day of the week when the override will become active.
End Time (Local TZ) Sets the end time on the last day of the week after which the override will no longer apply.

Daily fields

Field Description
Day check boxes

A select in a check box for a day means that overrides will apply on that day.

Tip: You can select more than one day.

Start Time Sets the start time when the override values will apply for each day included in Daily periods.
End Time Sets the end time after which the override values will no longer apply for each day included in Daily periods.

Adding time periods

Follow these steps to add a new time period to an event override.

  1. In the Time Periods area in the New or the Edit Named Event Override Dialog, click New.

    Result: You see the New Time Period Dialog.

  2. Configure this record by entering data in the fields on this screen.

    For more information about the fields on this screen, see Time period fields.

  3. Click Update.

    Result: The new period is listed in the Time Periods table.

Related topic

Time Periods

Editing time periods

Follow these steps to edit a time period for an event override.

  1. In the Time Periods area in the New or the Edit Named Event Override Dialog, select the time period to change and click Edit.

    Result: You see the Edit Time Period Dialog.

  2. Edit the fields to reflect the changes you need to make.

    For more information about the fields on this screen, see Time period fields.

  3. Click Update.

Related topic

Time Periods

Deleting time periods

Follow these steps to delete a time period for an override.

  1. In Time Periods area in the New or the Edit Named Event Override Dialog, select the time period to delete.

  2. Click Delete.

    Result: You see the Delete Confirmation record.

  3. Click OK.

Related topic

Time Periods

Importing and Exporting Named Event Catalogues

The Import and Export buttons on the Named Event Catalogue tab allow you to import and export named event catalogue data. Use this facility to create named event catalogue data externally, using third party tools, before importing it into CCS.

Note: Named event catalogue data is exported to file and imported from file in XML format. Refer to the files in the /IN/html/Ccs_Service/xml/productCatalogue directory on the SMS for more information.

Data import

Use the import named event catalogue facility to import new named event catalogue definitions from file.

When you import a named event catalogue, the import file is pre-parsed to check that it conforms to the import file specification. If there are any errors in the import file then the import process will fail. Any changes that have been made to the database will be rolled back and the details of the lines/sections in the import file containing the error will be reported to the user.

Warning: You cannot update or delete existing named event catalogues using this facility.

Data export

Use the export facility to export a named event catalogue definition to a specified file.

When you export a named event catalogue definition, all the data that is related to the selected catalogue is exported. This includes the following data:

  • The name of the selected catalogue

  • Include default value

  • Associated holiday set

  • Included values

  • Allowed values

  • Override configuration (general and time-based)

Importing named event catalogues

Follow these steps to import a named event catalogue from file.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, click Import.

    Result: You see an Import screen.

  3. Select the folder which holds the import file.

  4. In the File name field, enter the import file name.

    Warning: The import file type must be XML.

  5. Click Import.

    Result: You see the Confirmation screen.

  6. Click Continue.

    Result: You see an Import successful prompt.

  7. Click OK.

Exporting named event catalogues

Follow these steps to export a named event catalogue and its related data to file.

  1. In the Rating Management window, select the service provider from the Service Provider list.

  2. On the Named Event Catalogue tab, select the catalogue to export and click Export.

    Result: You see an Export screen.

  3. Select the folder in which to store the export file.

  4. In the File name field, enter the export file name.

    Warning: The export file type must be set to XML.

  5. Click Export.

    Result: You see an Export successful dialog.

  6. Click OK.