Allocate tokens and capacity
The allocation process moves inventory into an account’s virtual server.
You can also deallocate some or all of the inventory allocated to an account.
On the STA Token Management console, the On-Boarding > Allocation module shows the capacity and quantity of all token and authentication types that are allocated to an account’s virtual server. Capacity is the number of users that can be assigned a password or tokens.
-
Maximum: Shows the total, by capacity and authentication method, allocated to the account.
-
In Use: Shows the capacity and authentication methods that are consumed by the account. For virtual service providers, it shows the capacity and authentication methods that are consumed for their own use or allocated to accounts that they manage.
-
Available: Shows unconsumed capacity and authentication methods.
Allocate a token type or capacity
You allocate each type of token and capacity to an account in a separate transaction.
The steps in the allocation process depend on the type of allocation. In general, allocation includes the following steps:
-
Step 1: Determine the Allocation Type: Select either rental, sales, capacity, or SMS Credits.
-
Step 2: Select Tokens: Indicate the quantity of inventory to allocate.
-
Step 3: Create Billing References: Specify the amount to charge for the transaction or unit of transaction, billing triggers, customer reference, and comments.
-
Step 4: Confirm Allocation
Step 1: Determine the allocation type
-
On the STA Token Management console, select On-Boarding and select the account.
-
Select the Allocation module.
-
Click the Allocate button.
-
Select one of the following allocation types and any corresponding options:
-
By Transaction #
Transaction Type:
-
Sale: Indicates that token ownership is transferred to the account. Inventory that is not owned cannot be allocated in a sale transaction. Use this option when the account wants to own the tokens, rather than have the cost bundled into their recurring cost per user.
Only inventory that is available for sale can be used in a sale transaction.
Tokens can be allocated without capacity. Choose this option if replacing lost or damaged tokens owned or rented by the account.
Tokens can be allocated with a corresponding quantity of rental capacity. This option is the equivalent of two separate transactions: Rental > Capacity Only and Sale > Token (without capacity).
-
Rental: Indicates that ownership does not transfer. This transaction type can allocate from a token inventory that contains sale and rental tokens. Use this option for accounts that pay a recurring fee per user for capacity or some combination of capacity and tokens.
-
-
Capacity Only: Indicates that tokens are not included in this allocation. Capacity is the number of users who are allowed to enroll an authentication method. So you need to increase capacity if you enroll more users. Capacity is typically combined with an authentication method, but this is not always required, such as when using certificate-based authentication (CBA).
-
Tokens:
-
Transaction Type: (see Sale and Rental)
-
Token Type: Indicates the type of token to allocate.
-
Automatically add capacity with this allocation: Allocates a corresponding quantity of capacity.
If the Transaction Type is Sale, this option adds an equal amount of additional capacity to support the purchased tokens. Do not select this option if the account does not require additional capacity. For example, select this option for an account that is replacing owned tokens that have been lost, or replacing one token type with another.
If the Transaction Type is Rental, select this option if the account will pay a fee per user for the service, including a token per user.
For example, if your service bundles capacity and tokens into a single cost per user per month, select Tokens > Transaction Type > Rental, and select the Automatically add Capacity with this allocation option.
-
-
SMS Credits: Transfers a quantity of SMS credits to the account.
To allocate SMS credits, go to Allocate SMS credits.
-
-
Select Next.
Step 2: Select tokens
The next step is to select the tokens to allocate. The list of available tokens varies depending on how your inventory is managed.
-
Enter the search criteria. At a minimum, enter the Quantity to allocate. You can use any of the following options in your search:
-
Container: Indicates the container to allocate token inventory from. The Default container holds all tokens, unless additional containers have been created and inventory has been added to them.
-
Rental/Sale: Limits the tokens that are displayed in the list to Rental or Sale. Sale tokens can be allocated as sale or rental, while Rental tokens can be allocated only as rental.
-
Serial #: (Hardware tokens only) Selects a specific token from inventory, by serial number.
-
Available: Indicates the quantity available for allocation.
-
Quantity: Indicates the quantity to list.
-
-
Click Search.
The list is populated with inventory that matches the search criteria.
-
Select the check boxes for the tokens that you want to allocate.
-
Click Next to proceed to the next step.
Or, click Remove to remove the selected inventory from the Allocated list.
Step 3: Create billing references
Billing references are used in reporting to indicate how the transaction should be billed, and to link the transaction to customer references, such as purchase order numbers.
-
Billing Basis: The reporting system uses this flag to indicate the billing method associated with the transaction. It includes the following options:
-
Allocation: Indicates that billing occurs on the date when the inventory is allocated to the account.
-
Activate: Indicates that billing occurs when the token is assigned to a user. The user can be a user of this account or any account that it transfers the token to.
-
Authentication: Indicates that billing is based on token usage, where each authentication incurs a charge.
-
Transfer: Indicates that billing should start when this account (virtual service provider) allocates inventory to an account that it creates and manages. Transfer provides a mechanism to bill for the entire transaction or for only the quantity that is transferred.
-
-
Billing Start: Modifies the Billing Basis to indicate a date other than the transaction date to start billing. This is useful for allowing a grace period before billing commences. For example, on allocation, the Billing Start could allow 30 days after allocation before billing starts, whereas on Transfer, the Billing Start date could start billing on this date regardless of whether the inventory has been transferred.
-
Rate/Month: Indicates the charge that is applied per unit that is transferred. Do not include a character that is not easily used within the external billing system (for example, $, £).
-
Warranty Replacement: Indicates that the allocation is to replace product under warranty. When producing billing reports, this information helps to distinguish between new orders, billable product, and no-charge warranty replacements.
-
Reference: References external information that is related to this allocation, such as the customer purchase order number or a sales order number. This allows the transaction to be linked to external processes, such as order fulfillment.
For a Warranty Replacement, use the Reference to record the Return Material Authorization (RMA) number with the warranty replacement.
-
Evaluation: Indicates that the allocation is provided for evaluation purposes.
-
Comment: Include optional comments related to the transaction. Comments form a permanent part of the transaction record.
Step 4: Confirm allocation
This final step provides the opportunity to verify before committing the entire transaction.
The allocation table is updated when you select Finish.
Allocate SMS credits
Allocating SMS credits charges accounts, in advance, for the use of SMS services. Each SMS message that the account sends uses one credit (assuming customized message lengths do not exceed the SMS character limit, resulting in two or more SMS transmissions per message). STA decrements the account’s SMS credits inventory every time a message is sent.
Use this option if the account wants to use SMS/OTP, or if it will be configured to send alerts via SMS.
This option is available only if the virtual server has a configured SMS gateway or SMS modem, or if the account is a service provider that has SMS credits in inventory.
STA can send an alert to an account manager if an account’s remaining SMS credits fall below a specified threshold.
-
In the Allocation module, select Allocate.
-
Select the SMS Credits option and select Next.
The SMS Credits Inventory is unlimited if, as a service provider, you have configured an SMS gateway in the virtual server.
An SMS Credits Inventory of 0 indicates that, as a virtual service provider, you have not configured an SMS gateway and have either not purchased or consumed all SMS credits allocated to your account by your service provider.
-
Enter the number of SMS Credits to Allocate to the account.
-
Select Next and follow the steps.
View the allocation transaction log
A transaction record is created for each allocation.
A duplicate of the allocation table and transaction log is available on the Snapshot tab of the account’s virtual server.
-
Click the Transaction Log button.
Every allocation has a unique transaction ID. The transaction ID is a hyperlink if the allocation included tokens.
-
To display a list of all tokens that are included in the transaction by serial number, click the link.