Object types¶

When adding a new object, you can choose between the following object types.

Warning

You cannot change the object format / type as soon as it is applied. If you no longer need an object, consider disabling it instead of removing.

Note

What about the translation of my objects?

For some object types you can decide if they should be translatable or not. To be precise, it works only for the selectable fields because the possible choices are known and limited. For the following object types, you can set the translatable flag:

Boolean field

Single selection field

Multiple selection field

Single tree selection field

Multiple tree selection field

For these types, you can find an additional field Translate field contents:

Screenshot showing translatable object types

Screenshot with example of translatable object type¶

Boolean field

Provides a drop-down field with display values for true and false. Allows setting a default value.

Date field

Provides a date picker field and does not allow default values.

Default time diff (hours): This setting helps the user by highlighting the day from now plus the provided value. It does not pre-fill the field.

Date & time field

Provides a date and time picker – does not allow default values

Allow future: Forbid dates and times in the future.

Default: yes
Allow past: Forbid dates and times in the past.

Default: yes
Default time diff (minutes): This setting helps the user by highlighting the day from now plus the provided value. It does not pre-fill the field.

Available settings for Date & time fields

Integer field

Provides an input field that allows integer usage only. You may define a default value. You cannot enforce comma separation.

Minimal: The minimal value the field accepts.
Maximal: The maximum value the field accepts.

Multiple selection field

Provides a selection field that allows the selection of one or more out of several. This field does allow setting a default value.

Tip

Adding values can be tricky for first timers, don’t forget to press “➕ Add” after typing your values. Otherwise you may loose a value.

Hint

This field allows using URL fields (Link Templates).

Available settings for Multiple selection fields

Tip

↕️ This object allows position of its values ↔️

In order to re-arrange the fields options, edit the field and scroll below the values. Make sure to tick the option “Use custom option sort”.

Warning

If you do not tick this field, all manual position you did above will be lost upon saving! ☠️

Now use ☰ to drag the values in question to the correct position. When you’re ready, submit your changes to save the object.

Screencast showing how to re-position values

Single selection field

Provides a drop-down field that allows selection of one value out of several. This field does allow setting a default value.

Tip

Adding values can be tricky for first timers, don’t forget to press “➕ Add” after typing your values. Otherwise you may loose a value.

Hint

This field allows using URL fields (Link Templates).

Available settings for Single selection fields

Tip

↕️ This object allows position of its values ↔️

In order to re-arrange the fields options, edit the field and scroll below the values. Make sure to tick the option “Use custom option sort”.

Warning

If you do not tick this field, all manual position you did above will be lost upon saving! ☠️

Now use ☰ to drag the values in question to the correct position. When you’re ready, submit your changes to save the object.

Textarea field

Provides a text area input field (multiple lines) and thus allows e.g. new lines. You can set a default field value.

Note

Please note that this field does not support text formatting or HTML content (rich text).

Warning

🥵 This field can consume a lot of visual space

Depending on where you use this field type, it may use a lot of visual space if you provide a lot of text. This may be an issue to work with.

Default: The here provided text will be shown within the text area field or new data sets.
Maxlength: You can pick the maximum length of the field.

The default length of this object is 500.
Rows: Change the number of rows to dislay so that you can use only the space you really need.

The default number of rows is 4.

Text field

Provides a text field (one line) and allows choosing a default value.

Type

Defines the type of the input field. This allows e.g. your browser to ensure that you provide the specific type.

Currently available:

Email

Phone

Text

Url (URL fields disable link-template availability)

Maxlength

You can pick the maximum length of the field.

Hint

This field allows using URL fields (Link Templates).

Single tree selection field

Provides a select-like field with up to 6 layers of options. Does not allow setting a default value.

Tip

↕️ This object allows position of its values ↔️

In order to re-arrange the fields options, edit the field and to the values.

Use ☰ to drag the values in question to the correct position. If you want to change the layer depth, double click on ☰. By this you can cycle through the available layers.

When you’re ready, submit your changes to save the object.

Screencast showing how to re-position values on tree select like fields

Available settings for Tree Select fields

Multiple tree selection field

Provides a select-like field with up to 6 layers of options allowing the selection of multiple values. Does not allow setting a default value.

Tip

↕️ This object allows position of its values ↔️

In order to re-arrange the fields options, edit the field and to the values.

Use ☰ to drag the values in question to the correct position. If you want to change the layer depth, double click on ☰. By this you can cycle through the available layers.

When you’re ready, submit your changes to save the object.

URL fields (Link-Template)¶

Note

This function is restricted to Text and Select objects only.

Link-Templates are an amazing way to dynamically generate URLs. They allow you to integrate other systems better without having to manually copy data from Zammad if possible.

Note

Another great way of communicating with another system may be Zammad’s Webhooks.

After filling a link-template enabled field, an URL icon will appear on its right. Clicking on the icon opens a new tab.

Hint

Even though Zammad displays the link template within object edit and create screens, the function is optional. It’s only active if you populate the field.

What’s the difference between URL and text fields with link template…?!¶

Both fields have different use cases. Use text type text fields when ever you have a static url that requires dynamic parameters. If you require a drag & drop like field that you can put in any URL, use URL type text fields.

The difference is easier to spot when comparing the fields directly, below screencast shows the result - the dynamic approach uses existing values in the moment of updating to built the URL - e.g. https://google.com/search?q=cookies - while the URL approach uses the actual URL of the field - e.g. https://zammad.com.

Screencast showing the differents in between URL and text type fields with actual values

How does this work…?!¶

As an example, let’s say you have an object called amazingobject - you want to open a google search directly with the input from that field.

Providing below to the link-template field allows you to do so: https://www.google.com/search?q=#{ticket.amazingobject}

Tip

You can use any Zammad variable as long as it’s available in the moment you need it.

The result will look as follows.

The above screencast shows how the link template will perform after object creation.¶