An account can be flagged as a "test account" in the system which indicates that the account is fully provisioned, but is NOT billed (i.e. the account is not invoiced). For this reason, flagging an account as a test account is a best practice to test account creation and structuring your product catalog. If you wish to also test an account's billing, it is a best practice to set up an active account, which will be invoiced, and enter fake data (including payment information) so that there is no impact from the billing.
Home > Aria6 User Documentation > Configuration > Client Settings > Set Up a Test Account
Set Up a Test Account
Set Up a Test Account
Overview
Note: The system will never automatically mark an account as a test account, even if that account is created or updated with fake data (e.g. fake credit card information).
Setting Up a Test Account without Billing
Similarly to setting an account status to "Permanent," an account that is flagged as a test account is fully provisioned, but is not billed. An account can either be created as a test account or an active account can be updated at any time to be flagged as a test account in the system. Likewise, an account that has been previously flagged as a test account can be made into an active account that is fully provisioned and is invoiced at the time of billing.
New or existing accounts can be flagged as "test accounts" at any time via the UI or API.
Prerequisite
Before setting an account as a test account, you may want to set the Test Account "Days To Live" client parameter. This setting dictates the number of days after the creation of a test account that the system automatically terminates the account.
Note: If this client parameter is not specifically set, the default number of days before a test account is automatically terminated is 5.
Once an account is terminated, the account status moves to "Terminated," and the account can still be searched for and reviewed.
Getting Here: Click Configuration > Client Settings > Miscellaneous Settings
- Select the Test Account "Days To Live" client parameter.
- Enter the number of days in the Value field.
This dictates the number of days that a test account should exist in the system before being automatically terminated.
- Click Save.
Set Up a Test Account in the UI
New and Existing Accounts
Once an account is created, or if it already exists, it can be flagged as a test account by completing the following steps.
- Select the Toggle Test Account Flag tab on the account.
- Select the This account IS a test account toggle.
Note: The configured number of days for a "test account" to exist in the system before being automatically terminated displays on this screen.
- Click the Change Test Account Flag button.
At any time, the This account is NOT a test account toggle can be selected to change a "test account" into an active account.
Set Up a Test Account using APIs
New Accounts
To create a new account that is flagged as a test account, enter a value of 1 in the <test_acct_ind> input parameter via either the create_acct_complete or create_acct_hierarchy API.
Existing Accounts
To update an existing account to be flagged as a test account, enter a value of 1 in the <test_acct_ind> input parameter via the update_acct_complete API.
To change an account from a live account to a test account, or from a test account to a live account, utilize the toggle_test_account API.
Setting Up a Test Account with Billing
To fully test an account, including billing, it is a best practice to set up an active account, so that the account is invoiced. To prevent this account's billing from having any impact, it is recommended that all PII data (Personally Identifiable Information) is fake, including names, email addresses, and payment information.
Note: The system has no way of recognizing that this is fake data and, therefore, has no way of indicating that this is a test account. Accounts set up with fake data, to be used as test accounts, should be noted internally.
Managing Test Accounts Set Up with Billing
Some best practices to manage these accounts include adding a supplemental field of "Test" to the account or constructing a naming convention with the word "Test" within the test account name.
It should also be noted that, because an account set up this way is not flagged as a test account, the Test Account "Days To Live" client parameter does not apply. Users must manage accounts set up for this purpose along with all other active accounts.
- © Copyright 2023 Aria Developer Central