Configure Time Recording

Was this article helpful?

Global feature

Time Recording Feature Configuration

The Time Recording global feature controls how time is captured, recorded, and submitted across the system. 

Modeller > Global Features > Time Recording

You can enable or disable time recording at any point by toggling it on or off from the feature list.

Click the settings cog to access the settings.  This opens the Time Recording Feature blade. 

Work Type Configuration

Click the cog icon to open the work type configuration blade.  This lists all the work types.  

Click the right arrow next to a work type to enable time recording against it.  Toggle the option on/off.  When toggled on, the configuration settings display.

Restrict available time categories Toggle on to restrict what time categories can be used on this work type.  When switched on select the time category to restrict.
Default time category Sets the category that is pre-selected when a user records time against this work type. Typical options include Billable and Non-Billable.
Automated narrative Sets a default narrative that is pre-populated when time is recorded. You can also configure whether a narrative is mandatory or optional.
Automated stopwatch triggers

Controls what happens when an automated stopwatch opens for this work type. Options are: start recording automatically on open; stop recording on close.

Blade stack behaviour - A blade stack is when multiple blades are open at the same time. This setting controls how stopwatch recording behaves across stacked blades - for example, whether time records against all open blades or only the parent work item (such as the matter).

Phase change triggers Configures the stopwatch to start or stop automatically when the work item moves into a specific phase. For example, start the stopwatch when a task moves to In Progress, and stop it when it moves to Done.
Fixed time recording Sets a fixed amount of time (in minutes) to be automatically recorded when a work item reaches a specified phase. For example, record 30 minutes whenever a document moves to Done. Users can still record additional time on top of this fixed amount.

Blade Layout

Time Recording Blade Layout

Introduced in release 7.12 to incorporate Extended Narrative.

 

Set how you want the narrative to display on the time recording blade. 

Two options:

  • Standard - the existing time recording blade (default)
  • Extended Narrative - the new document-style blade

The default value is Standard. This setting can be changed at any time to apply the selected layout across all time recording entries for the firm.

Extended Narrative blade behaviour

When the Extended Narrative layout is selected, the following applies when a user opens a manual time entry via the clock icon ribbon button on a work item:

  • The Extended Narrative blade displays in place of the standard blade
  • The narrative box is free text and auto-expands to accommodate the content as the user types
  • When a stopwatch entry is stopped and the time entry is opened, the Extended Narrative field is present

Example Standard blade

Example Extended Narrative blade

Unit of measure

Unit of measure Sets whether time is recorded in hours or units.
Rounding behaviour Sets how recorded time is rounded, either up or to the nearest interval.
Minimum lapse time Sets the minimum time interval that rounding is applied to.

Stopwatch behaviour

On stop

Controls how time entries are created when a stopwatch is stopped.  

  • Record a single consolidated time entry
    or
  • Record one entry per day 
    Useful when a recording spans multiple days.
On pause When enabled, records a time entry immediately each time a stopwatch is paused, rather than waiting for it to be stopped.
Minimum duration Sets the shortest recording that will generate a time entry. For example, set to 30 seconds so that briefly opening a task does not create an entry.
Maximum duration Sets the longest duration a stopwatch can run before it is capped.
Browser navigate/close action Controls what happens if a user navigates away from the page or closes a tab while a stopwatch is running. Options include pausing the stopwatch or prompting the user before they leave.

Automatic stopwatch behaviour

Prevent user overrides.  When enabled, users cannot change or override the time codes set by automated stopwatches. This applies where a stopwatch has been configured to default to a specific time code.

Time Entry Creation Behaviour

Minimum & maximum narrative length

Maximum narrative length introduced in release 7.12

 

The Minimum narrative length can be used to make the narrative mandatory if set to greater than 0.

The Maximum narrative length sets an optional character limit on the narrative field. Leave it blank to apply no limit. The maximum must be greater than the minimum narrative length. If the minimum is not set, it is treated as 0, so any value greater than 0 is valid.

When a maximum value is set:

  • Users cannot submit a narrative that exceeds the limit. If a user enters more characters than the maximum allows, the narrative field displays how many characters are over the limit.
  • Auto-generated narratives that exceed the limit are capped automatically.
  • If the field is left blank, no maximum applies.

