Excerpt

hidden	true

Learn how you can to configure Access Token Business Definition that will dictate the overall behavior behaviour of Access Tokens

Panel

name	blue

Access Token Definitions are used to control the creation of access tokensAccess Tokens, by defining policies around the policies governing 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 EffectiveAccess 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 and have a better look of the available information. Use the Actions Menu to create a new (NEW) definition

page to see more detail.
Use the Actions Menu to create a NEW Definition, modify (EDIT)

or delete (DELETE) an

, or DELETE an existing one.

Use the (BACK) link to go back to the summary page and (CANCEL) to cancel

Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the

definition. Check out the attributes table

Definition.

Check the Validations & Restrictions 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. ActImage Removed

Creating, Editing & Deleting Validations & Restrictions

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.

Image Added

Validations & Restrictions Table

Action	Validations	Restrictions
General	Not applicable	Only one active access token definition 'Active' Access Token Definition can exist at any given time.
Create	Multiple access token definitions Access Token Definitions can exist in the system, but each one should have a unique name Name and alternative codeAlternative Code.	Not applicable
Save	Mandatory Fields: Name Alternative Code	Not applicable
Edit	Not applicable	Not applicable
Delete	Not applicable	Not applicable

Access Token Definition attributes

Attributes Table

An * indicates a field is mandatory

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

Status

colour	Red
title	Applicable up to R9

- a time.

SETTINGS: The settings related to the access tokensAccess Tokens

Status

colour	Green
title	Available from CRM.COM R10.0.0

- SETTINGS FOR ACCESS TOKENS WITH NO CLASSIFICATION

Identifier SettingsAutomatic 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:

None: If selected then identifiers The Identifiers will not be created automatically.
Unique Auto-Generated Number: If selected then identifiers The Identifiers will be created automatically, using the identifier their sequence number.
Unique Auto-Generated ID: If selected then identifiers Id: TheIdentifiers will be created automatically as an auto-generated IDId.

