Relayter Help

Appearance

Configure Campaign Package Setups ​

A Campaign Package Setup is a reusable configuration that defines how finished Publication Items are assembled into a PDF export, which fields to include, and how to organize the output. Administrators create setups so teams can export campaigns consistently without reconfiguring export options each time.

Create a campaign package setup ​

  1. Go to Export setups → Campaign package setups.
  2. Click Add setup.
  3. In the Information tab:
    • Enter a Name for the setup.
    • Enter an optional Description.
    • Select which Variants (if any) this setup applies to.
  4. Click Next or the Package data tab.
  5. Configure the data fields to include in the export (see Configure package data fields below).
  6. Click the PDF Export settings tab.
  7. Configure the PDF export behavior (see Configure PDF export settings below).
  8. Click Save.

Configure package data fields ​

Package data fields define which information gets included in the exported PDF. There are two kinds of fields:

Material data fields ​

These are custom fields about the physical product or material being exported (for example, "Number of copies" or "Print size"). They help track the output specifications.

  • Type: Choose String (text) or Number (for quantities and measurements)
  • Add or remove fields as needed for your export requirements

Campaign data fields ​

These fields pull information directly from the campaign and its publication items (for example, "Campaign title" or "Item description").

  • Name: A label for this field in the export
  • Source property: Select which campaign or item property to use (for example, campaignItems.dataFields.KEY-description pulls from a custom campaign data field)
  • Type: Automatically set to String or Date based on the source property
  • Variant (if applicable): If the source property is variant-specific, select which variant to use

Configure PDF export settings ​

These options control how the PDF is structured and what content it includes.

Layout ​

Select the Layout to use for formatting the PDF. The layout determines the visual structure and design of exported pages. This field is required if you configure any other PDF settings.

Sort items ​

Under Sort by, select one or more fields from your package data fields. Items in the PDF will be sorted by these fields in the order you specify. Leave empty to use the default item order.

Create variations ​

Multiply items by field: Select a field to create multiple versions of each package item. For example, if you select a "Color" field, Relayter will create separate item entries for each unique color value in your data.

Add table of contents or index pages ​

Under Add inserts for, select fields to create index pages in the PDF. Relayter will generate a separate page summarizing each unique value in the selected fields, helping readers navigate the document.

Add a title page ​

Check Add title page to include a cover page at the beginning of the exported PDF.

Create package setup rules ​

Rules let you apply conditional logic to package behavior. For example, you might create a rule that excludes certain items based on campaign properties.

  1. Open a campaign package setup for editing.
  2. Scroll to the Rules section (if available).
  3. Click Add rule or Create rule.
  4. Configure the rule conditions and actions.
  5. Save the setup.

See Rulesets for more detail on how to build rule conditions.

Edit a package setup ​

  1. Go to Export setups → Campaign package setups.
  2. Click the setup name to open it.
  3. Update any of the tabs:
    • Information: Name, description, or variants
    • Package data: Add, remove, or modify data fields
    • PDF Export settings: Change layout, sorting, or PDF options
  4. Click Save.

Delete a package setup ​

  1. Go to Export setups → Campaign package setups.
  2. Find the setup in the list.
  3. Click the delete icon or select the setup and click Delete.
  4. Confirm the deletion.

Note: Deleting a setup does not affect packages that were already created from it. However, users will no longer be able to create new packages using this setup.

Use a package setup to export ​

When you or your team export a campaign:

  1. Go to the campaign's Packages tab.
  2. Click Add packages.
  3. Select a Package setup from the list.
  4. Relayter creates a package configured according to the setup's data fields, export settings, and rules.
  5. Review and export the package's PDF using the Export button.

See Export a Campaign Package for detailed export steps.