Voucher Management

14 Voucher Management

This chapter explains how to create and manage vouchers.

This chapter contains the following topics.

Voucher Manager Module

Voucher Manager Module

The Voucher Management screen allows you to configure vouchers. It contains these tabs:

Accessing the Voucher Manager screen

Follow these steps to open the Voucher Manager screen.

Select the Services menu from the SMS main screen.

Note: The services which are available under the Services menu depend on the components which have been installed, and the permissions of the user. The services displayed in this screen shot may not match the services you have available on your system.
Select Voucher Manager.

Result: You see the Voucher Manager screen.

Voucher Type

The Voucher Type tab allows you to add, modify, or delete voucher types.

The voucher type determines the tariff plan, the restriction control plan, and the value of the calls for which recharges (including vouchers) are valid.

For each voucher type, you can:

Define a limited list of available product types, see Limited Product Type
Define product swap rules, see Product Swap
Define multiple balance types, see Multiple balance type
Associate tax plans to voucher type recharges, see Tax Plan
Define power charge scenarios, see Power charge scenarios

Voucher types define core details and restrictions for recharges such as vouchers and the balance increase part of credit transfers.

For more information about redeeming vouchers, see Vouchers Introduction. For more information about credit transfers, see Transfer Management.

Limited Product Type

You can define a limited list of product types a voucher type can recharge. This can be used to target customers with specific product types.

Product Swap

You can define a set of product swap rules which are executed when the recharge is redeemed.

You define a product swap rule by specifying the product type to change from, and the product type to change to. When the voucher is redeemed, wallets assigned to the 'From' product type are changed to the matching 'To' product type.

If you limited the product types that could be recharged, you can only choose the 'From' product type from the limited set. Otherwise, you can choose from all the available product types for the current service provider. The list of available product types to swap to is determined by the product type swap configuration set up in the Subscriber Management screen.

Multiple balance type

You can add more than one balance type to a voucher type. When a recharge or voucher is redeemed, all balance types associated with the voucher 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). You can add more than one entry for the same balance type, with different details for each entry, including:

Unique expiry dates and extension policies
The period during which this balance type entry can be recharged
The product types for which this balance type entry can be recharged

Tax Plan

You can associate a tax plan to a voucher recharge or voucher type recharge. A single tax plan can be optionally associated with each balance of a voucher type. This tax plan applies only to the cash amount.

If an inclusive tax plan is associated with the voucher, the tax component of the cash value is deducted from the voucher before crediting the account. Exclusive tax plans associated with a voucher balance will cause the full amount of the voucher to be credited to the account.

EDRs generated from voucher recharges will show the cash amount credited to the account and the tax component.

Example 1:

Consider a voucher defined for $11 and 200 SMSs. If the tax plan is inclusive with a tax definition of 10%, then the user is credited with $10 and the 200 SMSs. The EDR will report the $10 credit and the $1 tax.

Example 2:

Consider a voucher defined for $10 and 200 SMSs. If the tax plan is exclusive with a tax definition 10%, then the user is credited with a total of $10 and 200 SMSs. The EDR will report the $10 credit and the $1 tax.

Power charge scenarios

You can associate recharge scenarios to a balance type for a voucher type. The voucher type can then be redeemed in multiple ways depending on the scenario options available when it is redeemed. Scenarios can include both monetary balance types, such as general cash or promotional cash, and non-monetary balance types, such as free SMS or time. You can do one or more of the following:

Increment a balance
Extend the expiry date for the balance

Note: The scenarios functionality will only be available in the screens if it has been activated. For more information about activating scenarios, see CCS Technical Guide.

Voucher Type fields

The following table describes the function of each field.

Field	Description
Name	A unique name for the voucher type. Note: If this voucher type uses scenarios and you will be sending real-time wallet notifications for recharges, this field must be reflected in the name of the template you use for the notification. For more information about the required format, see CCS Technical Guide.
CDR Description	The description to use for EDRs which are produced by vouchers with this voucher type. Tip: You can use a maximum of 100 characters.
Description	A brief description of the voucher type.
Pre-use Expiry Period	The period (in days and hours) between this voucher being issued and when it will expire. Example: If a voucher has a pre-use expiry period of seven days, the holder of the voucher has seven days from the date of issue to begin using the voucher. If not used in seven days, the voucher expires and is no longer valid.
Wallet Expiry Period	The period (in days and hours, or months, depending upon the `Expiry Period Type`) between the wallet being activated and when it will expire. Tip: The `expireAtMidnight` configuration parameter in eserv.config overrides the displayed hour for expiry and will expire the wallet only at midnight on the expiry date. For further information about this configuration option, see VWS Technical Guide.
Expiry Period Type	The unit the wallet expiry period is calculated in. Select either: Hours – the wallet expiry is calculated in days and hours Months – the wallet expiry is calculated in months
Wallet Expiry Policy	Which date to calculate the wallet expiry period from. Select either: Best – extends expiry from the date the voucher is redeemed (this will only apply if there is a positive effect). Extend – extends expiry from the current expiry date.
Limited Product Types	The product types which can use vouchers with this type.
Product Swap Rules	When a voucher is redeemed, the subscriber's existing product type can be changed to a new product type. Subscribers with the product type in the From column are changed to the product type in the To column in the same row when vouchers with this type are redeemed. If no rules are set, the subscriber will continue to have their existing product type.
Scenario	The scenarios to associate with the balance type when the voucher is redeemed. Tip: You can add multiple scenarios to the same balance type by adding different scenario values. You can also edit/delete the default scenario. Note: This panel will only be visible on the tab if the scenarios functionality has been activated. For more information about activating scenarios see CCS Technical Guide.
Multi-Balances	The details of the changes vouchers with this type make to balance types when the voucher is redeemed. For more information about the fields in these records, see Multi-Balance fields. Tip: You can add multiple balance types to the same voucher type and you can specify the product type for each balance type. You can include the same balance type more than once.

