Skip to content

Fixes #973 - Remove restrictions about MySQL (because no longer supported) #1091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ralf401 merged 1 commit into from
Mar 17, 2026
Merged

Fixes #973 - Remove restrictions about MySQL (because no longer supported) #1091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 49 additions & 53 deletions locale/admin-docs.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Zammad Admin Documentation pre-release\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-03-17 10:13+0100\n"
"POT-Creation-Date: 2026-03-17 10:34+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -3611,7 +3611,7 @@ msgstr ""
#: ../manage/report-profiles.rst:49
#: ../manage/scheduler.rst:109
#: ../manage/slas.rst:64
#: ../system/objects/types.rst:275
#: ../system/objects/types.rst:271
msgid "Preview"
msgstr ""

Expand Down Expand Up @@ -5878,7 +5878,7 @@ msgstr ""
#: ../index.rst:96
#: ../index.rst:96
#: ../manage/roles/permissions.rst:291
#: ../system/objects/types.rst:283
#: ../system/objects/types.rst:279
msgid "Misc"
msgstr ""

Expand Down Expand Up @@ -22416,202 +22416,198 @@ msgid "Zammad just looks for the defined list and value keys, reads the content
msgstr ""

#: ../system/objects/types.rst:180
msgid "The usage of a PostgreSQL database for Zammad is required. In any other case, Zammad will hide the external data source type and you are not able to use it. If you want to use this feature, consider to :docs:`migrate your database </appendix/migrate-to-postgresql.html>`."
msgstr ""

#: ../system/objects/types.rst:184
msgid "Only ``GET`` is supported as request method."
msgstr ""

#: ../system/objects/types.rst:185
#: ../system/objects/types.rst:181
msgid "The data structure must be in JSON format and provide the objects in an array."
msgstr ""

#: ../system/objects/types.rst:187
#: ../system/objects/types.rst:183
msgid "The endpoint for the external data source has to support search. On Zammad side, there is no search/logic implemented; however, you can define the output key and value based on the result(s) from the response (which provides already filtered content based on the search)."
msgstr ""

#: ../system/objects/types.rst:191
#: ../system/objects/types.rst:187
msgid "If you receive more results as expected, your external data source search may not work properly or the structure of the URL is not correct. You should get in touch with a responsible person from the external system."
msgstr ""

#: ../system/objects/types.rst:196
#: ../system/objects/types.rst:192
msgid "Please have a look :doc:`at our example </system/objects/external-data-source-example>`, where you can find a possible configuration, using a public dummy endpoint."
msgstr ""

#: ../system/objects/types.rst:None
msgid "Available settings for external data source fields"
msgstr ""

#: ../system/objects/types.rst:220
#: ../system/objects/types.rst:216
msgid "Search URL"
msgstr ""

#: ../system/objects/types.rst:206
#: ../system/objects/types.rst:202
msgid "Set your endpoint where Zammad fetches the data. Please make sure to include a valid search :doc:`variable </misc/variables>` as an URL parameter. Example for a free text search at user input: ``#{search.term}``"
msgstr ""

#: ../system/objects/types.rst:211
#: ../system/objects/types.rst:207
msgid "If in doubt, ask the responsible person for the external data source how they expect the structure of the URL."
msgstr ""

#: ../system/objects/types.rst:215
#: ../system/objects/types.rst:211
msgid "Depending on your search variable, the preview might work or not. The reason is that the context might not be available and it is no bug."
msgstr ""

#: ../system/objects/types.rst:218
#: ../system/objects/types.rst:214
msgid "Please also make sure to use a variable which is available in your object context. For example you won't be able to search for a ticket in a user object context."
msgstr ""

#: ../system/objects/types.rst:230
#: ../system/objects/types.rst:226
msgid "SSL Verification"
msgstr ""

#: ../system/objects/types.rst:223
#: ../system/objects/types.rst:219
msgid "Here you can switch the SSL verification to no."
msgstr ""

#: ../system/objects/types.rst:227
#: ../system/objects/types.rst:223
msgid "If your external data source system is using self signed certificates, please have a look :doc:`here </settings/security/ssl-certificates>` for further information about how to handle them in Zammad, so you can keep the SSL verification activated."
msgstr ""

#: ../system/objects/types.rst:236
#: ../system/objects/types.rst:232
msgid "HTTP Authentication"
msgstr ""

#: ../system/objects/types.rst:233
#: ../system/objects/types.rst:229
msgid "If your external data source requires an authentication, you can set it here. You can leave it empty or choose between *Basic Authentication* or *Authentication Token* (selecting one of the two methods leads to additional fields where you can enter your credentials/token)."
msgstr ""

#: ../system/objects/types.rst:243
#: ../system/objects/types.rst:239
msgid "Search result list key"
msgstr ""

#: ../system/objects/types.rst:239
#: ../system/objects/types.rst:235
msgid "Defines the level in the JSON structure which provides the list with search results. You can leave it empty, if the data is already provided as an array. If you have to go deeper in the structure, you can provide a path with ``.`` as separators, e.g. ``key.subkey.sub-sub-key``."
msgstr ""

#: ../system/objects/types.rst:249
#: ../system/objects/types.rst:245
msgid "Search result value key"
msgstr ""

#: ../system/objects/types.rst:246
#: ../system/objects/types.rst:242
msgid "Defines the attribute in the structure in which your external data source provides the *value* for your data. An example would be a product *number*. If you have to go deeper in the structure, you can provide a path with ``.`` as separators, e.g. ``key.subkey.sub-sub-key``."
msgstr ""

#: ../system/objects/types.rst:255
#: ../system/objects/types.rst:251
msgid "Search result label key"
msgstr ""

