Campaign Fields

The Campaign Fields document function injects active campaigns into Outlook signature templates. It defines named campaign fields that are used as placeholders in the signature. Tag filters control which campaigns appear in which signature template.

note

This document function is available exclusively on Outlook signature templates.

---

Basic Structure

<CampaignConfiguration>
  <Campaign Name="SommerAktion" Label="Sommeraktion 2024">
    <TagFilter>
      <Tag>Kampagne</Tag>
      <Tag>Sommer</Tag>
    </TagFilter>
  </Campaign>
  <Campaign Name="WinterAktion" translate-Label="Campaigns.Winter" />
</CampaignConfiguration>

---

Campaign

Each <Campaign> element defines a campaign field entry.

Attributes

Attribute	Description
Name (required)	Technical identifier of the campaign field. Must be unique and contain no spaces.
Label	Display name in the user interface.
translate-Label	Translation key for the display name (alternative to Label).
AutoInsert	Controls whether an active campaign is inserted without the user doing anything. Default: true. With false, the effect differs per client type — see How AutoInsert behaves.

How AutoInsert behaves

AutoInsert="false" does not suppress a campaign the same way everywhere:

Client type	Effect of AutoInsert="false"
Outlook web add-in, signature inserted automatically (new message, changed recipients)	The campaign placeholder stays empty.
Outlook web add-in, signature inserted manually	The campaign dropdown is preselected to «no campaign». The campaign remains selectable and can be inserted deliberately.
primedocs Desktop, automatic signature	No effect. The automatic desktop signature uses a separate mechanism with the ribbon commands Activate campaign and Deactivate campaign.
primedocs Desktop, creating a document or testing a template	No effect — the campaign is inserted.

<!-- Campaign only on deliberate selection, not on its own -->
<Campaign Name="Sonderaktion" Label="Sonderaktion" AutoInsert="false" />

note

AutoInsert controls the preselection, not the permission. To keep a campaign out of the selection entirely, use the TagFilter or the permissions of the campaign template.

TagFilter

<TagFilter> restricts which campaigns appear on this signature template. Only campaigns that carry at least one of the defined tags are displayed.

<Campaign Name="SommerAktion" Label="Sommeraktion">
  <TagFilter>
    <Tag>Sommer</Tag>
    <Tag>Retail</Tag>
  </TagFilter>
</Campaign>

If no <TagFilter> is specified, all active campaigns are taken into account.

---

Interaction with Campaign Templates

Campaign fields in a signature template are populated by campaign templates. A campaign template (template type: Outlook campaign template) defines the concrete HTML content (banner, text, image) and is linked to the signature template via tags.

The interaction:

1. The signature template defines named placeholders (Name) using Campaign Fields.
2. One or more campaign templates are tagged with matching tags.
3. At runtime, primedocs selects the active campaign template based on the tags and inserts its content into the corresponding placeholder.