Adding voucher types

Follow these steps to add a new voucher type.

In the Voucher Management screen, select the Service Provider from the drop down box.
From the Voucher Type tab, click New.

Result: You see the New Voucher Type screen.
Start to configure this record by entering data in the fields in the top left of this screen. For more information about the fields on this screen, see Voucher Type fields.
If you want to limit the available product types for the voucher type, add the product types which can use vouchers with this type. For more information about adding product types to this list, see Adding limited product types.
If you want to define product swap rules for the voucher type, add the product type swap rules you want to apply when vouchers of this type are redeemed to the Product Swap Rules list. For more information about adding these rules, see Adding product swap rules.
If the Scenario panel is visible in the screen, then add the scenarios to associate with the balance type when vouchers of this type are redeemed. For details, see Adding scenarios to a voucher type.

Tip: You can add multiple scenarios to the same balance type by adding different scenario values.

Note: The Scenario panel will only be visible in the screen if the Scenarios functionality has been activated on your system.
Add the balance types that this type of voucher recharges when it is redeemed. For details, see Adding balance types to a voucher type.

Tip: You can add multiple balance types to the same voucher type and you can specify the product type for each balance type. You can include the same balance type more than once.
Click Save.

Related topic

Voucher Type

Adding limited product types

Follow these steps to add a product type to the limited product types list on the New or the Edit Voucher Type screen.

In the Limited Product Types area, click Add.

Result: You see the Add Limited Product Type screen.
From the Product Type drop down list, select the product type you want to add to the list.
Click Save.

Result: The product type is added to the limited products list and you are returned to the Voucher Type screen.

Related topic

Voucher Type

Editing limited product types

Follow these steps to edit a product type in the limited product types list on the New or the Edit Voucher Type screen.

In the Limited Product Types area, select the product type from the list and click Edit.

Result: You see the Edit Limited Product Type screen.
In the Product Type drop down list, select the new product type you want to add to the list.
Click Save.

Result: The product type in the limited products list is updated and you are returned to the Voucher Type screen.

Related topic

Voucher Type

Adding product swap rules

Follow these steps to add a product swap rule to the product swap rules list on the New or the Edit Voucher Type screen.

In the Product Swap Rules area, click Add.

Result: You see the Add Product Swap Rule screen.
From the From drop down list, select the product type to swap from.
From the To drop down list, select the product type to swap to.
Click Save.

Result: The product swap rule is added to the list of rules and you are returned to the Voucher Type screen.

Related topic

Voucher Type

Editing product swap rules

Follow these steps to edit a product swap rule in the product swap rules list on the New or the Edit Voucher Type screen.

In the Product Swap Rules area, select the swap rule and click Edit.

Result: You see the Edit Product Swap Rule screen.
From the From drop down list, select the product type to swap from.
From the To drop down list, select the product type to swap to.
Click Save.

Result: The product swap rule in the list of rules is updated and you are returned to the Voucher Type screen.

Related topic

Voucher Type

Editing voucher types

Follow these steps to edit an existing voucher type.

In the Voucher Management screen, select the Service Provider from the drop down box.
On the Voucher Type tab, select the record to edit.
Click Edit.

Result: You see the Edit Voucher Type screen. For information about voucher type fields, see Voucher Type fields.
Make the changes that you need to by editing the fields in this screen.
In the Limited Product Types area, to:
- Add a product type to the list, click Add. See Adding limited product types.
- Edit a product type already in the list, select it in the Product Type list,and click Edit. See Editing limited product types.
- Remove a previously selected product type, select it in the Product Type list, click Delete, and then click Yes to confirm the deletion.
In the Product Swap Rules area, to:
- Add a product swap rule to the list, click Add. See Adding product swap rules.
- Edit a product swap rule already in the list, select it in the From/To list, and click Edit. See Editing product swap rules.
- Remove a previously selected product swap rule, select it in the From/To list, click Delete, and then click Yes to confirm the deletion.
Add the scenarios to associate with the balance type when vouchers of this type are redeemed. For details, see Adding scenarios to a voucher type.

