E-Voucher Batch Life Cycle
E-Voucher Batches have various states that are transitioned through as they are configured.
E-Vouchers differ from standard batches as Vouchers are only generated on demand within the configured range. The vouchers that may be generated can be of any Voucher Type configured in the E-Voucher Batch configuration.
State | Description |
---|---|
Configuring | The E-Voucher Batch is being configured. |
Validated | The E-Voucher Batch configuration has been validated and is valid for activation. |
E-Voucher Active | The E-Voucher Batch is active. Voucher generation may be requested. Vouchers may be redeemed. |
Locked | The E-Voucher Batch has been marked as locked. Voucher generation may not be requested. Vouchers cannot be redeemed. |
Void | The E-Voucher Batch has been marked as void. Voucher generation may not be requested. Vouchers cannot be redeemed. |
E-Voucher Batch Creation
The following example outlines how an E-Voucher Batch may be created and processed through its life cycle.
Initial E-Voucher Batch creation configures a human readable Identifier and Description as well as the following properties:
- Marking the Voucher Batch as an E-Voucher Batch.
- Voucher Range between 700,000 and 800,000.
- Voucher Generation will use the
15-Digit HMAC SHA384
generator.
After saving the initial E-Voucher Batch three additional options are now available:
- Configuration of Service Channels that may utilize the E-Voucher Batch.
- Configuration of Voucher Types that may be generated by the E-Voucher Batch.
- Ability to Validate the E-Voucher Batch.
E-Voucher Batches must contain at least one Service Channel and one Voucher Type.
Selecting New
for either Service Channels or Voucher Types will show a configuration dialog which allows selection of the respective item.
Note: Service Channels and Voucher Types may be set to Active or Deactivated at any time using the Play
and Pause
button actions in the respective table.
This may be performed at any stage in the life cycle of the E-Voucher Batch.
After selection of Service Channels and Voucher Types the E-Voucher batch can be validated.
If any validation errors are encountered the user will be prompted and the E-Voucher Batch state will return to Configuring
.
If no validation errors are encounter the state will be changed to Validated
and two new options are now available to the user:
Mark E-Voucher Active
- Marks the E-Voucher Batch as Active, after this no further changes may be made to the Voucher Batch.Reconfigure
- Return to theConfiguring
state to make additional changes to the E-Voucher Batch.
Selecting Mark E-Voucher Active
will enable the E-Voucher Batch such that Voucher Type generation may be requested and Vouchers redeemed by the actively configured Service Channels.
After a E-Voucher Batch has been marked Active two additional options are available:
Lock
- Lock the E-Voucher Batch. Voucher generation cannot be requested. Vouchers cannot be redeemed.Void
- Void the E-Voucher Batch. All actions are unavailable and the batch is voided.
Both the E-Voucher Active and Lock states are interchangeable and may be toggled between at any time.