Skip to content

Commit 0778cbb

Browse files
authored
Maintenance: Changed text about restart handling (#590 system docs)
1 parent 1b52eaf commit 0778cbb

File tree

2 files changed

+66
-80
lines changed

2 files changed

+66
-80
lines changed

locale/admin-docs.pot

Lines changed: 58 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: Zammad Admin Documentation pre-release\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2024-11-29 15:26+0100\n"
11+
"POT-Creation-Date: 2024-12-17 13:20+0100\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <[email protected]>\n"
@@ -382,7 +382,7 @@ msgstr ""
382382

383383
#: ../channels/email/accounts/account-setup.rst:110
384384
#: ../misc/object-conditions/basics.rst:193
385-
#: ../system/objects.rst:154
385+
#: ../system/objects.rst:152
386386
#: ../system/objects/types.rst:157
387387
msgid "Type"
388388
msgstr ""
@@ -986,8 +986,8 @@ msgstr ""
986986
#: ../system/integrations/cti/includes/inbound-calls.include.rst:15
987987
#: ../system/integrations/cti/includes/inbound-calls.include.rst:15
988988
#: ../system/integrations/cti/includes/outbound-calls.include.rst:18
989-
#: ../system/objects.rst:162
990-
#: ../system/objects.rst:246
989+
#: ../system/objects.rst:160
990+
#: ../system/objects.rst:244
991991
msgid "Note"
992992
msgstr ""
993993

@@ -2634,8 +2634,8 @@ msgstr ""
26342634
#: ../manage/scheduler.rst:39
26352635
#: ../manage/slas/how-do-they-work.rst:26
26362636
#: ../manage/templates.rst:33
2637-
#: ../system/objects.rst:130
2638-
#: ../system/objects.rst:234
2637+
#: ../system/objects.rst:128
2638+
#: ../system/objects.rst:232
26392639
msgid "Name"
26402640
msgstr ""
26412641

@@ -2669,8 +2669,8 @@ msgstr ""
26692669
#: ../manage/scheduler.rst:111
26702670
#: ../manage/templates.rst:43
26712671
#: ../manage/webhook/add.rst:123
2672-
#: ../system/objects.rst:169
2673-
#: ../system/objects.rst:248
2672+
#: ../system/objects.rst:167
2673+
#: ../system/objects.rst:246
26742674
msgid "Active"
26752675
msgstr ""
26762676

@@ -20914,234 +20914,222 @@ msgid "Updating Database After Adding or Editing Attributes"
2091420914
msgstr ""
2091520915

2091620916
#: ../system/objects.rst:58
20917-
msgid "When adding or changing attributes, Zammad will not apply the changes instantly, but instead shows you the changed attributes first. If you're ready to go, just click on \"Update database\" to apply the changes to Zammad. If you made a mistake or just want to discard your changes, click \"Discard changes\"."
20917+
msgid "When adding or changing attributes, Zammad will not apply the changes instantly, but instead shows you the changed attributes first. If you're ready to go, just click on \"Update Database\" to apply the changes to Zammad. If you made a mistake or just want to discard your changes, click \"Discard changes\"."
2091820918
msgstr ""
2091920919

2092020920
#: ../system/objects.rst:64
20921-
msgid "After applying the changes with \"Update Database\", a restart of Zammad is **mandatory**. If you don't perform it, you may experience unexpected behavior or even errors. You may want to do this kind of configuration during maintenance windows."
20921+
msgid "After applying the changes with \"Update Database\", a restart of Zammad is **mandatory**. In most cases, the restart of the service works out of the box (see :docs:`console commands </admin/console/zammad-settings.html>` for more information). However, if your system is configured differently and you don't perform the restart, you may experience unexpected behavior or even errors. You may want to do this kind of configuration during maintenance windows."
2092220922
msgstr ""
2092320923

20924-
#: ../system/objects.rst:72
20924+
#: ../system/objects.rst:76
2092520925
msgid "Changes on objects require you to update the database to apply these changes."
2092620926
msgstr ""
2092720927

20928-
#: ../system/objects.rst:75
20929-
msgid "**🤓 Service restarts can be automated**"
20930-
msgstr ""
20931-
20932-
#: ../system/objects.rst:0
20933-
msgid "Hosted environments automatically restart for you."
20934-
msgstr ""
20935-
20936-
#: ../system/objects.rst:0
20937-
msgid "If you're using a self-hosted installation you can use :docs:`environment variables </appendix/configure-env-vars.html>`"
20938-
msgstr ""
20939-
20940-
#: ../system/objects.rst:82
20928+
#: ../system/objects.rst:80
2094120929
msgid "System Attributes"
2094220930
msgstr ""
2094320931

20944-
#: ../system/objects.rst:84
20932+
#: ../system/objects.rst:82
2094520933
msgid "Zammad comes with pre-configured attributes. Some of them can't be edited via UI (or at all). This is required for proper operation of Zammad and not a bug."
2094620934
msgstr ""
2094720935

20948-
#: ../system/objects.rst:90
20936+
#: ../system/objects.rst:88
2094920937
msgid "Ticket State"
2095020938
msgstr ""
2095120939

20952-
#: ../system/objects.rst:92
20940+
#: ../system/objects.rst:90
2095320941
msgid "If the pre-configured states aren't enough for you or you want to change them, you can do so by clicking on the cogwheel icon in the state row in the ticket tab. But you should be careful when changing pre-configured states. This can lead to unwanted behavior in some cases."
2095420942
msgstr ""
2095520943

2095620944
#: ../system/objects.rst:None
2095720945
msgid "Screenshot showing highlighted ticket state attribute"
2095820946
msgstr ""
2095920947

20960-
#: ../system/objects.rst:122
20948+
#: ../system/objects.rst:120
2096120949
msgid "Handling of states"
2096220950
msgstr ""
2096320951

20964-
#: ../system/objects.rst:102
20952+
#: ../system/objects.rst:100
2096520953
msgid "In the state configuration screen, you can add new states, disable states or change states."
2096620954
msgstr ""
2096720955

2096820956
#: ../system/objects.rst:0
2096920957
msgid "Screenshot showing table of default ticket states"
2097020958
msgstr ""
2097120959

20972-
#: ../system/objects.rst:110
20960+
#: ../system/objects.rst:108
2097320961
msgid "To add a new state, click on the \"New Ticket State\" button in the top right corner. To change an existing state, simply click on the affected state. This opens an edit dialog."
2097420962
msgstr ""
2097520963

20976-
#: ../system/objects.rst:114
20964+
#: ../system/objects.rst:112
2097720965
msgid "You can also clone a state or set them to \"Default for new tickets\" or \"Default for follow-ups\" by clicking on the ⁝ action button and select the desired function."
2097820966
msgstr ""
2097920967

20980-
#: ../system/objects.rst:118
20968+
#: ../system/objects.rst:116
2098120969
msgid "*Default for new tickets* means that this state is used for every newly created ticket."
2098220970
msgstr ""
2098320971

20984-
#: ../system/objects.rst:121
20972+
#: ../system/objects.rst:119
2098520973
msgid "*Default for follow-ups* means that this state is used if the ticket is re-opened after it was closed."
2098620974
msgstr ""
2098720975

20988-
#: ../system/objects.rst:171
20976+
#: ../system/objects.rst:169
2098920977
msgid "Ticket state in detail"
2099020978
msgstr ""
2099120979

20992-
#: ../system/objects.rst:125
20980+
#: ../system/objects.rst:123
2099320981
msgid "Below you can find a description for each field and option. Please head over to the :ref:`example <example-state>` to see the edit dialog."
2099420982
msgstr ""
2099520983

20996-
#: ../system/objects.rst:129
20984+
#: ../system/objects.rst:127
2099720985
msgid "This is the name of the state and what you and your agents are seeing when choosing a state somewhere (e.g. in tickets, trigger configuration)."
2099820986
msgstr ""
2099920987

21000-
#: ../system/objects.rst:137
20988+
#: ../system/objects.rst:135
2100120989
msgid "There are different state types you can choose from. By default, Zammad comes with one state per state type."
2100220990
msgstr ""
2100320991

21004-
#: ../system/objects.rst:140
20992+
#: ../system/objects.rst:138
2100520993
msgid "**new**: for states for tickets that are new and it hasn't been worked on them"
2100620994
msgstr ""
2100720995

21008-
#: ../system/objects.rst:142
20996+
#: ../system/objects.rst:140
2100920997
msgid "**open**: for states for tickets that are in progress and agents are working on them"
2101020998
msgstr ""
2101120999

21012-
#: ../system/objects.rst:144
21000+
#: ../system/objects.rst:142
2101321001
msgid "**merged**: for states for tickets that are merged with other tickets"
2101421002
msgstr ""
2101521003

21016-
#: ../system/objects.rst:145
21004+
#: ../system/objects.rst:143
2101721005
msgid "**pending reminder**: for states for tickets that are in progress and you want to set a reminder. (default example: *pending reminder*)"
2101821006
msgstr ""
2101921007

21020-
#: ../system/objects.rst:147
21008+
#: ../system/objects.rst:145
2102121009
msgid "**pending action**: for states for tickets that are waiting for a specified time and then change their state (default example: *pending close*)"
2102221010
msgstr ""
2102321011

21024-
#: ../system/objects.rst:150
21012+
#: ../system/objects.rst:148
2102521013
msgid "**closed**: for states for tickets that are finished and do not need to be processed further"
2102621014
msgstr ""
2102721015

21028-
#: ../system/objects.rst:153
21016+
#: ../system/objects.rst:151
2102921017
msgid "⚠️ Choosing the correct state type is important! If you are in doubt, have a look on the default states and their types!"
2103021018
msgstr ""
2103121019

21032-
#: ../system/objects.rst:158
21020+
#: ../system/objects.rst:156
2103321021
msgid "Ignore escalation"
2103421022
msgstr ""
2103521023

21036-
#: ../system/objects.rst:157
21024+
#: ../system/objects.rst:155
2103721025
msgid "Here you can define whether tickets of this state will count to escalation time or not."
2103821026
msgstr ""
2103921027

21040-
#: ../system/objects.rst:161
21028+
#: ../system/objects.rst:159
2104121029
msgid "You can create a note for the state to inform other admins about the state. This has no effect on tickets."
2104221030
msgstr ""
2104321031

21044-
#: ../system/objects.rst:165
21032+
#: ../system/objects.rst:163
2104521033
msgid "Set the state to *active* or *inactive*."
2104621034
msgstr ""
2104721035

21048-
#: ../system/objects.rst:167
21036+
#: ../system/objects.rst:165
2104921037
msgid "it is technically possible to set all states to inactive. To keep Zammad working in such a case, the inactive flag of one of the states is ignored."
2105021038
msgstr ""
2105121039

21052-
#: ../system/objects.rst:194
21040+
#: ../system/objects.rst:192
2105321041
msgid "Ticket state example"
2105421042
msgstr ""
2105521043

21056-
#: ../system/objects.rst:174
21044+
#: ../system/objects.rst:172
2105721045
msgid "Let's assume we want to create a new state which indicates that the ticket has to wait for a response of a third party (e.g. service contractor or manufacturer) and we want to to be able to set a reminder."
2105821046
msgstr ""
2105921047

21060-
#: ../system/objects.rst:178
21048+
#: ../system/objects.rst:176
2106121049
msgid "First we give the new state a proper name. In this example we call it \"waiting for manufacturer\"."
2106221050
msgstr ""
2106321051

21064-
#: ../system/objects.rst:181
21052+
#: ../system/objects.rst:179
2106521053
msgid "As state type we choose \"pending reminder\". This indicates that the ticket is still open and we can set a reminder. This reminder can be useful if our manufacturer sometimes isn't responding or we want to remind him to give us an answer."
2106621054
msgstr ""
2106721055

21068-
#: ../system/objects.rst:186
21056+
#: ../system/objects.rst:184
2106921057
msgid "We choose \"no\" for \"ignore escalation\" because we want to escalate the tickets even if we are waiting on the manufacturer's feedback."
2107021058
msgstr ""
2107121059

21072-
#: ../system/objects.rst:189
21060+
#: ../system/objects.rst:187
2107321061
msgid "The **result** in the creation dialog will look like this:"
2107421062
msgstr ""
2107521063

2107621064
#: ../system/objects.rst:0
2107721065
msgid "Screenshot showing ticket state creation dialog with example"
2107821066
msgstr ""
2107921067

21080-
#: ../system/objects.rst:199
21068+
#: ../system/objects.rst:197
2108121069
msgid "Ticket Priority"
2108221070
msgstr ""
2108321071

21084-
#: ../system/objects.rst:201
21072+
#: ../system/objects.rst:199
2108521073
msgid "If the pre-configured priorities aren't enough for you or you want to change them, you can do so by clicking on the cogwheel icon in the priority row in the ticket tab:"
2108621074
msgstr ""
2108721075

2108821076
#: ../system/objects.rst:None
2108921077
msgid "Screenshot showing highlighted ticket priority attribute"
2109021078
msgstr ""
2109121079

21092-
#: ../system/objects.rst:226
21080+
#: ../system/objects.rst:224
2109321081
msgid "Handling of priorities"
2109421082
msgstr ""
2109521083

21096-
#: ../system/objects.rst:210
21084+
#: ../system/objects.rst:208
2109721085
msgid "In the priority configuration screen, you can add new priorities, disable priorities or change priorities."
2109821086
msgstr ""
2109921087

2110021088
#: ../system/objects.rst:0
2110121089
msgid "Screenshot showing table of default ticket priorities"
2110221090
msgstr ""
2110321091

21104-
#: ../system/objects.rst:218
21092+
#: ../system/objects.rst:216
2110521093
msgid "To add a new priority, click on the \"New Priority\" button in the top right corner. To change an existing priority, simply click on the affected priority. This opens an edit dialog."
2110621094
msgstr ""
2110721095

21108-
#: ../system/objects.rst:222
21096+
#: ../system/objects.rst:220
2110921097
msgid "You can also clone a priority or set them to \"Default for new tickets\" by clicking on the ⁝ action button and select the desired function."
2111021098
msgstr ""
2111121099

21112-
#: ../system/objects.rst:225
21100+
#: ../system/objects.rst:223
2111321101
msgid "*Default for new tickets* means that this priority is used for every newly created ticket."
2111421102
msgstr ""
2111521103

21116-
#: ../system/objects.rst:248
21104+
#: ../system/objects.rst:246
2111721105
msgid "Priorities in detail"
2111821106
msgstr ""
2111921107

21120-
#: ../system/objects.rst:229
21108+
#: ../system/objects.rst:227
2112121109
msgid "Below you can find a description for each field and option."
2112221110
msgstr ""
2112321111

21124-
#: ../system/objects.rst:232
21112+
#: ../system/objects.rst:230
2112521113
msgid "This is the name of the priority and what you and your agents are seeing when choosing a priority somewhere (e.g. in tickets, trigger configuration)."
2112621114
msgstr ""
2112721115

21128-
#: ../system/objects.rst:242
21116+
#: ../system/objects.rst:240
2112921117
msgid "Highlight color"
2113021118
msgstr ""
2113121119

21132-
#: ../system/objects.rst:237
21120+
#: ../system/objects.rst:235
2113321121
msgid "Switch between *Low priority* (light blue), *High priority* (red) and - (default). This affects the displayed color for ticket titles in overviews."
2113421122
msgstr ""
2113521123

21136-
#: ../system/objects.rst:241
21124+
#: ../system/objects.rst:239
2113721125
msgid "The color options are currently limited to the mentioned options."
2113821126
msgstr ""
2113921127

21140-
#: ../system/objects.rst:245
21128+
#: ../system/objects.rst:243
2114121129
msgid "You can create a note for the priority to inform other admins about the priority. This has no effect on tickets."
2114221130
msgstr ""
2114321131

21144-
#: ../system/objects.rst:249
21132+
#: ../system/objects.rst:247
2114521133
msgid "Set the priority to *active* or *inactive*."
2114621134
msgstr ""
2114721135

system/objects.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,27 +57,25 @@ Updating Database After Adding or Editing Attributes
5757

5858
When adding or changing attributes, Zammad will not apply the changes instantly,
5959
but instead shows you the changed attributes first.
60-
If you're ready to go, just click on "Update database" to apply the changes
60+
If you're ready to go, just click on "Update Database" to apply the changes
6161
to Zammad. If you made a mistake or just want to discard your changes, click
6262
"Discard changes".
6363

6464
After applying the changes with "Update Database", a restart of Zammad
65-
is **mandatory**. If you don't perform it, you may experience unexpected
66-
behavior or even errors. You may want to do this kind of configuration
67-
during maintenance windows.
65+
is **mandatory**. In most cases, the restart of the service works
66+
out of the box (see
67+
:docs:`console commands </admin/console/zammad-settings.html>` for more
68+
information).
69+
However, if your system is configured differently and you don't perform the
70+
restart, you may experience unexpected behavior or even errors. You may want
71+
to do this kind of configuration during maintenance windows.
6872

6973
.. figure:: /images/system/objects/update-database.png
7074
:align: center
7175

7276
Changes on objects require you to update the database
7377
to apply these changes.
7478

75-
.. tip:: **🤓 Service restarts can be automated**
76-
77-
| Hosted environments automatically restart for you.
78-
| If you're using a self-hosted installation you can use
79-
:docs:`environment variables </appendix/configure-env-vars.html>`
80-
8179
System Attributes
8280
-----------------
8381

0 commit comments

Comments
 (0)