R9 - Configuring Access Token Definitions
What does this section cover?
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 and authentication code.
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: The settings related to the access tokens | |
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 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 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 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 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. |
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 | AVAILABLE FROM CRM.COM R9 If enabled, then access tokens created directly through the process of creating new accounts receivable will require verification. Those access tokens will be created in a pending verification life cycle state. A verification code is also generated automatically |
Rewards Participants 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 | AVAILABLE FROM CRM.COM R9 If enabled, then access tokens created directly through the process of creating new rewards participants will require verification. Those access tokens will be created in a pending verification life cycle state. A verification code is also generated automatically. |
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 |
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
- Navigate to CONFIGURATION > FOUNDATION > ACCESS TOKENS > SET UP ACCESS TOKEN DEFINITIONS
- Either search for an existing one or from the Top Menu click on NEW
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
- From the Top Menu click on SAVE
LOG INFORMATION
Log information section keeps all the logging information related to the specific record
- Basic set of information available in all entities
- Created By User: The user that created the entity
- Created By Unit: The unit of the user that created the entity
- Updated By User: The user that last updated the entity
- Updated by Unit: The unit of the user that last updated the entity
- Date Created: The date the account was entity
- Date Updated: The date the account was last entity
- Basic set of information available in all entities
Deleting Access Tokens Definitions
- Search for the entity that you would like to delete
Visit Using Summary Pages to find out how you can search using CRM.COM Summary Screens - Click on the link of the record you would like to delete, to be transferred to the Data Entry page
- From the actions menu click on "DELETE"
The entity will be deleted given that the validations are satisfied
Changing the Life Cycle State of Access Tokens Definition
- Navigate to the module you would like to activate a different definition for
- From the menu click of the Summary page click on ACTIONS > ACTIVATE DEFINITION
- From the Drop Down select the definition you would like to set as active
- Click on "SAVE"
System will switch between active and inactive definitions
Related Areas
-
Access Tokens - Configuration Requirements — Find out what configurations should be performed before starting to use the CRM.COM Access Tokens Module
-
Configuring Access Token Classifications — Learn to configure Access Token Classifications Business Definition that will dictate overall behaviour of Access Token Classifications
-
Configuring Access Token Definitions — Learn to configure Access Token Business Definition that will dictate the overall behaviour of Access Tokens
-
Understanding Access Tokens — Understand the usage of Access Tokens within CRM.COM
-
Managing Access Tokens — Learn to create new Access Tokens
Popular Labels
- accounts-receivable
- accounts-receivable-admin
- accounts-receivable-advanced
- accounts-receivable-advanced-r7
- accounts-receivable-basics
- activities
- activities-admin
- activities-admin-r7
- activities-basics
- activities-basics-r7
- additive-discounts-admin
- additive-discounts-advanced
- additive-discounts-basics
- billing-application
- billing-engine
- communication-centre
- communications-advanced-r7
- conax-web-services-advanced
- conax-web-services-basics
- contact-information
- contact-information-admin-r7
- crm-application
- crm-application-r7
- customer-events-basics-r7
- dashboards-advanced
- finance-application
- financial-transactions-admin
- financial-transactions-admin-r7
- financial-transactions-advanced
- financial-transactions-advanced-r7
- foundation-application
- foundation-application-r7
- global
- inventory-management
- inventory-management-advanced
- inventory-management-basics
- inventory-management-basics-r7
- jobs
- jobs-admin
- jobs-admin-r7
- jobs-advanced
- jobs-basics
- jobs-basics-r7
- leads
- leads-admin
- leads-admin-r7
- network-management-basics
- network-management-basics-r7
- normal-billing-admin-r7
- normal-billing-r7
- normal-billing-run-admin
- normal-billing-run-basics
- notifications
- notifications-basics
- panaccess
- platform-advanced
- platform-basics
- prepaid-billing-basics
- prepaid-billing-r7
- price-plans
- products-admin-r7
- rated-billing-items-advanced
- rated-billing-items-basics
- reports-basics
- resource-scheduling-advanced
- rewards-admin-r7
- rewards-advanced
- rewards-advanced-r7
- rewards-basics
- rewards-basics-r7
- security-management
- security-management-advanced
- security-management-advanced-r7
- segmentation-basics
- service-requests-admin
- service-requests-admin-r7
- service-requests-advanced
- service-requests-advanced-r7
- subscription-actions-r7
- subscriptions
- subscriptions-advanced
- subscriptions-advanced-r7
- subscriptions-basics
- subscriptions-basics-r7
- udrs
- udrs-admin-r7
- usage-service-r7
- user-management
- user-management-basics
- vouchers
- vouchers-advanced
- vouchers-basics
- wallets
- wallets-admin
- wallets-advanced
- wallets-basics
- workflows-admin-r7
- workflows-advanced-r7
- workflows-r7
- zapier-basics-r7