Configuring the Hours App

  • Updated on Apr 9, 2025
  • Published on Feb 10, 2025
  • 7 minute(s) read
  • DL
  • Migration Team
 Prev Next

Overview

The Hours App is a dedicated extension designed for seamless time tracking and management. It operates through six core modules: projects, jobs, tasks, work logs, users and teams ensuring precise and organised time entry. However, the Hours App is flexible and can be reused within any configuration to fit your specific time management needs.

Configuring the Project Module

Before configuring the Hours App, you will need to create a number of modules. Follow these steps to create the Project Module:

  1. Navigate to Site Configuration → Site Configuration → Modules.

  2. Click Create Module.

  3. Set the Type to Module.

  4. Specify a Name for the module (e.g., Briefs).

  5. Select a Template (e.g., With Preconfigured Media Settings and Audit Fields).

  6. Click OK to confirm the module creation.

An image highlighting the creation of Project level module named ‘Briefs’

  1. Navigate to Site Configuration → {Module} → Field Definition.

  2. Click New Field.

  3. Enter a Field Name. (e.g. Brief Title)

  4. Ensure the Field Type dropdown is set to Text Field.

  5. Click OK to create the field.

Configuring the Jobs Module

Next you will need to configure the Jobs Module but following the below steps:

  1. Navigate to Site Configuration → Site Configuration → Modules.

  2. Click Create Module.

  3. Set the Type to Module.

  4. Specify a Name for the module (e.g., Jobs).

  5. Select a Template (e.g., With Preconfigured Media Settings and Audit Fields).

  6. Click OK to confirm the module creation.

An image highlighting the creation of Job level module

  1. Navigate to Site Configuration → {Module} → Field Definition.

  2. Click New Field.

  3. Enter a Field Name (e.g. Briefs).

  4. Select Module from the Field Content dropdown.

  5. In the Field Type dropdown, select Select Box.

  6. Locate the Module field and select the Projects module previously created

  7. Within the Module Field dropdown, select the Text Field previously created to define Brief Title.

  8. Click OK to create the field.

  1. Navigate to Site Configuration → {Module} → Field Definition.

  2. Click New Field.

  3. Enter a Field Name. (e.g. Job Name)

  4. Ensure the Field Type dropdown is set to Text Field.

  5. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name. (e.g. Is Admin Job)

  3. Ensure the Field Type dropdown is set to Select Box.

  4. Locate Create, and add a single option labelled Yes

  5. Click OK to create the field.

Configuring the Task Module

Next you will need to configure the Task Module but following the below steps:

  1. Navigate to Site Configuration → Site Configuration → Modules.

  2. Click Create Module.

  3. Set the Type to Module.

  4. Specify a Name for the module (e.g., Tasks).

  5. Select a Template (e.g., With Preconfigured Media Settings and Audit Fields).

  6. Click OK to confirm the module creation.

An image highlighting the creation of Task level module

  1. Navigate to Site Configuration → {Module} → Field Definition.

  2. Click New Field.

  3. Enter a Field Name. (e.g. Task Name)

  4. Ensure the Field Type dropdown is set to Text Field.

  5. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Briefs).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Projects module previously created

  6. Within the Module Field dropdown, select the Text Field previously created to define Brief Title

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Jobs).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Jobs module previously created

  6. Within the Module Field dropdown, select the Text Field previously created to define Job Name.

  7. Click OK to create the field.

Configuring the Worklog Module

Next you will need to configure the Worklog Module but following the below steps:

  1. Navigate to Site Configuration → Site Configuration → Modules.

  2. Click Create Module.

  3. Set the Type to Module.

  4. Specify a Name for the module (e.g., Tasks).

  5. Select a Template (e.g., With Preconfigured Media Settings and Audit Fields).

  6. Click OK to confirm the module creation.