The message displayed in the narrative field depends on how minimum and maximum lengths are configured.

Configuration Message displayed
Minimum only

Must be at least X characters long

This message disappears once the user has entered enough characters to meet the minimum.

Minimum and maximum Must be between X and Y characters long
Maximum only No message; over-limit count shown if exceeded
Neither set No message
Require time code When enabled, users must select a time code before a time entry can be saved.

Stopwatch toast behaviour

Inform users of stopwatch events via toast When enabled, a notification appears in the bottom-right of the screen when a time entry is created. This confirms to the user that time has been recorded, which is particularly useful when recording is triggered automatically.

Time targets

Targets can be set at global organisation level or set the expected number of hours to be recorded per day for a given work type. Results can be reported on to track whether targets are being met or exceeded.

Click the settings cogs to configure.

See Time Recording Targets for full details on how to configure time targets.

Book for others

Allow booking time for other users When enabled, users with the appropriate permission can record time on behalf of another user. This is useful where fee earners have an administrator who records time for them. Enabling this setting at global level does not grant the permission to all users automatically. It must also be assigned at team or individual user level.

Time periods

Historic Time Sets how many days in the past a user can record time. For example, a value of 30 prevents users from backdating entries beyond 30 days.
Future Time Sets how many days in the future a user can record time. For example, a value of 30 prevents users from booking time more than 30 days ahead.

 

 

 

 
 

Time code sets

Time Recording: Configuring Time Code Sets

A time code set is a collection of codes that identify the type of work being recorded. Sets can have a flat list of codes or a hierarchical structure with parent and child codes. Time code sets are assigned to Classifications and presented to users when they record time.

Time Code Sets

A time code set represents a unique set of codes that are presented on the time capture screen.

Using the screenshot above as an example, Phase and Task and Activity are both time code sets.

Time Code Sets are maintained under Admin > Time.

  1. The Time code sets panel can be collapsed and expanded.
  2. Click a time set to see the time codes for that set
  3. Click + New Set to create a new time set. This opens the Add new time code set blade. Complete the details, Save and Close.

Add Time Codes to a Time Set

Sets can have a flat list of codes or a hierarchical structure with parent and child codes. 

+ New Code opens the Add new time code blade.  Complete the details, Save and Close.

Time code sets are grouped together in Time Classifications to form the set of codes that are entered on a time entry. A time code set must be assigned to at least one classification before it is available to users. 

 

 

 
 

Time classifications

Time Recording: Configuring Time Classifications

A classification is a segment (set of fields) that captures additional information about a time entry. For example, a classification called Activity might require the user to select a code from an activity code set. Classifications can be mandatory or optional, and can apply at the point of entry or submission.

Classifications are applied globally. If you need different classifications for different work types or matter types, use Category Rule Sets.

 

Using the screenshot above as an example, a time classification has been defined containing the Time Code Sets of Phase and Task and Activity.

Time Code Classifications are maintained under Admin > Time and consist of one or more segments.

For a given segment, you can specify the following.

Name The name of the segment as it will appear for your time entry users
Enabled Controls whether the field displays on the capture screen. Disable a field to remove it without deleting it.
Mandatory for entry Whether your users must enter this code before saving their time entry or not.
Mandatory for submission Whether your users must enter this code before submitting their time entry or not. 
Capture Type Whether the user should enter a Time Code Set or a memo field.
Time Code Set If the time capture type is "Time Code Set", select the Time Code Set.
Default Time Code for Stopwatches When a stopwatch is stopped, you can specify the default time code that is recorded.

You can only delete time classification segments that haven't been used. Once they have been used, you can only disable them.

 

 

 
 

Time categories & rule sets

Time Recording: Configuring Time Categories and Rule Sets

Whenever a time entry is created, the user will be asked to enter the top-level time category.

It is this choice that determines the different time codes that need to be entered.

Configure Time Categories

Time Categories are defined within Admin > Time and are defined by:

In addition to the default time classification, you can also specify a number of Rule Groups to vary the time classification that is used.

Within a rule group, you can specify that a given time classification is shown based on:

  • Matching rules that are evaluated for a time container (the time container is typically the matter but could also be the SoW).
  • Matching rules that are evaluated for the work item (typically a task) where time is being recorded against it.

