The Campaign entity  represents a marketing project including the goal, the responsibles, deadline and budget informations.

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

NameTypeLabelDescription
form *StringFormRepresents the entity form. Will always be "cpg".
cpg_name *StringNameThe object name
cpg_nr *String
Represents the campaign number. Will always be "C-YYxxxx" as serial number, that automatically increments by 1 as each new record is added.
cpg_resp_name *String
Represents the name of the person responsible for the campaign.
cpg_resp_unid *String
Represents the unique ID of the person document responsible for the campaign.
cpg_state *String
Represents the state of the campaign as a number. (e.g. 100, 200, 300)
cpg_state_text *String
Represents the state of the campaign as a text. (e.g. planed, in progress, closed)
cpg_end *Date/Time
Represents the end date of the campaign.
cpg_start *Date/Time
Represents the start date of the campaign.
cpg_budget_actual Number
Represents the actual value of the budget spent.
cpg_budget_performanceNumber
Represents the actual performance of the budget spent.
cpg_budget_targetNumber
Represents the targeted/expected budget to be spent.
cpg_cost_materialNumber
Represents the actual cost of the material spent.
cpg_cost_miscNumber
Represents the actual cost of other expences spent.
cpg_cost_totalNumber
Represents the actual total cost spent as a sum of all cost categories. 
cpg_cost_travelNumber
Represents the actual cost spent for travels. 
cpg_cost_workNumber
Represents the actual cost spent for labour.
cpg_descHTML String
Detailed description of the activity purpose. Can incloud imiges, links, tables aso. 
cpg_reaction_actualNumber
Represents the number of received reactions.
cpg_reaction_actual_positivNumber
Represents the number of positiv received reactions.
cpg_reaction_expectedNumber
Represents the number of expected reactions.
cpg_sacsNumber
Represents the number of sent e-mails in a series.
cpg_sacs_respNumber
Represents the number of answered e-mails from a series.
cpg_sacs_respnegNumber
Represents the number of positiv answered e-mails from a series.
cpg_sacs_respposNumber
Represents the number of negativ answered e-mails from a series.
cpg_sales_actualNumber
Represents the value of closed sales.
cpg_sales_expectedNumber
Represents the value of expected sales.

QEE classes level

The class representing the Campaign is QEECpg

Inherits from: QEEObject

REST level

The endpoints dealing with Campaign are:

xrCpg (GET, POST, PUT, DELETE)

xrCpgs (GET, PUT, DELETE)