| Excerpt | ||
|---|---|---|
| ||
Learn how you can configure Access Token Business Definition that will dictate overall behavior of Access Tokens |
| Panel | ||||
|---|---|---|---|---|
| ||||
Table of Contents
|
Navigating to Access Token Definitions
| Info |
|---|
CONFIGURATION > FOUNDATION APPLICATION > ACCESS TOKENS > SET UP DEFINITIONS |
What are Access Token Definitions?
Access Token Definitions are used to control the creation of access tokens, by defining policies around the format of the access token user identifier, pass code and authentication code.You can define whether you would like to create your access tokens without an identifier and pass code or whether an access token should be deactivated on removing the last entity association from the token. (i.e. removing the association between the access token and a rewards participant or an accounts receivable.)
Additionally settings related to Accounts Receivable and Rewards Participants, with relation to access tokens may be defined, as well as communication settings that allow access tokens to be automatically communicated to your customers once they are created.
Only definitions with an Effective Life Cycle State are applicable The life cycle state can be changed between Effective and Not Effective using a dedicated action.
Navigate to Access Token Definitions and explore existing records via the Summary page. Click on the link (name or number) of the record of your interest to enter the Data Entry page and have a better look of the available information. Use the Actions Menu to create a new (NEW) definition, modify (EDIT) or delete (DELETE) an existing one. Use the (BACK) link to go back to the summary page and (CANCEL) to cancel any unwanted changes made to the definition. Check out the attributes table below for a thorough explanation of the information kept for Access Token Definition and the Validations&Restrictions table to find out validations and restrictions applicable when working with the definitions. Act
Creating, Editing & Deleting Validations & Restrictions
| Action | Validations | Restrictions |
|---|---|---|
| General |
|
|
| Create |
|
|
| Save |
|
|
| Edit |
|
|
| Delete |
|
|
Access Token Definition attributes
Name | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Main Information | |||||||||||||
| Number | An auto generated number that uniquely identifies the access token definitions | ||||||||||||
| Name* | The name of the definition | ||||||||||||
| Alternative code* | An alternative code for the definition. On creating a new definition it defaults to the first letter of each word included in the name (in capitals), if nothing else is specified | ||||||||||||
| Description | A description for the definition | ||||||||||||
| State | The state of the definition which can be active or inactive. Only one active definition can exist at any point | Settings||||||||||||
| |||||||||||||
| Identifier Settings | |||||||||||||
| Automatic Creation Method | Defines if identifiers should be created automatically and the method that will be used to create them. The following options are supported:
| ||||||||||||
| Format | Defines the format of the identifiers. The following options are supported:
Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Minimum length | The minimum required length of the identifier | ||||||||||||
| Minimum number of alphabetical characters (a-z) | The minimum number of alphabetical characters (a-z) that should be included in the identifier Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email | ||||||||||||
| Minimum number of integers (0-9) | The minimum number of integers (0-9) that should be included in the identifier Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email. If If the format is set to phone number or number then this should be visible but not editable and should default to the minimum length | ||||||||||||
| Minimum number of other (special) characters | The minimum number of special characters that should be included in the identifier Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email | ||||||||||||
| Pass code Settings | |||||||||||||
| Automatic Creation Method | Defines if pass codes should be created automatically and the method that will be used to create them. The following options are supported:
| ||||||||||||
| Minimum length | The minimum required length of the pass code Visible Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Minimum number of alphabetical characters (a-z) | The minimum number of alphabetical characters (a-z) that should be included in the pass code Visible Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Minimum number of integers (0-9) | The minimum number of integers (0-9) that should be included in the pass code Visible Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Minimum number of other (special) characters | The minimum number of special characters that should be included in the pass code Visible Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Authentication Code Settings | |||||||||||||
| Automatic Creation Method | Defines if authentication codes should be created automatically and the method that will be used to create them. The following options are supported:
| ||||||||||||
| Format | Defines the format of the authentication codes. The following options are supported:
Visible and applicable only if the automatic creation is set to none | ||||||||||||
| Minimum length | The minimum required length of the authentication code | ||||||||||||
| Minimum number of alphabetical characters (a-z) | The minimum number of alphabetical characters (a-z) that should be included in the authentication code Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email | ||||||||||||
| Minimum number of integers (0-9) | The minimum number of integers (0-9) that should be included in the authentication code Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email. If If the format is set to phone number or number then this should be visible but not editable and should default to the minimum length | ||||||||||||
| Minimum number of other (special) characters | The minimum number of special characters that should be included in the authentication code Visible Visible and applicable only if the automatic creation is set to none and the format is set to free text or email | ||||||||||||
| Automation Settings | |||||||||||||
| Allow Creating Access Tokens with no identifier and pass code | If enabled, then it will be possible to create access tokens without specifying an identifier and pass code | ||||||||||||
| Set Access Tokens as Not Effective on removing the last entity association | If enabled, then an access token will be set a not effective if it was associated by one or more entities, and those associations were removed. | ||||||||||||
| |||||||||||||
| Allow Creating Access Tokens on Creating Accounts Receivable | If If enabled, then it will be possible to create access tokens directly through the process of creating a new accounts receivable | ||||||||||||
| Always require at least one access token | If checked then it will be mandatory to specify an access token for each accounts receivable | ||||||||||||
| Maximum number of access tokens | Defines the maximum number of access tokens that can be related with each accounts receivable | ||||||||||||
| Require Verification |
| ||||||||||||
| |||||||||||||
| Allow Creating Access Tokens on Creating Rewards participants | If enabled, then it will be possible to create access tokens directly through the process of creating a new rewards participant | ||||||||||||
| Always require at least one access token | If checked then it will be mandatory to specify an access token for each rewards participant | ||||||||||||
| Maximum number of access tokens | Defines the maximum number of access tokens that can be related with each rewards participant | ||||||||||||
| Require Verification |
| ||||||||||||
| Global Settings | |||||||||||||
Accounts Receivable Settings | |||||||||||||
| Allow Creating Access Tokens on Creating Accounts Receivable | If enabled, then it will be possible to create access tokens directly through the process of creating a new accounts receivable | ||||||||||||
| Always require at least one access token | If checked then it will be mandatory to specify an access token for each accounts receivable | ||||||||||||
| Maximum number of access tokens | Defines the maximum number of access tokens that can be related with each accounts receivable | ||||||||||||
| Require Verification |
| ||||||||||||
| Required number of access tokens per access token classification | It determines restrictions related with the minimum and maximum number of access tokens having a specific classification, that can be associated with an accounts receivable | ||||||||||||
| Access token classification | The restricted access token classification | ||||||||||||
| Minimum number of access tokens | The minimum number of access tokens of that classification | ||||||||||||
| Maximum number of access tokens | The maximum number of access tokens of that classification | ||||||||||||
Rewards Participant Settings | |||||||||||||
| Allow Creating Access Tokens on Creating Rewards participants | If enabled, then it will be possible to create access tokens directly through the process of creating a new rewards participant | ||||||||||||
| Always require at least one access token | If checked then it will be mandatory to specify an access token for each rewards participant | ||||||||||||
| Maximum number of access tokens | Defines the maximum number of access tokens that can be related with each rewards participant | ||||||||||||
| Require Verification |
| ||||||||||||
| Required number of access tokens per access token classification | It determines restrictions related with the minimum and maximum number of access tokens having a specific classification, that can be associated with a rewards participant | ||||||||||||
| Access token classification | The restricted access token classification | ||||||||||||
| Minimum number of access tokens | The minimum number of access tokens of that classification | ||||||||||||
| Maximum number of access tokens | The maximum number of access tokens of that classification | ||||||||||||
| Communication Settings | |||||||||||||
| Accounts Receivable Settings Define if access tokens should be communicated when they are used on accounts receivable | |||||||||||||
| Enable on assigning access tokens to Accounts Receivabe | If checked then access tokens will automatically be communicated when they are added on an accounts receivable | ||||||||||||
| Communication Template | The communication template that will be used to send the communication. The communication template should have media equals to email or sms and should be related with access token entity. This information is mandatory if the communication setting is enabled | ||||||||||||
| Communication Queue External System | The communication queue external system that will be used while sending the communication. If a communication queue external system is specified, then the communication will be created automatically, added in the communication queue, but will not be send | ||||||||||||
| Rewards Participant Settings Define if access tokens should be communicated when they are used on rewards participants | |||||||||||||
| Enable on assigning access tokens to Rewards Participants | If checked then access tokens will automatically be communicated when they are added on a rewards participant | ||||||||||||
| Communication Template | The communication template that will be used to send the communication. The communication template should have media equals to email or sms and should be related with access token entity. This information is mandatory if the communication setting is enabled | ||||||||||||
| Communication Queue External System | The communication queue external system that will be used while sending the communication. If a communication queue external system is specified, then the communication will be created automatically, added in the communication queue, but will not be send | ||||||||||||
| LOG INFORMATION | |||||||||||||
| Log Information | The standard Log Information | ||||||||||||
| Note |
|---|
Visit Applying Access Token Definition Settings on Access Tokens to get a full picture of how the system will behave based on each setting you select. |
Defining your own Access Tokens Definition tailored to your company's needs
MAIN INFORMATION
Provide the required information:
Name
Alternative Code
Description
SETTINGS
IDENTIFIER
Provide the required information as explained in the table above
PASSCODE
- Provide the required information as explained in the table above
AUTHENTICATION CODE
Provide the required information as explained in the table above
AUTOMATION
- Select which processes should automatically generate or set as inactive an Access Token
Allow Creating Access Tokens with No Identifier and Pass Code
Set Access Tokens as Not Effective on Removing the Last Entity Association
- Select which processes should automatically generate or set as inactive an Access Token
ACCOUNTS RECEIVABLE SETTINGS
Allow Creating Access Tokens on Creating Accounts Receivable : Check the box to enable
Always require at least one access token: Check the box to enable
- Maximum number of access tokens: Define a number for max access tokens
- Require Verification: Select if access tokens created directly through the process of creating new accounts receivable will require verification
REWARDS PARTICIPANT SETTINGS
Allow Creating Access Tokens on Creating Rewards Participants : Check the box to enable
Always require at least one access token: Check the box to enable
Maximum number of access tokens: Define a number for max access tokens
Require Verification: Select if access tokens created directly through the process of creating new rewards participants will require verification
COMMUNICATION SETTINGS
ACCOUNTS RECEIVABLE SETTINGS- Enable on assigning access tokens to Accounts Receivabe: Check the box to enable
- Communication Template: Search and add using quick search or search modal
- Communication Queue External System: Search and add using quick search or search modal
REWARDS PARTICIAPNT SETTINGS
- Enable on assigning access tokens to Rewards Participants : Check the box to enable
- Communication Template: Search and add using quick search or search modal
- Communication Queue External System: Search and add using quick search or search modal
LOG INFORMATION
Deleting Access Tokens Definitions
Changing the Life Cycle State of Access Tokens Definition
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
| Popular Labels | ||||||||||||
| spaceKey | V4Manual | style | heatmap||||||||||
Helpful Links
|