Skip to main content

All Module Configurations

The Modules page and the settings of every module, from users and groups to campaigns, telephony and AI.

Module Configuration Overview​

How the Modules page and its setting forms work: switches, numbers and the Keep all or Remove all control.

The Modules Page​

The Modules page lists every module of the platform. A green check on the right of a row means the module is on. A grey check means it is off. Select a row to open its panel on the right.

The Modules page listing twelve modules, with a green check beside the modules that are on

Figure 1. The Modules page. AI Assistant and Messaging show a grey check because they are off. The other ten modules are on.

ModuleWhat it is for
AI AssistantAI assistant and automation configuration.
AutomationsWorkflow management configuration and settings.
CampaignCampaign related configuration and settings.
CRMCRM related configuration and settings.
EdgeEdge configuration and settings.
EmailEmail provider management and configuration.
GroupsManaging user groups and permissions.
IntegrationsIntegration related configuration and settings.
MessagingSMS provider management and configuration.
TelephonyVoice provider management and configuration.
UsersManaging user accounts and settings.
Workforce ManagementStatus management configuration and settings.

How a Setting Form Works​

Every module panel follows the same pattern. The module name and a short description sit at the top. Below them, a switch turns the module on or off. The settings of the module follow, and Save Configuration at the bottom right stores them.

  1. Select the module in the list.
  2. Use the switch to turn the module on or off. Where a module has no switch, such as Groups and Users, it is always part of the platform.
  3. Change the settings. Each setting has a short help line under it that explains what it does.
  4. Click Save Configuration. Nothing changes until you save.

The settings use a small set of controls.

ControlHow to use it
SwitchClick to turn a feature on or off.
Number boxType a value, or use the arrows. A minimum is stated in the help line where one applies.
Drop down listChoose one value, for example a default agent status.
Multi select listChoose several values. Each chosen value appears as a tag that you remove with its cross.
CheckboxTick to turn a single option on, for example Echo Cancellation.
Number, Keep all or Remove allA retention setting. Choose Number and type how many items to keep, choose Keep all to retain everything, or choose Remove all to retain nothing.
Ordered listA list whose rows can be moved up or down and deleted, such as the codec order on the Edge module.

Rules to Remember​

  • The license decides which modules can be turned on. A module that the license does not include cannot be enabled.
  • Turning a module off hides its pages and menu entries for everyone. The data stays in place.
  • Settings are saved one module at a time. Switching to another module without saving discards the change.
warning

Turn a module off only when it is no longer needed. Agents lose access to its screens straight away.

tip

Make one change at a time and save it, so that it is easy to see what changed if behavior looks different afterwards.

Users, Groups and Workforce Management Settings​

Invitation expiry, group access and agent shift defaults.

Users​

The Users module controls how new people are invited. To invite supervisors who may not sign in on the first day, keep the invitation link valid for a full working day.

The Users module panel with the Invitation Expiry Window drop down set to 24 Hours (1 Day)

Figure 2. The Users module, with the Invitation Expiry Window set to 24 Hours (1 Day).

SettingWhat it doesDefault
Invitation Expiry WindowHow long the link in an invitation email stays valid. After that time the person needs a new invitation.24 Hours (1 Day)
tip

Choose a longer window for staff who join in batches, such as a new training class.

Groups​

The Groups module decides how group membership limits what a person can see. For example, a Support group should only see its own records.

The Groups module panel with Group Access Configuration set to only records directly linked to groups

Figure 3. The Groups module, with Group Access Configuration set to the direct relationship option.

SettingWhat it doesDefault
Group Access ConfigurationChooses how group permissions work for this module. The option shown limits a person to records that are directly linked to their groups through relationship fields.Only records directly linked to groups via relationship fields
info

Roles decide what a person can do. Groups decide which records the person can see. See Group Management.

Workforce Management​

The Workforce Management module sets the starting status of agents and the shift timers. A common setup is for agents to start as Available and for a shift to end on its own after eight hours.

The Workforce Management module panel with the default agent status and two shift thresholds

Figure 4. The Workforce Management module, with Available as the default status, a shift end threshold of 480 minutes and a resume threshold of 30 minutes.

SettingWhat it doesDefault
Default Agent StatusThe status an agent has after signing in.Available
Auto Shift End Threshold (minutes)How long a shift can run before it ends automatically.480
Auto Shift Resume Threshold (minutes)How soon after an automatic end a shift can be resumed.30
info

Statuses themselves are managed on the Status Management page. The monitoring side is covered in the Workforce use case.

Messaging and Email Settings​

Choose the email and SMS providers that the platform sends through.

Email​

The Email module chooses which email provider the platform uses. In this example email is sent through Mailgun, so the module is on and Mailgun Email is selected.

The Email module panel with the switch on and Mailgun Email chosen in the Email Configurations list

Figure 5. The Email module, with the switch on and Mailgun Email selected in Email Configurations.

SettingWhat it does
Email ConfigurationsThe provider that sends email. The list offers the email plugins that are turned on: Mailgun Email, SMTP Email and AWS SES Email.

A provider appears in the list only after its plugin is turned on and saved. Set it up first in Mailgun Email, SMTP Email or AWS SES Email.

Messaging​

The Messaging module covers SMS and WhatsApp style messaging. It is off in this example, which is the usual state until you decide to send text messages.

The Messaging module panel with the switch off

Figure 6. The Messaging module with its switch off. Turn it on and choose a provider in Messaging Configurations to start sending text messages.

SettingWhat it does
Messaging ConfigurationsThe SMS provider that sends text messages. The list offers the SMS plugins that are turned on: Generic SMS, Twilio SMS and Dialog E-SMS.
  1. Turn on and save the SMS plugin first. See Twilio SMS, Generic SMS and Dialog E-SMS.
  2. Open the Messaging module and turn the switch on.
  3. Choose the provider in Messaging Configurations.
  4. Click Save Configuration.