Tip: You can add multiple scenarios to the same balance type by adding different scenario values.
Add the balance types that this type of voucher recharges when it is redeemed. For details, see Adding balance types to a voucher type.

Tip: You can add multiple balance types to the same voucher type and you can specify the product type for each balance type. You can include the same balance type more than once.
Click Save.

Related topic

Voucher Type

Deleting voucher types

Follow these steps to delete an existing voucher type.

In the Voucher Management screen, select the Service Provider from the drop down box.
In the table on the Voucher Type 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: The record is deleted and you see the Voucher Type prompt.
Click OK.

Adding scenarios to a voucher type

Follow these steps to add a scenario to the scenario list on the New or Edit Voucher Type screens.

In the Scenario area, click Add.

Result: The New Scenario window is displayed.
From the Scenario ID drop down list, select the scenario number to associate to the scenario.
In the Scenario Name field, enter a name for the scenario.
In the Recharge Classification field, enter a description for how the recharge will be made.
Click OK.

Result: You are returned to the New/Edit Voucher Type screen and the new scenario is added to the list of scenarios.

Related topic

Voucher Type

Editing scenarios for a voucher type

Follow these steps to edit a scenario in the scenario list on the New, or Edit Voucher Type screen.

In the New or Edit Voucher Type screen, select the scenario to edit.
In the Scenario area, click Edit.

Result: The Edit Scenario screen is displayed.
Edit the details as required. See Adding scenarios to a voucher type for field details.
Click OK.

Related topic

Voucher Type

Deleting scenarios for a voucher type

Follow these steps to delete a scenario in the scenario list on the New, or Edit Voucher Type screen.

In the New or the Edit Voucher Type screen, select the scenario to delete.
Click Delete.

Result: The record is deleted from the list of scenarios.

Related topic

Voucher Type

Multi-Balance fields

This table describes the function of each field.

Field	Description
Action	Provides three actions: Recharge – The recharge value is added to the current balance value Replace Balance – The recharge value replaces the current balance value Reload Counter – The balance value is a counter for the number of reloads of the selected balance type
New Bucket	Whether to create a new bucket for the balance type when the voucher is redeemed.
Balance Type	The balance type to recharge when vouchers of this type are redeemed. 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 amount to recharge the balances of the balance type selected in the Balance Type field.
Expiry Policy	How to apply the expiry period for this balance type when vouchers of this type are redeemed. Select: Best – The system selects the best policy option for the subscriber depending on their particular circumstances. Extend – The current expiry period is extended by the specified days and hours. Ignore – No change is made to the current expiry period. Extend From Today – The current expiry period to be extended the specified number of days and hours from today's date. The following fields exist when the `jnlp.ECEExtensions` application property is true. These fields are only applicable when using an ECE charging domain. Select: First Use with Offset – The expiry is set a number of months or hours after the first use of the balance First Use – Account Cycle – The expiry is set to the date of the first use of the balance, plus a number of account cycles First Use – Bill Cycle – The expiry is set to the date of the first use of the balance, plus a number of billing cycles
Expiry Period Type	The unit the balance expiry period is calculated in. Select either: Hours – the balance expiry is calculated in days and hours. Months – the balance expiry is calculated in months.
Balance Expiry Period	The period between when the voucher is activated and when the balance expires. Depending on the selection in the expiry period type options, enter one of: Days and hours Months Cycles (if First Use- Account Cycle or First Use – Billing Cycle is selected in Expiry Policy) Example: If a voucher has an expiry period of 30 days, the holder of the voucher has 30 days from the date the voucher is first used to use the outstanding voucher balance. At the end of the expiry period any outstanding voucher balance expires. 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 `expireAtMidnight` configuration option in eserv.config overrides the displayed hour for expiry and will expire the balance only at midnight on the expiry date. For further information about this configuration option, see VWS Technical Guide.
Credit Available	Select one of the following: Now – Credit is available immediately In – Activates Dates/Hours and Months, from which you can set when credit becomes available in specified number of days and hours, or months On – Activates the date selector, from which you can set the exact date when credit becomes available Note: You can only specify Credit Available for chargeable or cross balance types.
Missing Balance Action	What to do, if this balance type does not already exist in the wallet when the voucher is redeemed. Select one of the following: Create Balance – The system creates the balance type and redeem the voucher. Fail Recharge – The voucher redemption fails. Skip Balance – The voucher is redeemed, but the system does not create the balance type.
Tax Plan	The tax plan associated with this voucher type. Note: For inclusive tax, the tax component will be removed before crediting the subscriber.
Scenario	The scenario which will apply this balance. Notes: This field will only be visible in the screen if the scenarios functionality has been activated. For more information about activating scenarios, see CCS Technical Guide. Only required if more than one scenario has been defined for this voucher type. The scenario value '`Default(All)`' indicates that the balance type applies to all scenarios. If scenarios have been defined, you cannot use the default scenario. If only one scenario has been defined, you do not have to specify a scenario.
Allowed Product Types	The product types which vouchers of this type can recharge for this balance type. Tip: An empty Allocated list means that the balance type can be recharged for all product types.
Configuration Restriction	Restricts the day, month and year that a balance starts and ends. Select the following: Applies From – Sets the date when balances of this type can be redeemed by vouchers of this type. To activate this field, select the check box to the left of the field, then, in the date selection boxes, select the day, month and year for the end date. Applies Until – Sets the date when balances of this type can no longer be redeemed by vouchers of this type. To activate this field, select the check box to the left of the field, then, in the date selection boxes, select the day, month and year for the end date.

Adding balance types to a voucher type

Follow these steps to add a balance type to the current voucher type.

Note: To add multiple balance types to the voucher type, repeat this process as required.

In the Multi-Balances area at the bottom of the New or the Edit Voucher Type 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-Balance fields.
In the Allowed Product Types section select the Product Types for which the voucher can recharge 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 recharged for all product types.
Click Save.

Result: The balance type details are saved, and you return to the Voucher Type screen.

Related topic

Voucher Type

Editing balance types for a voucher type

Follow these steps to edit an existing balance type for the current voucher type.

In the New or Edit Voucher Type screen, select the balance type record to edit from the Multi-Balances table.
Click Edit.
Edit the fields to reflect the changes you need to make.

For more information about the fields in this screen, see Multi-Balance fields.
If required, in the Allowed Product Types section select the Product Types for which the voucher can recharge 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 recharged for all product types.
Click Save.

Result: The modified balance type record is saved, and you return to the Voucher Type screen.

Related topic

Voucher Type

Deleting balance types for a voucher type

Follow these steps to delete an existing balance type from a voucher type.

In the New or the Edit Voucher Type screen, select the balance type record to delete from the Multi-Balances table.
Click Delete.

Result: You see the Delete Multi-Balance prompt.
Click Apply to delete the record from the database.

Related topic

Voucher Type

Voucher Batches

The Voucher Batches tab lets you search, display, create, and delete batches of vouchers for the selected customer.

You use the New Voucher Batch screen to create a simple voucher batch file, eliminating the need to generate the batch from the command line.

Tip: Configuration for the voucher tool used to create voucher batches is defined in eserv.config. For more information about eserv.config, see CCS Technical Guide.

Topics:

Voucher Batch fields

Finding voucher batches

Adding voucher batches

Checking voucher batch status

Editing voucher batches

Deleting voucher batches

Voucher Batch fields

The following table describes the functions of Voucher Batch fields.

