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 data is communicated to the external system using HTTP POST. 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
• Campaign activity and Campaign Group statistics--generated periodically at a user-defined interval

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 (Configuration Manager).
• If you want to generate periodic messages about current Campaign Group activity 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:

• http-response-timeout
• http-connection-pool-size

OCS uses the following new Trace-level log events to indicate that notfications have been sent:

ID	Level	Text	Attributes	Description	Actions
81000	TRACE	Sending HTTP status notification CampaignGroupState for Campaign Group &s1 to &s2.	&s1 Campaign Group name &s2 URL to which the notification has been sent.	See the table in HTTP POSTs to External System, below.	An HTTP status notification has been sent to an external system that the status of a Campaign Group has changed. For information included in the body of the notification, see HTTP POSTs to External System, below.	No actions required.
81001	TRACE	Sending periodic HTTP status notification CampaignGroupState for Campaign Group &s1 to &s2.	&s1 Campaign Group name &s2 URL to which the notification has been sent.	A periodic HTTP status notification has been sent to an external system that the activity of a Campaign Group. For information included in the body of the notification, see HTTP POSTs to External System, below.	No actions required.

Error Handling

There is no error-handling carried out by this feature. If the HTTP POST to the external system (Campaign Manager) fails, no post-processing or retries are executed.

HTTP POSTs to External System

The specific information sent to the external system is described in the Outbound Contact Reference Manual here, and differs between scenarios.

If the notification is being sent periodically (for Campaign Activity and Statistics), this is stated in the Text of the log message itself, for example: Trc 81000 Sending HTTP status notification CampaignGroupState for Campaign Group

The fields in the table below are passed by OCS in the body of the HTTP notification to the external system. All fields are sent, but fields not relevant to the status change or periodic activity scenario are left unassigned or set to a default value:

Attribute	Type	Required?	Description
GSW_USER_EVENT	String	Yes	Set to CampaignGroupState
GSW_DATE_TIME	String	Yes	Timestamp when action occurred; UTC time as seconds, with msec precision.
GSW_TENANT_NAME	String	Yes	Defaults to Unknown if not set.
GSW_TENANT_CCID	String	Yes	Defaults to Unknown if not set.
GSW_CAMPAIGN_GROUP_NAME	String	Yes
GSW_CAMPAIGN_GROUP_GUID	String	Yes
GSW_GROUP_NAME	String	Yes
GSW_CAMPAIGN_NAME	String	Yes (if present in configuration)
GSW_CAMPAIGN_TEMPLATE_NAME	String	Yes (if present in configuration)
GSW_QUEUE_NAME	String	Yes	Name of the Voice Transfer Destination DN
GSW_DIAL_MODE	Integer	No - Defined only for running Campaign Groups	Use CfgDialMode enum values
GSW_CAMPAIGN_GROUP_STATE	Integer	Yes	Use CM_GrpCampState enum values
GSW_CAMPAIGN_GROUP_ACTION	Integer	Yes	Identifies client request which has caused message generation. Use CM_ReqSetDialingMode when dial mode is changed. Use CMMessageType enum values CM_ReqLoadCampaign, CM_ReqUnloadCampaign, CM_ReqStartDialing, CM_ReqStopDialing, or CM_ReqSetDialingMode
GSW_CAMPAIGN_GROUP_ACTOR	Integer	Yes	Distinguishes action caused by OCS Client or automatic action taken by OCS itself (either per Schedule or per internal Campaign Group condition). Valid values are: 0 (zero) -- Actor Type unknown 1 -- Actor Type OCS Client (actions invoked by direct OCS Client connected via CM Library protocol) 2 -- Actor Type COMM Client (actions invoked by Communication DN Client connected via 3rd party Comm DN protocol) 3 -- Actor Type Self (actions invoked by Campaign Group internal logic) 4 -- Actor Type Schedule (actions invoked by Schedules) 5 -- Actor Type Sequence (actions invoked by Sequences)