| Excerpt | ||
|---|---|---|
| ||
Learn how you can to configure Access Token Business Definition that will dictate the overall behavior behaviour of Access Tokens |
Back to Access Tokens Main Page
| Panel | ||||
|---|---|---|---|---|
| ||||
Table of Contents
|
Navigating to Access Token Definitions
| Info |
|---|
CONFIGURATION > FOUNDATION APPLICATION > ACCESS TOKENS > SET UP ACCESS TOKEN DEFINITIONS |
What are Access Token Definitions?
Access Token Definitions are used to control the creation of access tokensAccess Tokens, by defining policies around the format of the access token user identifier and authentication code.
Creating, Editing & Deleting Validations & Restrictionspolicies governing the format of the Access Token User Identifier, Pass Code and Authentication Code. You can define whether Access Tokens can be created without an Identifier and Pass Code or deactivated when their last entity association (Rewards Participant or Accounts Receivable) is removed.
Additional settings relating to Access Tokens may also be defined, concerning Accounts Receivable and Rewards Participants, as well as Communication (Access Tokens can be automatically communicated to customers once 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 to see more detail.
- Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.
- Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition.
Check the Validations & Restrictions Table below for a list of available Actions when working with Access Token Definitions, including each Action's related validations and restrictions. View the Attributes Table for a comprehensive description of the Access Token Definitions fields.
Validations & Restrictions Table
| Action | Validations | Restrictions |
|---|---|---|
| General |
|
|
| Create |
|
|
| Save |
|
|
| Edit |
|
|
| Delete |
|
|
|
Attributes Table
An * indicates a field is mandatory
LOG INFORMATION
Deleting Access Tokens Definitions
Changing the Life Cycle State of Access Tokens Definition
Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Main Information | |||||||||
| Number | An auto-generated number that uniquely identifies the access token definitionsAccess Token Definitions | ||||||||
| Name* | The name of the definitionDefinition | ||||||||
| Alternative codeCode* | 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 specifiedDefinition. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters. | ||||||||
| Description | A description for of the definitionDefinition | ||||||||
| State | The state of the definition Definition which can be active or inactive'Active' or 'Inactive'. Only one active definition 'Active' Definition can exist at any point | Settingsa time. | |||||||
SETTINGS: The settings related to the access tokens | IdentifierAccess Tokens
| ||||||||
| Identifier Settings | |||||||||
| Automatic Creation Method | Defines if identifiers Determines whether Identifiers should be created automatically and the method that will be used to create them. The following options are supportedcan be selected:
| ||||||||
| Format | Defines the format of Determines how the identifiers are formatted. The following options are supported:
| ||||||||
| Minimum length | The minimum required length of the identifier | Minimum number of alphabetical characters Length | Theminimumrequirednumberofcharacters(alphabetical, numerical, or special) of the Identifier.
| ||||||
| Minimum Number Of Alphabetical Characters (a-z) | The minimum number of alphabetical characters (a-z)from 'a' to 'z' that should be included in the identifierVisible and applicable Identifier.
| Minimum number of integers
| |||||||
| Minimum Number Of Integers (0-9) | The minimum number of integers (0-9)from '0' to '9' that should be included in the identifierVisible and applicable Identifier.
| ||||||||
| Minimum number of other (special) characters | The minimum number of special characters that should be included in the identifier Visible and applicable only if the automatic creation is set to none and the format is set to free text or email | ||||||||
| Pass code | |||||||||
| Automatic Creation Method | Defines if pass codes
| ||||||||
| Minimum Number Of Other Special Characters | The minimum number of special characters that should be included in the Identifier.
| ||||||||
| Pass Code Settings | |||||||||
| Automatic Creation Method | Determines whether Pass Codes should be created automatically and the method used to create them. The following options can be selected:
| ||||||||
| Minimum Length | Theminimumrequirednumberofcharacters(alphabetical, numerical, or special) of the Pass Code.
| ||||||||
| Minimum Number Of Alphabetical Characters (a-z) | The minimum number of alphabetical characters from 'a' to 'z' that should be included in the Pass Code.
| ||||||||
| Minimum Number Of Integers (0-9) | The minimum number of integers from '0' to '9' that should be included in the Pass Code.
| ||||||||
| Minimum Number Of Other Special Characters | The minimum number of special characters that should be included in the Pass Code.
| ||||||||
| Authentication Code Settings | |||||||||
| Automatic Creation Method | Determines whether Authentication Codes should be created automatically and the method | that will be used to create them. The following options | are supportedcan be selected:
| If selected then pass codes
| If selected then pass codes
| the pass code
| ID: If selected then pass codes
| generated IDMinimum length | The minimum required length of the pass code
|
| Format | Determines how the Authentication Codes are formatted. The options are:
| ||||||||
| Minimum Length | Theminimumrequirednumberofcharacters(alphabetical, numerical, or special) of the Authentication Code.
| none
| |||||||
| Minimum | number of alphabetical charactersNumber Of Alphabetical Characters (a-z) | The minimum number of alphabetical characters | (a-z) from 'a' to 'z' that should be included in | the pass codethe Authentication Code.
| noneMinimum number of integers
| ||||
| Minimum Number Of Integers (0-9) | The minimum number of integers | (0-9) from '0' to '9' that should be included in | the pass codethe Authentication Code.
| noneMinimum number of other (special) characters
| |||||
| Minimum Number Of Other Special Characters | The minimum number of special characters that should be included in | the pass codethe Authentication Code.
| none|||||||
| Pass Code Settings | |||||||||
| Automation | |||||||||
| 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 | ||||||||
| 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 | ||||||||
| 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. | ||||||||
| Log Information | |||||||||
| Log Information | The standard log information | ||||||||
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:
Minimum Length
Minimum Number of Integers (0-9)
Minimum Number of Alphabetical Characters (a-z)
Minimum Number of Other Special Characters
PASSCODE
Provide the required information:
Minimum Length
Minimum Number of Integers (0-9)
Minimum Number of Alphabetical Characters (a-z)
Minimum Number of Other Special Characters
AUTOMATION
Provide the required information:
Allow Creating Access Tokens with No Identifier and Pass Code
Allow Creating Access Tokens on Creating Rewards Participants
Set Access Tokens as Not Effective on Removing the Last Entity Association
| |||||||||||||||||||||
| Automation Settings | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Allow Creating Access Tokens with No Identifier and Pass Code | If checked, one can create Access Tokens without specifying an Identifier and Pass Code. | ||||||||||||||||||||
| Set Access Tokens as 'Not Effective' on Removing the Last Entity Association | If checked, an Access Token will be set a 'Not Effective' if it is no longer associated with an entity. | ||||||||||||||||||||
| Accounts Receivable Settings | |||||||||||||||||||||
| Allow Creating Access Tokens on Creating Accounts Receivable | If checked, it will be possible to generate Access Tokens automatically when creating a new Accounts Receivable. | ||||||||||||||||||||
| Always Require at Least One Access Token | If checked, 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 to each Accounts Receivable. | ||||||||||||||||||||
| Require Verification | If checked, Access Tokens generated automatically when creating a new Accounts Receivable will require verification. They will have a 'Pending Verification' Life Cycle State. A verification code will also be generated automatically. | ||||||||||||||||||||
| Rewards Participants Settings | |||||||||||||||||||||
| Allow Creating Access Tokens on Creating Rewards Participants | If checked, it will be possible to generate Access Tokens automatically when creating a new Rewards Participant. | ||||||||||||||||||||
| Always Require at Least One Access Token | If checked, 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 | If checked, Access Tokens generated automatically when creating new Rewards Participants will require verification. They will have a 'Pending Verification' Life Cycle State. A verification code will also be generated automatically. | ||||||||||||||||||||
| Global Settings | |||||||||||||||||||||
Accounts Receivable Settings | |||||||||||||||||||||
| Allow Creating Access Tokens on Creating Accounts Receivable | If checked, it will be possible to generate Access Tokens automatically when creating a new Accounts Receivable. | ||||||||||||||||||||
| Always Require at Least One Access Token | If checked, 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 to each Accounts Receivable. | ||||||||||||||||||||
| Require Verification | If checked, Access Tokens generated automatically when creating a new Accounts Receivable will require verification. | ||||||||||||||||||||
| Required Number of Access Tokens per Access Token Classification | Determines the minimumandmaximumnumberofAccess Tokens of a specific Classification that can be associated with an Accounts Receivable.
| ||||||||||||||||||||
Required Verification of Access Tokens per Access Token Classification
| Defines a list of Access Tokens Classifications that will require verification when these Access Tokens are created directly through the process of creating new Accounts Receivable. If no classifications are defined then Access Tokens generated automatically when creating a new Accounts Receivable will require verification, regardless of classification. | ||||||||||||||||||||
Rewards Participant Settings | |||||||||||||||||||||
| Allow Creating Access Tokens on Creating Rewards Participant | If checked, it will be possible to generate Access Tokens automatically when creating a new Rewards Participant. | ||||||||||||||||||||
| Always Require at Least One Access Token | If checked, 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 | If checked, Access Tokens generated automatically when creating new Rewards Participants will require verification. They will have a 'Pending Verification' Life Cycle State and a verification code will be generated automatically. | ||||||||||||||||||||
| Required Number of Access Tokens per Access Token Classification | Determines the minimumandmaximumnumberofAccess Tokens of a specific Classification that can be associated with an Accounts Receivable.
| ||||||||||||||||||||
Required Verification of Access Tokens per Access Token Classification
| Defines a list of Access Tokens Classifications that will require verification when these Access Tokens are created directly through the process of creating new Rewards Participant. If no classifications are defined then Access Tokens generated automatically when creating a new Rewards Participant will require verification, regardless of 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 Receivable | If checked, Access Tokens will automatically be communicated when added to an Accounts Receivable. If checked, the following options are mandatory to be provided:
| ||||||||||||||||||||
Enable on Resetting Access Token Pass Code
| If checked, Access Tokens will automatically be communicated when their Pass Code is Reset. If checked, the following options are mandatory to be provided:
| ||||||||||||||||||||
| Communication Queue External System | The system that will be used to send the communication. If a Communication Queue External System is specified, the communication will be created automatically and added to the communication queue, but it will not be sent. | ||||||||||||||||||||
| 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, Access Tokens will automatically be communicated when added to a Rewards Participant. If checked, the following options are mandatory to be provided:
| ||||||||||||||||||||
Enable on Resetting Access Token Pass Code
| If checked, Access Tokens will automatically be communicated when their Pass Code is Reset. If checked, the following options are mandatory to be provided:
| ||||||||||||||||||||
| Communication Queue External System | The system that will be used to send the communication. If a Communication Queue External System is specified, the communication will be created automatically and added to the communication queue, but it will not be sent. | ||||||||||||||||||||
| LOG INFORMATION | |||||||||||||||||||||
| Log Information | The standard set of Log Details information available in all entities | ||||||||||||||||||||
| Note |
|---|
View Applying Access Token Definition Settings on Access Tokens for a complete overview of how the system behaves on each setting. |
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
| Popular Labels | ||||||||||||
| spaceKey | V4Manual | style | heatmap||||||||||
Helpful Links
|