Using matching rules, you can:

  • Vary the time capture by different matter types - for example, using the JCode classification for dispute matters and a separate classification for real estate matters.
  • Vary the time capture for different clients - for example, your client may wish for you to add additional time codes for their matters.

Rules sets are evaluated in the order in which they are displayed on the Admin screen. You can change this order by dragging and dropping them within this screen.

 

 

In the Time Recording Global Feature you can configure time categories for work types.

 

 
 

Time targets

Time Recording Targets

Time targets set the hours a user is expected to record. Clio Operate compares recorded time against the target on a schedule, and raises an event where the target is missed, so a firm can follow up with a notification or a task.

Time Targets are set in Time Recording Global Feature Configuration, but how to configure them and how they are used is explained here. 

How targets are scoped and inherited

Targets are held at three levels. 

Clio Operate resolves a user's target by taking the most specific record that exists, in this order.

  1. A record set against the user.
  2. A record set against the user's primary team.
  3. A record set against the user's working day calendar.

Resolution takes the whole record, not individual categories. A user level record replaces the team and calendar records outright. Where a category is left at 0 on the user level record, it resolves to 0. It does not fall back to the team or the calendar value.

Team targets match on a user's primary team only. Membership of a secondary team has no effect.

Where the blade opens on a user who has no record of their own, the values displayed are inherited from the team or the calendar, and a warning displays at the top of the blade:

Warning: Values are inherited on work types, saving these values here breaks the inheritance.

Saving from that state creates a new record at the user level. The parent record is left untouched, and the user no longer follows it. The warning displays for the user scope only, because team and calendar records are always held at their own level.

DANGER: Saving over an inheritance warning is a one way change, it cannot be reversed. Only do it where you intend that person's targets to be maintained separately from that point on.

 
 
 

Configure targets

Configure a target

Open the Time Target Settings blade for the calendar, team, or user you want to configure.

Trigger time targets on total hours

Set Trigger time targets on total hours to reflect how you want misses evaluated.

Controls how a missed target is evaluated. Disabled, a miss event is raised when any single category falls short of its target. Enabled, a miss event is raised only when the total hours recorded across all categories falls short of the combined target, so over-recording against one category offsets a shortfall against another. Either way, the event payload lists each category that fell short, with its target and its actual hours.

Monday to Sunday

Enter the target hours for each category, for each day of the week. Each section lists every active time category with an hours box, accepting a value between 0 and 24. Leave a category at 0 for days where no time is expected.

To leave a category untargeted at that scope, enter 0 across all seven days.

 

 

Total

Displays the sum of the hours entered for that day. Read-only. Check the Total for each day against the working pattern you are modelling.

  • The Total line rounds the values it displays down to whole hours. A day configured as 3.5 billable and 3.5 non-billable displays a total of 6. The 3.5 values are stored and checked correctly.
  • Leaving an hours box empty rather than entering 0 causes the Total to display NaN (Not a Number).
  • Nothing prevents the hours entered for a single day from exceeding 24 in total. Each box is capped at 24 individually, not collectively.
 

Select Save.

Clearing Targets 

There is a Remove button on the toolbar.  This sets all the hours boxes on the blade to 0. It does not delete the record. To apply the change you still need to select Save, and the record remains in place afterwards at that scope.

Clearing an hours box to blank has the same effect as entering 0. A blank target is read as 0 when targets are checked, so neither value removes the target. A target of 0 can never be missed.

This matters most at the person level, because inheritance depends on whether a record exists at that scope, not on the values it holds. Once a person level record is saved, it continues to take precedence over the team and calendar records whatever the hours are set to. As mentioned above, saving over an inheritance warning is irreversible. Only do it where you intend that person's targets to be maintained separately from that point on.

Turning User time targets or Team time targets off in the Time Targets Configuration blade does not reverse this. Those settings control whether the pickers display, and have no effect on records that already exist or on how targets are resolved when checks run.

Warning: Removing a person or team level record, so that targets inherit again, is a database operation. Raise it with your implementation contact rather than attempting it from the interface.

 
 
 

How targets are checked

