Skip to main content

Field types and common setup

Set up field types, properties, and dependencies for the Veeva Vault PromoMats publications

Anna Voloshchuk avatar
Written by Anna Voloshchuk
Updated over 9 months ago

For publications to Veeva Vault PromoMats, the following configurable field types are supported:

Field type

Definition

String

Text input field that supports a sequence of characters entered with the keyboard

Textarea

A field type that supports multi-line text input to enter longer pieces of text

Boolean

A field type that allows for only two possible values, typically representing "true" or "false". Checkboxes, toggle switches, and radio buttons are of the Boolean field type.

Date

A field type that captures a specific calendar date and is usually presented with a date picker to ensure proper formatting

String picklist

A field type that provides a dropdown list of predefined text options, allowing users to select a single value from the list

Picklist

A predefined list of options from which users can select a single value

Object list

A collection of objects, allowing users to select several values from a predefined list

Filtered object list

A dynamically filtered list of objects available for selection. The list options are filtered based on specific criteria or user input.

Related object list

A field type that allows users to select values from a predefined list of related objects. The Related object list type can be used to set up fields with values pulled from the relation table.

Multi-related object list

A field type that allows users to select several values from a predefined list of related objects. The Multi-related object list type can be used to set up fields with values pulled from the relation table.

Document list

A field type used for configuring the Approved PDF field to prepopulate, browse, and then link the approved PDF file stored in Veeva Vault PromoMats to the interactive document.
This field type is available only for the Veeva Vault interactive publish type.

Common field properties

All publish configuration fields have the following properties.

Property

Description

Label

User-friendly field name to display on the Publisher interface

Key

Unique identifier assigned to a field within the system. For publication to Veeva Vault as PDF for approval, the Key value must match the API key of the field in Veeva Vault PromoMats.

Type

A list of field type names that determine the set of field properties available for configuration

Max length

A numeric value that defines the maximum number of characters for text fields. The default values are 100 characters for String, 5000–for Textarea, and 10000–for String picklist.

Size

A numeric value between 1 and 100 that defines the field width proportionally to other fields. For example, to display three fields in a row, set the value to 33.33 for each field.

Required *

Checkbox to mark the field as required for filling in during the publication. When the checkbox is clear, the field is optional.

Readonly

Checkbox to make the field non-editable by users and gray it out on the Publisher pages. When the checkbox is clear, the field is available for editing by users.

Sealed *

Checkbox to hide the field from the Publisher interface. When the checkbox is clear, the field is shown on the interface.

Autocomplete field

A placeholder for the Approved PDF field value. With this property, metadata is inherited from the previously published PDF.
This property is available only for the Veeva Vault interactive publish type.

* If you select both the Required and Sealed checkboxes, be sure to enter the Default value property. As a result, this configured field will be hidden during the publication flow, but its metadata will be pushed to Veeva Vault PromoMats.

The fields marked with asterisks (*) are mandatory.

Field dependencies

Besides configuring common field properties, you can also set the logic for displaying the field on the Publisher interface based on the values of another field. You can do it in the DEPENDS ON configuration section as follows:

  • Field: Enter the Key value of the "parent", which determines the behavior of the given field. You can assign fields of the Boolean, String picklist, Picklist, Object list, Filtered object list, Related object list, and Multi-related object list types as "parents". Other field types aren't supported.

  • Required values: Specify the unique ID of the Veeva Vault parameter to use its value as "parent". To use several parameter values, separate their IDs with spaces.

For the Boolean field type, enter true/false to the Required values property.

Below these two parameters, you can find two subsections—Then and Else—with the same checkboxes.

Select these checkboxes to determine the dependent field behavior on the Publisher interface based on whether the dependency rule is met or not.

Subsection

Checkbox

Description

Then
(Dependency rule is met)

Make the dependent field mandatory

Hide the dependent field from the Publisher interface

Else
(Dependency rule isn't met)

Make the dependent field mandatory

Hide the dependent field from the Publisher interface

If you set the field dependency rule, the state of the Required and Sealed checkboxes takes priority over the Required and Sealed checkboxes in the common field properties.

With the field dependency setup, you can dynamically customize the context sensitivity of fields, where the appearance or behavior of one field can change based on the input or selection in another field.

Did this answer your question?