...
We started delivering the components in our release version 2.135 and more will be added in every upcoming release.
Version | 2.135 and up |
|---|---|
License | SelfService |
| Table of Contents |
|---|
Please find a full list of the components below:
Component | Purpose | Delivery |
|---|---|---|
Campaign creation | Set campaign parameters such as name, campaign goal, runtime and budget. | delivered in 2.135 |
Audience selection | Define the audiences you would like to reach with your ads. | delivered in 2.135 |
Result list | Receive products that fit to your search criteria and add them to your basket. | delivered in 2.138 |
Shopping cart | Get an overview of your basket and make some last minute changes such as quantities or removing products from the basket. | delivered in 2.138 |
Payment | Get an invoice in order to pay the invoice. | delivered in 2.140 |
Creative upload
Define all the criteria needed for the creatives and upload your creatives.
Create records / Save | Simplifying the save process and taking care of saving applied Commitment Conditions as well as Targeting Groups (audiences) which were matched. | delivered in 2.156 |
You can start setting up your Self Service by creating a Digital Experience. Please find the steps right here: 9.1 Create a Portal (Digital Experience)
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
...
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | no | budgetMax | Set the maximum number of budget that should be selectable. | number | 20,000 |
Input | no | budgetMin | Set the minimum number of budget that should be selectable. | number | 500 |
Input | no | budgetStep | Set the step value that should be applied while using the slider. | number | 500 |
Input | no | goals | Enter a custom setup of the Campaign Goals to customize them for your needs. | JSON string | please see below |
Input | no | Info Text | Enter an info text that will be shown below the budget in order to give a hint to the user. | text | empty |
Input | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Input | yes | mediaCampaign | Enter the variable of a Media Campaign that can be used for saving the Media Campaign to be configured virtually. | record variable of data type Media Campaign | empty |
Output | yes | mediaCampaign | Enter the variable of the Media Campaign from above in order to hand over the entered parameters to the next component. | record variable of data type Media Campaign | empty |
This Campaign Creation component uses an input for goals in order to be more dynamic. This is the default configuration if no other input is provided in the setup of the component:
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Use values from when the user last visited the screen”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | Media Campaign | Enter the variable of the Media Campaign from the first component to take over the Media Campaign parameters. | record variable of data type Media Campaign | empty |
Input | yes | Selected Targeting Groups | Enter a variable for Targeting Groups in order to load the entered parameterswhen navigating between different screens. | collection (Allow multiple values) variable of data type Targeting Group | empty |
Input | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Input | no | Targetings | Enter a custom setup of the Audience selection to customize it for your needs. | JSON string | please see below |
Output | no | Media Campaign | Enter the variable of the Media Campaign from the first screen in order to hand over the parameters to the next component. | record variable of type Media Campaign → should be left empty | empty |
Output | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Output | yes | Selected Targeting Groups | Enter a variable of Targeting Groups in order to hand over the entered parameters to the next component. | collection (Allow multiple values) variable of data type Targeting Group | empty |
This Audience component uses an input for targetings in order to be more dynamic. This is the default configuration if no other input is provided in the setup of the component:
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value | ||
|---|---|---|---|---|---|---|---|
Input | yes | campaignItems | Enter a variable to save the Campaign Items that will start to be created in this component. | collection (Allow multiple values) variable of data type Campaign Item | empty | ||
Input | no | Check Availability Enabled | Please enter a value that defines if an availability check should be done when starting the Result List or not.
| boolean | false | ||
Input | no | Items per Check Availability Job | This value defines how many items will be included in one availability job at the same time. The number affects the speed how fast results are coming in. The default of 10 is a well balanced value between not waiting too long but putting enough items together to not have too many jobs running in the end. | number | 10 | ||
Input | yes | Media Campaign | Enter the variable of the Media Campaign from the first component to take over the Media Campaign parameters. | record variable of data type Media Campaign | empty | ||
Input | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty | ||
Input | yes | Targeting Group Ids | Enter the existing variable for Targeting Groups in order to load the entered parameters on this screen. | collection (Allow multiple values) variable of data type Targeting Group | empty | ||
Output | yes |
campaignItems
Campaign Item Related List | The variable to hold all the information about Campaign items with related records, e.g. applied Commitment Conditions, Contents or Targeting Groups. | text variable | empty | ||
Output | yes | campaignItems | Enter the variable from the Input parameters again to hand over the Campaign Items in the basket to the next component. | collection (Allow multiple values) variable of data type Campaign Item | empty |
Output | yes | Media Campaign | Enter the variable of the Media Campaign from the first screen in order to hand over the parameters to the next component. | record variable of type Media Campaign | empty |
Output | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Output | yes | Targeting Group Ids | Enter the existing variable of Targeting Groups in order to hand over the values to the next component. | collection (Allow multiple values) variable of data type Targeting Group | empty |
...
Shopping cart
The fourth step is to add another new screen component to the flow.
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | Campaign |
Enter the variable from the third screen to load the basket items into this component.
Item Related List | The variable to hold all the information about Campaign items with related records, e.g. applied Commitment Conditions, Contents or Targeting Groups. | text variable | empty | ||
Input | yes | Campaign Items | Enter the variable from the third screen to load the basket items into this component. | collection (Allow multiple values) variable of data type Campaign Item | empty |
Input | yes | Media Campaign | Enter the variable of the Media Campaign from the first component to take over the Media Campaign parameters. | record variable of data type Media Campaign | empty |
Input | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Input | yes | Targeting Group Ids | Enter the existing variable for Targeting Groups in order to load the entered parameters on this screen. | collection (Allow multiple values) variable of data type Targeting Group | empty |
Output | yes |
campaignItems
Enter the variable from the third screen to hand over the Campaign Items in the basket to the next component.
Campaign Item Related List | The variable to hold all the information about Campaign items with related records, e.g. applied Commitment Conditions, Contents or Targeting Groups. | text variable | empty | ||
Output | yes | campaignItems | Enter the variable from the third screen to hand over the Campaign Items in the basket to the next component. | collection (Allow multiple values) variable of data type Campaign Item | empty |
Output | yes | Media Campaign | Enter the variable of the Media Campaign from the first screen in order to hand over the parameters to the next component. | record variable of type Media Campaign | empty |
Output | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Output | yes | Targeting Group Ids | Enter the existing variable of Targeting Groups in order to hand over the values to the next component. | collection (Allow multiple values) variable of data type Targeting Group | empty |
The Summary component will calculate the VAT values based on the Media Campaign information. To calculate VAT rates please keep in mind to
either set manually the needed information in the virtual Media Campaign by using an assignment component (Fields to be set then are the debtor and depending on your VAT setup the following: VAT Rate % Type 1A, Type 1B, Type 2A and Type 2B).
or you could also receive the relevant details by creating the Media Campaign before getting to the screen and then query the calculated details for the VAT calculation before starting the summary screen. You would still need to define the debtor to be set in the Media Campaign before creation.
Payment
The fifth step is to add another new screen component to the flow.
On the left side under the section Custom you will find the component Payment. Add it to the screen.
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
...
Input/Output
...
Required?
...
Parameter
...
Meaning
...
Value format
...
Default value
...
Input
...
yes
...
Campaign Items
...
Enter the variable from the third screen to load the basket items into this component.
...
collection (Allow multiple values) variable of data type Campaign Item
...
empty
...
Input
...
yes
...
Media Campaign
...
Enter the variable of the Media Campaign from the first component to take over the Media Campaign parameters.
...
record variable of data type Media Campaign
...
empty
...
Input
...
no
...
Media Campaign Id
...
(not relevant for now)
...
id of a Media Campaign
...
empty
...
Input
...
yes
...
Targeting Group Ids
...
Creating records
Now you might want to create the records in order to prepare everything for the payment.
| Note |
|---|
Especially when you are working with Commitments we ask you to create the Media Campaign before accessing the Result List component (Select products). Otherwise the Commitment matching can not happen. In order to do this you will need to use the Create Records element to create the Media Campaign from the saved parameters in the variable. |
To save all the rest the configured records we created the Save component for records. We recommend you to use this after the summary component and before Payment and Creative components.
Add a new screen component to the flow.
On the left side under the section Custom you will find the component selfSave. Add it to the screen.
| Note |
|---|
Sometimes you might need to cancel the component and add it again in order to see all components on the left side (only initially). |
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | Campaign Item Related List | The variable to hold all the information about Campaign items with related records, e.g. applied Commitment Conditions, Contents or Targeting Groups. | text variable | empty |
Input | yes | campaignItems | Enter the variable from the third screen to load the basket items into this component. | collection (Allow multiple values) variable of data type |
empty
Campaign Item | empty | ||||
Input | yes | Media Campaign | Enter the variable of the Media Campaign from the first component to take over the Media Campaign parameters. | record variable of data type Media Campaign | empty |
Output | yes | Media Campaign | Enter the variable of the Media Campaign from the first screen in order to hand over the parameters to the next component. | record variable of type Media Campaign | empty |
Output | yes | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Output | yes | saved Campaign Items | Enter the variable from the third screen to update the basket items which were saved in component. | collection (Allow multiple values) variable of data type Campaign Item | empty |
The Save component will
Save the Media Campaign (if not done before)
Save the Campaign Items related to the Media Campaign
Save related Targeting Groups (and their connected Contents if applicable)
Save related Commitments conditions (if applicable)
...
Payment
The next step is to add another new screen component to the flow.
On the left side under the section Custom you will find the component Payment. Add it to the screen.
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | Campaign Items | Enter the variable from the third screen to |
collection (Allow multiple values) variable of data type Campaign Item
empty
Output
no
Debtor Account
In case you needed to complete the billing address in the component this will deliver the updated debtor account that will need to be updated in the flow directly afterwards.
load the basket items into this component. | collection (Allow multiple values) variable of data type |
Campaign Item | empty |
Input | yes | Media Campaign | Enter the variable of the Media Campaign from the first |
component to |
take over the Media Campaign parameters |
. | record variable of data type Media Campaign | empty |
Input | no | Media Campaign Id | (not relevant for now |
) | id of a Media Campaign | empty | |||
Input | yes | Targeting Group Ids | Enter the existing variable for Targeting Groups in order to load the entered parameters on this screen. | collection (Allow multiple values) variable of data type Targeting Group | empty |
Output | yes |
Campaign Items | Enter the |
variable from the third screen to hand over the Campaign Items in the |
basket to the next component. | collection (Allow multiple values) variable of data type |
Campaign Item | empty |
Creating records
Now you might want to create the records in order to prepare everything for the payment.
In order to do this you will need to use the Create Records element to create the Media Campaign first (if not already done).
Before you can create the Campaign Items now you will need to update the Media Campaign Id in the virtual Campaign Items so that they will be connected to the right campaign.
You can do this by using a Loop element going through your Campaign Item record collection variable.
Using the Assignment element you can set the Media Campaign record id in every Campaign Item that needs to be created.
After that element you will need another Assignment element to fill a new Campaign Item collection variable because your changes will not be reflected in the existing variable.
After the last item if the loop element you can then use the Create Records element to finally create your Campaign items.
Output | no | Debtor Account | In case you needed to complete the billing address in the component this will deliver the updated debtor account that will need to be updated in the flow directly afterwards. | record variable of data type Account | empty |
Output | yes | Media Campaign | Enter the variable of the Media Campaign from the first screen in order to hand over the parameters to the next component. | record variable of type Media Campaign | empty |
Output | no | Media Campaign Id | (not relevant for now) | id of a Media Campaign | empty |
Output | yes | Targeting Group Ids | Enter the existing variable of Targeting Groups in order to hand over the values to the next component. | collection (Allow multiple values) variable of data type Targeting Group | empty |
...
Create Invoices
After the user decided how he wants to pay in the next step the invoices need to be created so that the user receives the invoice per mail and can download it directly in the system.
...
The first one needed is an action (not a screen). In the search you will need to enter “FlowInvocableProcess“. The parameters for the action are explained below. You can define the input parameter by checking the toggle next to parameters to true. The output parameters need to be defined by setting the checkbox “Manually assign variables” to true in the Advanced section for the component. For the transaction control you can select the recommended value (Let the flow decide).
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | action | Enter the action that will be called to create the invoices: “CreateInvoices” | string, “CreateInvoices“ | empty |
Input | yes | parameters | Enter the variable that holds the Media Campaign Ids to be invoiced. | collection (Allow multiple values) variable of data type text | empty |
Output | no | message | Enter a text variable to hold possible messages. | text variable | empty |
Output | yes | results | Enter a collection variable for data type text that can hold the invoice ids after creating the Pre-Invoices. | collection (Allow multiple values) variable of data type text | empty |
Output | no | status | Enter a text variable to hold the status. | text variable | empty |
After creating this element the next step is to loop through the Pre-Invoice Ids (received from the previous component) in order to start the Billing Run job.
...
The parameters on the right hand side of the component are explained below. The output parameters need to be defined by setting the checkbox “Manually assign variables (advanced)” to true in the Advanced section for the component. You should also set the radio button in the “Revisit Screen Values” section to true saying “Refresh inputs to incorporate changes elsewhere in the flow”.
Input/Output | Required? | Parameter | Meaning | Value format | Default value |
|---|---|---|---|---|---|
Input | yes | preInvoiceId | Enter the variable that holds the current item from the loop. | current item from the loop | empty |
Output | no | Error Messages | Enter a text variable to hold possible messages. | text variable | empty |
Output | yes | preInvoiceId | Enter the variable that hold the current item from the loop. | current item from the loop | empty |
Output | no | Status | Enter a text variable to hold the status. | text variable | empty |
After adding the Billing Run Initiator screen to your flow you can use an assignment element to collect the Invoice Ids that were created. You can use those Ids or the Media Campaign Id for example to show a success screen to your user with the link to see the created Campaign or Invoice.
...
The invoicing process can throw a few errors when the given data are not complete as expected. In these cases you should use the status output as well as the message/error outputs in order to decide if an error message is needed or if the user can proceed with the flow.
Component | Error Status | Output variable holding the status | Output variable holding the error message |
|---|---|---|---|
FlowInvocableProcess (CreateInvoices) | ERROR | status | message |
flowBillingRunInitiator | failure | Status | Error Messages |