An image highlighting the creation of Worklog module

  1. Click New Field.

  2. Enter a Field Name (e.g. Projects).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Projects module previously created

  6. Within the Module Field dropdown, select the Text Field previously created to define Project Name

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Jobs).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Jobs module previously created

  6. Within the Module Field dropdown, select the Text Field previously created to define Job Name.

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Tasks).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Tasks module previously created

  6. Within the Module Field dropdown, select the Text Field previously created to define Tasks.

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Worker).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Users module

  6. Within the Module Field dropdown, select the Text Field previously created to define Name.

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Start Date).

  3. In the Field Content dropdown, select Date.

  4. Locate the Skeleton field, and define the specific date format option.

  5. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Duration).

  3. In the Field Content dropdown, select Integer.

  4. Locate the Duration Enabled field and ensure it is checked.

  5. In the Duration View As dropdown, select Hour.

  6. In the Duration Round Up To dropdown, choose the desired rounding behaviour.

  7. In the Duration Hours in Day field, specify the default working hours per day.

  8. In the Duration Days in Week field, specify the default working days per week.

  9. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Timer Started At)

  3. In the Field Content dropdown, select Date.

  4. Locate the Skeleton field, and define the specific date format option.

  5. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Timer Ended At)

  3. In the Field Content dropdown, select Date.

  4. Locate the Skeleton field, and define the specific date format option.

  5. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Is running).

  3. In the Field Content dropdown, select Integer.

  4. Click OK to create the field.

Configuring the Teams Module

Next you will need to configure the Teams Module but following the below steps:

  1. Navigate to Site Configuration → Site Configuration → Modules.

  2. Click Create Module.

  3. Set the Type to Module.

  4. Specify a Name for the module (e.g., Departments).

  5. Select a Template (e.g., With Preconfigured Media Settings and Audit Fields).

  6. Click OK to confirm the module creation.

An image highlighting the Team module named ‘Departments’

  1. Click New Field.

  2. Enter a Field Name. (e.g. Department)

  3. Ensure the Field Type dropdown is set to Text Field.

  4. Click OK to create the field.

Configuring the Users Module

Next you will need to configure the Users Module but following the below steps:

  1. Navigate to Site Configuration → Users Configuration → Field Definition

  2. Click New Field.

  3. Enter a Field Name. (e.g. Is Line Manager)

  4. Ensure the Field Type dropdown is set to Select Box.

  5. Locate Create and add two options to the dropdown: Yes and No

  6. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Line Managers).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Users module previously created

  6. Within the Module Field dropdown, select the Text Field that defines users full name

  7. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Working Hours).

  3. In the Field Content dropdown, select Integer.

  4. In the Default Text and specify 8.

  5. Locate the Duration Enabled field and ensure it is checked.

  6. In the Duration View As dropdown, select Hour.

  7. In the Duration Round Up To dropdown, choose the desired rounding behaviour.

  8. In the Duration Hours in Day field, specify the default working hours per day.

  9. In the Duration Days in Week field, specify the default working days per week.

  10. Click OK to create the field.

  1. Click New Field.

  2. Enter a Field Name (e.g. Main Department).

  3. Select Module from the Field Content dropdown.

  4. In the Field Type dropdown, select Select Box.

  5. Locate the Module field and select the Department module previously created

  6. Within the Module Field dropdown, select the Text Field that defines Department

  7. Click OK to create the field.

Configuring the Hours App

To enable the Hours App, follow these steps:

  1. Navigate to Configuration → Apps Library from the sidebar.

  2. Locate the Hours App and click the card.

  3. The app Name will be pre-filled with ‘Hours’. Adjust to your requirements.

  4. Specify whether you wish to Enable Name Concatenation. This option allows for you to display more context about the project, job and task level within the Hours App.

  5. Navigate through each configuration option ensuring to select the fields previous created.

  6. Click Create to confirm settings.

Known behaviour

  • A user should have at least "Read" access to Project, Job, Task and Work Log modules specified within Hours App configuration.

  • A user should have "Read" + "Upload" access to the Work log module to be able to add time registration in Hours App.

  • A user without "Delete" access to the Work log module can deleted already existing work log entries.

  • Status access restrictions are ignored in the Work log module if configured.

  • Date picker respects the browser locale settings.

  • The "Timer started at", "Timer ended at", and "Is running" fields from the Worklog module should be displayed on the form. In case hidden by field usage, timer functionality will not work.

  • The following Duration field settings are currenly not supported in Hours app when entering worklog:  

    • Duration. Hours in day

    • Duration. Days in week

Related articles