New time booking feature (#665656)

The time booking feature in ConSol CM has been redesigned to extend its functionality and make is useful out-of-the-box without additional visualizations and scripting. The following features have been added:

• Viewing the time bookings for a case in the new Time bookings tile
• Editing time bookings
• Exporting time bookings as CSV files
• Configuring time booking using the Web Admin Suite

Web Client changes

The following features have been added to the Web Client:

• Dedicated time booking tile: The time bookings are now displayed in their own tile called Time booking. The table includes columns for all information saved about a time booking and can be filtered.
• Exporting time bookings: If the setting Allow export of time bookings is set to true, an Export to CSV button is shown below the time booking table in the case and on the Time booking page. It exports the displayed time bookings to a CSV file.
• Creating time booking reports: When a user has the permission Report all users' time bookings or administrator permissions, a second tile All time bookings is shown on the Time booking page. The user can see all the time bookings in the selected time range and filter by project, case, contact or user. If the export feature is enabled, he can create a CSV report with the displayed bookings.
• Editing own time bookings: When the user has the permission Edit own time bookings, edit and delete icons are shown in the rows of his time bookings. The user can modify the time bookings in a modal window or delete them. The time period while these actions are allowed after creation of a time booking is configured in the setting Time period for editing time bookings (in days).
• Editing other users' time bookings: Users who have the permission Edit all users' own time bookings or administrator permissions see edit and delete icons for all time bookings. They can modify or delete the time bookings in the configured time period.

info

To disable editing and deleting time bookings, you can either not grant the respective permissions or set the time period to 0.

The following features have been changed in the Web Client:

• The fields for creating a time booking have been rearranged in two sections to make the booking process clearer. In the new field Booking method, the user can select an action, or leave the default option Manual to enter the booked time using the date fields. The End field has been added to allow providing the time by entering a start and end time. Alternatively, a start time and a duration can be provided.
• The creation of time bookings on the Time booking page is now consistent with the case page. The only differences being that on the Time booking page, creation is done in a modal window, and that there is a case selector.
• The page customization attribute timeBookingFeature from the scope acimSection has been removed because the time booking tile is configured via sectionsGrid as the other tiles.
• The All time bookings tile on the Time booking page has been renamed to My time bookings. The table layout has been modernized. The bookings can now be filtered by a date range, project or case.

Web Admin Suite changes

The page Time booking has been added to the Web Client menu. It includes all settings which are needed for configuring the time booking feature - regardless of whether they are managed as system properties or page customizations internally.

The settings are grouped in three sections:

• Time booking display: Settings which affect the display of components in the Web Client. Currently available:
  • Show time booking page in the user profile
  • Allow export of time bookings
• Manual time booking: Settings which configure manual time booking in the Web Client. Currently available:
  • Enable manual time booking in cases
  • Show last actions when adding a time booking
  • Time period for editing time bookings (in days)
• Automatic time booking: Settings which configure automatic time booking. Currently available:
  • Enable automatic time booking

The Roles page has been extended with the time booking permissions in the Global permissions tab:

• Read all users' time bookings
• Report all users' time bookings
• Edit all users' time bookings
• Edit own time bookings

Workflow changes

Event triggers which have the option Time booking selected, now react on the editing and deletion of time bookings. There are three types of event TimeBookingCreateEvent, TimeBookingUpdateEvent and TimeBookingDeleteEvent.

You can check which kind of action was performed by getting the event:

var event = workflowApi.getVariable("event")
if(event instanceof TimeBookingCreateEvent){
    //your code
} else {
    //your code
}

DWH changes

All actions related to time bookings (create, edit and delete) are synchronized with the DWH.

Reporting

If your users have the permissions to edit their time bookings, they can directly influence your reports. Only grant this permission after considering the impact on reporting and set the allowed time to edit time bookings according to your reporting needs.

Documentation export

If you use the documentation export on the System documentation page of the Web Admin Suite, you need to adjust the system documentation script to cover the new permissions. Add the following lines to the localizations section:

TIME_BOOKING_READ_OTHERS: "Read all users' time bookings",
TIME_BOOKING_REPORT_OTHERS: "Report all users' time bookings",
TIME_BOOKING_WRITE_OTHERS: "Edit all users' time bookings",
TIME_BOOKING_WRITE_OWN: "Edit own time bookings",