Skip to main content

Veeva Vault interactive

Configure type-specific properties of fields for the Veeva Vault interactive publication.

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

In this section, we cover type-specific properties of fields that you can configure for the Veeva Vault interactive publication type.

e-Detailers, emails

Besides the DETAILS step configuration, Business Admin also allows you to customize publish fields displayed on the SLIDES step for e-Detailers and the FRAGMENTS step for emails.

String field setup

For the String field type, the following optional properties are available:

Property

Description

Default value

The default value to display on the DETAILS step of publication for this field type

Primary

The checkbox you can set to increase the size of this field on the Publisher interface and highlight it among other fields

Set PDF value

The checkbox you can set to always autopopulate metadata fields during publishing as interactive with the values from the PDF document published to Veeva Vault PromoMats. With this checkbox selected, the PDF values are autopopulated during both interactive publication flows—as new and as an update.

Source content field

The path to the source field of the content in the eWizard database from which the field you are configuring will retrieve its values

Textarea field setup

For the Textarea field type, the following optional property is available:

Property

Description

Default value

The default value to display on the DETAILS step of publication for this field type

Boolean field setup

For the Boolean field type, the following optional properties are available:

Property

Description

Default value

The initial state of the checkbox/radio button on the Publisher interface. Enter true to have the Boolean field selected by default or false–to clear it. If you leave the Default value field empty, the checkbox/radio button remains highlighted until user selects it on the Publisher interface.

Tooltip

Additional information you can provide for the Boolean field. When users hover over the tooltip icon next to the checkbox/radio button on the Publisher interface, they'll see short guidance or context to help them understand its purpose.

Date field setup

For the Date field type, the following optional property is available:

Property

Description

Default value

The default value to display on the DETAILS step of publication for this field type
The correct format is Year-month-date in numbers. For example, to set September 28, 2024 as the default date, enter 2024-09-28 in this field.

String picklist field setup

For the String picklist field type, the following optional properties are available:

Property

Description

Default value

The default value to display on the Publisher interface for this field type. Be sure to use one of the options from the List of values subsection available for configuration below.

Source content field

The path to the source field of the content in the eWizard database from which the field you are configuring will retrieve its values

List of values

A set of options available for selection on the Publisher interface. Click + to add as many list options as required for this field. In the input field that appears, enter the display name for each option. Use the button next to any option to remove it from the list.

Picklist field setup

During the publication, the values in the Picklist field type are taken from Veeva Vault PromoMats.

For the Picklist field type, the following optional properties are available:

Property

Description

Default value

The default value to display on the Publisher interface for this field type. If your picklist field contains only value labels in the table, enter the required label in this field. If the picklist field has both labels and IDs, enter both the label and ID of the required value using the following format: [{"id":"","name":""}].

Information key

With this field, you can configure the metadata prepopulation with the values available in the eWizard database instead of entering them from scratch. This property works for the Brand (Product in Veeva Vault PromoMats), Country, and Language metadata fields only. To allow users to select the menu options instead of entering values with the keyboard during the publication process, enter one of the following options: brand, country, or language.

Table

This field is subordinate to Veeva Vault objects. Enter here the key of the Veeva Vault object to extract its values to this field.

Multiple

The checkbox you can set to allow users to select several values in this field type on the Publisher interface.

Source content field

The path to the source field in the eWizard database from which the field you are configuring will retrieve its values.

Sorting options

Sorting order of values based on their names to display on the Publisher interface. Click + to define the sorting criteria for this field type. In the input field pair that appears, enter orderBy in the field on the left, and the required field key to determine the sorting–in the field on the right. Click + again and enter sortOrder in the field on the left, in the field on the right, enter ASC to sort list options in ascending order or DSC for descending order. Such setup ensures that the object list is displayed in a meaningful and easy-to-navigate way.

There's no need to configure both the Information key and Source content field properties as one configuration always replaces the other.

Object list field setup

For the Object list field type, the following optional properties are available:

Property

Description

Default value

The object field value to be autopopulated by default for the first content item publication. For the next publications or the update flow, the default value will be replaced by the matching value from Veeva Vault PromoMats. In Business Admin, by default, this field contains the initial value representing an empty object with no ID and no name in the following format: [{"id":"","name":""}]. This object format empowers the correct work of eWizard Publisher and also this field type. To add a certain default value, enter its ID and name in the matching quotation marks.

Multiple

The checkbox you can set to allow users to select several values in this field type on the Publisher interface.

Table

