Contents
Campaign Group Status Reporting
All New
Outbound Contact Server can store data about Campaign Groups in an external system, such as Elasticsearch, to support feature-rich reporting. The following states and information can be reported:
- Campaign Group loaded
- Campaign Group started
- Campaign Group stopped
- Campaign Group unloaded
- Campaign Group unloaded forcefully
- Campaign Group dial mode change
- Campaign Group general info events
Feature Configuration
To configure this feature, use the following configuration options:
- Set send-campaigngroup-states to true to enable the feature.
- Set campaigngroup-states-uri to the URI of the external system (Configuraiton Manager).
- If you want to generate periodic messages about the current state (loaded, started, stopped, unloaded) of the Campaign Group that also contain Campaign Group statistics, set campaigngroup-states-interval to the appropriate frequency at which you want to send the messages (the default is 10 seconds).
OCS uses the following options to retrieve connection information about the configuration:
Error Handling
There is no error-handling carried out by this feature. If the message to the external system (Campaign Manager) fails, no post-processing or retries are executed.
Messages to the External System
The set of messages for this feature is described in the Outbound Contact Reference Manual here.
The following attributes are passed by OCS in the body of the HTTP notification to the external Web/Application Server:
| Attribute | Type | Required? | Description |
|---|---|---|---|
| GSW_CAMPAIGN_NAME | String | Yes | |
| GSW_CAMPAIGN_TEMPLATE_NAME | String | Yes (if present in configuration) | Name of the Campaign Template |
| GSW_DIAL_MODE | No | ||
| GSW_GROUP_NAME | String | Yes | |
| GSW_OPTIMIZE_BY | No | ||
| GSW_OPTIMIZE_GOAL | No | ||
| GSW_TENANT_NAME | String | Yes |
Defaults to undefined if not set. QUESTION: This is described in the design as "New key; Value should be read from Environment Tenant\Annex\devops\customer_name option;" but it is defined in the Reference Guide in the table of Default Record Information. |