#: ../system/objects/types.rst:252
#: ../system/objects/types.rst:248
msgid "Defines the attribute in the structure in which your external data source provides the *label* for your data. An example would be a product *name*. If you have to go deeper in the structure, you can provide a path with ``.`` as separators, e.g. ``key.subkey.sub-sub-key``."
msgstr ""

#: ../system/objects/types.rst:258
#: ../system/objects/types.rst:254
msgid "In the preview area, you can find the following items (depending on your configuration above):"
msgstr ""

#: ../system/objects/types.rst:261
#: ../system/objects/types.rst:257
msgid "**Error/hint message** (only if configuration is not complete): Zammad tells you, if there is a problem and what you should change in your configuration."
msgstr ""

#: ../system/objects/types.rst:264
#: ../system/objects/types.rst:260
msgid "**Search field**: search for an existing attribute in the data source to get a preview. This is required for the fields below to show up."
msgstr ""

#: ../system/objects/types.rst:266
#: ../system/objects/types.rst:262
msgid "**Search result response** (only if configuration is not complete): here you can find a syntax highlighted JSON preview of the response, based on the search term you entered."
msgstr ""

#: ../system/objects/types.rst:269
#: ../system/objects/types.rst:265
msgid "**Search result list** (only if *search result list key* is properly set): output of the structure under the configured *search result list key*."
msgstr ""

#: ../system/objects/types.rst:272
#: ../system/objects/types.rst:268
msgid "**Preview table** (when fully configured): Zammad shows you a table which includes the found items based on the search string (value, label and optional link). You can use this preview if you don't have the complete data structure of the external system in mind."
msgstr ""

#: ../system/objects/types.rst:277
#: ../system/objects/types.rst:273
msgid "An example of a configured external data source field from agent perspective:"
msgstr ""

#: ../system/objects/types.rst:None
msgid "Screencast showing the search for a product in a ticket"
msgstr ""

#: ../system/objects/types.rst:288
#: ../system/objects/types.rst:284
msgid "Link-Template"
msgstr ""

#: ../system/objects/types.rst:290
#: ../system/objects/types.rst:286
msgid "Link templates allow you to generate dynamic URLs based on the content of the attribute. This way you can define a base URL and add a variable for the field's content, for example in a search query or as a product ID. After adding content to a link-template field, a URL icon appears on its right side. Clicking the icon opens a new browser tab with the generated URL."
msgstr ""

#: ../system/objects/types.rst:296
#: ../system/objects/types.rst:292
msgid "Example for a search query URL:"
msgstr ""

#: ../system/objects/types.rst:298
#: ../system/objects/types.rst:294
msgid "Ticket attribute type: **Text Field**"
msgstr ""

#: ../system/objects/types.rst:299
#: ../system/objects/types.rst:295
msgid "Text field type: **Text**"
msgstr ""

#: ../system/objects/types.rst:300
#: ../system/objects/types.rst:296
msgid "Ticket attribute name: ``my_attribute``"
msgstr ""

#: ../system/objects/types.rst:301
#: ../system/objects/types.rst:297
msgid "Link template content: ``https://www.duckduckgo.com/&q=#{ticket.my_attribute}``"
msgstr ""

#: ../system/objects/types.rst:302
#: ../system/objects/types.rst:298
msgid "Added field content: ``zammad``"
msgstr ""

#: ../system/objects/types.rst:303
#: ../system/objects/types.rst:299
msgid "Resulting URL: ``https://www.duckduckgo.com/&q=zammad``"
msgstr ""

#: ../system/objects/types.rst:307
#: ../system/objects/types.rst:303
msgid "You can use any :doc:`Zammad variable </misc/variables>` as long as it's available in the moment you need it."
msgstr ""

#: ../system/objects/types.rst:310
#: ../system/objects/types.rst:306
msgid "Available for the field types *Text* (type: text), *Single Selection*, *Multiple Selection* and *External Data Source*."
msgstr ""

#: ../system/objects/types.rst:315
#: ../system/objects/types.rst:311
msgid "Another great way of communicating with another system may be Zammad's :doc:`Webhooks </manage/webhook>`."
msgstr ""

#: ../system/objects/types.rst:319
#: ../system/objects/types.rst:315
msgid "Translate Field Contents"
msgstr ""

#: ../system/objects/types.rst:321
#: ../system/objects/types.rst:317
msgid "For some attribute types, you can decide if their values should be translatable or not. If they are configured as translatable, they appear in the :doc:`translation interface </system/translations>` as other strings in Zammad. This works only for fields with selectable options because the possible choices are known and limited. You can set the translatable flag for these types:"
msgstr ""

#: ../system/objects/types.rst:328
#: ../system/objects/types.rst:324
msgid "Boolean field"
msgstr ""

#: ../system/objects/types.rst:329
#: ../system/objects/types.rst:325
msgid "Single selection field"
msgstr ""

#: ../system/objects/types.rst:330
#: ../system/objects/types.rst:326
msgid "Multiple selection field"
msgstr ""

#: ../system/objects/types.rst:331
#: ../system/objects/types.rst:327
msgid "Single tree selection field"
msgstr ""

#: ../system/objects/types.rst:332
#: ../system/objects/types.rst:328
msgid "Multiple tree selection field"
msgstr ""

Expand Down
4 changes: 0 additions & 4 deletions system/objects/types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,6 @@ both data sources. It works like this:
and displays the value to the user. There is no search on Zammad side.

.. warning::
* The usage of a PostgreSQL database for Zammad is required. In any other
case, Zammad will hide the external data source type and you are not
able to use it. If you want to use this feature, consider to
:docs:`migrate your database </appendix/migrate-to-postgresql.html>`.
* Only ``GET`` is supported as request method.
* The data structure must be in JSON format and provide the objects in an
array.
Expand Down
Loading