Field	Description
Batch Code	The identifier which will be used to group the vouchers in this batch. This field can be used to group vouchers from several batches. Note: This field is not available: On the Edit Voucher Batch screen, and cannot be changed after the batch is generated
Batch Id	The batch ID for the voucher batch. This field is automatically populated when the vouchers are first generated. It cannot be changed and is only visible on the Voucher Batches tab.
Domain	The domain where the voucher batch was created. This field is only available on the New Voucher Batch screen.
Batch Name	The unique name for the batch. It can be up to 50 characters long and is optional.
Activation Date	Activation date of the voucher batch. This field cannot be changed after the batch is activated. Note: This field is not available on the New Voucher Batch screen.
Voucher Type	The type of the vouchers in this batch. This field is populated by the Voucher Types tab. For more information, see Voucher Type. This field cannot be changed after the batch is generated.
Expiry Date	The expiry date of the vouchers in this batch. This field enables you to specify the voucher batch expiry date, which sets a batch to expire on a specific day and shows users that a batch is no longer active and not available for use.
State	Displays the state of the voucher batch. Available states are: Active Created Unavailable Expired Note: This is different to the state of the individual vouchers within the batch. These states are available within the Voucher Batch Search screen but not in the New Voucher Batch screen.
Description	Reason for the voucher state change. Note: This field is only displayed in the New Voucher Batch screen, not in the Voucher Batch Search screen.
Initial Voucher State	The state new vouchers in a batch will be in when they are first generated. This field allows individual vouchers or ranges of vouchers in a voucher batch to be made Active as an additional security feature for service providers. In the New Voucher Batch screen a new batch should normally be created with the Initial Voucher State set to Active. This sets the individual voucher records in the batch to Active in the `CCS_VOUCHER_REFERENCE` table. Once the batch has been created, the Voucher Batches tab should be used to set the batch status to Active. This sets the batch record in `CCS_VOUCHER_BATCH` to Active enabling all vouchers in the batch. If a new batch is created with the Initial Voucher State set to Created, then vouchers can only be redeemed when their state has been reset to Active in the Vouchers tab (for individual activation) or in the Voucher Ranges tab (for a range of vouchers). To enable vouchers, set both the batch state and the voucher state to Active. Note: This is different to the state of the voucher batch (which is automatically set to Created when the batch is first generated. This field is only displayed in the New Voucher Batch screen, not in the Voucher Batch Search screen.
Voucher Number Length	The number of digits in the voucher number. This is set by the authentication rule for this voucher batch and cannot be changed after the batch is generated. Note: This field is only displayed in the New Voucher Batch screen, not in the Voucher Batch Search screen.
Start Voucher Number	Displays the number of the first voucher in the batch and the starting point for the voucher number range. Note: The length of the voucher number must match the voucher number length defined for the authentication rule being used. If the AltAuthMod authentication rule is being used, this will be 14 characters long. A voucher number range can be used more than once for: DES encrypted vouchers with GPG selected CB10 HRN encrypted vouchers with or without GPG selected Vouchers are generated from unused voucher numbers from the range. This field cannot be changed after the batch is generated.
End Voucher Number	Displays the number of the last voucher in the batch and the ending point for the number range. The value must be greater than the start of range value and have a matching number of digits. Note: This field cannot be changed after the batch is generated.
Start Serial Number	Displays the serial number of the first voucher in the batch. Note: This field is automatically populated and cannot be changed after the batch is generated. It is not available on the New Voucher Batch screen.
End Serial Number	Displays the serial number of the last voucher in the batch. Note: This field is automatically populated and cannot be changed after the batch is generated. It is not available on the New Voucher Batch screen.
Batch Size Original Count	The number of vouchers in this batch. This can be equal to or less than the difference between the start voucher number and the end voucher number. Note: This field cannot be changed after the batch is generated.
Authentication Rule	Indicates which encryption scheme the voucher batch has been created with. This field cannot be changed after the batch is generated. This list is populated by records from the Security tab in the Service Management screen. For more information about the Security tab, see CCS User's Guide.
GPG Public Key	The GPG Public key to use to encrypt the voucher batch export file. The key must have been imported and verified on the SMS. If you do not want to use a GPG Public key, select the blank entry. Note: This field is only available for voucher batch files generated using an authentication rule based on DES PIN encryption or CB10 HRN encryption. This field is only available on the New Voucher Batch screen. For more information about GPG public keys, see GPG Public Keys.
Pause Time	The time in seconds to pause after loading each 100 vouchers for writing to the export file. Note: This field is only displayed in the New Voucher Batch screen, not in the Voucher Batch Search screen.
Creation Date	The creation date of the batch.
CDR Description	Description to use for this voucher batch in any EDRs that are created for vouchers from this batch.
Remote Filename	The name of the voucher batch export file to write the details of the generated vouchers to. Note: This field is only displayed in the New Voucher Batch screen, not in the Voucher Batch Search screen.

Finding voucher batches

Follow these steps to search for an existing voucher batch.

In the Voucher Manager screen, choose the Service Provider from the drop down list.
On the Voucher Batches tab, enter the search strings you are using to find the required batch. Perform one of the following:
- Enter the first few characters of the specified batch code in the Code field and click Search
- Select the Voucher Batch state from the State drop down box and click Search
Note: There are three states:
- Active
- Created
- Unavailable
Result: The Voucher Batches table will display the first 100 records matching the search criteria. Results include creation date.
If the required voucher batch is not displayed and more than 100 records were returned, enter a longer search string and click Search again.

Adding voucher batches

Follow these steps to add a new voucher batch.

Note: The values for the voucher number length and voucher PIN length are determined by the authentication rule selected and cannot be edited. The GPG Public Key Description field is for information only.

In the Voucher Manager screen, select the Service Provider from the drop down box.
From the Voucher Batches tab, click New.

Result: You see the New New Voucher Batch Screen.
Enter data in the fields to configure this record.

For more information about the fields on this screen, see Voucher Batch fields.
Click Save.

Result: The batch generation process is started and you see the Voucher Batch Generation prompt.
Click OK.

Result: You see the Voucher Batch Progress bar. The COMPLETE message is displayed in the bar once the batch has been successfully created.
Click 'x' to close the progress bar.

Related topic

Voucher Batches

Checking voucher batch status

Follow these steps to check the status of an existing voucher batch.

Read the ccsSmsORB output log. For more information about the ccsSmsORB, see CCS Technical Guide.
Check for any error messages from the actual voucher-creation process.
Go to the /IN/service_packages/CCS/voucher/export/ directory.
Check that the following file exists:

remote_filename .lst.print

Where:

remote_filename is the name entered in the Remote Filename field of the New Voucher Batch screen.
If the file exists, is larger than 0 bytes in size and contains full records, the voucher batch job has been created successfully.

If the file does not exist, is 0 bytes in size or only contains headers, the voucher batch job has failed. You will need to repeat the procedure in Adding voucher batches.

Editing voucher batches

Follow these steps to edit an existing Voucher Batch.

Note: The Voucher Batch, Edit Voucher Batch, and Vouchers tabs have a creation date read-only value which preserves the creation date when a batch is edited.

In the Voucher Manager screen, select the Service Provider from the drop down box.
On the Voucher Batches tab enter the search criteria for the required voucher batch in the search fields and click Search. For details on finding voucher batches, see Finding voucher batches.
In the table on the tab, select the record you want to edit and click Edit.

Result: You see the Edit Voucher Batch Screen.
Edit the fields with the changes to make.

You can update only the following fields:
- CDR Description
- Voucher Batch Status
Tip: For descriptions of voucher batches fields, see Voucher Batch fields.
Click Save.

Related topic

Voucher Batches

Deleting voucher batches

Follow these steps to delete an existing voucher batch.

In the Voucher Manager screen, select the service provider from the Service Provider list.
On the Voucher Batches tab enter the search criteria for the voucher batch to delete and click Search.

For more information about finding voucher batches, see Finding voucher batches.
In the table on the tab, select the record to delete.

Note: Selecting Delete on an active batch will calculate if the batch is stale. Only active batches that are stale and unavailable batches can be deleted.
The Delete Voucher Batch prompt displays. Confirm your desire to delete the voucher batch by clicking OK.

Result: The voucher batch is deleted.

Related topic

Voucher Batches

Vouchers

The Vouchers tab allows you to view details of a voucher, change its status, and set voucher expiry.

The Vouchers tab has the following subtabs:

Voucher
Batch
Subscriber
Info
History

Voucher

The Voucher subtab enables you to:

View details of a voucher
Change voucher status
Set voucher expiry

Voucher fields

The following table describes the Voucher subtab fields.

Field	Description
Voucher Number	The voucher number.
Serial Number	The voucher serial number.
Private Secret	Encrypted voucher HRN or PIN.
Voucher Type	The type of the voucher in this batch. This field is populated by the Voucher Types tab.
Voucher Created	The voucher creation date.
Archive Date	The calculation date when archiving may take place.
Voucher Status	The status of the voucher. The available statuses are: Active Created Frozen Deleted
Voucher Expiry	The expiry date of the voucher. This field enables you to set a voucher to expire on a specific day. If an expiry date is already set for a voucher, this field displays the date and time when the voucher expires. You can set the date by clearing the Remove check box. Note:This field is enabled only if the Remove check box is cleared. By default, the Remove check box is selected.
Description	Additional information about the voucher state change or the voucher expiry date change.
Last State Change User	User name of the user who last changed the voucher state.

Changing voucher states

You can select a voucher owned by the selected service provider and set it to an 'active' or 'frozen' state.

In an 'active' voucher batch, if you set a voucher to the 'frozen' state, then the voucher can no longer be redeemed. If a voucher batch is in a 'created' or 'unavailable' state, then although you will be able to set a voucher within the batch to an 'active' state in this screen, you will not be able to redeem it. You may only redeem an active voucher if the voucher batch it belongs to is also in an 'Active' state.

Follow these steps to change the state of an existing voucher.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the Vouchers tab, enter one of the following:
- Voucher number or HRN in the Voucher Number field
- Voucher serial number in the Serial Number field
Click Search.

Tip: When searching on the voucher number, the number entered must be the length of the voucher number as defined for the authentication rule for this voucher.

Result: The Voucher subtab displays the details for the voucher searched for.
In the Voucher subtab, from the Voucher Status drop down box, select the status.

Available statuses are:
- Active
- Frozen
Note: If you want to be able to redeem the voucher, set the status to Active.

If the voucher has been redeemed already:
- This field is grayed out (indicating the value cannot be changed)
- The status will be Used
If the voucher has been deleted, this field is grayed out (indicating the value cannot be changed).
Click Save.

Setting voucher expiry

You can set a voucher to expire on any specific day beyond which it is not available for use.

Follow these steps to set an expiry date for a voucher.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the Vouchers tab, enter one of the following:
- Voucher number or HRN in the Voucher Number field
- Voucher serial number in the Serial Number field
Click Search.

Tip: When searching on the voucher number, the number entered must be the length of the voucher number as defined for the authentication rule for this voucher.

Result: The Voucher subtab displays the details for the voucher searched for.
In the Voucher subtab, in the Voucher Expiry field, clear the Remove check box and click the date chooser icon.

Result: The Date Chooser window is displayed.

Note: The Voucher Expiry field is disabled if the Remove check box is selected. By default, the Remove check box is selected.
In the Date Chooser window, select a date and time when you want the voucher to expire.
Click Save.

Batch

The Batch subtab displays information related to voucher batches. It provides information about batch ID, batch name, batch state, and batch expiry.

Batch fields

The following table describes the Batch subtab fields.

Field	Description
Batch Name	The name of the voucher batch. This can be up to 50 characters long.
Batch ID	Unique ID for the voucher batch.
Batch Code	The batch code for the voucher batch that includes this voucher.
Batch State	The state of vouchers in the voucher batch. The batch states are: Active Created Unavailable
Batch Activated	Activation date of the voucher batch.
Batch Expiry	The expiry date of the vouchers in this batch. This field enables you to specify the voucher batch expiry date, which sets a batch to expire on a specific day and shows users that a batch is no longer active and not available for use.

Subscriber

The Subscriber subtab displays voucher redemption, wallet reference, subscriber ID, and scenario information for a voucher.

Subscriber fields

The following table describes the Subscriber subtab fields.

Field	Description
Voucher Redeemed	The voucher redemption date.
Wallet Reference	The wallet reference of the redeeming wallet.
Subscriber ID	The ID of the subscriber redeeming the voucher.
Scenario	The voucher scenario used to redeem the voucher. Note: This field is visible only if scenarios have been installed and activated on your system. For more information about installing and activating scenarios, see CCS Technical Guide.

Info

The Info subtab displays details about distributor and retail channel and other additional information about a voucher.

Note:

The fields in Info subtab are editable only if the following conditions are met:

The voucher status needs to be in active, created, or frozen state.
The Info subtab needs to have CreateDelete or ReadModify permissions. You can modify the permissions under User Management > Template Creation > CCS > Voucher Info Subtab.

Info fields

The following table describes the Info subtab fields.

Field	Description
Barcode	The barcode number of the voucher. You can use a maximum of 12 digits.
Text	Description of the voucher. You can use a maximum of 50 characters.
Card Design	Version number of the voucher design. You can use a maximum of 4 digits.
Distributor Channel	Distributor of the voucher. You can use a maximum of 50 characters.
Retail Channel	Retailer of the voucher. You can use a maximum of 50 characters.
Provisioning Date	Date on which the voucher is created.
Free Text Field_1	Field for capturing business process information. You can use a maximum of 50 characters.
Free Text Field_2	Field for capturing business process information. You can use a maximum of 50 characters.
Free Text Field_3	Field for capturing business process information. You can use a maximum of 50 characters.

History

History subtab displays the history of changes made for that particular voucher.

History fields

This table describes the History subtab fields.

Field	Description
Date	Date when the voucher was modified.
Term	The host that modified the voucher.
User	User name of the user who made the changes.
Type	Type of the operation performed. Types are: V: Voucher Recharge S: Voucher State change E: Voucher Expiry change B: Both Voucher Expiry and Voucher State change
Description	The description of the changes made.

Voucher Validation

Use the Voucher Validation tab to test whether a given voucher signature (the voucher number and secret digits) is valid.

Note: You will only have access to this facility if you have sufficient user privileges.

Validating a voucher

Follow these steps to validate a voucher.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the Voucher Signature field in the Voucher Validation tab, enter the voucher number or HRN. Do not include any spaces.

Tip: The voucher number to use for searching must be the length of the voucher number as defined for the authentication rule for this voucher.
Click Validate.

Result: The Voucher Status field shows the validity of the voucher.

Voucher validation results

This table lists the possible messages displayed when you validate a Voucher.

Message	Description
`No Voucher to Check`	You clicked Validate before entering the voucher signature.
`Voucher Is Valid`	The signature has been confirmed by the SMS.
`Voucher Is Not Valid`	The signature was not recognized by the SMS.

Voucher Recharge

The Voucher Recharge tab allows you to recharge a voucher owned by the selected service provider.

Recharging vouchers

Follow these steps to recharge an existing voucher.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the Voucher Signature field on the Voucher Recharge tab, enter the signature of the voucher you want to recharge.

Note: The voucher signature is the voucher number and the HRN. For legacy vouchers, voucher signature is the voucher number and (depending on the encryption algorithm selected for the voucher batch) the PIN, or the HRN.

For more information about encryption algorithms, see CCS Technical Guide.
In the Subscriber ID field, enter the ID for the subscriber.
In the Description field, enter a reason for the recharge, if required.
If a scenario is required, click Refresh.

Result: The Scenario drop down list will be populated with all valid scenarios for the voucher specified in the Voucher Signature field.
From the Scenario drop down list, select the scenario to use with this redemption.
From the Primary and Secondary option buttons, select the wallet type for the Voucher Recharge.
Click Recharge.

Result: The system will attempt to recharge the subscriber with the voucher. If it is successful, the Success prompt will appear.
Click OK.

Voucher Ranges

The Voucher Ranges tab enables you to change the state of a group of vouchers. The vouchers are a defined range of voucher numbers.

Activating voucher ranges

Follow these steps to change the state of a range of vouchers.

In the Voucher Manager screen, select the Service Provider from the drop down box.
On the Voucher Ranges tab, from the Voucher Batch drop down list, select the voucher batch which contains the range to change.

Note: The voucher batch corresponds with the Batch ID field in the Voucher Batches screen.
From the Voucher State drop down list, select the new state the vouchers in the range should be.

Note: If you want to be able to redeem the vouchers you must set the voucher state to active.
In the Start Serial No field, enter the lowest voucher serial number in the voucher range you want to change.
In the End Serial No field, enter the highest voucher serial number in the voucher range you want to change.

Note: The range must be 100,000 vouchers or less.
In the Description field, enter a description for the voucher range, if required.
Click Change.

Result: The Confirm Voucher Change Operation prompt will appear.
Click OK.

Result: The Voucher Change State prompt will appear.
Click OK.

GPG Public Keys

The GPG Public Keys tab allows you to:

Import new GPG public keys into CCS
Verify imported keys

GPG keys are used to increase security when creating voucher batch export files for printing.

Once a public key has been verified it can be used as part of the security mechanism for creating voucher batches.

Note: You cannot remove public keys from the SMF database or from the GPG key-ring store on the SMS.

Importing GPG public keys

Follow these steps to import new GPG public keys from a specified file.

In the Voucher Manager screen, select the Service Provider from the drop down box.
Select the GPG Public Keys tab.
In the Import File field, enter the path and filename of the file containing the new GPG public keys or click Browse to select the file.
Click Import Keys.

Note: This button becomes enabled once the import file has been specified.

Result: Any keys not currently in the system are imported from the file and you see the GPG Key Importation prompt.
Click OK.

Result: The GPG Public Keys tab is refreshed to include the new keys.

Verifying public keys

Follow these steps to verify a GPG public key.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the table on the GPG Public Keys tab, select the GPG Key to verify.

Tip: If the value in the Verified column for this key is 'Y', then it has already been verified.
Click Verify Key.

Result: You see the GPG Key Importation validation prompt.
Click OK.

Deleting GPG public keys

Follow these steps to delete GPG public keys.

In the Voucher Manager screen, select the Service Provider from the drop down box.
In the table on the GPG Public Public Keys tab, select the public key to delete.
Click Delete.

Result: The Confirmation prompt appears.
Click OK to confirm.

AVD Configuration

The AVD Configuration tab allows you to:

Update the common configuration that will be used on the SMS and across all VWS voucher domains by the automatic voucher delete process.
View the date ranges for vouchers that are in the process of being deleted for each of the configured VWS domain nodes.

Notes:

Automatic voucher deletion (AVD) is performed on a regular basis by the ccsBeAvd binary processes. For information about ccsBeAvd, see CCS Technical Guide.
You manage the configuration of ccsBeAvd from the AVD Configuration tab. This tab also lists the current tasks that the ccsBEAvd binary processes are required to perform. However, it does not show the progress of the deletion of the redeemed vouchers from the VWS domain nodes.

AVD Configuration fields

This table describes the configuration fields in the AVD Configuration tab.

Field	Description
Keep Redeemed Vouchers For	Sets the number of weeks for which redeemed voucher records will be kept on the SMS and VWS nodes. Must be between 1 and 26 weeks.
Archive Frozen Vouchers	Globally archives frozen vouchers.
Max Records to Process	Sets the maximum number of voucher records to delete per run of the automatic deletion process (ccsBeAvd) on the VWS. Must be between 1 and 999999. Note: The frequency and times that the ccsBeAvd process is run on each VWS node is controlled by the crontab for the ccs_oper user. For more information, see Charging Control Services Technical Guide.
Commit After Num Rows	Sets the number of redeemed voucher records for ccsBeAvd to delete on the VWS node before committing the changes to the database. You must specify a value between 1 and 9999. If the value you specify is Less than the value for Batch Size, then ccsBeAvd commits the changes after deleting the number of vouchers defined by Batch Size. More than the value for Batch Size, then ccsBeAvd continues to delete batches of voucher records until the value of Commit After Num Rows is exceeded. Then it commits the changes to the database. Note: It is not possible to roll back changes once they have been committed.
Batch Size	Sets the maximum number of redeemed voucher records to delete in a single batch. You must specify a value between 1 and 999999.
Sleep Time	Sets the amount of time (in seconds) for ccsBeAvd to wait after the number of vouchers defined by Batch Size are deleted. You must specify a value between 1 and 999999 seconds. Note: This allows the system processing time for other jobs.

Node Status fields

The Node Status table on the AVD Configuration tab lists the deletion tasks currently under progress by the automatic deletion process on each VWS node. If there are no entries it means that currently there are no vouchers to delete on any VWS node.

This table describes the fields listed in the Node Status table.

Note: These fields are read-only and cannot be changed. The values in these fields are updated automatically by the automatic voucher deletion process.

Field	Description
Domain Name	The voucher domains that are currently undergoing automatic voucher deletion processing. Note: You configure domains on the Domain tab in the Service Management screen. See the Service Management chapter in CCS User's Guide for details.
Node Name	The defined domain nodes from which voucher records to be deleted.
Redeem Start Date	The start date of the date range for which redeemed vouchers to be deleted.
Redeem End Date	The end date of the date range for which redeemed vouchers to be deleted.
Voucher Batch	The batch IDs of the the voucher batch to be deleted.
Voucher Serial	The serial number of the first voucher in each batch to be deleted.

Changing AVD configuration

Follow these steps to change AVD configuration.

In the Voucher Manager window, click on the AVD Configuration tab.

Result: You see the current AVD configuration details. See AVD Configuration tab.
Edit the fields to reflect the changes you need to make.

For more information about the fields on this tab, see AVD Configuration fields.
Click Save.