| 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
- SETTINGS: The settings related to the access tokensStatus colour Red title Applicable up to R9
| Status | ||||
|---|---|---|---|---|
|
Defines if identifiers should be created automatically and the method that will be used to create them. The following options are supported:
- None: If selected then identifiers will not be created automatically
- Unique Auto Generated Number: If selected then identifiers will be created automatically, using the identifier sequence number.
- Unique Auto Generated ID: If selected then identifiers will be created automatically as an auto generated ID
Defines the format of the identifiers. The following options are supported:
- Email Address: If selected then the identifiers that will be provided should be formatted as email addresses
- Number: If selected then the identifiers that will be provided should be formatted as numbers
- Free text: If selected then the identifiers that will be provided will not have any restrictions on their format
Visible and applicable only if the automatic creation is set to none
The minimum required length of the identifier
Visible and applicable only if the automatic creation is set to none
| Excerpt | ||
|---|---|---|
| ||
Learn to configure Access Token Business Definition that will dictate the overall 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 Tokens, by defining the policies 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
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. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters. | ||||||||||
| Description | A description of the Definition | ||||||||||
| State | The state of the Definition which can be 'Active' or 'Inactive'. Only one 'Active' Definition can exist at a time. | ||||||||||
SETTINGS: The settings related to the Access Tokens
| |||||||||||
| Identifier Settings | |||||||||||
| Automatic Creation Method | Determines whether Identifiers should be created automatically and the method used to create them. The following options can be selected:
| ||||||||||
| Format | Determines how the identifiers are formatted. The options are:
| ||||||||||
| Minimum Length | Theminimumrequirednumberofcharacters(alphabetical, numerical, or special) of the Identifier.
| ||||||||||
| Minimum Number Of Alphabetical Characters (a-z) | The minimum number of alphabetical characters from 'a' to 'z' that should be included in the Identifier.
| ||||||||||
| Minimum Number Of Integers (0-9) | The minimum number of integers from '0' to '9' that should be included in the Identifier.
| ||||||||||
| 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 used to create them. The following options can be selected:
| ||||||||||
| Format | Determines how the Authentication Codes are formatted. The options are:
| ||||||||||
| Minimum Length | Theminimumrequirednumberofcharacters(alphabetical, numerical, or special) of the Authentication Code.
| ||||||||||
| 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 | identifierAuthentication Code.
| none
| format
| free text or emailMinimum 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 identifierthe Authentication Code.
| is set to none and the format is set to free text or email. If the format is set to phone number or number then this should be visible but not editable and should default to the minimum lengthMinimum number of other (special) characters
| |||||||
| Minimum Number Of Other Special Characters | The minimum number of special characters that should be included in the | identifierAuthentication Code.
| none
| format
| 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 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 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 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 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 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 and applicable only if the automatic creation is set to none and the format is set to free text or email. 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 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 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 | ||||||||||
| |||||||||||||||||||||
| 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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Helpful Links
|