4 Wallet Management
This chapter explains how to configure the components used to manage wallets.
Warning: The Wallet Management screens are only available if the Rating Management module has been installed on your system and if you are using the VWS domain. If you are using a third party domain, then you will not be able to access these screens.
This chapter contains the following topics.
Wallet Management Module
The Wallet Management screen lets you configure components of wallets. It contains the following tabs which are covered in the chapter:
In addition it contains the Periodic Charges tab. This tab is covered in the Wallet Management - Periodic Charges chapter.
Tracker Plans
The Tracker Plans tab lets you add, modify or delete tracker plans.
A tracker plan is associated to an expenditure plan. It sets a preference for recharging a certain balance type depending on the rules defined by the expenditure plan. Operators can use tracker plans during promotions when they want to:
-
Define counters which track a subscriber's usage or expenditure within a configured promotion period
-
Reward the subscriber based on their expenditure, either in real time or at the end of the period
Each counter is linked to a service (such as voice calls or SMS) and a configured rating scenario consisting of the following:
-
A corresponding balance type
-
Period of promotion (daily, weekly, monthly or yearly)
-
The amount of activity (cash, time or number of events) which will trigger the reward
When each service and rating scenario is defined, the counters which should be updated are chosen. This gives the operator full control over which services will be used as part of the promotion.
Tracker Plan fields
This table describes the function of each field.
Field | Description |
---|---|
Name | A unique name for the tracker plan. |
Tracker Plan | Indicates the expenditure plan that determines which balance types are tracked for promotion rewards. |
Bearer | Selecting this check box allows you to select the type of service to which the tracking plan applies. |
Channel | Selecting this check box allows you to select the method of recharge to which the tracking plan applies. |
Reference | Selecting this check box enables a text box where you can enter a short description of the tracking plan. |
Note: The bearer, channel or reference values are matched during voucher recharge. If they are not set, the voucher will be recharged using standard voucher information.
Adding tracker plans
Follow these steps to add a new tracker plan.
-
In the Wallet Management screen, select the service provider from the drop down box.
-
On the Tracker Plans tab, select the balance type to which the new tracker plan will be linked.
-
Click New.
Result: You see the New Tracker Plan screen.
-
Configure this record by entering data in the fields on this screen.
For more information about the fields on this screen, see Tracker Plan fields.
-
When you have completed configuring the new tracker plan, click Save.
Related topic
Editing tracker plans
Follow these steps to edit an existing tracker plan.
-
In the Wallet Management screen, select the service provider from the drop down box.
-
On the Tracker Plans tab, select the balance type to display all associated tracker plans.
-
In the table, select the record to edit and click Edit.
Result: You see the Edit Tracker Plan screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Tracker Plan fields.
-
Click Save.
Related topic
Deleting tracker plans
Follow these steps to delete an existing tracker plan.
-
In the Wallet Management screen, select the service provider from the drop down box.
-
On the Tracker Plans tab, select the balance type to display all associated tracker plans.
-
In the table, select the record to delete and click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the Tracker Plans prompt.
-
Click OK.
Balance Units
This screen enables you to view, add, edit and remove balance units.
Balance units are the type of unit used in balance types. Balance units are either cash or non-cash. Non-cash units include:
-
Notifications
-
Bad PIN counts,
-
Promotional Counters
-
Time
-
Data.
Note: The functionality that uses time balance units is only available if you have the appropriate license.
Topics:
Adding balance units
Follow these steps to add a new balance unit.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Units tab, click New.
Result: You see the New Balance Unit screen.
-
In the Name field, enter the name of the balance unit.
-
Click Save.
Related topic
Editing balance units
Follow these steps to edit an existing balance unit.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Units tab, select the balance unit you want to edit.
-
Click Edit.
Result: You see the Edit Balance Unit screen.
-
Edit the details as described in Adding balance units.
-
Click Save.
Related topic
Deleting balance units
Follow these steps to delete an existing balance unit.
Warning: If you delete a balance unit which is associated with a balance type, your system may become unstable.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Units tab, select the balance unit to delete.
-
Click Delete.
Result: A Delete Confirmation screen appears, similar to that shown below. The type of balance unit shown in the screen will depend on the name of the unit you are deleting.
-
Click OK.
Result: The record will be deleted from the database.
Related topic
Balance Types
The Balance Types tab on the Wallet Management screen allows you to view, add, and edit balance types.
Note: The units used for balance types can be either cash, time, data, or units.
Topics:
Balance type categories
This table describes the different categories of wallet balance types.
Balance Type | Description |
---|---|
Chargeable Balance |
Holds the balance types used to cover charges to subscribers. For example: General Cash. These are the only balances that can contribute to expenditure. |
Cross Balance | Used to apply a cross balance discount to calls that have a cash charge. |
Expenditure Balance | Used to accrue daily, weekly, monthly, annual, and total wallet expenditure. Expenditure is calculated based on charges applied to chargeable wallet balance types that have the 'Contributes to Expenditure Plans' flag set. |
Fraud Balance | Holds fraud balance types. For example: Bad PIN balances. |
Internal Balance | Used by the system for internal accounting purposes. Any balance type that is not chargeable, cross, expenditure, or fraud should be set to internal. |
Quota Balance | Used to accrue data quotas. As part of a multi-tariff rating definition, it can then be used to track, and limit, the use of another charging balance cascade. |
Cross balance types
The cross balances are collected into cross balance type cascades. Charges against the subscriber's wallet also debit the cross balances in the cross balance cascade. As each cross balance reaches zero, the debit passes to the next cross balance. The discount which applies is the discount configured for the cross balance which is highest in the cross balance cascade and has a positive balance.
Each cross balance type cascade applies to the CLI-DNs which include it in their configuration.
Charges from CLI-DNs are cumulative. For more information about cross balance type cascades, see Cross Balance Type Cascades. For more information about CLI-DNs, see CLI-DN.
Expenditure balance types
Expenditure balance types can have one of the following expenditure types:
-
Daily
-
Weekly
-
Monthly
-
Yearly
-
Wallet
Monthly, yearly, and wallet are always installed, but daily and weekly are only available if you have the Promotion Manager license.
All other balance types must have the Expenditure Type field set to
None
. Expenditure is updated by expenditure against chargeable
balances which:
-
Have the 'Contributes to Expenditure Plans' flag set to 'Y'
-
Are included in an expenditure plan which is included in a CLI-DN or named event
Expenditure balance types are also used as a basis for calculating promotions.
Expenditure expiry dates
The expiry date for an expenditure balance is first set when the wallet is activated and then reset when the balance expires. The date set will depend on the expenditure type and the date basis used.
The date basis determines which day of the month and month of the year is assigned to the balance. The options are:
-
Balance creation date (default)
-
Fixed date
-
Wallet activation date
-
Wallet expiry date
The expenditure type determines the period used to extend the expiry date. When the expenditure type is:
-
Daily, the expiry date will be extended by one day
-
Weekly, the expiry date will be extended by seven days
-
Monthly, the expiry date will be extended by one month
-
Yearly, the expiry date will be extended by one year
-
Wallet, the expiry date will be extended to match the current expiry date for the wallet
Example 1
If you set the expiry date calculation basis to 'Fixed Date' for a monthly expenditure balance type, then the specified day of the month will be used to extend the expiry date.
Example 2
If you set the expiry date calculation basis to 'Wallet Activation Date' for a yearly expenditure balance type, then the day and month of the year the wallet was activated will be used to extend the expiry date.
Distributed wallet balances
If the wallet has been distributed across separate charging and tracking domains, then you may not be able to edit all wallet balances through the Edit Subscriber screen. If the wallet has been configured to use:
-
A VWS domain for charging and tracking, you will be able to view and edit all wallet balances
-
A third party charging domain and no tracking domain, you will not be able for view or edit any wallet balances
-
A third party charging domain and a VWS tracking domain, you will only be able to view or edit expense and fraud balances
Maximum balances
You can set a maximum balance value for a balance type. If set, then this value may not be exceeded when a wallet is recharged or updated.
When applying a wallet recharge or update, the maximum balance value will be evaluated against currently available balances only. Any offset balances defined for the wallet will not be included in the total balance value.
Note: This functionality is applicable to prepaid balance types only.
Maximum balance policy
You can specify the policy to associate with the maximum balance value. This table describes the available policy options.
Policy | Description |
---|---|
Limit Additional Credits |
A wallet recharge or wallet update will be restricted to the maximum balance value configured for the balance type for all applicable balances. Any unused balance values will be recorded in the EXCEEDED_BALANCE_TYPES and EXCEEDED_VALUES tags in the resulting VWS EDR. |
Reject Credits Over |
The default option. You will not be able to apply a wallet recharge or update which would exceed the maximum value configured for any of the balance types in the wallet. This will result in failure and no balances will be updated or recharged. The balance types causing the failure will be recorded in the FAILED_BALANCE_TYPES tag in the resulting VWS EDR. |
Quota Notifications
You can define quota notifications that will be sent to users when their balance breaches a configured threshold.
On the Quota Notifications tab, the following fields are displayed:
-
Quota Notification 1
-
Notification
-
Threshold (%)
The Quota Notifications tab enables you to define up to three quota notifications per service provider. For each quota notification, you define the notification to send and the threshold value.
Thresholds are a percentage of the used quota that is in the Quota Tag Set profile fields. When a subscriber's balance breaches a quota of the specified threshold, the defined notification is sent.
For example, if the quota retrieved from the Quota Tag Set Profile field is 50% and the threshold value is 1000 (£10.00), the notification is sent when the subscriber's balance reaches 50% of the defined threshold value, £5.00.
The thresholds apply to all subscribers. However, they can be customized at the subscriber level by using the PI command to set the Quota Value and Quota Threshold profile fields.
See CCS Provisioning Interface Commands for more information about using PI commands to change subscriber profile fields.
Balance Types help
For help with a new Balance Type screen, see Adding balance types.
For help with editing an existing Balance Type screen, see Editing balance types.
Related topic
Balance Type screen
The New Balance Type and Edit Balance Type screens contain tabs which enable you to configure:
-
Balance Type Details
-
Balance Type Announcements
-
Quota Notifications
Balance Type Details fields
This table describes the function of each field on the Balance Type Details tab.
Field | Description |
---|---|
Name | Enter the name of the balance type. This field is required. |
Unit |
The balance unit associated with this balance type. The drop-down list displays all available balance units. Note: For more information about configuring balance units, see Balance Units. |
Default Type |
Indicates if the unit selected in the Unit field is the default cash balance type. Tip: Only one balance type in CCS should be set as the default type. |
Display to Spend Ratio |
The ratio value applied to this balance type. This increases the value of this balance type by the entered value when it is used within a rating solution. Notes:
|
Delete After Last Bucket Expiry |
Select this check box to delete this balance type when the last bucket expires. Note: You may not set this option for fraud balances or the default balance type (normally the General Cash balance type). |
Exclude from Creation |
Select this check box to exclude this balance type from all new wallets when they are created. Deselecting this check box adds this balance type to all newly created wallets. |
Play Announcement if Zero Balance |
Select this check box to play an announcement to the caller when the caller's balance is zero. Tip: This configuration option is used by feature nodes that inform a subscribers about their balances. |
Category |
Indicates if the balance type is:
For more information about balance type categories, see Balance type categories. Notes:
|
Primary Quota Tag Set |
Select the quota limit value for the primary wallet. Note: This is available when category is
set to |
Secondary Quota Tag Set | Select the quota limit value for secondary wallet. |
Allow Credit |
Select this check box if this balance type can have a credit limit. Credit limits are configured in the Convergent Charging, Subscriber Management, Wallets screen. |
Expenditure Type |
If Category is set to Expenditure Balance, set this field to how frequently the balance is reset to zero. Notes:
|
Contributes to Expenditure Plans |
Select this check box if charges against balances of this type can increase expenditure balances. Notes:
|
Include in Reward Notification |
Selecting this check box indicates that this balance type will be included in SMS notifications. Note: This check box is available for only if Category is set to Chargeable Balances. |
Re-create Bucket on Expiry |
Select this check box to recreate a bucket belonging to this balance type on expiry. Note: This check box is enabled only if
Category is set to |
Delete After Last Bucket Expiry |
Select this check box to delete balances of this type when the last bucket expires. Note: This check box is not enabled for fraud balances or the default balance types (the general cash balance type). |
Cross Balance Type Discount % |
The discount percentage to be applied for a cross balance type. Notes:
|
Max Balance |
(Optional) sets the maximum value a balance of this type may have. May be set for these balance categories:
In the cash field, type the required value in the units of the balance type and select the Policy to use from the drop down list. Notes:
|
Expiry Date Calculation |
Base the balance type expiry date for tracker balances on one of the following:
If you select |
Balance Type Announcements fields
This table describes the function of each field on the Balance Type Announcements tab.
Field | Description |
---|---|
Name | Name of the balance type. This field is required and must be the same as for the Balance Type Details tab. |
Expiry Announcement Set | The announcement set to play from when the subscriber's balance expires. |
Expiry Announcement Entry | The announcement entry to play to the subscriber if their balance expires. |
Single Day Expiry Announcement Set | The announcement set to play from when the subscriber's balance is due to expire in a day. |
Single Day Expiry Announcement Entry | The announcement entry to play to the subscriber if their balance is due to expire in a day. |
Positive Announcement Set |
The announcement set to play from if the subscriber's non-cash balance is positive. Note: This field cannot be set if
|
Positive Announcement Entry |
The announcement entry to play to the subscriber if their non-cash balance is positive. Note: This field cannot be set if
|
Negative/No Credit Announcement Set |
The announcement set to play from if the subscriber's balance is negative or has no credit. Note: This field cannot be set if
|
Negative/No Credit Announcement Entry |
The announcement entry to play to the subscriber if their balance is negative or has no credit. Note: This field cannot be set if
|
Quota Notifications fields
This table describes the function of each field.
Field | Description |
---|---|
Name | Name of the balance type. |
Notification | Select the notification to send to the subscriber from the list. |
Threshold (%) |
The threshold at which a notification is sent to the subscriber. A maximum of three thresholds can be set. Note: Thresholds are the percent of the used quota in the profile location selected in the Primary Quota Tag Set and Secondary Quota Tag Set fields.The Threshold field gets enabled when you select the notification to send the subscriber. |
Adding balance types
Follow these steps to add a new balance type.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Types tab, click New.
Result: You see the New Balance Type Screen, Balance Type Details tab.
-
Enter detail data in the available fields on this tab to configure this record.
For more information about the fields on this tab, see Balance Type Details fields.
Note: Some fields are unavailable depending on selections in other fields on this tab.
-
Select the Balance Type Announcements tab.
-
Configure the announcements from the a vailable drop down lists on this tab. For more information about the fields on this tab, see Balance Type Announcements fields.
Note: Depending on the Unit selection (on Balance Type Details tab), some of these fields will be unavailable.
-
Click New to add, edit and delete a currency to announcement maps. See Currency to Announcement Maps.
Tip: The New button will be available when the Unit is
Cash
(Balance Type Details tab). -
Select the Quota Notifications tab.
Note: This tab is only available when Category is set to
Quota Balance
on the Balance Type Details tab.For more information about the fields on this tab, see Quota Notifications fields.
-
For each quota notification, specify the quota notification thresholds by doing the following:.
-
From the Notifications list, select the notification to send.
-
In the Threshold % field, enter the threshold value.
Note: These notifications are sent to the subscriber when the thresholds set here have been breached. The thresholds are the percent of the used quota in the profile location selected in the Primary Quota Tag Set field and Secondary Quota Tag Set field.
Tip: When saved, the quota notification sets are sorted largest to smallest, so when adding a threshold value, any of the sets can be used. However the notifications are sent in ascending percentage order.
For example; thresholds for 60, 30 and 90 percent are set in that order, after saving, the list will be in 90, 60 and 30 order, but the first notification is sent after 30% of quota has been used, a second when 60% and a third after 90%.
-
-
Click Save.
Related topic
Editing balance types
Follow these steps to edit an existing balance type.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Types tab, select the balance type to edit from the table.
-
Perform one of the following:
-
Click Edit
-
Double-click on the record
Result: You see the Edit Balance Type Screen.
-
-
Edit the fields with the required changes on the Balance Type Details tab.
For information about the available fields, see Balance Type Details fields.
-
Edit the fields with the required changes on the Balance Type Announcements tab.
For information about the available fields, see Balance Type Announcements fields.
-
If the balance unit is
Cash
, you can add, edit and delete a currency to announcement map for Positive and Negative/No Credit announcements. See Currency to Announcement Maps. -
If the Category of the balance type is
Quota Balance
, you can configure notifications for the quota on the Quota Notifications tab.For information about the available fields, see Quota Notifications fields.
-
Click Save.
Related topic
Currency to Announcement Maps
As part of setting up a balance type, you can configure currency to announcement maps. Announcements are used in the Cumulative Balances feature node.
Topics:
Adding a currency to announcement map
Adding a currency to announcement map
Follow these steps to add a currency to announcement map for a cash unit balance type.
-
Open the Balance Type screen for an existing cash unit balance type, as described in steps 1-3 of Editing balance types.
-
Click New.
Result: You see the Currency to Announcement Mapping screen.
-
From the Currency One drop down box, select the primary currency this balance type will use.
-
If this service provider has a second currency configured, select the second currency from the Currency Two drop down box.
-
From the Positive Announcement Set drop down box, select the announcement set which contains the announcement entry which should be played to the subscriber if their balance is positive.
-
From the Positive Announcement drop down box, select the announcement entry which should be played to the subscriber if their balance is positive.
-
From the Negative Announcement Set drop down box, select the announcement set which contains the announcement entry which should be played to the subscriber if their balance is negative.
-
From the Negative Announcement drop down box, select the announcement entry which should be played to the subscriber if their balance is negative.
-
Click Save to save the changes to the database and return to the Balance Type screen. The mapping will appear in the table.
Editing a currency to announcement map
Follow these steps to edit a currency to announcement map for a cash unit balance type.
-
Open the Balance Type screen for an existing cash unit balance type, as described in steps 1-3 of Editing balance types.
-
Select a mapping from the table and click Edit.
Result: You see the Currency to Announcement Mapping screen.
-
Edit the details, as described in Adding a currency to announcement map.
-
Click Save.
Deleting a currency to announcement map
Follow these steps to delete a currency to announcement map for a cash unit balance type.
-
Open the Balance Type screen for an existing cash unit balance type, as described in steps 1-3 of Editing balance types.
-
Select a mapping from the table and click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to remove the mapping and return to the Balance Type screen.
Balance Type Translations
The Balance Type Translations tab lets you view, add, edit and remove translations of balance types. All SMS Notifications which include balance amounts use these translations. Short messages which use this method of displaying balances include:
-
Short messages generated by the Call Info Text Message feature node
-
Reward notification short messages
-
Recharge confirmation short messages.
Notes:
-
If your system lets you specify time costs, then you can define translations for time balance messages. The time balances are displayed in both seconds and in minutes and seconds. This functionality is only available if you have the appropriate license.
-
If no translations of a balance type are provided here for a language, no references to that balance type will be displayed in any short message generated in that language.
Message values
Cash balances
Cash balances in a notification have this format:
[Translated Balance Type Name] [Currency Code][Wallet Balance] [Separator]
where
-
[Translated Balance Type Name] is entered in the Translated Name field
-
[Currency Code] is the default currency's currency code
-
[Wallet Balance] is the subscriber's currency wallet balance
-
[Separator] is the character, entered in the Separator field, used to separate the main units of the balance value from its sub units.
Example: If the translated name is 'Gen' and the separator is '.', then the translated short message will be:
Non cash balance messages
A non cash balance notification has this format:
[Translated Balance Type Name] [Wallet Balance]
Where:
-
[Translated Balance Type Name] is entered in the Translated Name field
-
[Wallet Balance] is the subscriber's balance in the appropriate units
Example: If the translated name is 'Time', and the balance in seconds is 300, then the short message will be:
"Your Time balance is 300 seconds"
Balance Type Translations Fields
This table describes the balance-type translation fields.
Field | Description |
---|---|
Language |
The language the short message is being translated to. This field cannot be changed after the record is first saved. This list is populated by the Language tab on the ACS Tools screen. For more information about configuring languages, see ACS User's Guide. |
Balance Type |
The balance type this translation will be for. This list is populated by the records configured in the Balance Types tab. This field cannot be changed after the record is first saved. Tip: You can create only one balance-type translation for each language and balance-type combination. |
Single Balance Currency Type |
If required, you can select a different single balance currency type to use for the balance type. Note: This field is available only if the Balance Type field is set to a balance type that has a unit of cash. |
Dual Balance Currency Type |
If required, you can select a different dual-balance currency type to use for the balance type. Note: This field is available only if the Balance Type field is set to a balance type that has a unit of cash. |
Translated Name |
The translated balance-type name to send to the subscriber in short messages. If nothing is entered in this field, this part of the message will not be sent. Tip: The maximum number of characters allowed is 20. |
Single Format for Balance | The structure of the data to send to the subscriber in short messages for a single (or first) currency. See Single Format for Balance Field. |
Dual Format for Balance |
The structure of the data to send to the subscriber in short messages for the second currency. Note: This field is not available for non-cash balance types or balance types that have only one currency. |
Separator |
The character to use to separate the different balances when put together in an SMS Notification. Example: If you enter a comma (,) and there are two balances, General Cash and Promotional Cash, the short message sent in response to a balance inquiry looks like this: General Cash balance $20.00 , Promotional Cash balance $10.00 . |
Balance Expiry |
The balance-expiry text. Warning: You must include '%d' in the text. This variable will be converted to the number of days remaining until the balance expires. |
No Balance Expiry | The text to output for balances that have no expiry date. |
Adding balance type translations
Follow these steps to add a new balance type translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Balance Type Translations tab, click New.
Result: You see the New Balance Type Translation screen.
-
Enter data in the fields to configure this record.
For more information about these fields, see Balance Type Translations Fields.
Note: The Single Balance Currency Type and Dual Balance Currency Type fields and the Dual Format for Balance field are only available if you select a balance type which has a balance unit of cash from the Balance Type drop down list.
-
Click Save.
Related topic
Editing balance type translations
Follow these steps to edit an existing balance type translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Balance Type Translations tab, select the balance type translation to edit.
-
Click Edit.
Result: You see the Edit Balance Type Translation screen.
-
Edit the fields with the changes to make.
For more information about the fields on this screen, see Balance Type Translations Fields.
Note: The Language and Balance Type fields cannot be edited.
-
Click Save.
Related topic
Deleting balance type translations
Follow these steps to delete an existing balance type translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Balance Type Translations tab, select the balance type translation to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database and return to the Balance Type Translations tab.
Related topic
Rewards
The Rewards tab lets you view, add, edit and remove rewards.
You use rewards to:
-
Configure product type changes based on the amount of activity a subscriber did in a defined period
-
Specify the message to output to a subscriber when they receive a reward
-
Grant additional cash or equivalent bonuses
Any combination of product type change and cash reward can be defined, including:
-
Cash rewards only (where there is no product type change)
-
Product type changes only (where there is no associated cash reward)
-
Both cash rewards and product type rewards
Multiple balance type
You can add more than one balance type to a reward type. When a reward is triggered, all balance types associated with the reward type are recharged. This can include both monetary balance types (such as general cash or promotional cash) and non-monetary balance types (such as free SMS or time).
More than one entry can be added for the same balance type, with different details for each entry, including:
-
Balance values and balance policies
-
Unique expiry dates and extension policies
-
Balance availability dates that will be applied when the selected balance type entry is recharged
Offset date rules
Here are the rules which apply when setting a balance offset date.
-
You may only set balance offset dates for the following balance type categories:
-
Chargeable
-
Cross balance discount
-
-
If you set the balance offset date to a specific date then the balance expiry policy options will be disabled.
-
If you set the balance offset date to a specified number of days or months, then the balance offset date will be determined by extending the current system date by the configured value.
-
If you set the balance offset date (either as a specific date or as a number of days/months) then you can also set a balance expiry date. The balance expiry date will be calculated from the specified balance offset date.
Notifications
Notifications can be sent when a reward is triggered. To send a notification when the subscriber's account is close to triggering a reward, specify an additional reward with no value, which includes the notification.
Example: You have a reward which is triggered when the subscriber has used 100 short messages. You want to send subscribers who have sent 90 short messages a notification which will encourage them to send 10 more (for example: "You have nearly reached the bonus SMS level.").
Create a new reward which is triggered when a subscriber has used 90 short messages. The new reward will not change any balances, but it will send out the message as a notification.
Triggering rewards
Rewards are triggered on VWS Voucher and Wallet Servers for one of the following:
-
The reward type balance type threshold is reached.
-
The relevant expenditure balance expires.
Expiration examples
This table provides examples of when a reward is triggered.
Period | Expiration | Example |
---|---|---|
Daily | Midnight same day |
Activated @ 1:30 pm. Expires midnight same day. |
Weekly | Midnight |
Activated @ 1:30 pm Tuesday. Expires midnight following Monday. |
Monthly | Midnight following month |
Activated @ 1:30 pm 5th of the month. Expires midnight of 4th of the following month. |
Yearly | Midnight following year |
Activated @ 1:30 pm 5th March. Expires midnight 4th March following year. |
Wallet | 24 hours before the wallet expires @ 1:30pm 5th March. |
Expires 1:30pm 4th March If less than 24 hours exist before wallet expiry, wallet will not be recreated. |
Note: Unlike other expenditure balance types, the wallet expenditure balance type cannot be used again on expiry. Once the wallet expires, the system will not recreate or add to the wallet expenditure balance, until the wallet expiry date/time is extended to be more than 24 hours in the future. The wallet expenditure balance is recreated and will be used once more after the wallet expiry extension.
Rewards fields
This table describes the function of each field.
Field | Description |
---|---|
Reward Type | The expenditure balance type where the activity qualifying the subscriber for the reward is recorded. |
Current Product |
The product type from which the subscriber's account is being transferred. Tip: Selecting |
Start Amount |
The amount which will trigger the change of product type. Warning: Rewards must be defined for all monthly totals within a product type. For example, if you want to have a reward which is triggered when a subscriber has a total of $50 of activity in a month/year, you will also need to configure a reward for subscribers who have a smaller monthly total and the same current product. |
Reward Product |
The product type to which the subscriber's account is being transferred. Note: Selecting |
Reward Description | A brief description of the reward. |
Start Date | The start date of the period during which the subscriber's expenditure will be tracked for earning this reward. |
End Date | The end date of the period during which the subscriber's expenditure will be tracked for earning this reward. |
Notification Template |
The notification sent to the subscriber when they receive a reward. Note: For information about setting up notifications, see ACS User's Guide. |
Reset Counter |
Whether to reset the expenditure balance type specified in the Reward Type field when the reward is triggered. Note: This check box is only available if you have selected the Real-Time Reward option. |
Real-Time Reward | Indicates that the reward is applied as soon as the expenditure threshold is reached. |
Control Plan |
Defines the control plan that will be used to apply the reward for subscribers who are on a non VWS charging domain. Note: The control plan must contain the Voucher Type Recharge node. |
Reward Announcement | Defines the announcement to play when the reward is selected using the Play Reward node. |
Adding rewards
Follow these steps to add a new reward.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Rewards tab, click New.
Result: You see the New Reward screen.
-
Configure this record by entering data in the fields on this screen.
For more information about the fields on this screen, see Rewards fields.
-
Click Save.
Related topic
Editing rewards
Follow these steps to edit an existing reward.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Rewards tab, select the reward to edit.
-
Click Edit.
Result: You see the Edit Reward screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Rewards fields.
-
Click Save.
Related topic
Deleting rewards
Follow these steps to delete an existing reward.
Warning: When you delete a reward, any associated freeform SMS messages are also deleted.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Rewards tab, select the reward to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database and return to the Rewards tab.
Related topic
Multi-Balances fields
This table describes the function of each field.
Field | Description |
---|---|
Balance Type |
The balance type you want the reward to apply to. This field is populated by the records on the Balance Types tab. Note: Any valid balance type can be selected. This includes non cash balance types, such as time. |
Value | The reward amount for balances of the balance type selected in the Balance Type field. |
Tax Plan |
The tax plan associated with this voucher type. Note: For inclusive tax, the tax component will be removed before crediting the subscriber. |
Balance Expiry Period |
The period between when the reward is activated and when the balance will expire. Depending on the selection in the expiry period type options, enter one of:
Note: Month expiries set expiry dates measured in calendar months. If a bucket is created on the 31st of the month, and the expiry will be on month which has 30 days or less, the expiry date is set for the 1st of the month after. For example, a two-month bucket created on the 31st of December will expire on the 1st of March. Tip: The |
Expiry Period Type |
The unit the balance expiry period is calculated in. Select either:
|
Applicable Start Date | Optional start date when balances of this type can be rewarded by rewards of this type. To activate this field, select the check box to the right of the field, then, in the date selection boxes, select the day, month and year for the start date. |
Applicable End Date | Optional end date when balances of this type can no longer be rewarded using rewards of this type. To activate this field, select the check box to the right of the field, then, in the date selection boxes, select the day, month and year for the end date. |
Offset Date |
Optional offset date fields used to configure the offset date to apply when balances of this type are recharged. To activate these fields, select the check box to the right of the offset date fields area. To enter:
Note: For details on the rules applying to offset dates, see Offset date rules. |
Missing Balance Policy |
What to do, if this balance type does not already exist in the wallet when the reward is applied. Choose one of:
|
Expiry Policy |
How to apply the expiry period for this balance type when rewards of this type are applied. Choose:
|
New Bucket | Whether to create a new bucket for the balance type when the reward is applied. |
Replace Balance |
Whether to replace the existing balance for the balance type with the new value when the reward is applied. Note: You can only set the replace balance option providing there are no overlapping reward balances for the same balance type with this option set. |
Allowed Product Types |
The product types which rewards of this type can apply to. Tip: An empty Allocated list means that the balance type can be rewarded for all product types. |
Adding balance types to a reward
Follow these steps to add a balance type to the current reward type.
Note: To add multiple balance types to the reward type, repeat this process as required.
-
In the Multi-Balances area at the bottom of the New Reward screen or Edit Reward screen, click New.
Result: You see the New Multi-Balance screen.
-
Start to configure this record by entering data in the fields in the top of this screen. For more information about the fields on this screen, see Multi-Balances fields.
-
In the Allowed Product Types section select the product types for which the reward can be applied to this balance type. To:
-
Allocate a product type, select it in the Available list and click the '>>' button
-
Remove an allocated product type, select it in the Allocated list and click the '<<' button.
Tip: An empty Allocated list means that the balance type can be rewarded for all product types.
-
-
Click Save.
Result: The balance type details are saved, and you return to the Reward screen.
Related topic
Editing balance types for a reward
Follow these steps to edit an existing balance type for the current reward type.
-
In the New Reward screen or Edit Reward screen, select the balance type record to edit in the Multi-Balances area.
-
Click Edit.
Result: You see the Edit Multi-Balance screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Multi-Balances fields.
-
If required, in the Allowed Product Types section select the product types for which this balance type can be rewarded. To:
-
Allocate a product type, select it in the Available list and click the '>>' button
-
Remove an allocated product type, select it in the Allocated list and click the '<<' button.
Tip: An empty Allocated list means that the balance type can be rewarded for all product types.
-
-
Click Save.
Result: The modified balance type record is saved, and you return to the Reward screen.
Related topic
Deleting balance types for a reward
Follow these steps to delete an existing balance type from a reward.
-
In the New Reward screen or Edit Reward screen, select the balance type record to delete in the Multi-Balances area.
-
Click Delete.
Result: You see the Delete Multi-Balance prompt.
-
Click Apply to delete the record from the database.
Related topic
Reward Product Translations
The Reward Product Translations tab lets you view, add, edit and remove the translations used by the Call Info Text Message feature node.
A translation is required for each language, source product and destination product. The reward translations are specified separately for each service provider.
Topics:
Adding reward product translations
Adding reward product translations
Follow these steps to add a new reward product translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Reward Product Translations tab, click New.
Result: You see the New Reward Product Translation screen.
-
From the Reward Type drop down list, select the balance type the reward applies to.
Tip: The available reward types are a sub-set of the balance types that have been configured where the expenditure type is not
None
. -
From the Original Product Type drop down box, select the subscriber's previous product type.
-
From the Reward Product Type drop down box, select the product type the subscriber is being transferred to.
Tip: If an invalid product type transfer has been chosen, the instructions under the Translation field will indicate that an invalid original/reward combination was selected. The original and reward product types must match a current and reward product type pair in a reward.
-
From the Language drop down box, select the language the message sent to the subscriber should be in. This will be sent instead of the default text for this system.
-
In the Translation field, type the text which should be sent to the subscriber when their product type is changed as part of a reward.
Tip: If the text entered in this field is invalid, the instructions under the Translation field will indicate that text entered is invalid.
-
Click Save.
Related topic
Editing reward product translations
Follow these steps to edit an existing reward product translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Reward Product Translations tab, select the reward product translation to edit.
-
Click Edit.
Result: You see the Edit Reward Product Translation screen.
-
The Translation field is the only editable field.
Tip: The details of the fields are described in Adding reward product translations.
-
Click Save.
Related topic
Deleting reward product translations
Follow these steps to delete an existing reward product translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Reward Product Translations tab, select the reward product translation to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database and return to the Reward Product Translations tab.
Related topic
Wallet Name Translation
The Wallet Name Translation tab lets you view, add, edit and remove translations of wallet type names to the subscriber's language for real-time wallet notifications. A translation is required for each wallet type and language. The wallet name translations are specified separately for each service provider.
Topics:
Adding wallet name translations
Adding wallet name translations
Follow these steps to add a new translation for a wallet type name.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Wallet Name Translation tab, click New.
Result: You see the New Wallet Name Translation screen.
-
From the Language drop down box, select the language the wallet type name will be translated to.
-
From the Wallet Type drop down box, select the wallet type that will be translated.
-
In the Translation field, type the text which will be sent to the subscriber in the short message. This will be sent instead of the default text for this system.
Tip: If there is a problem with the translation text, the instructions under this field will indicate one of the following:
-
A translation is required (because there is no text in the Translation field)
-
The translation is too long (because there are more than 12 characters in it)
-
-
In the Wallet Expiry field, type in the balance expiry text.
Warning: You must include '%d' in the text. This variable will be converted to the number of days remaining until the wallet expires.
-
In the No Wallet Expiry field, type the text to output for wallets that have no expiry date.
-
Click Save.
Related topic
Editing a wallet name translation
Follow these steps to edit an existing Wallet Name Translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Wallet Name Translation tab, select the wallet name translation to edit.
-
Click Edit.
Result: You see the Edit Wallet Name Translation screen.
-
Edit the details as described in Adding wallet name translations.
Note: The Language and Wallet Type fields are for reference only, they are not editable.
-
Click Save.
Related topic
Deleting a wallet name translation
Follow these steps to delete an existing wallet name translation.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Wallet Name Translation tab, select the wallet name translation to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database and return to the Wallet Name Translation tab.
Related topic
Real-Time Wallet Notifications
The Real-Time Wallet Notifications tab lets you configure when to trigger real-time notification messages for a subscriber, based on the following events:
-
Wallet expired
-
Wallet state changed
-
Balance Expired
-
Balance Charged
-
Balance Recharged
For more information about how real-time wallet notifications are delivered, see CCS Technical Guide.
Tip: You choose which real-time wallet notifications to enable on the Product Type screens (SMS > Services > Subscriber Management > Product Type tab, then for a product type, Real-Time Wallet Notification option).
Real-Time Notifications fields
This table describes the function of each field.
Field | Description |
---|---|
Name | A unique name for the real-time notification message. |
Notification Type | The type of event that triggers the notification. |
Threshold |
The total balance that triggers the notification. For charging notifications, the message is triggered when a balance that was above the threshold changes so it is equal to or below the threshold. For recharging notifications, the message is triggered when a balance that was below the threshold changes so it is equal to or above the threshold. Tip: For time thresholds, this value is in seconds. Note: This field is optional. If no value is entered, no threshold check is made and a notification is triggered on any charge or recharge event. |
Above credit limit |
Include the subscriber's credit limit with the threshold to determine notification triggering. Note: This check box is on the New and Edit Real-Time Notification screens and not on the tab table. |
Excluding reservations |
To determine notification triggering, exclude all current uncommitted reservations from the balance for comparison with the threshold. The default is to include all uncommitted reservations in the balance for comparison with the threshold. Note: This check box is on the New and Edit Real-Time Notification screens and not on the tab table. |
Old State |
Indicates the state a wallet must be changed from when
triggering a Note: This option is only available if
|
New State |
Indicates the state a wallet must be changed to when
triggering a Notes:
|
Balance Type |
The balance type associated with the notification. Tip: This field applies to charging, recharging and balance expiry notifications. |
DAP Operation |
The name of the DAP operation to use to output the
notification message. Choosing Tip: This field is populated by the XML templates set up in the DAP application. For more information on templates, see DAP User's Guide. |
Suppress DAP |
Indicates whether DAP notifications should be suppressed for certain events. Individual subscribers can opt-out of receiving DAP notifications by having the value true in their profile at the drop-down tag selected here. Tip: If |
Notification Template (SMS Template) |
The name of the notification template to use to output a
notification. Choosing Tip: This field is populated by the notification templates set up in ACS. For more information, see ACS User's Guide. |
Suppress Notification (Suppress SMS) |
Indicates whether notifications should be suppressed. No
notifications will be sent if this field is set to
Tip: If |
Wallet Type |
The wallet type associated with the notification. Options are:
|
Reference | Reference |
Trigger notification example
This example is for a charging notification.
If the:
-
threshold is $30
-
actual balance is $30
-
credit limit is $10, and
-
an outstanding reservation for $5
This table shows how the comparison value is computed for these values:
Excluding reservations | Not above credit limit | Above credit limit |
---|---|---|
No |
Actual balance = $30 Notification triggered (comparison = threshold) |
Actual balance + Credit Limit $30+ $10 = $40 No notification (comparison > threshold) |
Yes |
Actual balance - Reservations $30 - $5 = $25 Notification triggered (comparison < threshold) |
Actual balance - Reservations + Credit Limit $30 - $5 + $10 = $35 No notification (comparison > threshold) |
Adding real-time wallet notifications
Follow these steps to add the configuration for a real-time wallet notification.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Real-Time Wallet Notifications tab, click New.
Result: You see the New Real-Time Wallet Notifications screen.
-
In the Name field enter a unique name for the real-time notification message.
-
From the Notification Type drop down box, select the type of notification to generate.
-
Fill in the fields, depending upon notification type selected:
-
For notification types
Charging
orRecharging
, enter data as follows:-
Threshold field - the threshold for the notification.
-
Above credit limit check box - select to use any credit limit with the threshold.
-
Exclude reserved funds check box - select to exclude uncommitted reservations from the balance that is compared with the threshold value; leave clear to include uncommitted reservations with the balance.
-
Balance Type drop down list - select the applicable balance type.
Tip: For time thresholds, the Threshold value is in milliseconds.
-
-
For notification type
Wallet State Change,
enter data in the Old State and New State drop down boxes. -
For notification type
Balance Expiry
, select a record from the Balance Type drop down box.
-
-
Configure the rest of this record by selecting the required option from the remaining drop down lists on this screen.
For more information about the fields on this screen, see Real-Time Notifications fields.
-
Click Save.
Warning: Real-time wallet notifications are not usable until they are associated with one or more product types. To use this new notification for a subscriber, the wallet product type for the subscriber must now be configured.
To check which product type the wallet uses, see SMS > Services > Subscriber Management > Subscriber tab, then edit the required subscriber details, followed by the Wallets option.
To configure the product types that may use this new real-time wallet notification see SMS > Services > Subscriber Management > Product Type tab, then for a product type, Real-Time Wallet Notification option, see Real-Time Wallet Notifications.
Related topic
Editing real-time wallet notifications
Follow these steps to edit an existing real-time wallet notification.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Real-Time Wallet Notifications tab, select the wallet notification to edit.
-
Click Edit.
Result: You see the Edit Real-Time Wallet Notifications screen.
-
Edit the fields with the required changes.
For more information about the fields in this screen, see Real-Time Notifications fields and Adding real-time wallet notifications.
-
Click Save.
Related topic
Deleting real-time wallet notifications
Follow these steps to delete an existing real-time notification configuration.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Real-Time Wallet Notifications tab, select the real-time wallet notification to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the Real-time Notifications confirmation message and the record is removed from the database.
Policy Counters
The Policy Counters tab lets you view, add, edit and remove policy label tiers and policy label tier ranges.
Policy Counters fields
This table describes the function of each field.
Field | Description |
---|---|
Label Name | Name of the policy label tier. |
Balance Type | Type of balance. |
Send Pending Policy | Specify whether to send pending policy. |
Change User | User ID of the user who changed the status. |
Change Date | Date on which the change was made. |
Policy Label Tier fields
This table describes the function of each field.
Field | Description |
---|---|
Name | Name of the policy label tier. |
Balance Type | Type of balance |
Send Pending Policy | Specify whether to send pending policy. |
Status Name | Name of the status |
Start | Start of range |
End | End of range |
Change User | User ID of the user who made the change. |
Change Date | Date on which the change was made. |
Adding Policy Label Tiers
Follow these steps to add policy label tiers.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, click New.
Result: You see the New Policy Label Tier screen.
-
In the Name field, enter a unique name for the policy label tier.
-
From the Balance Type drop down box, select the type of balance.
-
If you want to send pending policy, select Send Pending Policy.
-
Click Save.
Related topic
Editing Policy Label Tiers
Follow these steps to edit an existing policy label tier.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, select the policy counter to edit.
-
Click Edit.
Result: You see the Edit Policy Label Tier screen.
-
Edit the fields with the required changes.
-
Click Save.
Related topic
Deleting Policy Label Tiers
Follow these steps to delete an existing policy label tier.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, select the policy counter to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the confirmation message and the record is removed from the database.
Related topic
Adding Policy Label Tier Ranges
Follow these steps to add policy label tier ranges.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, select the policy counter to which you want to add policy label tier ranges.
-
Click Edit.
Result: You see the Edit Policy Label Tier screen.
-
Click New.
Result: You see the Policy Label Tier Range screen.
-
Fill in the fields:
-
Status Name field - the name of the tier. For example, Low Balance.
-
Start of range field - enter a number for the start of the policy label tier range.
-
End of range field - enter a number for the end of the policy label tier range.
-
-
Click Save.
Related topic
Policy Label Tier Range fields
This table describes the function of each field.
Field | Description |
---|---|
Status Name | Name of the status |
Service State | The state the status is mapped to. |
Editing Policy Label Tier Ranges
Follow these steps to edit policy label tier ranges.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, select the policy counter you want to edit.
-
Click Edit.
Result: You see the Edit Policy Label Tier screen.
-
In the Edit Policy Label Tier screen, select the policy label tier to edit.
Click Edit.
Result: You see the Policy Label Tier Range screen.
-
Edit the fields with the required changes.
-
Click Save.
Related topic
Deleting Policy Label Tier Ranges
Follow these steps to delete policy label tier ranges.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Policy Counters tab, select the policy counter from which you want to delete policy label tier ranges.
-
Click Edit.
Result: You see the Edit Policy Label Tier screen.
-
In the Edit Policy Label Tier screen, select the policy label tier to delete.
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the confirmation message and the record is removed from the database.
Related topic
Free Form Recharge
The Free Form Recharge tab lets you recharge a subscriber's wallets. It can be used when the subscriber has experienced problems with either the voucher or credit card recharge.
Recharging Rules - Wallet Expiry Date
The following recharge rules apply to the wallet expiry date when performing a free form recharge.
The date is calculated by determining the greatest value of the following:
-
Current date + period entered in screen
-
Current wallet expiry date
If the wallet is in the pre-use period, the initial wallet expiry period is used to calculate the current wallet expiry date before the comparison of the above date.
The free form recharging rules differ in that they ignore the recharge minimum wallet expiry periods specified at product type level.
Note: Non-expiry wallets ignore the expiry periods.
A subscriber's wallet with a ‘Pre-Use’ or ‘Dormant’ state will have its status changed to ‘Active’.
Recharging Rules - Balance Expiry Date
The following recharge rules apply to the balance expiry date when performing a free form recharge.
The date is calculated by calculating the greatest value of the following:
-
Current date + period entered in screen.
-
Current balance expiry date.
If the wallet is in pre-use, the initial balance expiry period is used to calculate the current balance expiry date before the comparison of the above date.
The free form recharging rules differ in that they ignore the recharge minimum balance expiry periods specified at product type level.
Note: Non-expiry wallets ignore the expiry periods.
A subscriber's wallet with a ‘Pre-Use’ or ‘Dormant’ state will have it status changed to ‘Active’.
Completing free form recharges
Follow these steps to perform a free form recharge on a subscriber's wallet.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the Free Form Recharge tab, enter the Subscriber ID.
-
From the Wallet Type options, select one of the following:
-
Primary Wallet
-
Secondary Wallet.
-
-
In the Balance Expiry Period fields, enter the days and hours to be added to the subscriber's balance expiry period.
Tip: The
expireAtMidnight
configuration option overrides the displayed hour for expiry and will expire the balance only at midnight on the expiry date. For more information about this configuration option, see the VWS Technical Guide. -
In the Wallet Expiry Period fields, type the days and hours to be added to the wallet expiry period.
Note: The
expireAtMidnight
configuration option overrides the displayed hour for expiry and will expire the balance only at midnight on the expiry date. For more information about this configuration option, see the VWS Technical Guide. -
In the Amount field, enter the amount which will be added (or subtracted in the case of a negative value) to the wallet balance.
Tip: The amount is in the system currency.
-
In the Reference field, enter the recharge reference ID.
Tip: The recharge may include a bonus award if the reference matches a Bonus Type Component field.
-
From the Type Of Recharge options, select the type of recharge to be completed. Select one of the following:
-
Free Form Recharge
to indicate a free form recharge will be performed (EDR type 8). -
Credit Card Recharge
to indicate a credit card recharge will be performed (EDR type 9) -
Voucher Recharge
to indicate the customer tried to perform voucher recharge (EDR type 10)
Notes:
-
Credit card recharges require a properly configured credit card to be available.
-
Voucher recharges requires the balance type to allow vouchers.
-
-
Click Recharge to create an EDR of the type specified in step 7.
Note: If a maximum value has been configured for the balance type being recharged, then the maximum value policy will be applied to amounts which exceed the configured maximum. For more information on:
-
Maximum balance values, see Maximum balances
-
Maximum value policy, see Maximum balance policy
-
Error Messages – Free Form Recharges
There are six possible types of error messages that may be reported when Recharge is clicked. The messages are:
-
Invalid CLI. Recharge was not performed.
-
This account does not have any credit card details. Recharge was not performed.
-
This account does not allow voucher recharges. Recharge was not performed.
-
This account is in state frozen. Recharge was not performed.
-
This account is in state suspended. Recharge was not performed.
-
This account is in state terminated. Recharge was not performed.
Wallet Life Cycle
WLC plans
A wallet life cycle plan is defined at service provider level.
Wallets may be shared by many subscribers and these subscribers may have different product types and hence different wallet life cycle plans to apply.
A WLC plan contains a list of WLC periods, which are actioned in their offset order.
WLC periods
A wallet life cycle period is associated to the account, which is a single subscriber-wallet association. if a subscriber has multiple wallets, each subscriber-wallet association could have its own distinct WLC period.
In a shared wallet environment, the current wallet life cycle period to apply is calculated from the wallet expiry and the wallet life cycle plan associated with the specific subscriber and the product type linked to that subscriber-wallet association.
When viewing the defined wallet life cycle periods within the Wallet Life Cycle Plan tab, the periods are ordered in ascending wallet expiry offset order, for example, -5 days before, then -2 days before, +1 days after. See Wallet Life Cycle Period fields.
Duration of period
A WLC period starts at its expiry offset date and continues until the next period starts, or the wallet is removed.
Example 1
WLC Plan 1 contains 3 periods:
-
WLC Period 1 (-10 days)
-
WLC Period 2 (0 days)
-
WLC Period 3 (10 days)
WLC period 1 starts 10 days before expiry and finishes on wallet expiry, when WLC period 2 starts.
Example 2
WLC Plan 2 contains 2 periods:
-
WLC Period 4 (-20 days)
-
WLC Period 5 (+20 days)
WLC period 4 starts 20 days before expiry and finishes 20 days after wallet expiry, when WLC period 5 starts.
Product Type swap
The wallet life cycle plan for a given product type will apply to all subscribers of that product type.
When a subscriber swaps to a different product type, the wallet life cycle period for the new product type will be calculated based on the wallet expiry date, and the control plan for the new period will be executed.
On product type swap the wallet life cycle period “On Backout” actions (if configured) and the “On Entry” actions (if configured) will be executed when the product type swap action will be treated by the system.
Note: There will be a delay between the moment when the product type swap was requested and the moment when all actions are executed.
Finding a WLC plan
Follow these steps to search for an existing wallet life cycle plan..
-
In the Wallet Management screen, select the service provider from the drop down list.
-
On the Wallet Life Cycle tab, enter the search criteria you are using to find the required WLC plan.
-
You can select the Marked For Deletion check box to include plans in the process of being deleted in the search results (row will be grayed).
Note: By default the check box is cleared and the search will ignore deleted plans.
-
Click Search.
Result: The WLC plan table displays the first 100 records matching the search criteria entered in steps 2 and 3. If the required plan is not displayed and more than 100 records were returned, enter different search criteria and click Search again.
Adding a WLC plan
Follow these steps to add a new wallet life cycle plan.
-
On the Wallet Life Cycle tab, click New.
Result: You see the New Wallet Life Cycle Plan screen.
-
In the Name field, enter the name of the wallet life cycle plan.
-
Click Save.
Result: The new plan is created. To add periods to the plan, you need to edit the plan. See Editing a WLC plan.
Related topic
Copying a WLC plan
Follow these steps to copy a wallet life cycle plan.
-
On the Wallet Life Cycle tab, select the wallet life cycle plan you want to copy from the table and click Copy.
Result: You see the Copy Wallet Life Cycle Plan screen.
-
Name the wallet life cycle plan.
-
Click Save.
Result: The plan is added to the list in the table. The copied plan will contain the same periods as the original plan.
Modifying a currently active/associated plan
Here is the recommended method to modify a currently active/associated wallet life cycle plan.
-
Copy the WLC plan.
-
Make the required changes to the plan copy.
-
Re-associate the appropriate product types to the new plan.
-
Delete the original plan when transition to the new plan is deemed successful.
Editing a WLC plan
Follow these steps to edit a wallet life cycle plan.
-
On the Wallet Life Cycle tab, select the wallet life cycle plan you want to edit from the table and click Edit.
Result: You see the Edit Wallet Life Cycle Plan screen.
-
The screen displays the wallet life cycle periods, in ascending wallet expiry offset order, for this plan. At the bottom of the screen, you can:
Related topic
Deleting a WLC plan
Follow these steps to delete an existing wallet life cycle plan.
-
On the Wallet Life Cycle tab, select the wallet life cycle plan to delete from the table and click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK.
Result: You see a second prompt.
-
Click OK.
Result: The plan is removed from the table on the tab. It will be deleted from the system after all subscribers have been disassociated from the WLC Plan.
Note: You can search for deleted WLC plans by first selecting the Marked for Deletion check box.
Related topic
Adding a WLC period
Follow these steps to add a new wallet life cycle period to a wallet life cycle plan.
-
On the Edit Wallet Life Cycle Plan screen, click Add.
Result: You see the New Wallet Life Cycle Period screen.
-
Fill in the fields, select disabled features and allow or disallow named event classes, as described in Wallet Life Cycle Period fields.
Note: If the wallet life cycle period defines no functions to be disabled when the period is entered, then a notification or control plan operation is required.
-
Click Save.
Related topic
Wallet Life Cycle Period fields
This table describes the function of each field.
Field | Description |
---|---|
Name | Unique name for the WLC period. |
Display Name |
The display name of the WLC period. Note: Although a Wallet Life Cycle period name must be unique within the Wallet Lifecycle Plan, the Display Name may be non-unique and used within the CCP screens across multiple subscribers and product types. |
Expiry Offset (days) |
Number of days offset, from expiry of the wallet, to start the period.
Only one Wallet Life Cycle period will be applicable (active) for any given expiry offset within a defined Wallet Life Cycle Plan. Example: ‘-10’ evaluates to 10 days before expiry, or ‘+5’ evaluates to 5 days after expiry. Creating one period with offset -10 results in a single period active from 10 days before expiry right up to removed date. Creating a second period with offset +5 will immediately curtail the first period, ending it at +4. It will be invalid to create two periods with the same offset. |
Disabled feature |
You can select the check box(es) to disable:
|
Named Event Classes |
Select and move the available and disallowed Named Event classes using the >> and << buttons. If the period is:
|
Notifications |
If required, select the notifications to send on:
For more information about configuring SMS Notifications, see ACS User's Guide. |
Control Plans |
If required, select the control plans to run on:
|
Editing a WLC period
Follow these steps to edit a wallet life cycle period.
-
On the Edit Life Cycle Plan screen, select the wallet life cycle period to edit from the table and click Edit.
Result: You see the Edit Wallet Life Cycle Period screen.
-
Edit the fields and named event classes, as described in Wallet Life Cycle Period fields.
Note: If the wallet life cycle period defines no functions to be disabled when the period is entered, then a notification or control plan operation is required.
-
Click Save.
Related topic
Deleting a WLC period
Follow these steps to delete an existing wallet life cycle period.
-
On the Edit Wallet Life Cycle Plan screen, select the WLC period to delete from the table and click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK.
Result: You see a second prompt.
-
Click OK.
Result: The period is greyed out in the WLC Period table. The period will be deleted from the system after all subscribers have been disassociated from the WLC Period.
Related topic
Bonus Types
The Bonus Types tab lets you view, add, edit and remove bonus types.
Bonuses allow awards to be given to subscribers who recharge their wallets, where the recharge value is within a specified range of values.
Bonus types defines the following:
-
Which awards are available for each type of recharge
-
What balances the award is added to
Topics:
Bonus Types fields
This table describes the function of each field.
Field | Description |
---|---|
Bonus Type | The type of recharge to which this bonus type will apply. |
Component |
If Tip: A Bonus Set will only be applied when the Free Form Recharge Reference field and the Bonus Type Component field match. |
Bonus Set | The bonus values set containing the promotional balance to which this bonus type will be applied. |
Promotional Balance |
The balance type to which this bonus type will be applied. Note: If the Percentage field is filled out in a bonus value used with this bonus type, the recharge bonus will be added to this balance type. |
Adding bonus types
Follow these steps to add a new Bonus Type.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
From the Bonus Types tab, click New.
Result: You see the New Bonus Type screen.
-
From the Bonus Type drop down list, select the type of recharge this Bonus Type will apply to.
-
If you have selected Custom from the Bonus Type box, in the Component field type in the component reference value.
-
Configure the rest of this record by entering data in the remaining fields on this screen.
For more information about the fields on this screen, see Bonus Types fields.
-
Click Save.
Related topic
Editing bonus types
Follow these steps to edit an existing Bonus Type.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Bonus Types tab, select the record you want to edit.
-
Click Edit.
Result: You see the Edit Bonus Type screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Rewards fields.
-
Click Save.
Related topic
Deleting bonus types
Follow these steps to delete an existing bonus type.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Bonus Types tab, select the record to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the Error prompt.
-
Click OK.
Related topic
Bonus Values
The Bonus Values tab lets you view, add, edit and remove Bonus Values.
Bonus Values are used in Bonus Types to define:
-
the amount which triggers the award
-
the value of the award, and
-
the balance which must be recharged to qualify for the reward.
Awards may be either:
-
a bonus percentage applied to the amount the Balance is recharged by, or
-
a Voucher Type.
The entries in a Bonus Set must cover the full range of values from 0 to the highest End value. If there is a gap in the covered values, the Bonus Set will fail. The Bonus Set may contain both percentage bonus values and voucher type bonus values.
For more information about Voucher Types, see Voucher Type.
Bonus Values Example 1
To create a Bonus Value which applies a 5% bonus to all Voucher recharges of more than $20, you must also configure a Bonus Value which applies a 0% bonus to recharges of $0 to $19.
Bonus Values Example 2
Three recharge Bonuses have been specified in the example screen below.
-
For a recharge of 0 to 1,000 cents, a Bonus of 8% of the recharge amount is added to the Balance.
-
For a recharge of 1,001 cents to 4999 cents, a Bonus of 10% of the recharge amount is added to the Balance.
-
For a recharge of over 5000 cents, a Bonus of 12.5% of the recharge amount is added to the Balance.
Adding bonus values sets
Follow these steps to add a new Bonus Values Set.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
From the Bonus Values tab, click New Set.
Result: You see the New Bonus Values Set screen.
-
In the Name field, type the name of the new Bonus Values Set.
-
Click Save.
Related topic
Editing bonus values sets
Follow these steps to edit an existing Bonus Values Set.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
From the Bonus Values tab, in the Bonus Set Name drop down box, select the record you want to edit.
-
Click Edit Set.
Result: You see the Edit Bonus Values Set screen.
-
Edit the set name as required.
-
Click Save.
Related topic
Deleting bonus values sets
Follow these steps to delete an existing Bonus Set.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
From the Bonus Values tab, in the Bonus Set Name drop down box, select the record to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the Bonus Value Set prompt.
-
Click OK.
Related topic
Bonus Values fields
This table describes the function of each field.
Field | Description |
---|---|
Trigger Balance |
This bonus value will be triggered when recharges are made to this balance. If not set, the trigger balance will be general cash. |
Start |
The low end of the range of recharge value that will trigger this bonus. Note: At least one bonus value in the set must start at 0. |
End | The high end of the range of recharge value that will trigger this bonus. |
Percentage |
The percentage of the recharge amount to add to the recharge as a bonus when this bonus is triggered. Notes:
|
Voucher Type |
The voucher type which defines the reward which will be given to the subscriber when the bonus is triggered. Notes:
|
Adding bonus values
Follow these steps to add a new Bonus Value.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Bonus Values tab, select the Bonus Set Name to add bonus values to, from the drop down list.
-
Click New.
Result: You see the New Bonus Values screen.
-
Configure this record by entering data in the fields on this screen.
For more information about the fields on this screen, see Bonus Types fields.
-
Click Save.
Related topic
Editing bonus values
Follow these steps to edit an existing Bonus Value.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Bonus Values tab select the Bonus Set Name that contains the values you want to edit.
-
In the grid on the tab, select the record you want to edit and click Edit.
Result: You see the Edit Bonus Values screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Bonus Values fields.
-
Click Save.
Related topic
Deleting bonus values
Follow these steps to delete an existing Bonus Value.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Bonus Values tab, select the Bonus Set Name that contains the value to delete from the drop down box.
-
In the table, select the record to delete and click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Result: You see the Bonus Value Set prompt.
-
Click OK.
Related topic
Cumulative Balance Plans
The Cumulative Balance Plans tab lets you:
-
configure the balance categories included in your cumulative balance plans and
-
assign balance types to the different balance categories.
The Cumulative Balances node will sum the balances for each balance category in a selected cumulative balance plan and play the relevant announcements.
Cumulative Balance Plan fields
This table describes the function of each field.
Field | Description |
---|---|
Name | Cumulative balance plan name. |
Unit Type | Lists the available unit types for balance categories. |
Available Unit_Type balances | Lists the available balance types for the selected unit type. |
Unit_Type categories | Lists the categories that have been configured for the selected unit type. The balance types that have been assigned to each category are listed below the category heading. |
Playback Order |
|
Adding cumulative balance plans
Follow these steps to add a cumulative balance plan.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Cumulative Balance Plans tab, click New.
Result: You see the New Cumulative Balance Plan screen.
-
In the Name field, type in the new cumulative balance plan name.
-
For each relevant Unit Type, add the required balance categories. For details, see Adding balance categories.
-
Use drag and drop to add the required balances to each balance category. To:
-
add a balance to a balance category, select it in the available balances list and drag it to the required balance category
-
remove a balance from a balance category, select in the categories list and drag it to the available balances list.
Tip: You can add a balance type to more than one category if required.
-
-
If required, change the order in which balance categories are played. You can see the current order in the Playback Order section.
To change the position of a Category in the play order, select it in the Playback Order section and click either the UP or DOWN button.
Note: All the configured categories appear in the Playback Order section irrespective of their Unit Type.
-
Click Save.
Related topic
Editing cumulative balance plans
Follow these steps to edit a cumulative balance plan.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Cumulative Balance Plans tab, select the required cumulative balance plan and click Edit.
Result: You see the Edit Cumulative Balance Plan screen.
-
Make the required changes in the available fields. For more information on:
-
cumulative balance plan fields, see Cumulative Balance Plan fields.
-
adding balance categories, see Adding balance categories
-
editing balance categories, see Editing balance categories, or
-
deleting balance categories, see Deleting balance categories.
-
-
Click Save.
Related topic
Deleting cumulative balance plans
Follow these steps to delete an existing Cumulative Balance Plan.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
In the table on the Cumulative Balance Plans tab, select the record to delete.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.
Related topic
Balance Category fields
This table describes the function of each field.
Field | Description |
---|---|
Category Name | A unique name for the balance category. The name can be up to 30 alphanumeric characters long. |
Announcement Set |
|
Announcement Entry |
|
Use unreserved balances | When selected, exclude uncommitted reservations in the available funds played in the announcements (the uncommitted reservation amount is subtracted from the available funds value). |
Play Zero Cumulative Balance announcement | To play the announcements even if the cumulative balance for the category is zero, select this check box. |
Play Expiry announcement | To play expiry announcements, select this check box. |
Adding balance categories
Follow these steps to add a balance category to a cumulative balance plan.
-
In the Balance Categories area in the New/Edit Cumulative Balance Plan screen, select the Unit Type for which to define balance categories from the drop down list.
Result: You see the list of available balance types for the Unit Type, and the list of available balance categories.
-
Click Add Category.
Result: You see the Add Balance Category screen.
-
Configure this record by entering data in the fields on this screen.
For more information about the fields on this screen, see Balance Category fields.
-
Click Apply.
Result: You will be returned to the New/Edit Cumulative Balance Plan screen and the new category will be displayed in the balance categories list.
Related topic
Editing balance categories
Follow these steps to view or edit a cumulative balance category for a Cumulative Balance Plan.
-
In the Balance Categories area in the New/Edit Cumulative Balance Plan screen, select the Unit Type to view or edit balance categories for from the drop down list.
Result: You see the list of available balance types for the Unit Type, and the list of available balance categories.
-
Select the category to view or change and click Modify Category.
Result: You see the Modify Balance Category screen.
-
Check or update the Balance Category as necessary.
For more information about the available fields, see Balance Category fields.
-
If you have made changes to save, click Apply.
If you do not want to make changes to the balance category, click Cancel.
Result: You are returned to the New/Edit Cumulative Balance Plan screen.
-
Use drag and drop to modify the list of balance types included in the balance category.
Tip: You can add a balance type to more than one category if required.
-
If required, change the order in which balance categories are played. You can see the current order in the Playback Order section.
To change the position of a Category in the play order, select it in the Playback Order section and click either the UP or DOWN button.
Note: All the configured categories appear in the Playback Order section irrespective of their Unit Type.
-
Click Save.
Related topic
Deleting balance categories
Follow these steps to delete a cumulative balance category from a Cumulative Balance Plan.
-
In the New/Edit Cumulative Balance Plan screen, select the Unit Type which holds the balance category you want to delete.
-
Select the balance category record you want to delete and click Delete Category.
Result: You see the Modify Balance Category deletion prompt.
-
Click OK.
Related topic
Periodic Charge Groups
Periodic charge groups control which periodic charges a subscriber can transfer to using the Periodic Charge Transfer node, or through the CCP screen. Subscribers can only transfer to periodic charges which are in the same group as the periodic charge they want to transfer from.
Warning: CCS determines which subscription will be transferred from, by locating the current subscription which is in the periodic charge group specified by the Periodic Charge Transfer node or a periodic charge field in CCP. If a subscriber has two subscriptions within the same periodic charge group, their transfer will fail. You must ensure the design of the service restricts subscriptions appropriately.
Periodic charge group fields
This table describes the function of each field.
Field | Description |
---|---|
Name | The unique name of the periodic charge group. |
Charges |
The periodic charges listed in the Allocated list are members of this group. The periodic charges which are in these lists are populated from the records on the Periodic Charges tab. Notes:
For more information about how to use these fields and buttons, see Selection lists. |
Adding periodic charge groups
Follow these steps to add a new periodic charge group.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Periodic Charge Groups tab, click New.
Result: You see the New Periodic Charge Group screen.
-
Configure this record by entering data in the fields on this screen.
For more information about the fields on this screen, see Periodic charge group fields.
-
When you have completed configuring the new periodic charge group, click Save.
Related topic
Editing periodic charge groups
Follow these steps to edit and existing periodic charge group.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Periodic Charge Groups tab, select the periodic charge group you want to edit.
Tip: You can search for a specific periodic charge group by entering the periodic charge group's name in the Name field on the tab, and clicking Search. You can also use % as a wildcard.
-
Click Edit.
Result: You see the Edit Periodic Charge Group screen.
-
Edit the fields to reflect the changes you need to make.
For more information about the fields in this screen, see Periodic charge group fields.
-
Click Save.
Related topic
Deleting periodic charge groups
Follow these steps to delete an existing periodic charge group.
-
In the Wallet Management screen, select the service provider from the Service Provider list.
-
On the Periodic Charge Groups tab, select the periodic charge group to delete.
Tip: You can search for a specific periodic charge group by entering the periodic charge group's name in the Name field on the tab, and clicking Search.
-
Click Delete.
Result: You see the Delete Confirmation prompt.
-
Click OK to delete the record from the database.