Overview

This section provides an overview on the Campaign microservices. Campaign microservice is a reusable functional component, which enables the branch user to create and store the Campaign definition details.

The following Campaign details are stored in Campaign microservices database:

Name, description, objective along with product details (if any), priority, and start and end dates of the Campaign
Channel details such as Channel Type (Online or Offline) and its associated content, output content location along with target URLs for image banners and so on.
Details of the event triggering the Campaign
Profile condition details defined to identify the target audience for the Campaign

The following context diagram depicts the flow of control from front office solution to microservices database.

Campaign Workflow

The following sequential flow diagram depicts the campaign definition and execution use cases.

Data Model

The following entity relationship diagram depicts the details of the entities and the relationships among them.

The following are the base entities created as part of the Campaign microservices.

Campaign

Fields	Type
campaignId	String
campaignName	String
campaignDescription	String
objectiveType	String
productId	String
productGroupId	String
campaignPriority	String
campaignType	String
campaignStatus	String
startDate	Date
endDate	Date

EventTriggers

Fields	Type
eventTriggerId	String
eventName	String
eventDescription	String
triggerType	String
eventSource	String
eventCode	String

Profiles

Fields	Type
profileId	String
numberOfUsers	Integer
profileCreationDate	Date
profileDeactivatedDate	Date
profileDescription	String
profileName	String
profileStatus	String

ProfileCondition

Fields	Type
profileConditionId	String
profileId	Object
dataContextId	Object
conditionExpression	String

OnlineContent

Fields	Type
onlineContentId	String
placeholderId	object
imageIndex	Integer
imageURL	String
targetURL	object
campaignId	object
callToActionButtonLabel	String
callToActionTargetURL	String
showReadLaterButton	String
showCloseIcon	String
bannerTitle	String
bannerDescription	String

OfflineTemplate

Fields	Type
offlineTemplateId	String
campaignId	object
channelSubType	String
subject	String
content	longtext

PlaceHolder

Fields	Type
placeholderId	String
placeholderName	String
placeholderDescription	String
channelSubType	String
application	String
placeholderIdentifier	String
imageResolution	String
imageScale	String
imageSize	String

DataContext

Fields	Type
dataContextId	String
dataContextName	String
dataContextDescription	String
dataContextSource	String
dataContextServiceName	String
dataContextEndPoints	String

Bookmark Name	Actions

BACK

In this topic

Add Bookmark View Bookmark

Previous Docs

Feedback