Versions Compared

Old Version 1

changes.mady.by.user Persia Xenopoulou

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Find out how settings defined in the access token definition Access Token Definition are applied when creating or updating access tokens

What does this section cover?

Access Tokens

Back to Access Tokens Main Page 

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Applying Access Token Definition or Classification Settings

Access Token Definitions provide a plethora of  and the Access Token Classifications (from CRM.COM R10 onwards) provide several settings related to the access token Access Token attributes, such as the Pass CodeCodes, the Identifier and the Authentication Code.
In this manual you can find out how the system behaves Identifier and Authentication Codes. 

Note

Access Token Definitions and Access Classification Settings are the same. The settings defined in the Access Token Definitions will only be applied as long as a Classification is not defined on the Access Token.

This manual tackles system behaviour for each of the settings that can be defined in the the Access Token Definitions

Validations & Restrictions

 

 

 or Access Token Classifications (from CRM.COM R10 onwards).

Applying Identifier Settings

ActionValidations & System Processing
On SavingSave
  • If the automatic creation method is set to Unique Auto-Generated Number then
    • The identifier Identifier is read 'Read-only'
    • The identifier Identifier is generated using the identifier Identifier sequence number
    • The generation is done takes place on saving (and not on creating)
  • If the automatic creation method is set to Unique Auto-Generated ID then
    • The identifier Identifier is read 'Read-only'
    • The identifier Identifier is generated using a GUID value (Globally Unique Identifier)
    • The generation is done takes place on saving (and not on creating)
On UpdatingUpdateThe identifier Identifier is validated based on the specified format settings (see the "Validation information based on specified Format" process below)

 

Applying Pass Code Settings

ActionValidations & System Processing
On SavingSave
  • If the automatic creation method is set to Unique Auto-Generated Number then
    • The pass code is read onlyThe pass code Pass Code is 'Read-only'
    • The Pass Code is generated using the pass code sequence Pass Code sequence number
    • The generation is done on saving (and not on creating)
  • If the automatic creation method is set to Unique Auto-Generated ID then
    • The pass code is read onlyThe pass code is Pass Code is 'Read-only'
    • The Pass Code is generated using a GUID value
    • The generation is done on saving (and not on creating)
 
On UpdatingUpdateThe pass code is Pass Code is validated based on the specified format settings (see the "Validation information based on specified Format" process below)

Applying Authentication Code Settings

   
   
   

 

 
ActionValidations & System Processing
On Save
  • If the automatic creation method is set to Unique Auto-Generated Number then
    • The
authentication code is read only
    • Authentication Code is 'Read-only'
    • The
authentication code
    • Authentication Code is generated using the
authentication code sequence
    • Authentication Code sequence number
    • The generation is done on saving (and not on creating)
  • If the automatic creation method is set to Unique Auto-Generated ID then
    • The
authentication code is read only
    • Authentication Code is 'Read-only'
    • The
authentication code is
    • Authentication Code is generated using a GUID value
    • The generation is done on saving (and not on creating)
On
updating an access token
UpdateThe
authentication  code is
Authentication Code is validated based on the specified format settings
(see the "Validation information based on specified Format" process below)

Applying Automation Settings on Access Tokens Identifier and Pass Code

Image RemovedCRMCOM-2829 - Ability to use access tokens to identify accounts receivable IN PROGRESS

This process is used to apply automation setting on access tokens identifier and pass code. The following logic is applied:

If the "
SettingValidations & System Processing
Allow Creating Access Tokens with no
identifier and pass code" is enabled on the active access token definition thenOn
Identifier and Pass Code: Selected When creating or updating an
access token
Access Token
  • If the
identifier
  • Identifier is not specified and not auto-generated
automatically
  • then
No
  • no validation error will be
thrown
  • displayed
  • If the
pass code
  • Pass Code is not specified and not auto-generated
automatically
  • then
No
  • no validation error will be
thrown
  • displayed
If the "
Allow Creating Access Tokens with no
identifier and pass code" is not enabled on the active access token definition thenOn
Identifier and Pass Code: Not Selected

When creating or updating an

access token

Access Token

    • If the
identifier
    • Identifier is not specified and not
generated automatically thenA
    • auto-generated the a validation error will be
thrown
    • displayed
    • If the
pass code
    • Pass Code is not specified and not auto-generated
automatically
    • then
A
    • a validation error will be
thrown
    • displayed

Applying Accounts Receivable Settings on

relating

related Access Tokens with Accounts Receivable

Image RemovedCRMCOM-2829 - Ability to use access tokens to identify accounts receivable IN PROGRESS

This process is used to apply accounts receivable settings while relating an access token with an accounts receivable. The following logic is applied:

