3.7. Working Time Schedules
The system allows you to create working time schedules that can be used in business processes to calculate Due Dates and Deadlines for user tasks.
Schedules can be created by users with the Admin / Developer / OrganizationManager roles.
3.7.1. Day Schedule Templates
Administrators can create day schedule templates, which can later be used when configuring working time cycles or exception working days.
To create a day schedule template, open the Organization Structure workspace, then open the Working Time Schedules folder, select the Day Schedule Templates shortcut, and click Add.
Fill in the required fields listed in the table below, and then click Save.
| Field Name | Description |
|---|---|
| Code | Unique day schedule template code — filled in automatically |
| Name* | Display name of the day schedule template |
| Description | Description of the day schedule template |
| Intervals* | Working time intervals |
When adding intervals, the system automatically calculates the total number of working hours. By default, intervals use a 30-minute step. If you need to use a different interval value, configure the intervals first, then click the gear icon and select Edit Working Time JSON Configuration. You can then define the required interval in JSON format without changing the data structure.
3.7.2. Working Time Cycle Templates
Administrators can create working time cycle templates, which are used when configuring working time schedules.
To create a working time cycle template, open the Organization Structure workspace, then open the Working Time Schedules folder, select the Working Time Cycle Templates shortcut, and click Add.
Fill in the required fields listed in the table below, and then click Save.
| Field Name | Description |
|---|---|
| Code | Unique template code — filled in automatically |
| Name* | Display name of the template |
| Description | Description of the template |
| Cycle Type* | Switch between: Week / Custom |
| Working Time Configuration | Working hour configuration for cycle days |
The system supports two cycle types:
- Week — a 7-day cycle from Monday to Sunday
- Custom — allows configuring a custom number of cycle days
To configure working time settings, after selecting the cycle type, specify working hours for each cycle day that is not a day off. To do this, click Edit.
Then select the day type.
If the day is a working day, configure the working time intervals. You can either configure them manually or apply previously created Day Schedule Templates. The system will display the total number of working hours for the current day.
You can copy the working time configuration to the next day by clicking Copy to Next Day.
To make a day a non-working day, click Set as Day Off. This will remove the working time configuration for the selected day.
After configuring the working time settings, the system will display the total number of working hours for the entire cycle.
You can also edit working time cycle settings in JSON format. To do this, click the gear icon and select Edit Working Time JSON Configuration. You can then configure the required settings in JSON format without changing the data structure.
3.7.3. Working Time Schedules
Administrators can create working time schedules that can be used in business processes to calculate Due Dates and Deadlines for user tasks.
To create a working time schedule, open the Organization Structure workspace, then open the Working Time Schedules folder, select the Working Time Schedules shortcut, and click Add.
Fill in the required fields listed in the table below, and then click Save.
| Field Name | Description |
|---|---|
| Code | Unique schedule code — filled in automatically |
| Name* | Display name of the schedule |
| Description | Description of the schedule |
| Working Cycle Assignments* | Defines the validity period and working time cycle. Multiple cycles can be added |
| Exception Days | Adds exception days applied to the working time schedule |
After filling in the required fields and saving the schedule, the Set as Default and Switch to Calendar Mode buttons will become available.
When a schedule is set as the default, its code is automatically added to the system setting with the calendar.wtSchedule.default code. This setting supports localization, allowing you to configure different schedules for different locales.
You can also configure a time zone for the working time schedule. If a time zone is configured for the schedule, the system will calculate deadlines based on that time zone.
It is also possible to configure a time zone in the calendar.timezone.default system setting. In this case, the system uses this time zone when calculating deadlines. If time zones are configured both in the system settings and in the working time schedule, the schedule time zone takes priority during calculations. This setting supports localization, allowing different time zones to be configured for different locales.
If no time zone is configured in either the schedule or the system settings, deadline calculations are performed using the time zone configured on the server where the system is deployed.
You can add exception days to a working time schedule, such as non-working or working days that do not match the configured working time cycle. To do this, in the default mode, click Add in the Exception Days table.
You can then specify an exception day description, select a date, and define the day type. If the day is a working day, configure the working time settings either manually or by applying existing Day Schedule Templates.
To delete an existing exception day, select it in the table, open the context menu, and select Delete, or open the exception day form and click Delete.
Calendar mode displays applied working time cycles and exception days. If a day contains more than four working time intervals, all intervals will be displayed when hovering over the day in the calendar. Exception days are displayed with their names, if a description was specified during creation.
Four calendar view modes are available: Agenda, Month (default), Week, and Day. You can switch between views by clicking the corresponding mode button.
Using the context menu in calendar mode, you can create, open, or delete exception days.
You can also edit working time schedule settings in JSON format. To do this, click the gear icon and select Edit Working Time JSON Configuration. You can then configure the required settings in JSON format without changing the data structure.
3.7.4. Use a Working Time Schedule in a Business Process
Configured working time schedules can be used in business processes for user tasks. To do this:
-
Open the user task in the process modeler, go to the Assignments tab, and click Edit for either Due Date or Deadline.
-
In the deadline configuration form, select the start date:
- Task creation date and time
- From process variable — specify the process variable code that contains the date. The variable value must be a string in ISO 8601 format, for example:
2023-08-02T10:55:24.454Z, in the UTC time zone
-
Configure the offset:
- From process variable — specify the process variable code that contains the offset value. The variable value must use the following format:
2d,10h,100m - Fixed value — allows setting the offset in minutes, hours, or days
- From process variable — specify the process variable code that contains the offset value. The variable value must use the following format:
-
Select the working time schedule:
- Default system schedule — applies the default working time schedule configured in the system
- From process variable — specify the process variable code that contains the working time schedule code
- Fixed value — allows selecting one of the working time schedules created in the system
After configuring the settings in the form, the applied configuration description will be displayed.
When the user task is created, the due date will be calculated according to the configured working time schedule.