Skip to content
Optima docs
ConsoleEdge

Forms

Build sign-up and preference forms that write straight to a visitor's profile, hosted on their own page or embedded in your site.

Forms are public capture forms: a newsletter sign-up, a preference form, a competition entry. Each form is a list of fields, and each field writes to a profile attribute, an identifier (such as an email address) or a consent purpose. Optima hosts the form on its own page with an address you can link to, and the SDK can also draw it inside your site. A visitor who comes back is asked only what Optima does not yet know, which is called progressive profiling. Submissions follow the same allowlist and consent rules as the rest of Tracking.

Who uses it

Campaign creators build forms; privacy officers check the consent purposes and policy. Reading needs content_viewer and creating, editing and publishing needs content_editor, or another role your administrator has given access to this area — see Licences and roles. Forms need the landing pages feature of the Digital package and sit under On-site in the navigation.

You also need a web or mobile tracking entity and a public base URL on Tracking, and an event type named form_submitted with a text attribute form_id, which Optima fills on every submission.

The Forms screen with a status filter above a table of forms showing slug, status, fields, double opt-in and page

Fields

The list

Filter by status (All statuses, Draft, Published, Archived). Columns: Name, Slug, Status, Fields (count), Double opt-in and Page. Open page opens the hosted page; Not published yet is shown until a form is published and the page address exists. Each row has Publish or Unpublish, the pencil (edit) and the trash can (delete).

The editor

The New form dialog with slug, tracking entity, purposes, double opt-in, page settings and a field builder with a live preview

New form opens the dialog.

FieldMeaningValid valuesDefault
NameA label for you.TextNone (required)
SlugPart of the hosted page's address. Must be unique.Lowercase letters, digits and hyphens, starting with a letter or digitNone (required)
Tracking entityThe profile type the form writes to. Every field targets its schema.The web or mobile tracking entity from Tracking → SettingsNone (required)
Max fields per renderMost remaining fields the page shows at once; the rest follow on the next visit.A whole number; 0 shows every field not yet asked0
Collection purposesStamped on attribute and identifier writes: the stored purposes are the submission's declared set within these.Active purposesNone
Consent purposesConsent decisions are recorded under these. A form with a consent field needs at least one, plus a policy.Active purposesNone
Consent policy, Policy versionThe consent text version shown at submit time, recorded on every consent decision as a receipt. Shown once a consent purpose is chosen.A policy and one of its versionsNone
Double opt-inAn identifier stays unconfirmed until the visitor clicks the link sent with the chosen template.On or offOff
Confirmation identifierThe identifier the link is sent to. Shown with double opt-in.An identifier of the entity, such as emailFirst available
Confirmation templateThe notification template for the confirmation message.An existing notification template; saving or publishing is refused if the name matches none. Create it first under Settings → Workspace → Notifications; see NotificationsNone
Minimum submit interval (seconds)Anti-abuse floor between the page being drawn and the submit arriving. Faster submissions are treated as bots.0 to 3600Empty (default)
PageThe hosted page's address, built from the public base URL and an active web SDK key. Read-only; empty until both exist.n/an/a
Page titleThe title of the hosted page.TextEmpty
Page body (HTML)The markup around the generated field list.HTML, at most 192 KiBEmpty
Personalized (Go-template rendered server-side)The page body may use tokens over the visitor's attributes, consents and linked profiles; see Web personalization.On or offOff
Success messageShown after a successful submit.TextEmpty
Success redirect URLSend the visitor here after submit instead.A full addressEmpty

Form fields

Add field adds a field; the arrows Move field up and Move field down reorder; Remove field deletes. A form needs at least one field.

FieldMeaningValid valuesDefault
Target kindWhat the field writes to.Attribute, Identifier, ConsentAttribute
TargetThe attribute, identifier or consent purpose.Options come from the tracking entity's schema or the Consent purposes above. Payment-card-like attribute names are refused.None (required)
Input typeThe control.Text, Email, Phone, Number, Checkbox, Select, Textarea, HiddenText
LabelWhat the visitor reads.TextNone (required)
PlaceholderHint text inside the control.TextEmpty
RequiredThe visitor must fill it in. An empty answer is rejected, and a required checkbox or consent must be ticked.On or offOff
Ask onceOmit the field once the profile already holds a value: progressive profiling.On or offOff
Validation regex (optional)A pattern the value must match.A regular expressionEmpty
OptionsFor Select: pairs of Value and Label; Add option.At least oneNone

If your environment has languages configured, Field language lets you translate the labels: choose a language to see the default label as a placeholder, and an empty translation serves the default. Add, reorder and configure fields in the default language.

The Live preview draws the form as a visitor sees it. Simulate returning visitor hides fields marked Ask once, and a count shows how many fields are visible.

Actions

  • Create or Save stores the form as a draft. Publish makes the page and the SDK form live; Unpublish takes them down.
  • Saving can be refused with a message that forms need the event type form_submitted with a form_id attribute. The message links to the event type settings. A slug already in use is reported at the field.
  • Delete removes the form. This cannot be undone.

Examples

Newsletter sign-up with double opt-in. Slug newsletter, Tracking entity visitor, one Identifier field email of type Email (Required), one Consent field newsletter as a Checkbox. Consent purposes newsletter, Consent policy privacy-policy, Double opt-in on with Confirmation identifier email and a confirmation template. The email address stays unconfirmed until the visitor clicks the link, and consent is only granted then.

Preference form that never asks twice. Three Attribute fields (favourite_category, birth_year, postcode) with Ask once on and Max fields per render 1. Each visit adds one answer.

Common problems

  • The form cannot be saved: it needs an event type. Add form_submitted with a text attribute form_id, then save again.
  • Page shows "Not published yet". Publish the form, set the public base URL under Tracking → Settings, and make sure an active web SDK key exists.
  • No targets to choose. Choose the tracking entity first, or add consent purposes above for Consent fields.
  • Submissions are rejected. The submit came back too fast (see Minimum submit interval), a bot field was filled, or the field is outside the allowlist.
  • A confirmation email never arrives. Check the Confirmation template and that the template's channel is configured.

On this page