Tagbox

Icon

Behavior

VIDEO: How MultiValue Tagbox Behaves

When you click into the field, you get suggestions. When you type, you get suggestions that match your input. 

The List Display Pattern of the connected list is used for suggestions. Please ensure that the display pattern is adapted for correct suggestions. 

Main benefit

Tags are specific, support searching with a lot of additional attributes, and are easy to maintain. You can add attributes to the tags anytime, which extends the metadata for all tagged Content Items. You can translate only your tags and find your Content Items in all translated languages. 

Tagboxes also support the user when adding metadata by showing suggestions, and the user cannot add wrong spelled product names or person names, so the metadata values are already "validated." By not allowing the creation of new List Items, users must work with approved terms only, and your metadata is safe. 

Note: Permission to create new List Items: "Manage items" in the Schema Permission Set applied to the List.

Support for circular references allows for creating extended schemas.  

Connected List

You can create a tagbox without having the List created. When choosing your connected List you can create one. 

VIDEO: How To Create List From Tagbox Settings

Custom vs. System Lists

System Lists are already available in the system used in various places. You cannot change them or the values.

• Country

• Region

• Language

Custom lists are lists you create for your purposes, like keywords or products or events. 

List Items

The List contains List Items, which have various attributes. The List Item can have a name only or a name, description, and further useful information. 

When you connect the List to a Tagbox, the List Items become tags added to the Content Item, also known as "tagging." 

View mode

In view mode, the display of tags comes from the Name Display Pattern of the List, connected to the Tagbox field. 

Edit mode

In edit mode:

• The assigned tags are displayed as defined in the Name Display Pattern of the List, connected to the Tagbox field. 

• The suggested tags are displayed as defined in the List Display Pattern of the List, connected to the Tagbox field. 

Filters

You can add a tagbox as a filter, using it as facet in the sidebar or for suggestions.

In the filter editor you select the tagbox._refid value as filter field, then you add a text field e.g. tagbox.name as search field. This way the tags are shown with a name. When a user selects a tag the ID is used to find the assigned Content Items, which is more accurate.

Suggestions in the Tagbox

When you click into the Tagbox Field, you get suggestions from the connected List. You can continue typing to drill down the suggestions further to find your desired tag. The suggestions consider the filter defined in the Tagbox Settings. 

The Display Pattern List of the connected list is used for suggestions. Please ensure that the display pattern is adapted for correct suggestions. 

With appropriate permissions, you can add new List Items while editing your Content Item. 

• Permissions: "Manage items" in the Schema Permission Set applied to the List

• Create new tag while editing: 

  • Insert your desired tag.

  • Get the message "No matches found. Add a new [List Name] item".

  • Select the List where you want to add your new List Item.
     This selection shows that the Tagbox connects to a parent List. You can select the correct child Lists your tags. The parent serves as a container for all children, which is used as a base for filters, allowing them to access multiple lists in one filter. 

  • See the fields configured on the List. 

  • Create and find your new tag directly assigned. 

VIDEO: How To Create New Tag While Editing Content Item

Contextual information (card)

The assigned tags in view mode appear as clickable links. When you click the tag, you see a card with further attributes of the List Item. 

The card display consists of: 

• The card title, as defined in the List Display Pattern of the List, connected to the Tagbox field. 

• The card body text, as defined in the Thumbnail Display Pattern of the List, connected to the Tagbox field. 

Examples

• Product List

• Employees

• Campaigns

• Events

Picturepark Setup Example

Layer: Corporate Information (ID: CorporateInformation)

Field: Persons (ID: persons)

Fieldpath

corporateInformation.persons

Usage in Excel

LAYER.TAGBOX-FIELD.CONNECTED-LIST-FIELD

Tagbox in Fieldset in Business Rules

Entering a list item into a tagbox inside a fieldset requires to first initialize the fieldset, then add the value:

1. Assign Layer with Default Value for the Fieldset

   CODE

   {
   	"kind": "AssignLayerAction",
   	"layerId": "Product",
   	"defaultValues": {
   		"fieldsetFieldId": {}
   	},
   	"traceRefId": null
   }

2. Assign Tagbox Items

   JSON

   {
   	"kind": "AssignTagboxItemsAction",
   	"path": "layerId.fieldsetFieldId",
   	"fieldId": "tagboxId",
   	"refIds": "$variable$",
   	"replace": false,
   	"traceRefId": null
   }

Advanced search for field

_exists_:corporateInformation.persons

• This query finds all Content Items with the tagbox available and not empty. 

Advanced search for the field value

Use in Display Pattern

Unique Identifier

_refId

Returned field value

Single:

• Field Id from the underlying schema

• Value in field

Multi: Array

• Field Id from the underlying schema

• Value in field

Name

For single Tagboxes, use the singular for name, e.g., department.
Multi Tagboxes use plural names e.g., persons.

ID

The ID field is the ID of your field, which is used to link to this field. The field ID is always lowercase. The field's ID is set when creating a new field using camel casing. You need the field ID for the configuration of filters or display patterns. 

The ID is automatically created from the name you insert: 

• Example: You insert the field name "My NeW fielDs #1 Purpose?

• Automatic Id: myNeWFielDs1Purpose

You can open the Display Pattern Editor to see the JSON of a Content Item. 

Single item tagbox

Allow one or multiple tags. Once set and saved, this cannot be changed afterward.

Use single item tagbox where you want to make sure only one tag is sufficient like either-or questions, e.g., state (active, passive).

Connected List

This List contains the List Items used as tags within the Tagbox field. You can create a tagbox without having the List created. When choosing your connected List you can create one. 

VIDEO: How To Create List From Tagbox Settings

Item filter

Limit the List Items available for selection by using a filter, e.g., show only actual products or employees from the board of management.

Minimum

Only whole numbers (integers) are supported. Adding a minimum value sets the field required.

Maximum

Setting the maximum value to 1 turns a multi-item tagbox to a single item tagbox; however, we recommend choosing a single item tagbox instead.

Required

Required ensures that editors add at least one tag. 

Sortable

The Sortable field setting defines if Picturepark uses the values of those fields for sorting List Items (in Lists). Sorting of contents based on fields in a Layer is possible via the channel configuration, which only considers fields marked as sortable. All fields except for Geo Point and Relationship fields are sortable. This can be changed after field creation. 

Preview pattern

The option to define which Display Pattern shows in the view mode of the Tagbox. The Preview pattern allows showing the List Display Pattern with additional values instead of the Name Pattern, which shall be short and precise. 

Default Values

Assign the default values for when users create new tags while editing Content Items. When you add default values, you can also create the filter for the Tagbox from them.  

When Picturepark finds Default Values, you find a link above the "Filter" field that allows generating the Filter from Default values. 

VIDEO: How To Create Filter from Default Values

Include in Filters

Sorting of tagboxes and fieldsets uses the "Name" display pattern of the items. There is a language fallback.

Search

Definition of the fields which Picturepark search considers. 

Boost

Picturepark ignores the boost settings of the underlying schema.