You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: collections/_documentation/configurations.md
+42-13Lines changed: 42 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ users with the permission `system_configuration` (by default [ROLE_SUPER_ADMIN](
23
23
-`Minute selection for From & To` - steps counter for the "begin time" and "end time" dropdown-menu in the timesheet forms
24
24
-`Minute selection for Duration` - steps counter for the "duration" dropdown-menu in the timesheet forms
25
25
-`Maximum duration of a timesheet record` - maximum duration of a timesheet record in minutes, before update/stop is rejected (eg. to prevent users from booking a whole day). Can be deactivated by setting it to 0.
26
+
-`Break` - Activates break time tracking (a beta feature of Kimai)
26
27
27
28
### Time-tracking modes
28
29
@@ -91,16 +92,16 @@ More examples:
91
92
## Time rounding
92
93
93
94
-`Rounding mode` - see below
94
-
-`Rounding of the start time` - in minutes, zero (0) deactivates this config
95
-
-`Rounding of the end time` - in minutes, zero (0) deactivates this config
96
-
-`Rounding of the duration` - in minutes, zero (0) deactivates this config
97
-
-`Days of the week when rounding will be applied` - on all other days, the real recorded values will be used
95
+
-`Rounding of the start time` - in minutes, zero (0) deactivates this config (recommended 1)
96
+
-`Rounding of the end time` - in minutes, zero (0) deactivates this config (recommended 1)
97
+
-`Rounding of the duration` - in minutes, zero (0) deactivates this config (recommended 3, 6, 9, 12 or 15) [read this chapter]({% link _documentation/rounding.md %})
98
+
-`Days of the week when rounding will be applied` - on all other days, the real recorded values will be used (recommended: all days of the week)
98
99
99
100
Rounding rules are used to round the `begin` and `end` times and the `duration` for timesheet records:
100
101
101
102
- The `end` date of timesheet records will be used to match the day (think of overnight entries)
102
103
- If you set one of `begin`, `end`, `duration` to 0 no rounding will be applied for that field, the exact time (including seconds) is used for calculation
103
-
- The values of the rules are minutes (not the minute of an hour), so 5 for "begin" means we round down to the previous multiple of five
104
+
- The values of the rules are minutes (not the minute of an hour), so 5 for `begin` means we round down to the previous multiple of five
104
105
- Rounding rules will be applied on stopped timesheet records only, so you might see an un-rounded value for the start time and duration until you stop the record
105
106
106
107
These are the existing rounding modes:
@@ -112,7 +113,6 @@ These are the existing rounding modes:
112
113
## Invoices
113
114
114
115
-`Invoice number format` - read more at [invoices]({% link _documentation/invoices.md %})
115
-
-`Simple search` - displays a shorter search form, removing some fields which are used less often
116
116
117
117
## Authentication
118
118
@@ -133,6 +133,7 @@ These are the existing rounding modes:
@@ -152,20 +153,52 @@ You can use increment (for configuring a start value)) and decrement (for adjust
152
153
153
154
-`Display of entries in selection lists` - the display of a project in dropdown fields
154
155
-`Take over teams from the logged-in user when creating new entries` - if this is active, all teams of the currently logged-in users will be copied over to new created project, therefor extending the visibility of the current user (and all his teams) to the new project
155
-
-`Project number format` - format for automatically generated project numbers, allowed replacers are `{pc}`, `{Y}`, `{y}`, `{M}`, `{m}`, `{D}`, `{d}`, `{YY}`, `{yy}`, `{MM}`, `{DD}` (see above at `Customer`)
156
+
-`Project number format` - format for automatically generated project numbers, allowed replacers are `{pc}`, `{Y}`, `{y}`, `{M}`, `{m}`, `{D}`, `{d}`, `{YY}`, `{yy}`, `{MM}`, `{DD}`
156
157
-`Allow multiple usages of the same number` - whether the same number can be used on multiple projects
|`{YY}`| Like {y}, but incrementing until an unused number will be found | 2027 |
169
+
|`{yy}`| Like {y}, but incrementing until an unused number will be found | 27 |
170
+
|`{MM}`| Like {y}, but incrementing until an unused number will be found | 07 |
171
+
|`{DD}`| Like {y}, but incrementing until an unused number will be found | 27 |
172
+
{: .table }
173
+
158
174
## Activity
159
175
160
176
-`Display of entries in selection lists` - the display of an activity in dropdown fields
161
177
-`Activity number format` - format for automatically generated activity numbers, allowed replacers are `{ac}`, `{Y}`, `{y}`, `{M}`, `{m}`, `{D}`, `{d}`, `{YY}`, `{yy}`, `{MM}`, `{DD}` (see above at `Customer`)
162
178
-`Allow multiple usages of the same number` - whether the same number can be used on multiple activities
|`{YY}`| Like {y}, but incrementing until an unused number will be found | 2027 |
190
+
|`{yy}`| Like {y}, but incrementing until an unused number will be found | 27 |
191
+
|`{MM}`| Like {y}, but incrementing until an unused number will be found | 07 |
192
+
|`{DD}`| Like {y}, but incrementing until an unused number will be found | 27 |
193
+
{: .table }
194
+
164
195
## User
165
196
166
197
-`Timezone` - default value for the "create user" form
167
-
-`Country` - default value for the "create user" form
198
+
-`Language` - default value for the "create user" form
199
+
-`Design` - default value for the "create user" form
168
200
-`Currency` - ONLY used to display the users hourly rate
201
+
-`Allow the use of URLs for avatar images` - if activated, you can use a URL for a user avatar image
169
202
170
203
## Theme
171
204
@@ -188,13 +221,9 @@ The default color palette is:
188
221
-`End of visible time range` - the end time of the calendars week and day view (default: 24:00)
189
222
-`Slot duration for week- and day view` - defines the duration for each calendar slot (row) in the week and day views, format: hh:mm:ss (default: 00:30:00 = 30 minutes)
190
223
-`Amount of entries for drag&drop` - amount of rows per drag & drop box (0 = deactivated)
224
+
-`Copies data when adding via drag and drop` - when activated, form details will be populated from last entry
191
225
-`Display of the titles of calendar entries` - which data should be displayed in the title of each calendar entry
192
226
193
-
Not editable right now:
194
-
195
-
-`day_limit` - defined the max amount of items to be displayed for one day in the monthly view (default: 4)
196
-
-`businessHours.days` - defines your working days, which will be highlighted in the weekly and daily view. counting starts with sunday and the index 0, so 1 = monday, ..., 6 = saturday. (default: 1-5 / monday to friday)
197
-
198
227
## My company
199
228
200
229
Kimai offers some configuration settings to adapt the branding to your company:
0 commit comments