A subordinate field to Veeva Vault objects. Enter here the API key of the Veeva Vault object to extract its values to this field.

Table fields

A dedicated property to secure the correct processing of field mapping between Veeva Vault PromoMats in eWizard Publisher. Click + to add a minimal list of table object fields required for pulling/pushing table object values.

Source content field

The path to the source field in the eWizard database from which the field you are configuring will retrieve its values.

Information key

The eWizard database field the value from which will be autopopulated for the first content item publication (if this value exists). You can configure the metadata prepopulation with the values available in the eWizard database instead of entering them from scratch. This property works for the Brand (Product in Veeva Vault PromoMats), Country, and Language metadata fields only. To allow users to select the menu options instead of entering values with the keyboard during the publication process, enter one of the following options: brand, country, or language.

Sorting options

Sorting order of values based on their names to display on the Publisher interface. Click + to define the sorting criteria for this field type. In the input field pair that appears, enter orderBy in the field on the left, and the required field key to determine the sorting–in the field on the right. Click + again and enter sortOrder in the field on the left, in the field on the right, enter ASC to sort list options in ascending order or DSC for descending order. Such a setup ensures that the object list is displayed in a meaningful and easy-to-navigate way.

Filtered object list field setup

For the Filtered object list field type, the following optional properties are available:

Property

Description

Default value

The object field value to be autopopulated by default for the first content item publication. For the next publications or the update flow, the default value will be replaced by the matching value from Veeva Vault PromoMats. In Business Admin by default, this field contains the initial value representing an empty object with no ID and no name in the following format: [{"id":"","name":""}]. This object format empowers the correct work of eWizard Publisher and also this field type. To add a certain default value, enter its ID and name in the matching quotation marks.

Multiple

The checkbox you can set to allow users to select several values in this field type on the Publisher interface.

Table

A subordinate field to Veeva Vault objects. Enter the API key of the Veeva Vault object to extract its values to this field.

Table fields

A dedicated property to secure the correct processing of field mapping between Veeva Vault PromoMats in eWizard Publisher. Click + to add a minimal list of table object fields required for pulling/pushing table object values.

Information key

The eWizard database field the value from which will be autopopulated for the first content item publication (if this value exists). You can configure the metadata prepopulation with the values available in the eWizard database instead of entering them from scratch. This property works for the Brand (Product in Veeva Vault PromoMats), Country, and Language metadata fields only. To allow users to select the menu options instead of entering values with the keyboard during the publication process, enter one of the following options: brand, country, or language.

Filter expression

Filtering rules that define conditions for data filtering within the eWizard Publisher. Enter the filter expression formula in the markup language of Veeva Vault PromoMats to retrieve specific subsets of data based on criteria they define to show and allow only those records that are relevant to the selected record of another object field.

Filter expression mapping

Mapping of the fields from the relation table object with the objects used in the expression formula filters. Click + and enter keys from Veeva Vault PromoMats to secure the required mapping and control the visibility or inclusion of data based on predefined criteria.

Related object list field setup

For the Related object list field type, the following optional properties are available:

Property

Description

Default value

The object field value to be autopopulated by default for the first content item publication. For the next publications or the update flow, the default value will be replaced by the matching value from Veeva Vault PromoMats. In Business Admin by default, this field contains the initial value representing an empty object with no ID and no name in the following format: [{"id":"","name":""}]. This object format empowers the correct work of eWizard Publisher and also this field type. To add a certain default value, enter its ID and name in the matching quotation marks.

Sorting options

Sorting order of values based on their names to display on the Publisher interface. Click + to define the sorting criteria for this field type. In the input field pair that appears, enter orderBy in the field on the left, and the required field key to determine the sorting–in the field on the right. Click + again and enter sortOrder in the field on the left, in the field on the right, enter ASC to sort list options in ascending order or DSC for descending order. Such setup ensures that the object list is displayed in a meaningful and easy-to-navigate way.

Table

A subordinate field to Veeva Vault objects. Enter the API key of the Veeva Vault object to extract its values to this field.

Table fields

A dedicated property to secure the correct processing of field mapping between Veeva Vault PromoMats in eWizard Publisher. Click + to add a minimal list of table object fields required for pulling/pushing table object values.

Information key

The eWizard database field the value from which will be autopopulated for the first content item publication (if this value exists). You can configure the metadata prepopulation with the values available in the eWizard database instead of entering them from scratch. This property works for the Brand (Product in Veeva Vault PromoMats), Country, and Language metadata fields only. To allow users to select the menu options instead of entering values with the keyboard during the publication process, enter one of the following options: brand, country, or language.

