Voucher Batch
The Voucher Server supports generation of Vouchers in Batches using the concept of Voucher Batches.
The Voucher Server supports the creation of two different types of Voucher Batches:
- Standard - Vouchers are bulk generated and distribution of Voucher Types within is fixed.
- E-Voucher - Vouchers are only generated on demand by configured Service Channels and Voucher Type distribution within is not fixed.
Each Voucher Batch specifies a range of Vouchers serials to generate utilizing defined Voucher Types, Generators and Distribution Channels.
To access the Voucher Batch search page, select the Voucher Batches menu link.
All configured Voucher Batches will be shown with standard features for searching and sorting available via the table controls.
Double clicking a row or clicking the edit icon will display the Voucher Batch details page.
In the example screenshot the configured Voucher Batch DATA 20 Batch 2024.001 is configured to generate 6000 Data 20 Vouchers between the serial range of 100,000 and 105,999. Vouchers will be generated using the 15-digit HMAC SHA384 Voucher Generator and distributed to the local filesystem as JSON.
| Configuration Property | Description |
|---|---|
| Identifier | Identifiable name used by the Voucher Server GUI to identify Voucher Batches. |
| E-Voucher Batch | Specifies if the Voucher Batch is an E-Voucher Batch. |
| Description | Free form description field used by the Voucher Server GUI to identify Voucher Batch configuration. |
| Start Serial Number | Starting Serial Number to use when generating the Voucher Batch. |
| End Serial Number | End Serial Number to use when generating the Voucher Batch. Must be Larger than the Start Serial Number Encompassing Range must be Globally Unique |
| Voucher Generator | Voucher Generator to use when generating the Voucher Batch. |
| Distribution Channel | The Distribution Channel to use when distributing the Voucher Batch. Only present for non E-Voucher Batches. |
Voucher Batch Types
After creation of a standard Voucher Batch the Voucher Batch Types configuration becomes available.
Voucher Batch Types define what kinds of Vouchers will be generated within the Voucher Batch defined range.
These may consist of one or many different voucher types, but must be defined within the specified Start/End range defined by the Voucher Batch.
| Configuration Property | Description |
|---|---|
| Voucher Type | The Voucher Type to utilize when generating the Voucher Batch. |
| Start Serial Number | Starting Serial Number to use when generating the Voucher Type as part of the Voucher Batch. |
| End Serial Number | End Serial Number to use when generating the Voucher Type as part of the Voucher Batch. Must be Larger than the Start Serial Number Encompassing Range must fit within the confines of the parent Serial Number Range |
Voucher Types and Service Channels
After creation of an E-Voucher based Voucher Batch the Voucher Types and Service Channel configuration becomes available.
Service Channels define which Service Channels may utilize the Voucher Batch both requesting generation of one of the configured Voucher Types as well as redeeming said Voucher.
Voucher Types define which Voucher Types may be generated by requesting Service Channels.
Both Service Channels and Voucher Types may be marked Active or Deactivated at any time in the life cycle of the E-Voucher Batch.
Voucher Batch State History
Voucher Batch state auditing is treated as a first class citizen in the Voucher Batch details screen. While it is viewable via the standard auditing channels a more succinct view of state transitions is provided.
This functionality may be accessed via the hour glass button next to the Voucher Batch state.
Clicking the hour glass button will reveal a drop down panel which contains a filterable and sort-able list of state changes, the user responsible and the time it occurred.
By default the latest state change will be at the top and be ordered by a descending change date.
