Skip to content

Initial documentation for Ticket Masks #41

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.

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

Open
wants to merge 2 commits into
base: rel-11_0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
Ticket Masks
=========
============

With ticket masks you are able to define your own forms, for specific actions.
Every action (e.g. AgentTicketPhone, CustomerTicketMessage, etc.) can have its own ticket mask.

To create a ticket mask you have to write the definition in YAML-code.

In the following example you see a ticket mask, that enhances the action AgentTicketPhone to look like:

.. figure:: images/ticket-mask-example.png
:alt: Example of a ticket mask for action AgentTicketPhone

Example of a ticket mask for action AgentTicketPhone

If you want to know how to configure this please head over to our :doc:`How-To <../../how-tos/create-ticket-masks>`.
38 changes: 38 additions & 0 deletions content/how-tos/create-ticket-masks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
How-To: Create a Ticket Mask
============================

#. Make sure you have created every dynamic field that should be used in your ticket mask.
#. Create a new ticket mask for the action AgentTicketPhone.
.. figure:: images/create-ticket-mask-change-definition.png
:alt: Create/change mask definition

Create/change mask definition
#. Change the definition to:
.. code-block:: yaml
---
- DF: TitleBuyingFlowers
- DF: Budget
Mandatory: 1
- DF: SetBuyingFlowers
- DF: TitlePersonalData
- Grid:
Columns: 5
Rows:
-
- DF: GivenName
Mandatory: 1
ColumnStart: 2
- DF: Surname
Mandatory: 1
ColumnStart: 3
- DF: RemainingMoney
Readonly: 1
ColumnStart: 4
code
#. Save the definition and test it by opening the action (in our example AgentTicketPhone).

The result look like:
.. figure:: ../administration-area/process-automation/images/ticket-mask-example.png
:alt: Example of a ticket mask for action AgentTicketPhone

Example of a ticket mask for action AgentTicketPhone
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "COPYING".

Published by: Rother OSS GmbH, (https://otobo.de),
Published by: Rother OSS GmbH, (https://otobo.io),
Oberwalting 31, 94339 Leiblfing, Germany.

Authors: OTRS AG (original version), Rother OSS GmbH (https://otobo.de).
Expand Down