Skip to content

Effort

The Effort fieldlet allows tracking time spent on a topic. It appears as a grid in the topic view mode with columns for date, effort type, hours, and the user who created the entry. It is not available in topic edit mode.

Users with write permissions see a "+" button that opens a modal to add effort entries.

Configuration

Effort Type Class

The CI class used to populate the effort type dropdown. Defaults to EffortType.

Holidays Class

The CI class that stores bank holiday dates. Defaults to BankHolidays. Holiday dates are highlighted in red in the date picker.

Section to view

Indicates where the fieldlet will be in the Summary view of the Topic.

  • Header - Shows the fieldlet in the middle of the page.
  • More info - Shows the fieldlet in a new tab "More info" at the bottom of the page.

Effort Entry Fields

When adding a new effort entry, the following fields are available:

  • Effort Type - Select from the configured CI class.
  • Date - A date picker. Future dates are disabled. Bank holidays are highlighted in red.
  • Hours - A whole number between 1 and 24.

Validation Rules

  • Effort cannot be created for a future date.
  • The total hours for a user on a given day across all topics cannot exceed 24.
  • Hours must be a whole number between 1 and 24.

Editing and Deleting

Only the user who created an effort entry can edit or delete it. Edit and delete icons appear in the actions column of the grid for entries created by the current user.

Data Storage

Effort data is stored in a dedicated effort MongoDB collection, separate from the topic document. Each entry contains the topic MID, effort type, date, hours, and creator information.