Two scheduled checks compare recorded time against the configured targets.

  • The daily check takes the previous day, reads the target for that day of the week, and compares it against time recorded on that date.
  • The weekly check sums all seven days per category, and compares the total against time recorded in the previous week. The week is treated as starting on Monday.

Weekly Check Leeway (Days), in the Time Targets Configuration blade, delays the weekly check by the number of days you specify from Monday. This allows time for the previous week's entries to be submitted. Accepted values are 0 to 6.

Only submitted time counts

Time entries count towards a target once they reach Submitted or Approved. Time left in Draft or Revising is not counted, so a user who records time but does not submit it registers as having missed their target.

Missed Targets

Where a target is missed, a daily-time-target-missed or weekly-time-target-missed event is raised for the user. 

Nothing consumes these events by default. Configuring a response, such as a notification or a task, is an implementation activity. Until that is done, a missed target is recorded in the logs and produces no visible outcome.

 
 

Where targets display

The Time Radar widget compares recorded hours against target hours for the people working on a matter.

See Time Recording: Configuring list views and portals.

 
 

 

 

 
 

Internal costs

Time - Internal Costs

When a time recording entry is created, it is possible to record the internal cost associated with that time. The internal cost represents the time recorder's wage, rather than their charge-out rate. Recording it alongside the charge out value lets a firm report on the profitability of work. 

Create the Rate Card

An internal cost rate card will likely already exist on your database. 

  1. Navigate to Modeller > Global Features > Finance.
  2. Enable Goods & Services, then select the settings cog.
  3. Create an Internal Cost Rate.
  4. You must ensure the item type category is set to be an internal cost rate item.
  5. Save & Close.
 
 

Internal cost global feature

The Time - Internal Cost feature, located in Modeller > Global Features > Finance, must be enabled in order for the internal cost to be captured when time recording. 

Pre-requisites: Enable the Chart of Accounts global feature first. Time - Internal Costs depends on it and will not validate without it. You also need a Goods and Services rate card whose item type category is set to an internal cost rate item.

 
  1. Navigate to Modeller > Global Features > Finance.
  2. Enable Time - Internal Costs, then select the settings cog.
  3. Set a default internal hourly rate for every enabled currency.
    The default rates are used for any user for which an internal rate has been created.  The internal cost rates are configured via a rate card, which internal rate card to use is configured within this area. 
  4. Select the internal cost rate card.
  5. When time is recorded, the internal cost is recorded as a transaction in the chart of accounts. Set the account the transaction posts to and map each of the four time statuses to a transaction status.
  6. Save & Close.
 
 

Create rates for internal costs

Once an internal rate card has been created, the cost rates for each job role need to be configured.

The internal costs rates are determined by a users job role. For example:

  • a partner's internal cost = £250.00 per hour
  • a trainee = £50.00 per hour

Optionally, a firm may also choose to create rates for specific people. For example: Wendy is a partner, the default rate for a partner is £250.00 but the rate for Wendy is £285.00 an hour. 

For the user specific rates to be valid, they must be configured against the correct job role for the user, i.e. if Wendy's job role was not a partner than the rate record below would not be applied.

  1. Navigate to Admin > Finance > Internal Costs.
  2. Select Add Item > Internal Cost Record or click on an internal cost record to edit it.
  3. Complete the Item Details.
  4. To add the rates click + in Pricing 

Default Rate

Individual Person Rate

Rate for different Jurisdictions

  1. All rates then display in pricing:
  2. Save & Close.

How a rate is chosen

Once rates have been configured, any time recording records the internal cost in the Chart of Accounts. 

Rates are resolved by job role first, then narrowed by person and jurisdiction. The default rate is the fallback.

Order Match Used when
1 Person and jurisdiction A rate exists for that person in that jurisdiction.
2 Person A rate exists for that person with no jurisdiction.
3 Jurisdiction A rate exists for the jurisdiction with no person.
4 Default rate No job role rate is matched for the user.
For a person specific rate to apply, it must be configured against the job role the person holds. A rate recorded under the wrong job role is never reached.

Job role is resolved at the entry's start time.

The job role used is the one assigned at the time entry's start date and time. Where someone changes role part way through an entry, the role at the start applies.

Adding a person specific rate for one partner overrides the partner default for that person only.

 
 

Who can see internal costs

