Vouchers

This document will help you to use the Vouchers applet in RADIUSdesk. If you want to learn more about the principles of Vouchers in order to gain more background on their usage; please read this page Principles of Vouchers .

Consider the following screen shot of the Vouchers applet.

The following is handy to know:

• Each voucher has an owner which can be either the root user on an Access Provider.
• Each voucher belongs to a realm.
• Each voucher has a profile attached to it.
• A voucher can be single or part of a batch of vouchers.
• If the profile attached to the voucher limits the voucher by the total time or data and the voucher has been used; a progress-bar will indicate the percent usage.
• A status column will indicate the status of each voucher. Vouchers can be one of four states.
  • New
  • Used
  • Depleted
  • Expired

The grid which lists the vouchers has some handy features and capabilities which we will discuss next.

We can filter on various columns on the grid to create a fine grained search filter which is very powerful; yet simple to use.

• As soon as you hover over the heading of a column a small down arrow will appear on the side of the column.
• Click on this small down arrow to bring up a menu.
• Here we can see the options to order; filter; and select columns from the menu.
• We can supply some text to the filter menu item which will apply the filter in a 'live' manner.
• A small filter icon on the heading column will now give a visual indication if a filter is applied to a certain column.

• In order to sort the list of vouchers; you can simply click on the heading of a column.
• If the column can be sorted; a small up or down arrow will appear right next to the heading's text to indicate the sort order.

• You can select which columns to show or hide.
• Simply hover over any of the column headings to allow for the down arrow button with the menu to show.
• Click on the Columns menu and select / deselect those columns that you want to show or hide.
• This will be remembered the next time you open the applet.

By default there are five hidden columns on the Voucher's grid can be very handy when doing troubleshooting.

• The reload button includes an advanced feature that provides the option to auto reload at specified intervals.
• Simply click on the down arrow on the side of the button to select from a menu with specified interval options.
• If this feature is enabled the icon on the reload button will include a clock to give a visual indication that the auto reload feature is currently enabled.
• By selecting Stop auto reload from the menu the icon will change back to normal again and the auto reload feature is disabled.

The Add screen has the following options:

• Selecting an owner. If the current user does not own any Access Providers, there is only one choice; that if the logged in user.
• Precede string. An optional string which will precede the username of the voucher or batch of vouchers.
• Realm. The realm to which this voucher or batch of vouchers will belong.
• Profile. The profile to which this voucher or batch of vouchers will be attached.
• How many. If it is more than one it becomes a batch and requires a batch name to be specified.
• Batch name. Not shown but is activated and required to specify as soon as the quantity becomes more than one.
• Password length. Specify the length of the password of each voucher or batch of vouchers. Default minimum is 3 characters.

• Activate upon first login. A handy option which allows you to print day vouchers beforehand. As soon as a person logs in for the first time with the voucher; the countdown begins.
• Days available after first login. After this amount of days; the voucher is considered depleted and no longer usable.
• Never expire. If selected; the voucher or batch of vouchers can be used up to any date in the future.
• Expire. If specified; the voucher or batch of vouchers can not be used after the specified future date.

• To delete items; simply select one or more from the grid and click on the Delete button.
• A dialog box will pop-up asking you to confirm your action before executing your request.
• Remember that everything related to this item will be deleted including all the accounting records which may affect the accuracy of the stats on certain realms and NAS devices.

• To edit items; simply select one or more from the grid and click the Edit button to open each one on its own tab.
• These opened Vouchers will contain three sub tabs
  • Basic info. This displays the current values for the settings which were gathered during creation of the voucher.
  • Private attributes. These values should not be changed unless you know what you are doing.
  • Accounting data. The current accounting data for the specified voucher. Remove this to make the voucher new again.

The Vouchers applet allows you to export the data in the following formats:

1. PDF
2. CSV

• Simply click on the Export to PDF button to bring up a dialog box that will offer you some choices.
  • Output format Select the format of the PDF. RADIUSdesk supports various Avery label formats and also standard A4.
  • Language Select the language of the PDF document.
  • Only Selected Optional to export only the selected items. If you have not selected any items; all those items listed will be exported and this option will not be available.
  • When you click OK another window will open containing the PDF. If your browser does not support showing a PDF file in the window; it will be downloaded.

• Simply click on the Export to CSV button to bring up a dialog box that will offer you a choice of columns to include.
• When you click OK your browser will download the CSV file and may offer you the option to open it with a specified program.

• To change the password of a voucher; simply select the voucher from the grid and click on the Change password button.
• A dialog box will pop-up requesting the new password.
• Specify the new password and click OK to commit the change.

• To test the RADIUS authentication of a Voucher; simply select the voucher from the grid and click on the Test RADIUS button.
• This will open the RADIUS Client applet with the specified voucher already selected.
• You can now simply click the OK button to see the results of the Authentication request.