Format
Defines Determines how the format of the identifiers are formatted. The following options are supported:
as 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 (es)
as Number(s)
as Free Text with no restrictions on their format
Visible and applicable Applicable only if the automatic creation Automatic Creation Method is set to none'None'.
Minimum lengthLength
The minimum required length number of characters (alphabetical, numerical, or special) of the identifier
Visible and applicable Identifier.
Applicable only if the automatic creation Automatic Creation Method is set to none'None'.
Minimum number of alphabetical characters Number Of Alphabetical Characters (a-z)
The minimum number of alphabetical characters
(a-z)
from 'a' to 'z' that should be included in the
identifier
Visible and applicable
Identifier.
Applicable only if the
automatic creation
Automatic Creation Method is set to
none
'None' and the
format
Format is set to
free text or emailMinimum number of integers
'Free Text' or 'Email Address'.
Minimum Number Of Integers (0-9)
The minimum number of integers
(0-9)
from '0' to '9' that should be included in the
identifier
Visible and applicable
Identifier.
Applicable only if the
automatic creation
Automatic Creation Method is set to
none
'None' and the
format
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
'Free Text' or 'Email Address'.
Minimum Number Of Other Special Characters
The minimum number of special characters that should be included in the
identifier
Visible and applicable
Identifier.
Applicable only if the
automatic creation
Automatic Creation Method is set to
none
'None' and the
format
Format is set to
free text or email
'Free Text' or 'Email Address'.
Pass code Code Settings
Automatic Creation Method
Defines if pass codes Determines whether Pass Codes should be created automatically and the method that will be used to create them. The following options are supportedcan be selected:
None: If selected then pass codes The Pass Codes will not be created automatically
Unique Auto-Generated Number: If selected then pass codes The Pass Codes will be created automatically, using the pass code their sequence number.
Unique Auto-Generated ID: If selected then pass codes Id: The Pass Codes will be created automatically as an auto-generated IDId
Minimum lengthLength
The minimum required
length of the pass code
Visible and applicable only if the automatic creation is set to noneMinimum number of alphabetical characters
number of characters (alphabetical, numerical, or special) of the Pass Code.
Applicable only if the Automatic Creation Method is set to 'None'.
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 pass code
Visible and applicable
the Pass Code.
Applicable only if the
automatic creation e
Automatic Creation Method is set to
non
'None'.
Minimum number of integers Number Of Integers (0-9)
The minimum number of integers
(0-9)
from '0' to '9' that should be included in
the pass code
Visible and applicable
the Pass Code.
Applicable only if the
automatic creation
Automatic Creation Method is set to
noneMinimum number of other (special) characters
'None'.
Minimum Number Of Other Special Characters
The minimum number of special characters that should be included in
the pass code
Visible and applicable
the Pass Code.
Applicable only if the
automatic creation e
Automatic Creation Method is set to
non
'None'.
Authentication Code SettingsAutomatic Creation Method
Defines if authentication codes 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:
None: If selected then authentication codes The Authentication Codes will not be created automatically.
Unique Auto-Generated Number: If selected then authentication codes The Authentication Codes will be created automatically, using the authentication codes their sequence number.
Unique Auto-Generated ID: If selected then authentication codes Id: The Authentication Codes will be created automatically as an auto-generated IDId.
Format
Defines the format of the authentication codes. The following options are supported:
Email Address: If selected then the authentication codes that will be provided should be formatted as email addresses
Number: If selected then the authentication codes that will be provided should be formatted as numbers
Free text: If selected then the authentication codes that will be provided will not have any
Determines how the Authentication Codes are formatted. The options are:
as Email Address(es)
as Number(s)
as Free Text with no restrictions on their format
Visible and applicable Applicable only if the automatic creation Automatic Creation Method is set to none'None'.
Minimum lengthLength
The minimum required length of the authentication code
Visible and applicable number of characters (alphabetical, numerical, or special) of the Authentication Code.
Applicable only if the automatic creation is set to none'None'.
Minimum number of alphabetical characters Number Of Alphabetical Characters (a-z)
The minimum number of alphabetical characters
(a-z)
from 'a' to 'z' that should be included in the
authentication code
Visible and applicable
Authentication Code.
Applicable only if the automatic creation is set to
none
'None' and the
format
Format is set to
free text or emailMinimum number of integers
'Free Text' or 'Email Address'
Minimum Number Of Integers (0-9)
The minimum number of integers
(0-9)
from '0' to '9' that should be included in
the authentication code
Visible and applicable
the Authentication Code.
Applicable only if the automatic creation is set to
none
'None' and the
format
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
'Free Text' or 'Email Address'.
Minimum Number Of Other Special Characters
The minimum number of special characters that should be included in the
authentication code
Visible and applicable
Authentication Code.
Applicable only if the automatic creation is set to
none
'None' and the
format
Format is set to
free text or email
'Free Text' or 'Email Address'.
Automation Settings
Allow Creating Access Tokens with no identifier and pass codeNo Identifier and Pass CodeIf enabled, then it will be possible to create access tokens checked, one can create Access Tokens without specifying an identifier and pass codeIdentifier and Pass Code.Set Access Tokens as 'Not Effective' on removing the last entity associationRemoving the Last Entity AssociationIf enabledchecked, then an access token Access Token will be set a not effective 'Not Effective' if it was associated by one or more entities, and those associations were removed.
Status
colour Red
title Applicable up to CRM.COM R9
- is no longer associated with an entity.Accounts Receivable SettingsAllow Creating Access Tokens on Creating Accounts ReceivableIf enabledchecked, then it will be possible to create access tokens directly through the process of generate Access Tokens automatically when creating a new accounts receivableAccounts Receivable.Always require at least one access tokenRequire at Least One Access TokenIf checked then , it will be mandatory to specify an access token Access Token for each accounts receivableAccounts Receivable.Maximum number Number of access tokensAccess TokensDefines the maximum number of access tokens Access Tokens that can be related with each accounts receivableto each Accounts Receivable.Require Verification StatuscolourRedtitleAvailable from CRM.COM R9
If enabled, then access tokens created directly through the process of creating new accounts receivable checked, Access Tokens generated automatically when creating a new Accounts Receivable will require verification. Those access tokens will be created in a pending verification life cycle stateThey will have a 'Pending Verification' Life Cycle State. A verification code is will also be generated automatically
StatuscolourRedtitleApplicable up to CRM
.
COM R9
- Rewards Participants SettingsAllow Creating Access Tokens on Creating Rewards participantsParticipantsIf enabledchecked, then it will be possible to create access tokens directly through the process of creating a new rewards participantAlways require at least one access tokenIf checked then generate Access Tokens automatically when creating a new Rewards Participant.Always Require at Least One Access TokenIf checked, it will be mandatory to specify an access token for each rewards participantAccess Token for each Rewards Participant.Maximum number Number of access tokensAccess TokensDefines the maximum number of access tokens Access Tokens that can be related with each rewards participantRewards Participant.Require Verification StatuscolourRedtitleAvailable from CRM.COM R9If enabled, then access tokens created directly through the process of creating new rewards participants checked, Access Tokens generated automatically when creating new Rewards Participants will require verification. Those access tokens will be created in a pending verification life cycle stateThey will have a 'Pending Verification' Life Cycle State. A verification code is will also be generated automatically.Global Settings
Status
colour Green
title Available from CRM.COM R10.0.0
Accounts Receivable Settings
Allow Creating Access Tokens on Creating Accounts ReceivableIf enabledchecked, then it will be possible to create access tokens directly through the process of generate Access Tokens automatically when creating a new accounts receivableAccounts Receivable.Always require at least one access tokenRequire at Least One Access TokenIf checked then , it will be mandatory to specify an access token Access Token for each accounts receivableAccounts Receivable.Maximum number Number of access tokensAccess TokensDefines the maximum number of access tokens Access Tokens that can be related with each accounts receivableto each Accounts Receivable.Require Verification StatuscolourRedtitleAvailable from CRM.COM R9
If enabled, then access tokens created directly through the process of creating new accounts receivable checked, Access Tokens generated automatically when creating a new Accounts Receivable will require verification. Those access tokens will be created in a pending verification life cycle stateThey will have a 'Pending Verification' Life Cycle State. A verification code is will also be generated automatically

