Skip to content
Snippets Groups Projects
Commit 1a33e948 authored by Dominik Lechner's avatar Dominik Lechner
Browse files

Documentation campaign

parent 5e2b42fb
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 196 additions and 137 deletions
entity/CampaignAddParticipants_entity/CampaignAddParticipants_entity.aod
+ 138
− 137
View file @ 1a33e948
<?xml version="1.0" encoding="UTF-8"?>
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignAddParticipants_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<title>Add participants to Campaign</title>
<onValidation>%aditoprj%/entity/CampaignAddParticipants_entity/onValidation.js</onValidation>
<recordContainer>jdito</recordContainer>
<entityFields>
<entityProvider>
<name>#PROVIDER</name>
</entityProvider>
<entityField>
<name>CAMPAIGN_ID</name>
<title>Campaign</title>
<consumer>CampaignConsumer</consumer>
<mandatory v="true" />
<state>AUTO</state>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/valueProcess.js</valueProcess>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/displayValueProcess.js</displayValueProcess>
<onValueChange>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/onValueChange.js</onValueChange>
<onValueChangeTypes>
<element>MASK</element>
<element>PROCESS</element>
<element>PROCESS_SETVALUE</element>
<element>RECORD</element>
</onValueChangeTypes>
</entityField>
<entityField>
<name>CAMPAIGNSTEP_ID</name>
<title>Campaign Step</title>
<consumer>CampaignStepConsumer</consumer>
<mandatory v="true" />
<state>EDITABLE</state>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstep_id/displayValueProcess.js</displayValueProcess>
<onValueChange>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstep_id/onValueChange.js</onValueChange>
</entityField>
<entityField>
<name>campaignParticipantMessage</name>
<state>READONLY</state>
<onValueChangeTypes>
<element>PROCESS</element>
</onValueChangeTypes>
</entityField>
<entityParameter>
<name>campaignParticipantsRowIds_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityConsumer>
<name>CampaignConsumer</name>
<dependency>
<name>dependency</name>
<entityName>Campaign_entity</entityName>
<fieldName>Campaigns</fieldName>
</dependency>
</entityConsumer>
<entityConsumer>
<name>CampaignStepConsumer</name>
<dependency>
<name>dependency</name>
<entityName>CampaignStep_entity</entityName>
<fieldName>CampaignSteps</fieldName>
</dependency>
<children>
<entityParameter>
<name>campaignId_param</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepconsumer/children/campaignid_param/valueProcess.js</valueProcess>
<expose v="true" />
</entityParameter>
</children>
</entityConsumer>
<entityField>
<name>UID</name>
</entityField>
<entityParameter>
<name>currentCampaignId_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityParameter>
<name>currentCampaignStepId_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityParameter>
<name>isUpdate_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityConsumer>
<name>CampaignAnalyses</name>
<dependency>
<name>dependency</name>
<entityName>CampaignAnalysis_entity</entityName>
<fieldName>#PROVIDER</fieldName>
</dependency>
</entityConsumer>
<entityField>
<name>campaignStepCurrentParticipantCount</name>
<title>Current participants</title>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepcurrentparticipantcount/displayValueProcess.js</displayValueProcess>
</entityField>
<entityField>
<name>campaignStepMaxParticipantCount</name>
<title>Max participants</title>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepmaxparticipantcount/displayValueProcess.js</displayValueProcess>
</entityField>
<entityField>
<name>isUpdate</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/isupdate/valueProcess.js</valueProcess>
</entityField>
<entityParameter>
<name>campaignParticipantsCondition_param</name>
<expose v="true" />
</entityParameter>
<entityParameter>
<name>dataSourceTableName_param</name>
<expose v="true" />
</entityParameter>
<entityField>
<name>isOperationValid</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/isoperationvalid/valueProcess.js</valueProcess>
</entityField>
</entityFields>
<recordContainers>
<jDitoRecordContainer>
<name>jdito</name>
<jDitoRecordAlias>Data_alias</jDitoRecordAlias>
<onInsert>%aditoprj%/entity/CampaignAddParticipants_entity/recordcontainers/jdito/onInsert.js</onInsert>
<recordFieldMappings>
<jDitoRecordFieldMapping>
<name>UID.value</name>
</jDitoRecordFieldMapping>
</recordFieldMappings>
</jDitoRecordContainer>
</recordContainers>
</entity>
<?xml version="1.0" encoding="UTF-8"?>
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignAddParticipants_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignAddParticipants_entity/documentation.adoc</documentation>
<title>Add participants to Campaign</title>
<onValidation>%aditoprj%/entity/CampaignAddParticipants_entity/onValidation.js</onValidation>
<recordContainer>jdito</recordContainer>
<entityFields>
<entityProvider>
<name>#PROVIDER</name>
</entityProvider>
<entityField>
<name>CAMPAIGN_ID</name>
<title>Campaign</title>
<consumer>CampaignConsumer</consumer>
<mandatory v="true" />
<state>AUTO</state>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/valueProcess.js</valueProcess>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/displayValueProcess.js</displayValueProcess>
<onValueChange>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaign_id/onValueChange.js</onValueChange>
<onValueChangeTypes>
<element>MASK</element>
<element>PROCESS</element>
<element>PROCESS_SETVALUE</element>
<element>RECORD</element>
</onValueChangeTypes>
</entityField>
<entityField>
<name>CAMPAIGNSTEP_ID</name>
<title>Campaign Step</title>
<consumer>CampaignStepConsumer</consumer>
<mandatory v="true" />
<state>EDITABLE</state>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstep_id/displayValueProcess.js</displayValueProcess>
<onValueChange>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstep_id/onValueChange.js</onValueChange>
</entityField>
<entityField>
<name>campaignParticipantMessage</name>
<state>READONLY</state>
<onValueChangeTypes>
<element>PROCESS</element>
</onValueChangeTypes>
</entityField>
<entityParameter>
<name>campaignParticipantsRowIds_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityConsumer>
<name>CampaignConsumer</name>
<dependency>
<name>dependency</name>
<entityName>Campaign_entity</entityName>
<fieldName>Campaigns</fieldName>
</dependency>
</entityConsumer>
<entityConsumer>
<name>CampaignStepConsumer</name>
<dependency>
<name>dependency</name>
<entityName>CampaignStep_entity</entityName>
<fieldName>CampaignSteps</fieldName>
</dependency>
<children>
<entityParameter>
<name>campaignId_param</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepconsumer/children/campaignid_param/valueProcess.js</valueProcess>
<expose v="true" />
</entityParameter>
</children>
</entityConsumer>
<entityField>
<name>UID</name>
</entityField>
<entityParameter>
<name>currentCampaignId_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityParameter>
<name>currentCampaignStepId_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityParameter>
<name>isUpdate_param</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
<entityConsumer>
<name>CampaignAnalyses</name>
<dependency>
<name>dependency</name>
<entityName>CampaignAnalysis_entity</entityName>
<fieldName>#PROVIDER</fieldName>
</dependency>
</entityConsumer>
<entityField>
<name>campaignStepCurrentParticipantCount</name>
<title>Current participants</title>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepcurrentparticipantcount/displayValueProcess.js</displayValueProcess>
</entityField>
<entityField>
<name>campaignStepMaxParticipantCount</name>
<title>Max participants</title>
<displayValueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/campaignstepmaxparticipantcount/displayValueProcess.js</displayValueProcess>
</entityField>
<entityField>
<name>isUpdate</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/isupdate/valueProcess.js</valueProcess>
</entityField>
<entityParameter>
<name>campaignParticipantsCondition_param</name>
<expose v="true" />
</entityParameter>
<entityParameter>
<name>dataSourceTableName_param</name>
<expose v="true" />
</entityParameter>
<entityField>
<name>isOperationValid</name>
<valueProcess>%aditoprj%/entity/CampaignAddParticipants_entity/entityfields/isoperationvalid/valueProcess.js</valueProcess>
</entityField>
</entityFields>
<recordContainers>
<jDitoRecordContainer>
<name>jdito</name>
<jDitoRecordAlias>Data_alias</jDitoRecordAlias>
<onInsert>%aditoprj%/entity/CampaignAddParticipants_entity/recordcontainers/jdito/onInsert.js</onInsert>
<recordFieldMappings>
<jDitoRecordFieldMapping>
<name>UID.value</name>
</jDitoRecordFieldMapping>
</recordFieldMappings>
</jDitoRecordContainer>
</recordContainers>
</entity>
entity/CampaignAddParticipants_entity/documentation.adoc 0 → 100644
+ 4
− 0
View file @ 1a33e948
= CampaignAddRecipients_entity
This entity handling the seriel action to add more than one organisation / person to a campaign (campaignparticipant).
This action can´t be done with the CampaignParticipant_entity, because a entity displays always one dataset.
\ No newline at end of file
entity/CampaignAnalysis_entity/CampaignAnalysis_entity.aod
+ 2
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignAnalysis_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignAnalysis_entity/documentation.adoc</documentation>
<siblings>
<element>CampaignCost_entity</element>
</siblings>
......@@ -12,6 +13,7 @@
</entityProvider>
<entityProvider>
<name>CampaignAnalysisProvider</name>
<documentation>%aditoprj%/entity/CampaignAnalysis_entity/entityfields/campaignanalysisprovider/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>bd130613-f0e4-4591-8035-2c2491b08c50</name>
......
entity/CampaignAnalysis_entity/documentation.adoc 0 → 100644
+ 4
− 0
View file @ 1a33e948
= BulkMailAnalysis_entity
Calculates some information for charts for the campaign like amount of participants.
There are separate charts for cost and participant.
\ No newline at end of file
entity/CampaignAnalysis_entity/entityfields/campaignanalysisprovider/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignAnalysis_entity - CampaignAnalysisProvider
Provides the information so they can be consumed inside the campaign to display the chart
\ No newline at end of file
entity/CampaignCostChart_entity/CampaignCostChart_entity.aod
+ 2
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignCostChart_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignCostChart_entity/documentation.adoc</documentation>
<siblings>
<element>CampaignCost_entity</element>
</siblings>
......@@ -31,6 +32,7 @@
</entityParameter>
<entityProvider>
<name>CostChart</name>
<documentation>%aditoprj%/entity/CampaignCostChart_entity/entityfields/costchart/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>e519262b-ff42-4c26-9d28-4d9566eafcdc</name>
......
entity/CampaignCostChart_entity/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignCostChart_entity
Provides the information for the chart to display the campaign costs
\ No newline at end of file
entity/CampaignCostChart_entity/entityfields/costchart/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignCostChart_entity - CostChart
Provider to display the chart in the campaign-view
\ No newline at end of file
entity/CampaignCost_entity/CampaignCost_entity.aod
+ 3
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignCost_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignCost_entity/documentation.adoc</documentation>
<siblings>
<element>CampaignAnalysis_entity</element>
<element>CampaignCostChart_entity</element>
......@@ -77,6 +78,7 @@
</entityField>
<entityProvider>
<name>CampaignCosts</name>
<documentation>%aditoprj%/entity/CampaignCost_entity/entityfields/campaigncosts/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>7131288b-af5c-4914-96f5-c5d70217fc23</name>
......@@ -107,6 +109,7 @@
</entityProvider>
<entityProvider>
<name>StepCosts</name>
<documentation>%aditoprj%/entity/CampaignCost_entity/entityfields/stepcosts/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>af147f3e-a1bd-4eb0-9ac8-325dbdaba17d</name>
......
entity/CampaignCost_entity/documentation.adoc 0 → 100644
+ 6
− 0
View file @ 1a33e948
= CampaignCost_entity
Calculates all the information for the costs of an campaign.
There is also a entity "CampaignCostChart_entity" to display this information via charts.
There are different providers for costs of the campaign itself and for costs of campaignsteps.
\ No newline at end of file
entity/CampaignCost_entity/entityfields/campaigncosts/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignCost_entity - CampaignCost
Provides the information for the chart to display the campaign costs
\ No newline at end of file
entity/CampaignCost_entity/entityfields/stepcosts/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignCost_entity - StepCost
Provides the information for the chart to display the step costs
\ No newline at end of file
entity/CampaignParticipantChart_entity/CampaignParticipantChart_entity.aod
+ 2
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignParticipantChart_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignParticipantChart_entity/documentation.adoc</documentation>
<siblings>
<element>CampaignParticipant_entity</element>
<element>CampaignStep_entity</element>
......@@ -14,6 +15,7 @@
</entityProvider>
<entityProvider>
<name>ParticipantChart</name>
<documentation>%aditoprj%/entity/CampaignParticipantChart_entity/entityfields/participantchart/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>59e7c7ff-a649-4efe-89dd-8fdb7967261b</name>
......
entity/CampaignParticipantChart_entity/documentation.adoc 0 → 100644
+ 4
− 0
View file @ 1a33e948
= CampaignParticipantChart_entity
Provides the information for the chart to display the participant information combined with steps.
The information is stored in the campaignparticipantlog db table.
\ No newline at end of file
entity/CampaignParticipantChart_entity/entityfields/participantchart/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignParticipantChart_entity - ParticipantChart
Provides the information for the chart to display the participant chart
\ No newline at end of file
entity/CampaignParticipant_entity/CampaignParticipant_entity.aod
+ 2
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignParticipant_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignParticipant_entity/documentation.adoc</documentation>
<title>Participant</title>
<siblings>
<element>CampaignAddParticipants_entity</element>
......@@ -18,6 +19,7 @@
<name>CampaignParticipantsProvider</name>
<targetContextField>CONTACTCONTEXT</targetContextField>
<targetIdField>CONTACT_ID</targetIdField>
<documentation>%aditoprj%/entity/CampaignParticipant_entity/entityfields/campaignparticipantsprovider/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>f28945cd-4613-4dfa-91f7-a7d9d64cef58</name>
......
entity/CampaignParticipant_entity/documentation.adoc 0 → 100644
+ 4
− 0
View file @ 1a33e948
= CampaignParticipant_entity
Handling of the information and logic of an campaign participant.
A campaign participant can be a organisation or a person.
\ No newline at end of file
entity/CampaignParticipant_entity/entityfields/campaignparticipantsprovider/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignCostChart_entity - CampaignParticipantsProvider
Provider to display the campaign participants in the campaign itself
\ No newline at end of file
entity/CampaignPlanning_entity/CampaignPlanning_entity.aod
+ 1
− 0
View file @ 1a33e948
......@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>CampaignPlanning_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/entity/CampaignPlanning_entity/documentation.adoc</documentation>
<title>Campaign planning</title>
<siblings>
<element>Campaign_entity</element>
......
entity/CampaignPlanning_entity/documentation.adoc 0 → 100644
+ 3
− 0
View file @ 1a33e948
= CampaignPlanning_entity
Provides the information an logic to display all campaigns via a gantt chart.
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment