Versions Compared

Key

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

Back to Communications Main Page

Excerpt
hiddentrue

Learn how you can to configure Communication Queue External Systems

What does this section cover?

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are the Communication

Navigating to Communication Queue External Systems

Info

CONFIGURATION > CRM APPLICATION > COMMUNICATIONS > SET UP COMMUNICATION QUEUE EXTERNAL SYSTEMS

What are Communication Queue External Systems?

Communications Queue External Systems are used to define the external systems which are allowed to External Systems which can access and process information kept in the communications queuethe Communications Queue. External Systems are added on a communication during its creation Communication when it's created via Notification Runs, provisioning mail runs or when created Provisioning Mail Runs or by the Web API. 
Communications created via the user interface communication data entry interface Communication Data Entry page or through the  Communicate Entity actionAction, cannot have external systems added to them.

Creating, Editing and Deleting Validations and Restrictions

ActionRestrictionsCreateN/AEditN/ADelete

be added External Systems.

  • Navigate to Communication Queue External Systems and explore existing entries via the Summary page.  
  • Click on the link (Name or Number) of the entry of your interest to enter the Data Entry page and see more detail. 
  • Use the Actions Menu to create a NEW Communication Queue External Systems, modify (EDIT) or DELETE  an existing one.  
  • Use the BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Communication Queue External Systems.

Check the Validations & Restrictions Table below for a list of available Actions when working with Communication Queue External Systems, including each Action's related validations and restrictions. View the Attributes Table for a comprehensive description of the Communication Queue External Systems fields.

Summary PageImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictions
Create
  • Mandatory Fields must be defined
  • Not Applicable
Edit
  • Mandatory Fields must be defined
  • Not Applicable
Delete
  • Not Applicable
  • Cannot be deleted if they are already used by communications queue Communications Queue entries which are still pending
Communication Queue External Systems attributes 
  • 'Pending'.

Anchor
attributes
attributes
 Attributes

An * indicates a field is mandatory.

max external system The minimum limit between this and the limit Communication definition is taken into consideration when sending communications

Name

Description

Main Information 

Name*

The name Name of the external systemExternal System.

Description

The description Description of the external systemExternal System.

Alternative Code*

The alternative code of the external system. On creating a new external system it defaults to the first letter of each word included in the name (in capitals), if nothing else is specifiedExternal System. Unless otherwise specified, the codes for new External Systems default to the External System's Name initials in capital letters.

Message Character Count Limit

The

maximum number of characters accepted by the

External System when used to send a message.


When a limit is also set in the

Log InformationIncludes the standard log information
Allowed Organisational unitsThe organisational units that can use the specific external system

 

Defining your own Communication Queue External Systems tailored to your company's needs

  • Navigate to Module Configuration > CRM Application > Communications > Set up Communication Queue External Systems
    Summary PageImage Removed

  • Either search for an existing one or from the top menu click on "NEW" to access the data entry page
    Data Entry PageImage Removed
     
  • Main Information

    1. Provide the following information:

      1. Name

      2. Description
      3. Alternative Code
      4. Message Character Count Limit
  • Allowed Organisational Units

    Include PageSetting Allowed Organisation Units - GlobalSetting Allowed Organisation Units - Global 

    Log Information

    Include PageLog Information - GlobalLog Information - Global
  • From the Top Menu click on "SAVE"
  • Deleting Communication Queue External Systems

    Include PageDeleting a record - GlobalDeleting a record - Global

     

     

     Communication Definition, the System will validate against the minimum limit of the two.

     

     

    Supported Media
    Media

    The Media that is supported by the Communication Entity. Available options are:

    • Email
    • SMS
    • Device (related to Provisioning)
    • Face 2 Face
    • Letter
    Note

    Select 'All Media' to apply for all available Media in the System.

    Allowed Organisational units
    Allowed Organisational unitsThe Organisational Units that can assign the External System on Communications and Communication Templates.
    Log Information
    Log InformationThe standard set of Log Details information available in all entities.
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalseexcerpttrue
    labelscommunications-basics-r7,communications-advanced-r7,communications-admin-r7

    heatmap

    Helpful Links

    Panel
    namegrey

    Popular Labels

    Popular Labels
    spaceKeyV4Manual
    style
    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    labelsglobal