.
Required number Number of access tokens per access token classificationIt determines restrictions related with Access Tokens per Access Token Classification
Determines the minimum and maximum number of
access tokens having
Access Tokens of a specific
classification,
Classification that can be associated with an
accounts receivableAccess token classificationThe restricted access token classification
Accounts Receivable.
Access Token Classification: Defines the behaviour of each Access Token and the business settings and restrictions that will be applied while creating, maintaining or using it.
Minimum number of
access tokens
Access Tokens: The minimum number of
access tokens
Access Tokens of that
classification
Classification.
Maximum number of
access tokens
Access Tokens: The maximum number of
access tokens
Access Tokens of that
classification
Classification.

Status
colour Green
title Available from CRM.COM R10.0.0
Rewards Participant Settings
Allow Creating Access Tokens on Creating Rewards participantsParticipantIf enabledchecked, then it will be possible to create access tokens directly through the process of creating a new rewards participantAlways require at least one access tokenIf checked then generate Access Tokens automatically when creating a new Rewards Participant.Always Require at Least One Access TokenIf checked, it will be mandatory to specify an access token for each rewards participantAccess Token for each Rewards Participant.Maximum number Number of access tokensAccess TokensDefines the maximum number of access tokens Access Tokens that can be related with each rewards participantRewards Participant.Require Verification
Status
colour Red
title Available from CRM.COM R9
If enabled, then access tokens created directly through the process of creating new rewards participants If checked, Access Tokens generated automatically when creating new Rewards Participants will require verification. Those access tokens will be created in a pending verification life cycle stateThey will have a 'Pending Verification' Life Cycle State. A verification code is will also be generated automatically.  Required number Number of access tokens per access token classificationIt determines restrictions related with Access Tokens per Access Token Classification
Determines the minimum and maximum number of
access tokens having
Access Tokens of a specific
classification,
Classification that can be associated with
a rewards participantAccess token classificationThe restricted access token classification
an Accounts Receivable.
Access Token Classification: Defines the behaviour of each Access Token and the business settings and restrictions that will be applied while creating, maintaining or using it.
Minimum number of
access tokens
Access Tokens: The minimum number of
access tokens
Access Tokens of that
classification
Classification.
Maximum number of
access tokens
Access Tokens: The maximum number of
access tokens
Access Tokens of that
classification
Classification.
Communication SettingsAccounts Receivable Settings
Define if access tokens Access Tokens should be communicated when they are used on accounts receivableAccounts Receivable
Enable on assigning access tokens Assigning Access Tokens to Accounts ReceivabeReceivableIf checked then access tokens , Access Tokens will automatically be communicated when they are added on an accounts receivableto an Accounts Receivable.Communication TemplateThe communication The template that will be used to send the communication. The communication template Communication Template should have media equals set to email or sms- and should be related with access token an Access Token entity. This information is mandatory if the communication setting is enabledCommunication Setting is 'Enabled'.Communication Queue External SystemThe communication queue external system that will be used while sending to send the communication. If a communication queue external system Communication Queue External System is specified, then the communication will be created automatically , and added in to the communication queue, but it will not be sendsent.Rewards Participant Settings
Define if access tokens Access Tokens should be communicated when they are used on rewards participants
Enable on assigning access tokens Assigning Access Tokens to Rewards ParticipantsIf checked then access tokens , Access Tokens will automatically be communicated when they are added on a rewards participantto a Rewards Participant.Communication TemplateThe communication The template that will be used to send the communication. The communication template Communication Template should have have media equals set to email or sms and - and should be related with access token an Access Token entity. This information is mandatory if the communication setting is enabledCommunication Setting is 'Enabled'.Communication Queue External SystemThe communication queue external system that will be used while sending to send the communication. If a communication queue external system Communication Queue External System is specified, then the communication will be created automatically , and added in to the communication queue, but it will not be sendsent.LOG INFORMATIONLog InformationThe standard Log Information

NoteVisit Applying Access Token Definition Settings on Access Tokens to get a full picture
set of Log Details information available in all entities
Note
View /wiki/spaces/WIP/pages/10010273 for a complete overview of how the system will behave based behaves on each setting you select.

Panel

name	grey

Related Areas

Filter by label (Content by label)

showLabels	false
spaces	V4Manual
showSpace	false
labels	access-tokens-basics-r7,access-tokens-admin-r7

Panel

name	grey

Helpful Links

Filter by label (Content by label)

showLabels	false
spaces	V4Manual
showSpace	false
excerpt	true
labels	global

Versions Compared

Old Version 15

New Version 16

Key

Table of Contents

Navigating to Access Token Definitions

What are Access Token Definitions?

Validations & Restrictions Table

Attributes Table

Related Areas

Helpful Links

Page Comparison

Versions Compared

Old Version 15

New Version 16

Key

Table of Contents

Navigating to Access Token Definitions

What are Access Token Definitions?

Validations & Restrictions Table

Attributes Table

Related Areas

Helpful Links