warning

While Messaging is off, the SMS and WhatsApp template pages ask you to enable the relevant module, and the message icon on CRM records is not available.

CRM, Campaign, Telephony and Edge Settings​

The settings of the four modules that run customer records, outbound campaigns, voice calls and the browser phone.

CRM​

The CRM module switch makes the CRM screens available. Its record types, fields and layouts are configured on the CRM page of the Configuration menu, not here.

The CRM module panel with only its description and switch

Figure 7. The CRM module, which has a switch and no further settings on this page.

info

See the CRM use case for how records are configured.

Campaign​

The Campaign module controls how outbound campaigns run. Keep the retry rules strict and the number of simultaneous calls low for reminder style campaigns.

The first part of the Campaign module panel showing agent presence, retry statuses, sweep settings and the concurrent call limit

Figure 8. The first part of the Campaign module: agent presence, retry statuses, retry sweep settings and the concurrent call limit.

SettingWhat it does
Agent Presence StatusThe status applied to agents while they handle campaign interactions.
Retriable Lead StatusesLead statuses that are eligible for another attempt, for example Delivery Failed, Queue Dropped and System Failure.
Attempt Consuming Lead StatusesStatuses that use up one retry attempt when a voice lead moves into them, for example Connected and Not Connected.
Retry Sweep Interval (ms)How often the retry sweep runs for running voice campaigns.
Retry Sweep Batch SizeThe most leads put back in the queue per campaign in one sweep.
System Retry Delay (ms)The wait before a failed campaign action is tried again. The minimum is 5000 ms.
Max Concurrent CallsThe most outbound calls at one time. The help line reminds you that the telephony license limits calls and that agent and internal calls share the same limit.

The middle part of the Campaign module panel showing queue retention, retry attempts and queue sizes

Figure 9. The middle part of the Campaign module: queue retention, retry attempts, shuffling interval and queue sizes.

SettingWhat it does
Max Completed Jobs (Queue Retention)How many completed jobs the queue keeps. Choose Number and type a value, or choose Keep all or Remove all.
Max Failed Jobs (Queue Retention)How many failed jobs the queue keeps. It uses the same Number, Keep all or Remove all control.
Max Retry AttemptsThe most retry attempts for campaign queue jobs.
CLI Shuffling Interval (ms)How often the calling numbers are shuffled.
DB Chunk SizeHow many leads are read from the database at once. The minimum is 100.
Buffer SizeHow many jobs are held before they are sent to the queue. The minimum is 50.
Max Queue SizeThe most active or waiting jobs in the campaign queue. The minimum is 50.
Queue Check Delay (ms)The wait before checking again for space when the queue is full. The minimum is 3000 ms.

The last part of the Campaign module panel showing the three campaign priority numbers

Figure 10. The last part of the Campaign module: the priority numbers for normal, follow up and delayed follow up calls.

SettingWhat it does
Normal PriorityPriority of ordinary campaign calls. A lower number means a higher priority.
Follow Up PriorityPriority of follow up calls.
Delayed Follow Up PriorityPriority of follow up calls that were delayed.
tip

Keep Max Concurrent Calls below the call limit of the telephony license, so that campaign calls never crowd out agents who are on customer calls.

info

Campaign design is covered in the Campaign use case.

Telephony​

The Telephony module chooses the voice provider. In this example 3CX is selected.

The Telephony module panel with the switch on and 3CX chosen in Telephony Configurations

Figure 11. The Telephony module, with 3CX selected in Telephony Configurations.

SettingWhat it does
Telephony ConfigurationsThe voice provider in use. It lists the telephony plugins that are turned on.
info

The provider connection is set up in 3CX. The wider telephony setup is in the Telephony use case.

Edge​

The Edge module sets how the browser phone behaves for agents. Keep the audio options off and the log level at Info, then adjust the codec order if the call quality needs it.

The Edge module panel with four audio checkboxes, the system log level and the start of the codec list

Figure 12. The Edge module, with the audio options, the system log level and the start of the ordered codec list.

SettingWhat it does
Auto Answer ModeAnswers incoming calls automatically.
Auto Gain ControlEvens out the volume of the microphone.
Echo CancellationRemoves echo from the call audio.
Noise ReductionReduces background noise.
System Log LevelHow much detail the Edge client records, from the most detailed level down to none.
Audio/Video CodecsAn ordered list of codecs. The first row has the highest priority. Use the arrows to move a row and the red button to delete it.

Automations, AI Assistant and Integrations Settings​

The switches and settings of the modules that automate work and connect outside systems.

Automations​

The Automations module switch makes the workflow builder available. It has no further settings here. The workflow log retention is set in Retention, Purge and Export Limits.

The Automations module panel with its description and switch on

Figure 13. The Automations module, which has a switch and no further settings on this page.

info

Workflows are explained in the Automations use case.

AI Assistant​

The AI Assistant module is off until an AI provider is chosen. Once it is on, two settings appear.

The AI Assistant module panel with the switch off

Figure 14. The AI Assistant module with its switch off.

SettingWhat it doesDefault
AI ConfigurationsThe AI provider to use. The list offers the AI plugins that are turned on: OpenAI and Gemini.None chosen
Knowledge Base Worker ConcurrencyHow many knowledge base jobs run at the same time. The minimum is 1.5

Turn on a provider first in OpenAI or Gemini, then return here and choose it.

Integrations​

The Integrations module switch makes the integration screens available.

The Integrations module panel with its description and switch on

Figure 15. The Integrations module, which has a switch and no further settings on this page.

info

The integration screens are described in the Integrations Overview.