The following are Softdial Campaign Manager™ registry settings specific to client and server:
Type | Stored in |
---|---|
V10 (32 bit) | HKEY_CURRENT_USER\Software\Sytel\CMClient |
V10 (64 bit) | HKEY_CURRENT_USER\Software\Wow6432Node\Sytel\CMClient |
defaults | HKEY_LOCAL_MACHINE\<32 or 64 bit path as above>\CMClient |
Registry Key | Description | Default Setting | Type |
---|---|---|---|
AutomationNegValueAllowed | Automation switch to allow return value of 0 if a campaign is unknown by Softdial Campaign Manager™ client.![]() By default, will return -1 in this scenario. |
1 | REG_DWORD |
ConnectionTimeout | Timeout (msec) when waiting for a response from Softdial Campaign Manager™ Server . | 30000 | REG_DWORD |
FilterFieldListUnlimited | Allow filter fields to include Softdial Campaign Manager™-specific ones. ![]() By default, excludes the retry fields. |
0 | REG_DWORD |
HelpFileName | Name of help file (integrated into Softdial Campaign Manager™ client). | scm.chm | REG_SZ |
LogPurgeDays | Days before the logs are purged. | 7 | REG_DWORD |
LogUniqueId | If set to 1, will result in a unique Id within the log file. | 0 | REG_DWORD |
NumDisplayErrors | Max number of errors/ warnings to appear in the notification pane | 200 | REG_DWORD |
RetriesLimit | Max number of retries allowed in campaign properties. | 10 | REG_DWORD |
ServerName | Softdial Campaign Manager™ Server Name. | REG_SZ | |
ServerPort | Softdial Campaign Manager™ Server Port. | 6565 | REG_DWORD |
Type | Stored in |
---|---|
V9 | HKEY_LOCAL_MACHINE\Software\Sytel\CMServer |
V10 (32 bit) | HKEY_LOCAL_MACHINE\Software\Sytel\CMServer\[Tenant] |
V10 (64 bit) | HKEY_LOCAL_MACHINE\Software\Wow6432Node\Sytel\CMServer\[Tenant] |
The [Tenant] appendix is omitted for Landlord settings.
Settings are by tenant unless indicated otherwise in the registry key description.
From V10.6.442 - The keys (below) marked * are dynamic
Registry Key | Description | Default Setting | Type | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AbandonOutcomeValue* | Custom Abandoned call outcome![]() Users may change the base set of dialing outcome codes to comply with legacy reporting needs. This registry value allows users to change the abandoned call outcome value from the default value (7). |
7 | REG_DWORD | |||||||||||||||
AgentNotLoggedInOutcomeValue* | Custom Agent-specific callback failure due to agent not logged in call outcome![]() Users may change the base set of dialing outcome codes to comply with legacy reporting needs. This registry value allows users to change the Agent-specific callback failure due to agent not logged in call outcome value from the default value (32). |
32 | REG_DWORD | |||||||||||||||
AuditPurgeDays* | How old audit trail data (in audit tables) should be before discarded.![]() Data is only discarded if campaign is still being run. |
28 | REG_DWORD | |||||||||||||||
AuditPurgeIncomplete* | From V10.6.129 - option to purge either completed or all records solely based on their age.![]() When set to
Previously, the Audit table would only purge old records if they had been marked as completed, which can cause slow start up issues as the audit table grows with large data sets. |
1 | REG_DWORD | |||||||||||||||
BusyOutcomeValue* |
![]() Users may change the base set of dialing outcome codes to comply with legacy reporting needs. This registry value allows users to change the busy call outcome value from the default value (1). |
1 | REG_DWORD | |||||||||||||||
CallbackInUTC* | Callbacks sent with Transaction Complete [TC] can be specified in local time or UTC.![]() Softdial CallGem™ doesn't care, but Softdial Campaign Manager™ does. Default is 0 (Local Time). Set to 1 for UTC. |
0 | REG_DWORD | |||||||||||||||
CallbackstoObserveCallExpiry* | To enable callbacks not limited by expiry time, set this value to 0.![]() Some users require the ability to process callbacks outside of the compliance call expiry time. With the default setting of 1, calls are limited by call expiry time |
1 | REG_DWORD | |||||||||||||||
CampaignDNC* | Identifies the telephony outcome (reason / cause code) that will be interpreted as Don't call again on this campaign. | 99 | REG_DWORD | |||||||||||||||
CleanOnStart* | This will, on campaign start, set all switch results in the table which are -1, to 0.![]() From V10.6.670 - if not set, defaults to 1 (ON). If filters are set on the campaign, it will include those filters in the "cleaning" statement e.g. Campaign with filter to pick up records with Contact_ID < 100, will only clean records with Contact_ID <100. Only ever set this registry value if you have campaigns with overlapping data sets i.e. where the selection criteria for more than one campaign includes the same rows in the same tables. |
1 | REG_DWORD | |||||||||||||||
CloseDatabaseOnReload | From V10.6.890 - Controls whether the database connection should be closed and reopened on cursor reload (1) or not (0).![]() Some ODBC driver implementations will continue to use broken connections, therefore generating ODBC socket timeout errors. Setting this to 1 forces full closure of the ODBC connection to the database, including any socket connection for the underlying driver. |
1 | REG_DWORD | |||||||||||||||
DBCloseTimeout* | Sets the period in seconds for starting database cleanup after campaign close. ![]() The default delay (60) allows a further 60 seconds for cleanup to complete. |
60 | REG_DWORD | |||||||||||||||
DBErrorTimeout* | Sets the period in seconds for attempting to re-establishing a database connection after it is dropped. | 60 | REG_DWORD | |||||||||||||||
DBFailOnDTUpdate* | Controls whether a Data (DT) parameter update failure causes the database rollforward recovery to take place. Set to 0 to inhibit rollforward recovery after a Data (DT) update failure. Set to 0 if the integration with the customer database may cause database failure errors. | 1 | REG_DWORD | |||||||||||||||
DBMaxRows* | This indicates the maximum size of the rowset to be selected when opening a cursor on an outbound campaign.![]() Limiting the size of this rowset enables customers to open campaigns on very large tables a lot quicker than otherwise possible. The number of rows should be greater than the number of fresh rows to be dialled in a single day on the largest campaign that a tenant runs. A simple rule of thumb for this value would be to take the peak agent count on the largest campaign and multiply by 1200 to give a value. WARNING: When configuring this value in the registry editor please make sure to select a decimal value rather than hexadecimal. 100,000h is 1,048,576 in base 10. At the time of writing opening a cursor on a 500,000 row table may take 25 seconds for the server to cache the index information for 500,000 rows. By limiting to 200,000 rows this would reduce load times to 10 seconds. |
200000 | REG_DWORD | |||||||||||||||
DBMaxRowsCA* | This indicates the number of rows to select to perform column analysis.![]() When running an inbound campaign, Softdial Campaign Manager™ needs to interrogate the primary table structure. This is done by opening a rowset cursor and iterating over the column definitions. A value of 0 does not limit the row count. |
2 | REG_DWORD | |||||||||||||||
DBType* | This indicates the database type to Softdial Campaign Manager™. ![]() There is not wide adoption of the ISO SQL2008 standard for limiting row counts with the syntax FETCH FIRST N ROWS ONLY. The default value of 0 tells Softdial Campaign Manager™ not to modify SELECT statements to limit the row count. This provides for backwards compatibility. Other legal values are:
Other relational databases that are ISO SQL 2008 conformant should set this value to 4. A single Softdial Campaign Manager™instance can connect to multiple different databases, although in practice this rarely happens. If using Softdial Campaign Manager™ to connect to 2 different DBMS, you should contact Sytel Support for advice. |
0 | REG_DWORD | |||||||||||||||
DebugCampaignLifetime* | Set to 1 to display scheduling info in the Softdial Campaign Manager™ logs | 0 | REG_DWORD | |||||||||||||||
DebugDBUpdate* | From V10.6.848 - Set to 1 to display all the database update transaction data in the Softdial Campaign Manager™ logs. Some data is excluded by default in order to comply with PCI DSS requirements. | 0 | REG_DWORD | |||||||||||||||
DebugRetry* | From V10.6.442 - allows debug logging of retry and number indexing to be turned on (1) or off (0). | 0 | REG_DWORD | |||||||||||||||
DialerCacheOffsetSecs* | How long a number sits in cache in Softdial CallGem™ before being dialed, so we can work out if legally ought to be sent or not. | 60 | REG_DWORD | |||||||||||||||
DialerServerName | Softdial CallGem™ server name. | localhost | REG_SZ | |||||||||||||||
DialerServerPort | Softdial CallGem™ server port. | 6500 | REG_DWORD | |||||||||||||||
DisableAutoStop* | When set to 1, campaigns on this tenant will remain running when there are no numbers left to dial (primary or otherwise).![]() * From V10.6.393 - default setting changed from 0 to 1 from . |
1* | REG_DWORD | |||||||||||||||
DNCOutcomeValue* | The standard switch outcome for a DNC number. Best left alone. | 100 | REG_DWORD | |||||||||||||||
IDDCode* | International dialing prefix.![]() The default value is 00 (UK). This value is also used if the registry key is not present. For international dialing, set this value to either
|
00 | REG_SZ | |||||||||||||||
InconsistencyReportSuppressed* | Setting this key to 1 inhibits resulting alerts.![]() Altering retry data during a campaign run produces inconsistencies between audit and contact databases. |
0 | REG_DWORD | |||||||||||||||
IncrementRetryOnCallback* | When set to 1, the maximum number of retries set in the client becomes the maximum total number of calls to this number, including callbacks. | 0 | REG_DWORD | |||||||||||||||
LegacyCompatibility* | Enable Softdial Campaign Manager™ to run against a version of Softdial CallGem™ that supports SDMP 1.0 framing. | 0 | REG_DWORD | |||||||||||||||
ListenPort | Port the server listens on | 6565 | REG_DWORD | |||||||||||||||
LogDirectory | Where the logs go. This is a landlord setting. |
REG_SZ | ||||||||||||||||
LogPurgeDays* | How many days till the logs are purged. | 28 | REG_DWORD | |||||||||||||||
LogRecordRead* | Diagnostic aid, to write a record to the logfile exactly as it was read. Set to 1 to activate. | 0 | REG_DWORD | |||||||||||||||
LogSQLErrorPurgeDays* | How many days till the SQL error logs are purged. | 28 | REG_DWORD | |||||||||||||||
MaxReadAheadBurstSize* | How many contacts can be read from the DB in one chunk. | 200 | REG_DWORD | |||||||||||||||
MaxReadAheadRequestSize* | How many contacts can be read from the DB in a row without reading retries. | 700 | REG_DWORD | |||||||||||||||
MaxReadRetryCacheSize* | When reading reschedules and retries, Softdial Campaign Manager™ Server will only read up to this number of total cache entries (including primary and secondary) per campaign. | 5000 | REG_DWORD | |||||||||||||||
NonUpdatableColumns* | Takes a comma delimited set of columns that should not be updated during a database update. | - | REG_DWORD | |||||||||||||||
NumberInvalidOutcomeValue* | The standard switch outcome for an Invalid number. Best left alone. | 101 | REG_DWORD | |||||||||||||||
NumDigitsPostcode* |
Limits the maximum length of a postcode (when using timezone management with a postcode scheme) ![]() The default is 5 characters, to be consistent with US zip codes. For other territories with post coding schemes and multiple timezones, this should be set to the number of characters in the longest possible postal code. |
5 | REG_DWORD | |||||||||||||||
ODBCRecordsetType* | Allows new records to be picked up by Softdial Campaign Manager™ when they are added after the cursor.![]() Valid values are:
|
1 | REG_DWORD | |||||||||||||||
ODBCSnapshotType* |
The recordset type to be used for snapshot type queries (counting rows, retry cursor). ![]() Valid values as ODBCRecordsetType above. |
1 | REG_DWORD | |||||||||||||||
PeriodicCloseCursor* |
When this is > 0, it represents the period in minutes that the database cursor will be reloaded for each campaign. ![]() From V10.6.263 - now a tenant level configuration. Default value of 0 means that periodic cursor reload is disabled. |
0 | REG_DWORD | |||||||||||||||
PreviewDNC* | The custom switch outcome for setting a record as DNC on a Preview campaign (before the record is dialed). | REG_DWORD | ||||||||||||||||
ReportingServerName | Name of the reporting server. | localhost | REG_SZ | |||||||||||||||
ReportingServerNSPort | Port to connect to for the Reporting server. | 6808 | REG_DWORD | |||||||||||||||
ResetStatsOnStart* | Auto reset of campaign stats if set to 1. | 0 | REG_DWORD | |||||||||||||||
RestartCampaigns* | When Softdial Campaign Manager™ process is stopped, it will auto restart campaigns unless this is set to 0. | 1 | REG_DWORD | |||||||||||||||
RetryInterval* | The time window that the retry cursor scans ahead and caches.![]() With long cursor open times this may be reduced. |
60 | REG_DWORD | |||||||||||||||
RetryPushbackThreshold* |
The number of retries kept in cache, even if some of these are overdue. ![]() Overdue retries get purged from cache after a configurable amount of time. This setting allows a minimum number of retries to be cached in order to ensure there is always data available to deliver to Softdial CallGem™. |
250 | REG_DWORD | |||||||||||||||
RNLateMode* | When set to 1, if a Remove Number [RN] attempt is late according to Softdial CallGem™ (i.e. it's already being tried), then remove from the internal DNC list. | 0 | REG_DWORD | |||||||||||||||
RunoutReloadFrequency* | Sets the reload frequency for cursors that have reached end-of-file.![]() If your database is updated with fresh data in real-time during the shift, you may need to alter the reload frequency to prevent number starvation at end-of-list. |
5 | REG_DWORD | |||||||||||||||
SchedulingIntervalSeconds* | From V10.6.853 - For linked campaigns, the time delay in seconds that campaigns are scheduled to be started/ stopped, to avoid flooding the database with too many connections all at once. For example, using the default setting, starting a linked campaign containing 100 campaigns will schedule all the campaigns to open in 5 second intervals. Staggered starts/ stops will start to occur prior to the scheduled time so that all linked campaigns are started/ stopped by that time. |
5 | REG_DWORD | |||||||||||||||
SQLConnectTimeout* | Number of seconds before a connection attempt to a DB fails. | 60 | REG_DWORD | |||||||||||||||
SQLFloatAsDouble* | Set value to any string value (e.g. "on") to format the values in the database as SQL_DOUBLE.![]() For MS SQL, they are normally set to SQL_FLOAT which can lead to rounding errors in MySQL. |
REG_SZ | ||||||||||||||||
SQLLogging* | Switches on SQL verbose mode; shows every single DB access that is made. | 0 | REG_DWORD | |||||||||||||||
SQLQueryTimeout* | Number of seconds before a SQL query attempt fails. | 60 | REG_DWORD | |||||||||||||||
SqlTerminator* | The string that appears at the end of every SQL statement. ![]() Set this to <empty> for older versions of Oracle. |
; | REG_SZ | |||||||||||||||
SSMDCallbackLookaheadMins* | For a Manual Outbound (SSMD) Campaign, the number of minutes ahead of 'now' that Softdial Campaign Manager™ will look for callbacks. Callbacks are not fed to Softdial CallGem™ on a time schedule; they are only sent in response to agent demand. The callback lookahead period allows calls that have been scheduled for callback at the same time to be ordered by the agent. | 10 | REG_DWORD | |||||||||||||||
StopOnDBRunout* | Auto-stop functionality for selected users. ![]() When the DB runs out, then the next detection of a cache runout will result in automatic stopping of campaign. |
0 | REG_DWORD | |||||||||||||||
StreamedQueryTimeout* | The timeout for updates and retry cursor open. | 20 | REG_DWORD | |||||||||||||||
SuppressAudittrail* | Switch off audit table generation. Better to use the setting in properties these days. | 0 | REG_DWORD | |||||||||||||||
TelephoneNumberMaxLength* | Number validation - maximum length![]() From V10.6.478 - the maximum number of digits supported is 18. |
18 | REG_DWORD | |||||||||||||||
TelephoneNumberMinLength* | Number validation - minimum length. | 4 | REG_DWORD | |||||||||||||||
TelephonyID | Identifies the telephony layer that the tenant uses. | __singlecti | REG_SZ | |||||||||||||||
TenantDNC* | Identifies the telephony outcome (reason / cause code) that will be interpreted as Don't call again on on any campaign on this tenant. | 98 | REG_DWORD | |||||||||||||||
TenantID | The tenant ID if in multi-tenancy mode | default | REG_SZ | |||||||||||||||
TZAutoReloadMins* | Number of minutes between auto-reloads when using Timezone Management. | 15 | REG_DWORD | |||||||||||||||
UseDoInPreview* | Select whether to use Detection Option (DO) for Preview campaigns: 0 = Off, 1 = On This is a landlord setting. ![]() If set, the <UseDoInPreview> setting in the Softdial Telephony Gateway™ config.xml file must also be enabled. |
0 | REG_DWORD | |||||||||||||||
UseMwOnOT* | Select whether to use the Maximum Wrap (MW) parameter in the Overdial Tuning [OT] message: 0 = Off, 1 = On This is a landlord setting. |
1 | REG_DWORD | |||||||||||||||
UseReloadOnAgentless* | Enables dynamic cursor reload with agentless campaigns![]() Also makes the Agentless option visible in the Windows and Web clients. To enable, add this key and set to 1. |
0 | REG_DWORD | |||||||||||||||
ValidStartCodes* | Number validation. Comma delimited list of valid start codes. | REG_SZ |
See also Configuring Campaign Initialisation using Registry Settings on the Abandon Rate Management page.