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:
|
Name |
Type |
Label |
Description |
|---|---|---|---|
|
form * |
String |
Form |
Represents the entity form. Will always be "cpg". |
|
cpg_name * |
String |
Name |
The 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. planned, 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_performance |
Number |
|
Represents the actual performance of the budget spent. |
|
cpg_budget_target |
Number |
|
Represents the targeted/expected budget to be spent. |
|
cpg_cost_material |
Number |
|
Represents the actual cost of the material spent. |
|
cpg_cost_misc |
Number |
|
Represents the actual cost of other expences spent. |
|
cpg_cost_total |
Number |
|
Represents the actual total cost spent as a sum of all cost categories. |
|
cpg_cost_travel |
Number |
|
Represents the actual cost spent for travels. |
|
cpg_cost_work |
Number |
|
Represents the actual cost spent for labour. |
|
cpg_desc |
HTML String |
|
Detailed description of the activity purpose. Can incloud imiges, links, tables aso. |
|
cpg_reaction_actual |
Number |
|
Represents the number of received reactions. |
|
cpg_reaction_actual_positiv |
Number |
|
Represents the number of positiv received reactions. |
|
cpg_reaction_expected |
Number |
|
Represents the number of expected reactions. |
|
cpg_sacs |
Number |
|
Represents the number of sent e-mails in a series. |
|
cpg_sacs_resp |
Number |
|
Represents the number of answered e-mails from a series. |
|
cpg_sacs_respneg |
Number |
|
Represents the number of positiv answered e-mails from a series. |
|
cpg_sacs_resppos |
Number |
|
Represents the number of negativ answered e-mails from a series. |
|
cpg_sales_actual |
Number |
|
Represents the value of closed sales. |
|
cpg_sales_expected |
Number |
|
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)