Relation table

The outbound relationship table API key. You can find this key on the Object > Relationships tab in Veeva Vault PromoMats.

Relation search fields

Fields in the relation table object that filter its values based on the previously selected metadata values for the corresponding fields.

Filter expression

Filtering rules that define conditions for data filtering within the eWizard Publisher. Enter the filter expression formula in the markup language of Veeva Vault PromoMats to retrieve specific subsets of data based on criteria they define to show and allow only those records that are relevant to the selected record of another object field.

Filter expression mapping

Mapping of the fields from the relation table object with the objects used in the expression formula filters. Click + and enter keys from Veeva Vault PromoMats to secure the required mapping and control the visibility or inclusion of data based on predefined criteria.

Filters

Used to filter the relation table object values when an outbound relationship is not applied. This property contains fields from the relation table object that are used to filter its values.

Multi-related object list field setup

For the Multi-related object list field type, the following optional properties are available:

Property

Description

Default value

The object field value to be autopopulated by default for the first content item publication. For the next publications or the update flow, the default value will be replaced by the matching value from Veeva Vault PromoMats. In Business Admin by default, this field contains the initial value representing an empty object with no ID and no name in the following format: [{"id":"","name":""}]. This object format empowers the correct work of eWizard Publisher and also this field type. To add a certain default value, enter its ID and name in the matching quotation marks.

Sorting options

Sorting order of values based on their names to display on the Publisher interface. Click + to define the sorting criteria for this field type. In the input field pair that appears, enter orderBy in the field on the left, and the required field key to determine the sorting–in the field on the right. Click + again and enter sortOrder in the field on the left, in the field on the right, enter ASC to sort list options in ascending order or DSC for descending order. Such setup ensures that the object list is displayed in a meaningful and easy-to-navigate way.

Table

A subordinate field to Veeva Vault objects. Enter the API key of the Veeva Vault object to extract its values to this field.

Table fields

A dedicated property to secure the correct processing of field mapping between Veeva Vault PromoMats in eWizard Publisher. Click + to add a minimal list of table object fields required for pulling/pushing table object values.

Information key

With this field, you can configure the metadata prepopulation with the values available in the eWizard database instead of entering them from scratch. This property works for the Brand (Product in Veeva Vault PromoMats), Country, and Language metadata fields only. To allow users to select the menu options instead of entering values with the keyboard during the publication process, enter one of the following options: brand, country, or language.

Relation table

The outbound relationship table API key. You can find this key on the Object > Relationships tab in Veeva Vault PromoMats.

Relation search fields

Fields in the relation table object that filter its values based on the previously selected metadata values for the corresponding fields.

Filter expression

Filtering rules that define conditions for data filtering within the eWizard Publisher. Enter the filter expression in the markup language of Veeva Vault PromoMats to retrieve specific subsets of data based on criteria they define to show and allow only those records that are relevant to the selected record of another object field.

Filter expression mapping

Mapping of the fields from the relation table object with the objects used in the expression formula filters. Click + and enter keys from Veeva Vault PromoMats to secure the required mapping and control the visibility or inclusion of data based on predefined criteria.

Filters

Used to filter the relation table object values when an outbound relationship is not applied. This property contains fields from the relation table object that are used to filter its values.

Document list

For the Document list field type, the following optional properties are available:

Property

Description

Default value

The default value to display on the DETAILS step of publication for this field type. We recommend leaving this field empty as PDF files are pulled dynamically during publication.

Document fields

API keys of document fields in Veeva Vault PromoMats used for searching for PDF files. The same keys are used to link PDF files to Interactive documents. For example, to search for PDF files by name, enter the name__v key; to search for PDF files by document number, use the document_number__v key. To link the latest version of the selected PDF file during publication, configure both major_version_number__v and minor_version_number__v API keys.

Allowed status

The document statuses allowed for PDF file selection during publication. Enter the names of document statuses you have configured for PDF files in Veeva Vault PromoMats. As a result, when user tries to select a PDF file with a status not listed here, this document remains unavailable for selection on the Publisher interface.

Filters

Used to filter document types supported when searching for PDF documents stored in Veeva Vault PromoMats. To specify search criteria, click + and add the field key and its matching value.

Related document

Configuration of the document linkage with the related interactive document during publishing to secure the correct linkage of PDF to the interactive document in Veeva Vault PromoMats. To use this relation, select the Active checkbox and enter the required API key of the Veeva Vault field within the Relationships tab.

Did this answer your question?