Internal costs are sensitive. Visibility is controlled by the Time internal costs - Read permission, which applies to time queries, time entry list views and financial transaction list views.

As the internal cost is a sensitive information, whether internal costs are visual to a user is controlled via Time Recording Permissions.

 

 
 

 

 

 

 

 

 
 

List views & portals

Time Recording: Configuring list views and portals

Five time recording elements can be placed on portals and work item blades. This article covers the time specific configuration. 

Time entry list view

Clio Operate includes a dedicated time entry list view provider, core-time-entries. Configure it with the list view widget to display time entries on a portal.

The list view provides specific filtering capabilities for:

Filter What it does
Timekeeper Filters by the person who recorded the time.
Time state Filters by state: Draft, Revising, Submitted or Approved. 
Time period Combines a unit, day or week, with a relative period, current, previous or next.

Internal cost columns are permission gated

Internal cost columns display only for users who hold core.timeinternalcosts.read. Everyone else sees the list view without them.
 

The list view supports CSV export. The export includes the time entry state and the recorder's job role alongside the visible columns.

 
 

Time commands

Add either command to a portal, a blade or a menu.

Command System name What it does
Record a time entry record-time-entry Opens the time entry blade to record time against a work item.
View time entries view-time-entries Opens the time entry list view blade, for time booked against the current work item or the user's own time.
 
 

Time top navigation widget

Time Entry Quick View (Sharedo.Core.Case.Widgets.StopwatchQuickView) sits in the top-menu and displays running stopwatches. 

Place and configure it through Menu Configuration.

Time top navigation widget

 
 

Time nav bar aspect

The Time Nav aspect displays a summary of time recorded against a work item, and gives quick access to the entries. 

Add it to a work item blade through the Blade Editor.

Time Nav aspect on a work item

 
 

Time radar

The Time Radar widget compares recorded hours against target hours for the people working on a work item, with a cumulative time by person chart and a count of time entries. It sits well above a time entry list view on the same page.

Time Entries page for a matter. The Time Radar widget displays 40.26 recorded hours against 46 target hours and 116 time entries, with a cumulative time by person chart. Below it, the Time Entries list displays state, date, time keeper, work item, category, time code, duration and units.

The radar needs targets to be meaningful. Target hours come from the time target configuration. Where no target is set for the people involved, the widget has nothing to compare recorded time against. See Configure time targets.

Add the widget through Introduction to Personas and Portals.

 
 

 

 

 


 

 

 

 
 

Permissions

Time Recording Permissions

Two things decide what a user can do to a time entry. The time permissions they hold, and their update access to the matter the time is recorded against. Both apply.

What each permission does

Ten permissions sit in the Time group. The description column is the wording shown in the product, which is generic for several of them, so the third column explains what each one actually governs.

Permission Description in the product What it governs
Time - Read Restricts access to all time views across the application Seeing time entries anywhere: list views, the time nav bar and the time entry blade. Without it, a user sees no time at all.
Time - Create Restricts access to time recording Recording time, by stopwatch or by hand.
Time - Update Restricts access to time recording Nothing today, despite the name. Editing an entry is governed by the state of the entry and by update access to the matter. Withholding this permission does not stop a user changing their time.
Time - Delete Restricts access to time recording Deleting an entry while it is in Draft or Revising. A user can delete their own entries. Deleting someone else's also needs Time - Finance Admin.
Time - Finance Admin Can reverse time entries and manage time actions that have financial impact Returning a submitted entry to Revising so it can be corrected, and editing or deleting time belonging to another user. Owning an entry is not enough to un-submit it, so this is the only route to correcting submitted time. In the default configuration pack it is granted to the System Admin permission set alone.
Time - Record for others Can book time for other users Recording and editing time on behalf of another user. Has no effect unless Allow booking time for other users is also enabled in the global feature. In the default configuration pack it is granted to the System Admin permission set alone.
Time - View Fee Costs Can view Fee costs for time records Seeing the fee cost, what the client is charged, on a time record.
Time Internal Costs - Read Restricts access to Time Internal Costs views across the system

Seeing internal costs, what the work costs the firm, on time entries, in time entry list views and on financial transactions.

This is sensitive data - only assign to users who need to see internal costs.

Time Targets - View Can view time targets Seeing time targets. Also required for the two time target settings to display in the global feature.
Time Targets - Update Can update time targets Setting and changing time target values.

Another permission not in the Time Group is Admin Access - Finance.  This governs opening the Finance area of the Admin portal, which contains Admin > Time. Without it a user cannot maintain time code sets, classifications or categories, whatever time permissions they hold. Not the same as Time - Finance Admin, which governs what a user can do to a time entry.

Who can edit a time entry

To do this A user needs
Edit their own entry, in Draft or Revising Update access to the matter the time is recorded against. No separate time permission gates this today.
Edit another user's entry, in Draft or Revising Time - Finance Admin and Time - Record for others, with Allow booking time for other users enabled, and update access to the matter.
Move a Submitted entry back to Revising Time - Finance Admin. Owning the entry is not enough, so a user cannot un-submit their own time.
Edit or reverse an Approved entry Not possible, for anyone. Approved time is frozen.

Matter access: A user who holds every time permission still cannot touch time recorded against a matter they cannot update. Anyone correcting time across the firm needs update access to those matters as well.

 

Default grants

From the default configuration pack. Any environment that has been live for a while may differ, so confirm what a firm's permission sets actually hold.

Permission set Time - Finance Admin Time - Delete
System Admin Yes, the only set that has it Yes
Fee Earners No Yes
Support Staff No Yes
Team Leaders No Yes
Case Admin No Yes
Finance No Yes
Client Case Handler No No

For how permission sets are created and assigned, see Global Permissions and Role-based Permissions.

Check the environment rather than the defaults. A live environment may have been changed since, so confirm what a firm's permission sets actually hold before advising on them.

 

What to think about when assigning

  • Decide who returns submitted time for correction. Only Time - Finance Admin can do it, so that group is the single route to fixing a submitted entry. One person is a bottleneck, and an absence stops corrections.
  • Check where the permission sits today. In the default configuration pack, Time - Finance Admin is granted to System Admin alone, which is usually IT rather than finance.
  • Avoid solving it with System Admin. That set carries broad platform permissions well beyond time recording. A dedicated set for the people who own timesheet quality, usually finance or billing, and sometimes team leaders, keeps the reach proportionate.
  • Decide whether users keep Time - Delete. Fee earners hold it by default. Deleting your own draft is normal housekeeping, but combined with editing it means a user can reshape their own time freely until they submit it.
  • Check Time - Record for others. It is granted to System Admin only by default, so booking time for someone else needs both the permission and the setting.
  • Decide who sees costs. Time - View Fee Costs exposes what the client is charged, and Time Internal Costs - Read exposes what the work costs the firm. Treat the second as the more sensitive of the two.
  • Separate viewing targets from setting them. Time Targets - View and Time Targets - Update are different permissions, so a team leader can be given sight of targets without the ability to change them.
  • Remember the matter side. Permissions decide what a user may do to time in principle. Matter access decides which time they can reach.

 

 
 

Configure Passive Time Capture

Configure passive time capture

Passive time capture times work as it happens. A stopwatch starts when a user opens a work item, stops when they close it, and a time entry is created for them, already coded. This article covers the whole setup in the order it needs doing. See Understanding Time Recording for a full overview.

Some of the detail here also appears in the articles about the global feature, work types and classifications. It is repeated so you can work through the setup without moving between articles.

Before you start

  • You need access to Modeller, and the finance admin access permission, to reach Admin > Time. 
  • The people the capture applies to need Time - Read and Time - Create permissions
  • Decide which work types should capture time passively before you start, because most of the configuration is per work type.

Configuration

Enable time recording

Nothing else works until the feature is on.

  1. Navigate to Modeller > Global Features.
  2. Locate Work Item Time Recording in the Case category.
  3. Toggle the feature on.
  4. Select the settings cog. The Time Recording Configuration blade displays.

Set how stopwatches behave

Decides when an entry is created, how short a visit is ignored, and what happens when the browser closes. These settings are system wide. They apply to every work type that captures time.

When an entry is created

Select one of three options. They are mutually exclusive, so choosing one replaces the others.

Option What it does
On Stop - Record as a single consolidated entry Creates one entry when the stopwatch stops, however long it ran.
On Stop - Record an entry per day Creates one entry for each day the stopwatch spans. Use this where stopwatches run across more than one day.
On Pause - Record a time entry immediately Creates an entry each time the user pauses, rather than waiting for the stopwatch to stop.

Duration limits and browser behaviour

Setting What to set
Minimum Duration for a Stopwatch (Seconds) Below this, no entry is created. This is what stops a two second visit to a task producing a time entry. Note the unit is seconds.
Maximum Duration for a Stopwatch (Minutes) The longest a stopwatch runs before it is capped. Note the unit is minutes.
Browser Navigate / Close Action

Choose what happens when the user navigates away or closes:

  • Default - Prompt the user if there are active stopwatches in session
  • Pause All - Pause all stopwatches for the current user
  • Stop Active in Session - Stop any that are active, for example in an open blade.
Inform users of stopwatch events via toast Displays a notification in the bottom right when a stopwatch starts or stops, and when an entry is created. Enabled by default. Leave it on for passive capture, because it is the only signal a user gets.

Set the work type triggers

Decides what starts and stops a stopwatch.

  1. In the Time Recording Global Feature, select the cog on Work Type Configuration. A list of work types displays.
  2. Select the right arrow next to the work type you want to configure. The Time Recording Settings blade displays.
  3. Set Enable Time Recording to enabled.
  4. Under Automatic Stopwatches - System Triggers, enable Start on Open, Stop on Close, or both. Start on Open on its own is enough.
  5. Set Blade stack behaviour to Trigger events for parent only or Trigger events for all blades.
    Blade stack behaviour is only enabled once Start on Open or Stop on Close is on, so set the triggers first. Where neither is on, no stopwatch starts by itself and there is no passive capture on that work type.
  6. Under Automatic Stopwatches - Phase Change Triggers, add any phases that should start or stop a stopwatch.
  7. Save the blade.

Fixed time is a separate mechanism on the same blade. It records a set number of minutes when a work item moves between two phases, rather than timing the work. 

Give automatic entries their codes

An automatic stopwatch has nobody to ask which codes to use, so it uses the defaults on the classification. Without them, entries arrive with empty fields and the user has to complete each one, which removes most of the benefit.

  1. Navigate to Admin > Time > Time Classifications.
  2. Open the classification used by the categories the work type can record against.
  3. Open each field in turn.
  4. Under Automatic recording, set Default time code for fields that capture a time code set.
  5. Set Default value for fields that capture a memo. 
  6. Check every field, including mandatory ones. A field marked Mandatory for submission with no default leaves the user with an entry they cannot submit until they complete it. Either give it a default, or accept that users complete that field by hand.
  7. Save.

For how classifications and their fields work, see Time Classifications

Add the widget to the blade

Triggers control when time is captured. The blade controls whether anyone can see it.

  1. Navigate to Modeller > Work Types.
  2. Select the work type, then select Blade Editor.
  3. Add the time recording widget to the blade.
  4. Save the blade.

This is the step most often missed. Where the triggers are configured but the widget is not on the blade, time is captured and users have no way to see it on the work item. It is the usual cause of a report that passive time recording is not working.

 

Decide what users can change

Automatic entries can be locked down more than manual ones. Both settings are in the Time Recording Global Feature under automatic stopwatch behaviour.

Setting What it does
Restrict users from overriding automatic stopwatch duration and start/end dates Prevents users editing the recorded duration or the start and end dates on an entry a stopwatch created.
Restrict users from overriding time codes for these stopwatches Prevents users changing the codes the stopwatch applied.
Enable for users with permission Displays under each restriction. Holders of the selected permission are exempt from it.

Things that catch people out

  • The widget. Triggers without the widget means invisible time.
  • Minimum duration set too high. Short pieces of work are exactly what passive capture is meant to catch, so a high minimum defeats the purpose. A high maximum has the opposite risk, capping a genuine long session.
  • Missing defaults on mandatory fields. Users end up with entries they cannot submit.
  • Toasts turned off. Users then have no signal that time is being recorded for them, which is where complaints about unexpected entries come from.
  • Assuming Time - Update controls editing. It does not. Use the override restrictions above to limit what users can change on automatic entries.

 

 
 

 

Was this article helpful?

Related Articles

Related articles in the knowledge base