If the "
SettingValidations & System Processing
Allow Creating Access Tokens on Creating Accounts Receivable
" is enabled then
: Selected
  • It
should be
  • is possible to create new
access tokens
  • Access Tokens while creating a new or updating an existing
accounts receivable
If the "
  • Accounts Receivable.

Allow Creating Access Tokens on Creating Accounts Receivable
" is not enabled then
: Not Selected
  • It
 should
  • is not
be possible
  • possible to create new
access tokens
  • Access Tokens while creating a new or updating an existing
accounts receivable
  • Accounts Receivable. The system will only allow
selecting existing access tokens
If the "
  • the selection of existing Access Tokens.

Always require at least one
access token" is enabled then
Access Token: Selected
  • The system will validate that at least one
access token
  • Access Token is related with the
accounts receivable
  • Accounts Receivable which isbeing created or updated.
If the "
Maximum number of
access tokens" is specified
Access Tokens: Defined
  • The system will validate that the
access tokens
  • Access Tokens related with the
accounts receivable
  • Accounts Receivable which is
created
  • being created or updated, are equal or less than the
specified
  • defined number.

Applying Rewards Participants Settings on

relating

related Access Tokens with Rewards Participants

Image RemovedCRMCOM-2829 - Ability to use access tokens to identify accounts receivable IN PROGRESS

This process is used to apply rewards participants settings while relating an access token with a rewards participant. The following logic is applied:

If the "
SettingValidations & System Processing
Allow Creating Access Tokens on Creating Rewards
Participant" is enabled then
Participants: Selected
  • It
should be
  • is possible to create new
access tokens
  • Access Tokens while creating a new or updating an
existing rewards participant
If the "
  • existing Rewards Participants
Allow Creating Access Tokens on Creating Rewards
Participant" is not enabled then
Participants: Not Selected
  • It
 should
  • is not
be possible
  • possible to create new
access tokens
  • Access Tokens while creating a new or updating an existing
rewards participant
  • Rewards Participants. The system will only allow
selecting existing access tokens
If the "
  • the selection of existing Access Tokens.
Always require at least one
access token" is enabled then
Access Token: Selected
  • The system will validate that at least one
access token
  • Access Token is related with
the rewards participant which is
  • the Rewards Participants which is being created or updated
If the "
Maximum number of
access tokens" is specified
Access Tokens: Defined
  • The system will validate that the
access tokens
  • Access Tokens related with
the rewards participant which is
  • the Rewards Participants which is being created or updated
,
  • are equal or less than the
specified number

Validating information based on specified Format

Image RemovedCRMCOM-3923 - Ability to set up business rules that will define and validate the format of the access token authentication informationTO BE APPROVED

This process is used to validate the authentication code, identifier and pass code based on the format which is specified on the active access token definition. The following logic is applied (on each type of information that will be validated):

  • On creating or updating an access token then
    • If the automatic creation method is set to None then
      • For the authentication code and identifier
        • If the format is set to email address then
          • The specified authentication code or identifier should be validated as email based on the following logic:
            • The structure should be localpart@domain
            • "@" character should exist
            • The local part should not start or end with a dot (".")
            • The local part should not include two or more successive dots (".")
            • The domain part should not start or end with a dot (".")
            • The domain part should not include two or more successive dots (".")
            • The domain part should include at least one dot (".")
        • If the format is set to number then
          • The specified authentication code or identifier should be validated as number based on the following logic:
            • It should include only integer numbers (0-9)
            • If the minimum length is specified then the length should be equal or greater than the specified value
        • If the format is set to free text then
          • The specified authentication code or identifier should be validated as free text based on the following logic:
            • If the minimum length is specified then the length should be equal or greater than the specified value
            • If the minimum number of alphabetical characters is specified then the number of alphabetical characters (a-z) should be equal or greater than the specified value
            • If the minimum number of integers is specified then the number of integers (0-9) should be equal or greater than the specified value
            • If the minimum number of other (special) characters is specified then the number of other (special) characters should be equal or greater than the specified value
      • For the pass code
        • The specified pass code should be validated as free text based on the following logic:
          • If the minimum length is specified then the length should be equal or greater than the specified value
            • If the minimum number of alphabetical characters is specified then the number of alphabetical characters (a-z) should be equal or greater than the specified value
            • If the minimum number of integers is specified then the number of integers (0-9) should be equal or greater than the specified value
            • If the minimum number of other (special) characters is specified then the number of other (special) characters should be equal or greater than the specified value

Rewards Particiapnt Related

  • defined numb
Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
excerpttrue
labelsaccess-tokens-basics-r7,access-tokens-advanced-r7,access-tokens-admin-r7

Popular Labels

heatmap
Panel
namegrey
Popular Labels
spaceKeyV4Manual
style

Helpful Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsglobal