0% found this document useful (0 votes)
7 views

Clocktimizer Installation Guide 2023

The Clocktimizer Installation Guide provides detailed instructions for installing Clocktimizer both on-premises and in the cloud, including authentication setup and access control mechanisms. It outlines system requirements, pre-installation considerations, and post-implementation tasks, along with specific configurations for various authentication methods like Azure AD and ADFS. The guide is intended for end-users, system administrators, and deployment teams to streamline operations within law firms.
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
7 views

Clocktimizer Installation Guide 2023

The Clocktimizer Installation Guide provides detailed instructions for installing Clocktimizer both on-premises and in the cloud, including authentication setup and access control mechanisms. It outlines system requirements, pre-installation considerations, and post-implementation tasks, along with specific configurations for various authentication methods like Azure AD and ADFS. The guide is intended for end-users, system administrators, and deployment teams to streamline operations within law firms.
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 48

Clocktimizer

Installation Guide

April 2023
Copyright © 2023 Litera Corp. All rights reserved.

The information in this document is confidential and subject to change without notice and does not
represent a commitment by Litera. The software referred to in this document is furnished under a license
and may not be used or copied except in accordance with the terms of that license.

Clocktimizer is a trademark of Litera Corp. All product names are trademarks of their respective
companies.

Litera
550 West Jackson Blvd.
Suite 200
Chicago, IL 60661
US: +1 630 598 1100 UK: +44 (0)20 3890 2860

On the Web: https://www.litera.com/


Contents
Introduction ................................................................................................................... 1
Authentication Setup ................................................................................................... 1
Access Control ............................................................................................................ 4
Clocktimizer in the Cloud ............................................................................................. 7
Clocktimizer Cloud Infrastructure Diagram .................................................................. 7
Azure Hybrid Connections ........................................................................................... 7
Clocktimizer On-premises.......................................................................................... 14
Clocktimizer On-premises Network Diagram ............................................................. 14
Software Prerequisites .............................................................................................. 15
Hardware Prerequisites ............................................................................................. 16
Environment .............................................................................................................. 17
Preinstallation Requirements and Considerations ..................................................... 17
Initial Technical Implementation ................................................................................ 21
Installation File Contents ........................................................................................... 21
Installing Clocktimizer ................................................................................................ 22
Post-implementation Tasks and Checks ................................................................... 22
Upgrading Clocktimizer to the Latest Version ............................................................ 22
Appendix ..................................................................................................................... 24
Glossary of Terms ..................................................................................................... 24
Clocktimizer Data Model ............................................................................................ 25
Aderant Expert Data Extract ...................................................................................... 33
Elite 3E Data Extract ................................................................................................. 37
Elite Enterprise Data Extract ..................................................................................... 42

i
Introduction

Introduction
Clocktimizer helps law firms to streamline operations, easily build and scale pricing and
legal project management teams, improve firmwide profitability, and offer increased
client transparency.
This document contains detailed information for installing Clocktimizer on-premises,
and for setting up the cloud version. Verify the software and hardware requirements for
the on-premises version of Clocktimizer have been met before installation. See
Clocktimizer System Requirements available from the Litera Customer Center
https://support.litera.com/s/. For easy reference, the requirements are also included in
this guide.
This guide has been written for the following intended audiences: End-users, system
administrators, database administrators, and implementation/deployment teams.
Caution: Old versions of Clocktimizer use dependencies that are no longer supported
by Microsoft, for example .NET 2.2.6 which has been EOL since 2019. Litera
recommends that all customers use at least version 5.50 of Clocktimizer.

Authentication Setup
Clocktimizer supports the following authentication methods to log into the Clocktimizer
application:
▪ Azure Active Directory (Azure AD)
▪ Active Directory Federation Services (ADFS) using OpenID Connect or WS-
Federation
▪ Direct domain authentication for Active Directory (deprecated). This option is
available on-premises only and does not support single sign-on (SSO); as a
deprecated method, it is not recommended.
▪ Clocktimizer accounts

Azure AD Configuration Guide


Information on how to setup Azure AD as the authentication method can be found here:
https://support.litera.com/s/article/RegisteringtheClocktimizerapplicationforAzureADauth
entication6199ede7a6546

1
Introduction

Active Directory Federated Authentication (ADFS)


Federated authentication for AD FS or other providers is the preferred solution for
authentication of users. This method is simple to set up, supports complex
configurations, allows users to use their AD password and enables single sign-on.
Clocktimizer supports two schemes:

WS-Federation
To set up authentication via WS-Federation:
1. Set up an app registration. The process is documented here:
https://docs.microsoft.com/en-us/aspnet/core/security/authentication/ws-
federation?view=aspnetcore-2.2.
Note: You DO NOT need to set up the Azure AD app registration, you can ignore
that paragraph.
The Wt Realm is https://yourdomain.clocktimizer.com/
2. Configure the following claims:
a. Name ID
b. E-mail
c. Groups
3. Once these have been set up, provide us with the metadata address. It should
look like this: https://{ADFS FQDN}}/FederationMetadata/2007-
06/FederationMetadata.xml

OpenID Connect
To use OpenID Connect for authentication, you should set up an app registration in
ADFS. This process is documented here:
http://www.cloudidentity.com/blog/2015/08/21/openid-connect-web-sign-on-with-adfs-
in-windows-server-2016-tp3/.
The Metadata Address contains information on the authentication endpoints that should
be used in the OpenID Connect authentication flow. It should look something like this:
https://{domain}/.well-known/openid-configuration
The Metadata Address should be accessible from Azure.
The Client Identifier uniquely identifies the app registration within your ADFS setup.
Once you set up everything, please send us the metadata address and the client
identifier.

2
Introduction

Okta
Okta is supported using the OpenId Connect authentication scheme. It needs to be
configured as follows:
▪ Okta Domain: Your Okta domain
▪ Login Redirect URIs: https://{clocktimizer-hostname.domain}/sigin-oidc-
OpenIdConnect
▪ Logout Redirect URIs: -
▪ Login initiated: App Only
▪ Initiate Login Uri: https://{clocktimizer-hostname.domain}/

After OpenId has been connected, you will need to supply us with the following
information:
▪ Metadata Address: This should look like https://{your-okta-server}/.well-
known/openid-configuration
▪ Client identifier: A unique string identifying the client app registration.
Adding users You can add a Clocktimizer user using the Admin Panel. Users will be
matched using their e-mail address.

3
Introduction

Automated provisioning of users Clocktimizer Users can automatically be added on


login. For this, a group uid can be assigned to any Clocktimizer role. If the group’s claim
is enabled, and a user can be matched to exactly one of the Clocktimizer roles, a user
will be created automatically with that role.

Clocktimizer accounts
An account can be created within the Clocktimizer application using an email address.
For more information, please see the following guide:
https://support.clocktimizer.com/en/support/solutions/articles/11000013872-add-new-
users

Access Control
There are two kinds of access control in Clocktimizer:
▪ A role-based permission system that determines which parts of the application
can be accessed by the user.
▪ A data-visibility system that determines which data is visible to the user.

Role-based permission system


In the role-based permission system, each user has exactly one role. Each role can
have one or more permissions which determine if a user can perform a certain action
within Clocktimizer. Access is controlled by assigning users to a role and modifying the
permissions of these roles.
There are two ways to manage role membership:
▪ Users with the ‘AccountManagement’ permission can assign roles to individual
users using the administration portal in Clocktimizer.
▪ AD-/ADFS-based group membership. Each group has an assigned role (e.g.
Power user) and when logging in, users will be assigned a role based on the
group they belong to.

Data Visibility
Clocktimizer offers options to limit the type of data that is visible to the user based on
their role in the organization. You should decide on a data-visibility policy before you
get started with Clocktimizer. Data visibility is organized in several layers. For each
layer, there are several mutually exclusive visibility levels. Some of these depend on
the office and/or practice group of the user. In this case, the office and/or practice group

4
Introduction

of the users and matters should be made available in the data extract. Data visibility
can be assigned on a role-level basis.
If clients, matters, or entries are included in a report to which a user has access (for
instance a practice group performance report), but a user does not have access to the
names of those clients, matters, or entries, this information will be visible as <masked>
so totals add up.

Layer 0: Import
Any information that should never be visible within Clocktimizer (for instance, strictly
confidential matters during a pilot phase) should be excluded from the data extract.
Exclusion can be handled in two ways (they are not mutually exclusive):
▪ The extract can be performed on a copy of the time-tracking database from
which sensitive data has been removed.
▪ Additional filtering can be specified in the import specification. This will need to
be communicated to Clocktimizer.

Layer 1: Drilldown visibility


The drilldown allows the user to inspect the data from many different viewpoints.
Access to the drilldown functionality can be controlled using the role system.
Additionally, the data visible to the user can be limited in the following ways:
▪ All: No limit. This is the default level.
▪ Office: Users can only view matter data belonging to their own office.
PracticeGroup: Users can only view matter data belonging to their own practice
group.
▪ OfficePracticeGroup: Users can only view matter data belonging to their own
office and their own practice group.
▪ None: No data is visible in the drilldown

Layer 2: Client visibility


Client visibility governs which clients can be accessed from the client analysis. If a
report yields information about a client that is not visible to the user, its name will be
masked. The data visible to the user can be limited in the following ways:
▪ All: No limit. This is the default level.
▪ Office: Users can only view clients if at least one matter belongs to their own
office.
▪ PracticeGroup: Users can only view clients with at least one matter belonging to
their own practice group.

5
Introduction

▪ OfficePracticeGroup: Users can only view clients with at least one matter
belonging to their own office and their own practice group.
▪ ClientManager: Users can only view clients for which they are the manager.
▪ Timekeeper: Users can only view clients for which they have recorded time.
▪ None: No clients are visible

Layer 3: Matter visibility


Matter visibility governs which matters and budgets can be accessed using the matter
analysis and budget list. If a report yields information about a matter that is not visible
to the user, its name will be masked. The data visible to the user can be limited in the
following ways:
▪ All: No limit. This is the default level.
▪ Office: Users can only view matters belonging to their own office. PracticeGroup:
Users can only view matters belonging to their own practice group.
▪ OfficePracticeGroup: Users can only view matters belonging to their own office
and their own practice group.
▪ Whitelist: Users can only view matters for which they are whitelisted. The
whitelist should be provided in the data extract.
▪ Manager: Users can only view matters for which they are the manager.
▪ Timekeeper: Users can only view matters for which they have recorded time.
▪ TimekeeperManager: Users can only view matters for which they are the
manager or have recorded time.
▪ None: No matters are visible

Layer 4: Timecard narrative visibility


Timecard narrative visibility governs which timecard narratives can be viewed. If a
report yields timecards that should not be visible to the user, the narratives will be
masked. The timecard visibility level should be at least as restrictive as the matter
visibility level. The data visible to the user can be limited in the following ways:
▪ All: No limit. This is the default level.
▪ Office: Users can only view narratives for matters belonging to their own office.
PracticeGroup: Users can only view narratives for matters belonging to their own
practice group.
▪ OfficePracticeGroup: Users can only view narratives belonging to their own
office and their own practice group.
▪ Manager: Users can only view narratives of matters for which they are the
manager.

6
Clocktimizer in the Cloud

▪ TimekeeperManager: Users can only view narratives of matters for which they
are the manager or have recorded time.
▪ TimekeeperMatter: Users can only view narratives of matters on which they
have written time.
▪ TimekeeperOwner: Users can only view their own narratives.
▪ Masked: All narratives are masked.

Clocktimizer in the Cloud

Clocktimizer Cloud Infrastructure Diagram

Azure Hybrid Connections


Azure Hybrid Connections is a technology that allows Azure resources (like the cloud
hosted Clocktimizer web app) to

7
Clocktimizer in the Cloud

▪ Access on-premises resources like the SQL Server database of your practice
management/financial system
▪ Allow point-to-point connections that don’t require opening ports in the users’
firewalls
▪ Control and revoke access at any time
Note: All credentials are stored in Azure Key Vault
You can find more information on this technology on Microsoft’s dedicated page:
https://learn.microsoft.com/en-us/azure/app-service/app-service-hybrid-connections

Pre-implementation Checklist
Clocktimizer will need at least the following information to get started:
▪ The Azure region where the application will be hosted. We currently support the
following regions:
 West Europe
 Canada Central
 West US
 East US
If you need a different Azure region, please contact us.
▪ The hostname of the database server. The database server does not need to
be available from the internet, but it should be reachable by this hostname from
the server that will host the Hybrid Connection Manager. We need a fully
qualified domain name to prevent namespace clashes.
▪ The port SQL Server is listening on. This will almost always be 1433, but it is
possible to specify a different port.
▪ The e-mail address for a user that will get access to our cloud environment for
management and monitoring.
▪ Information on the time tracking database. Clocktimizer has a number of
questions you should answer, depending on the financial software you use. If
you have not yet been provided with this information and the list of tables that
Clocktimizer needs read-only access to, please ask your Clocktimizer contact.
Once the Clocktimizer team has received this information, we can start setting up the
hybrid connection

8
Clocktimizer in the Cloud

Setting up the Hybrid Connection


Note: These tasks will be handled by Clocktimizer engineers. They are detailed here
to give customers a better understanding of how the setup works.

Create a hybrid connection in the Azure Portal.


1. Navigate to the app service clm-app-{app} in the Azure Portal.
2. Go to Networking -> Configure your Hybrid Connection Endpoints -> Add hybrid
connection to go to the ‘Add hybrid connection’ dialog.
3. Click on Create new hybrid connection and configure it:
a. The naming convention is clm-hybrid-{app}.
b. Provide the supplied endpoint host and port.
c. Use the service bus for the app region (clm-bus-{region}). Create it if it
does not exist yet.
d. Take note of the gateway connection string, as it will be required during the
on-site client configuration.

4. Go to Azure Active Directory and set up an Azure


Guest User for the supplied e-mail address:

5. Within each of the following Azure resources, grant reader access to the Azure
Guest User. Resources can be found under All resources in the left-hand side
menu.
 App Service clm-app-{app}
 Azure Key Vault clm-vault-{app}
 Service Bus clm-bus-{region}

4. In the Azure Key Vault, additionally set up an access policy for the Azure Guest
User, granting them all permissions for Keys, Secrets, and Certificates.

9
Clocktimizer in the Cloud

On-site Client Configuration


Note: These tasks will need to be completed by Litera engineers or someone from
the customer’s IT department.
1. Install the Azure Hybrid Connection Manager tool. The Hybrid Connection
Manager allows a machine to act as a relay between Azure Cloud Services and
on-premises resources. The tool can either be installed on the database server
or on a different server that can access the database server. The machine
containing the Hybrid Connection Manager does not need to be accessible from
the internet, but it does need to have internet access. The database server
needs neither. The tool can be downloaded here:
https://clmstorswesteu.blob.core.windows.net/download-clocktimizer-
com/HybridConnectionManager.msi
2. Create a SQL Server account for Clocktimizer with read-only access to (a copy
of) the database containing the required practice management and narrative
information. The account should have SQL Server Authentication. SQL Server
Authentication and the TCP/IP protocol should be enabled for the database
server. If the Hybrid Connection Manager is installed on a different machine than
the database server, the firewall on the database server should allow
connections from that machine.
3. Add the Hybrid Connection with Powershell. You need to perform these steps on
the system on which the hybrid connection manager has been installed:
a. Fire up a Powershell prompt with Administrator privileges.
b. Run the following command:
Add-HybridConnection -ConnectionString "{connection-string}"
Note: this connection string is not the connection string to connect to the SQL
database; It grants access to the Hybrid Connection. We will provide the
connection string to you.

10
Clocktimizer in the Cloud

4. Run the command Get-HybridConnection to verify the hybrid connection was


added. It should look like this:

11
Clocktimizer in the Cloud

5. Provide the connection string to the time tracking database. The connection
string needs to be relative from the machine containing the Hybrid Connection
Manager. The string should look something like this:

Server=tcp:sql01.internal.pearson-hardman.com,1433;Initial
Catalog=Elite_3E_Warehouse;User
ID=<username>;Password=<password>;Persist Security Info=False

The connection string will be stored in the Azure Key Vault.

Whenever the connection string is needed by the application, it is retrieved from


the key vault and discarded after the connection has been established. This way
the connection string will not be stored in plain text. If you remove the connection
string, Clocktimizer will no longer be able to import data.

Storing the connection string


Go to your Azure Portal and (if you don’t see your Clocktimizer resources already),
switch to the Clocktimizer directory by clicking on your profile picture in the top right and
switch directories.

1. Go into your Key Vault


2. Select Secrets.

12
Clocktimizer in the Cloud

3. Click on Generate/Import.

4. On the Create a secret screen choose the following values:


a. Upload options: Manual
b. Name: database-import-connection-string
c. Value: the database connection string (please see above for what the
database connection string should look like)
5. Leave the other values to their defaults.
6. Click Create.
Once you receive the message that the secret has been successfully created, you may
click on it on the list. You can then see some of the properties. If you click on the
current version, you can see the value you specified in the previous steps.

Verify the Connection


Once everything is set up, the connection needs to be tested. The tests will be
performed by the Clocktimizer engineer leading the installation.

13
Clocktimizer On-premises

Clocktimizer On-premises

Clocktimizer On-premises Network Diagram

14
Clocktimizer On-premises

Software Prerequisites
To make hosting as easy as possible, Clocktimizer relies on Microsoft industry-
standard technologies:
▪ Clocktimizer is a web application hosted on IIS 8.0 or higher.
▪ We use SQL Server 2017 or higher as database technology.

Web Server
▪ Windows Server 2017 R2 or higher
▪ Internet Information server 8.0 or higher with at least the following components:
 Application Development Features:
▫ ASP.NET
▫ .NET Extensibility
▫ ISAPI Extensions
▫ ISAPI Filters
▫ Application Initialization
▫ Common HTTP Features: All features, except WebDAV publishing
▫ Performance Features: All features
 Security:
▫ Request Filtering
▫ Windows Authentication
▪ Microsoft .NET 6
▪ Microsoft Web Deploy 3.0 or higher
▪ Microsoft C++ Redistributable 2017
▪ Microsoft .NET core Hosting bundle:
https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.4-windows-
hosting-bundle-installer
▪ Microsoft .NET 6 hosting bundle: https://dotnet.microsoft.com/en-
us/download/dotnet/6.0

Database Server
▪ Windows Server 2017 or higher
▪ Microsoft SQL server 2017 R2 or higher

15
Clocktimizer On-premises

Other Requirements
▪ Information about the authentication method. For more details, see the chapter
on Authentication.
▪ Chromium must be installed on the web server running Clocktimizer. However,
this step will be performed during deployment by a Clocktimizer engineer.
▪ An SMTP server is needed for the following functionality:
 Automatic Error reporting
 Recurring Reports
 Password reset functionality
Note: Clocktimizer no longer support Internet Explorer, or the legacy version of
Microsoft Edge.

Hardware Prerequisites
Clocktimizer recommends using different servers for the webserver and the database.
Clocktimizer will work if both tiers are hosted on the same server, but performance will
be reduced. As required memory depends on dataset size, Clocktimizer should be the
only application using the webserver.

Web Server
▪ x64 architecture
▪ Up to 1-million-time records: 8GB memory
▪ 1–15-million-time records: 16GB memory
▪ 15+ million-time records: 32GB memory
▪ Dual core processor
▪ 10GB free disk space

Database Server
In most cases, the database server will be used by more than one application.
Application performance depends on the aggregate workload of all these applications.
Note: These specifications apply to both the database server hosting the
Clocktimizer database and the server hosting the time tracking database.
▪ x64 architecture
▪ Up to 1-million-time records: 8GB memory

16
Clocktimizer On-premises

▪ 1–10-million-time records: 16GB memory


▪ 10–25-million-time records: 32GB memory
▪ 25+ million-time records: 64GB memory
▪ Quad-core processor
▪ 10KB free disk space per time record (assuming SQL Server Simple Recovery
Mode is used)

Virtualization
Clocktimizer has been verified to work in virtual machine environments.

Environment
We recommend setting up separate environments for production and staging. This way,
new versions can be evaluated without affecting the production environment. Each
environment has a separate hostname and database. Multiple environments can be
used on the same web server, but this may negatively affect performance.
Note: This nomenclature has nothing to do with the status of Clocktimizer within your
organization. Even for a proof of concept, we will set up a production
environment.

Preinstallation Requirements and Considerations


Before starting the deployment, you will need to make some choices. These choices
are listed here to ease planning. Once everything is set up, we can install the
application.

Web Application
You will need to select a hostname for the application. The hostname should be easy to
remember and point to the IP address of the webserver. While the hostname depends
on your network setup, we recommend that ‘clocktimizer’ is part of the hostname. Keep
in mind each environment needs a separate hostname. Examples:
▪ http://clocktimizer/ - Production environment
▪ http://clocktimizer-staging/ - Staging environment
Note: Before installing the web application, make sure that all hostnames resolve to
the correct IP Address of the webserver.

17
Clocktimizer On-premises

Data Extract
Clocktimizer will pull time card data from the practice management system. We support
all major systems like Elite Enterprise. We recommend creating (or reusing) a daily
copy of the practice management system database.
Note: The indices should also be duplicated on the copy for adequate extract
performance. Depending on your practice management system, please refer
to the Elite Enterprise, Elite 3E or Aderant Data extract sections in the
Appendix to see how the Clocktimizer data model is mapped to your PMS’
data model.

HTTP(S)
You will need to choose whether you want to use HTTPS or not. If Clocktimizer is only
accessed from the intranet, using HTTPS is not strictly necessary. However, since
setting up HTTPS is relatively easy, we recommend using HTTPS even in intranet-only
environments; That way, the application is future-proof. If you use HTTPS, you will
need to create a certificate for every hostname and the certificate needs to be installed
on the webserver.
Note: If you are using ADFS, HTTPS is required.

Service Account
By default, Internet Information Services (IIS) applications run under the same service
account as IIS. For user isolation, it is desirable that each application runs under a
different account. Therefore, we recommend that you create a domain account for
Clocktimizer.
Tip: Suggested username: clocktimizer_svc.
The account should have the following permissions:
▪ db_owner permissions on the Clocktimizer database
▪ db_reader permissions on the copy of the time tracking database.
▪ Local administrator rights on the webserver
It is not necessary to add separate service accounts for each environment. If your
security policy dictates that service accounts and interactive accounts should be
separated, you need to supply the usernames of both accounts.
Note: If the password of the service account changes, the account needs to be re-
assigned to the Clocktimizer application pool.

18
Clocktimizer On-premises

Database
You need to create a database that contains all information for the Clocktimizer
application:
▪ For the database name, we recommend Clocktimizer_{environment}. The
Production environment would use the database Clocktimizer_Production and
the Staging environment would use the database Clocktimizer_Staging.
▪ Database size: Assume 10kb/time card.
▪ Collation: You should use the default Latin case insensitive collation
(SQL_Latin1_General_CP1_CI_AS)
Make a note of the hostname (and instance, if applicable) of the database server. For
instance: PH_SQL01\Instance_CLM.

Checklist
The following information needs to be provided to us:
▪ Technical contacts’ names and email addresses
▪ Names of the environments
▪ Hostnames for all environments
▪ Horizon date and number of timecards
Note: Contact your Clocktimizer representative for the query for the number of
timecards.
▪ Name(s) of service account(s)
▪ Connection string to the Clocktimizer database(s) (db_owner permissions)
▪ Connection string to the time tracking database (db_reader permissions)
▪ Authentication method and details:
 WS-Federation: Federation Metadata address.
 OpenId Connect: Client identifier and metadata address
 Direct Domain Authentication (deprecated): Domain and Clocktimizer group
 SMTP:
▫ Hostname credentials if applicable
▫ Sender email address. It needs to be an existing user or needs to be
configured in the Clocktimizer portal

19
Clocktimizer On-premises

Data Extract
Clocktimizer will pull time card data from the practice management system into our own
proprietary database for efficient querying. After the first import, Clocktimizer will
perform an update every night.
Note: please refer to the Elite Enterprise, Elite 3E, or Aderant Data extract sections
in the Appendix to see how the Clocktimizer data model is mapped to your
PMS’ data model.
We support all major practice management systems and can also implement a data
connection to other systems as long as they are using Microsoft SQL Server.
Clocktimizer will only read data from the time tracking system and never write anything
back. We recommend using a copy of the time tracking database. This way, the
Clocktimizer extract can never interfere with day-to-day operations.
To set up a data extract, we will need some information from your Practice
Management System:
▪ Elite Enterprise:
 The name of the field of the table title containing the title description (tiglmask
or tititle).
 Related matters used (matter.mrelated), if any.
 If there are any database customizations that need to be included in the
extract, we need schemas for these tables.
▪ Elite 3E:
 Should Clocktimizer use Sections or Departments as its practice groups?
 If there are any database customizations that need to be included in the
extract, we need schemas for these tables.
▪ Aderant Expert:
 If there are any database customizations that need to be included in the
extract, we need schemas for these tables.
▪ Other practice management systems:
 You need to create database views for us to read from. Contact us for
details.
▪ Date range of the extract. Usually, we start with the horizon date set at 01-01-
2018. Any matter that was active on that date or opened after the date will be
imported completely.
▪ Should non-billable matters be included in the extract?

20
Clocktimizer On-premises

▪ The import window. Usually, Clocktimizer performs an import every night at 2


AM. If necessary (because of another extract for instance), we can use a
different import window.
Once we have all this information, we can create an Import Specification, describing the
mapping between your time tracking database and our database format. We can use it
to configure the import.

Initial Technical Implementation


The technical implementation of an on-premises Clocktimizer environment requires the
following items to be set up/available/performed:
▪ The customer needs to set up VMs, user accounts, etc. Please refer to Software
Prerequisites and Hardware Prerequisites for more details. These must be set
up before Clocktimizer can be installed.
▪ The software needs to be installed for all environments.
▪ Verification of external connectivity:
 Database connection
 Preferred authentication method
 E-mail
▪ Data verification. We will need a single closed historical matter ID that falls within
the data horizon and is verifiable in the source system (e.g. total numbers of
hours, total billed value, etc.) for the initial test import. Verify that the numbers
add up, and that all necessary fields (including user-defined values) are in the
database.
▪ Narrative-recognition-quality test.

Installation File Contents


You will be provided with a link to download the pre-configured version of Clocktimizer.
The following files in the .zip folder are key items for the installation:
▪ Setup-{Environment}.cmd - Creates the folder structure and prepares the
directory for deployment; this only needs to be done once during the initial
installation.
▪ Deploy-{Environment}.cmd - Copies the Clocktimizer files into the directory. It is
also used for upgrading to newer versions.

21
Clocktimizer On-premises

Installing Clocktimizer
Note: This will be done by the Clocktimizer team during the deployment call.
Clocktimizer team members please refer to the ‘On-premises deployment call
tasks’ document.

Post-implementation Tasks and Checks


Note: This will be done by the Clocktimizer team during the deployment call.
Clocktimizer team members please refer to the ‘On-premises deployment call
tasks’ document.

Upgrading Clocktimizer to the Latest Version


Note: Making sure their Clocktimizer version is always the latest is the customers’
responsibility.
A new version of Clocktimizer is released every two weeks. Clients must apply these
updates in a timely manner. The procedure is as follows:
1. You will receive an e-mail announcing the latest version with the release notes
and a download link.
2. Download the install archive. It should be called
Clocktimizer.{FirmName}.5.x.y.1.zip.
3. Copy the archive to C:\Clocktimizer\Releases and unzip it in this folder. The
contents should now be contained in the folder Clocktimizer.{FirmName}.5.x.y.1.
4. Open a command prompt with administrator rights and navigate to the new
folder.
5. Run Deploy-Staging.cmd to deploy to the application to the staging environment.
Note: Database migration will automatically be applied by the web application.
Both the web application and the importer will be updated.
6. Open a browser and navigate to /selftest/version on the staging environment.
7. Verify that the version is equal to the version number of the archive.
8. Perform any User Acceptance Tests required by your update policy.
9. Once you are satisfied, the update can be deployed to the production
environment by running Deploy-Production.cmd.
Note: All updates are cumulative. There is no need to deploy previous updates
if they have not been applied yet.

22
Clocktimizer On-premises

23
Appendix

Appendix

Glossary of Terms
Terms Description
Source database The database that contains the time
tracking data. For 80% of our clients, the
financial system is Elite Enterprise, Elite
3E, or Aderant Expert. Usually,
Clocktimizer doesn’t read directly from
the production database but from a copy
of the database used for DATA
WAREHOUSING PURPOSES.
Clocktimizer only reads from the source
database.
Clocktimizer database The SQL Server database that stores the
time card data and all other data that
needs to be persisted for Clocktimizer to
function, such as Accounts, Reports,
Configuration, etc.
Import specification An XML file which describes how the
source database should be mapped to
the Clocktimizer database. It is contained
in the pre-configured release package.
The database extract is changed by
updating the import specification (by
deploying the release package containing
it) and running a full import.
Data horizon The matter import date range for
Clocktimizer. Since older data is less
relevant for analysis and large data sets
can negatively impact performance, the
import is limited by time using a horizon
date. Matters are only imported if they
have one or more time cards with a
transaction date after the horizon date.
The horizon date is specified in the
import specification.
Daily import Import of matters with time cards that
have changed in the last seven days.

24
Appendix

Full database import Full import of the entire Clocktimizer


database with all the timecard data from
the source database after the horizon
date. In most cases, this is triggered
every Sunday.

Clocktimizer Data Model


The model uses the nomenclature that Clocktimizer uses internally. Our Terminology
layer allows the use of different terminologies, so the terms displayed in the application
match those used by the client.

Overview

25
Appendix

Office
The Office corresponds to a physical location where firm activities take place. It can
also be called Location. Both Matters and Time Keepers can belong to 0 or 1 office.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the office.
Example: AMS
Name NVARCHAR(MAX) Y Name of the office.
Example: Amsterdam

Section, Practice Group, and Department


These words correspond to organizational units, usually focused around one or more
legal areas. Both Matters and Time Keepers can belong to 0 or 1 section, practice
group and/or department.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier. Example:
COR
Name NVARCHAR(MAX) Y Name. Example:
Corporate

Employee
An employee can be anyone who records time or is associated with a matter or client.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the
employee
Name NVARCHAR(MAX) Y Name of the employee
Office VARCHAR(20) Y Office of the employee,
matching the key from
the Office table
PracticeGroup VARCHAR(20) N Practice group of the
employee, matching
the practice group table
Title NVARCHAR(20) N Title of the employee
CostBaseRate NUMERIC N Cost base rate of the
employee
CostBaseCurrency NVARCHAR(MAX) N If a rate is provided, a
currency must also be
set

26
Appendix

StandardRate NUMERIC N Standard rate of the


employee
StandardCurrency NVARCHAR(max) N If a rate is provided, a
currency must also be
set

EmployeeHistory
The employee history contains information about an employee which may change over
time, like the job title or standard hourly rate.

Clocktimizer Field Data Type Required Remarks


Employee NVARCHAR(20) Y Identifier of the
employee, matching
the key in the
employee table
StartDate DATETIME Y Start date of validity of
this record
EndDate DATETIME N End date of validity of
this record
Office VARCHAR(20) N Identifier of the office
PracticeGroup VARCHAR(20) N Identifier of the practice
group
Title NVARCHAR(MAX) N Job title
CostBaseRate NUMERIC N Cost base rate of the
employee
CostBaseCurrency NVARCHAR(MAX) N If a rate is provided, a
currency must also be
set
StandardRate NUMERIC N Standard rate of the
employee
StandardCurrency NVARCHAR(MAX) N If a rate is provided, a
currency must also be
set
ExtraValues Review the Extra Values section to learn more

Client
A client is a user of legal services.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the client
Name NVARCHAR(MAX) Y Name of the client

27
Appendix

Group NVARCHAR(MAX) N Used for grouping


clients
Manager NVARCHAR(20) N Refers to the employee
managing this client. It
must match the key in
the employee table
Sector NVARCHAR(MAX) N Client sector
Location NVARCHAR(MAX) N Client location
ExtraValues Review the Extra Values section to learn more

Matter
A matter is a unit of legal work, comparable to a project in project management
systems.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the matter
Name NVARCHAR(MAX) Y Name of the matter
RelatedKey NVARCHAR(20) N Identifier of the related
matter
JointlyBilledKey NVARCHAR(20) N Identifier of the related
matter
Office NVARCHAR(20) N Identifier of the office of
the matter
PracticeGroup NVARCHAR(20) N Identifier of the practice
group of the mater
Client NVARCHAR(20) Y Identifier of the matter
client. It must match a
key in the client table
Manager NVARCHAR(20) N Employee managing
this matter
Originator NVARCHAR(20) N Originating attorney of
this matter
CurrencyCode CHAR(3) Y The currency code
(ISO-4217). It can be
overridden on the time
card level
Type NVARCHAR(MAX) N Matter type
Sector NVARCHAR(MAX) N Matter sector

28
Appendix

MatterHistory
The employee history contains information about an employee which may change over
time, like the job title or standard hourly rate.

Clocktimizer Field Data Type Required Remarks


Matter NVARCHAR(20) Y Identifier of the matter
StartDate DATETIME Y Start date of validity of
this record
EndDate DATETIME N End date of validity of
this record
PracticeGroup NVARCHAR(20) N Identifier of the practice
group
Office NVARCHAR(20) N Identifier of the office
Manager NVARCHAR(20) N The employee
responsible for
managing the matter
Originator NVARCHAR(20) N The employee that
referred the work to the
firm
ExtraValues Review the Extra Values section to learn more

Timecard
Timecards are the main source of truth for Clocktimizer.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the time
card
Employee NVARCHAR(20) Y Identifier of the
employee
Matter NVARCHAR(20) Y Identifier of the matter
Date DATETIME Y Worked date /
transaction date
DateBilled DATETIME N Bill date / invoice date
DateWritten DATETIME N Written date / post date
DatePaid DATETIME N Date the invoice was
paid / collection date
Currency CHAR(3) N The currency code
(ISO-4217). In most
cases, this can be sot
on the matter level
Duration NUMERIC Y Decimal hours

29
Appendix

WorkedValue NUMERIC N Worked value /


recorded value
WorkedRate NUMERIC N Worked rate / recorded
rate
CostBaseValue NUMERIC N Value at cost base rate.
It can also be derived
from the
EmployeeHistory table
CostBaseRate NUMERIC N Cost base rate
StandardRate NUMERIC N Standard rate
BilledValue NUMERIC N Billd value
BilledRate NUMERIC N Billed rate
PaidValue NUMERIC N Paid value / collected
value
PaidRate NUMERIC N Paid rate
OpenValue NUMERIC N Open value
WipValue NUMERIC N Work in progress
Narrative NVARCHAR(MAX) Y Narrtive of the timecard
Action NVARCHAR(64) N Action description
Phase NVARCHAR(64) N Phase description
Task NVARCHAR(64) N Task description
ExtraValues Review the Extra Values section to learn more

Disbursement
Disbursements contain information about expenses.

Clocktimizer Field Data Type Required Remarks


Key NVARCHAR(20) Y Identifier of the time
card
Employee NVARCHAR(20) Y Identifier of the
employee
Matter NVARCHAR(20) Y Identifier of the matter
Date DATETIME Y Worked date /
transaction date
DateBilled DATETIME N Bill date / invoice date
DateWritten DATETIME N Written date / post date
DatePaid DATETIME N Date the invoice was
paid / collection date
Currency CHAR(3) N The currency code
(ISO-4217). In most

30
Appendix

cases, this can be sot


on the matter level
Duration NUMERIC Y Decimal hours
RecordedValue NUMERIC N Worked value /
recorded value
recordedRate NUMERIC N Worked rate / recorded
rate
CostBaseValue NUMERIC N Value at cost base rate.
It can also be derived
from the
EmployeeHistory table
CostBaseRate NUMERIC N Cost base rate
StandardRate NUMERIC N Standard rate
BilledValue NUMERIC N Billd value
BilledAmount NUMERIC N Billed amount
OpenValue NUMERIC N Open value
WipValue NUMERIC N Work in progress
PaidValue NUMERIC N Paid value / collected
value
Narrative NVARCHAR(MAX) Y Narrative of the
timecard
Action NVARCHAR(64) N Action description
Phase NVARCHAR(64) N Phase description
Task NVARCHAR(64) N Task description
Cost NVARCHAR(64) N Cost code / description
Unit NVARCHAR(64) N Type of unit used in
disbursement
IsPassthrough BIT N Hard / Soft
disbursement

ExtraValues
ExtraValues provide a way of customizing Clocktimizer, so that if our existing data-
model doesn't include something that a client uses on a daily basis, like an extra
column for an entity (Client, Matter, Timecard etc.), it can be included.
There is a very strict limit to these because they can grow out of control and could clog
the whole environment: Due to the way the values are stored, the ExtraValues system
should only be used to store variables with a limited number of values.
▪ Good candidates for ExtraValues:
 Time Keeper Profit Center

31
Appendix

 Matter State
▪ Poor candidates for ExtraValues:
 Total Deal Value
 Bill Notes

32
Appendix

Aderant Expert Data Extract


This section describes how the Clocktimizer data model is mapped to the Aderant data
model.
You can find a Google sheet document called Data Mapping Explanation with these
fields at the link below.
Download it, keep only the fields relevant for the correct financial system and send the
file to the customers so it is easier for them to fill in the information required.
https://drive.google.com/drive/folders/1dcO1dxVs7nGV_pzOFEVE_7kfx_NhCKFq

Data Size
The number of time cards in the extract can be estimated by running the following
query:
SELECT COUNT(*) FROM [TAT_TIME]
WHERE [MATTER_UNO] IN
(
SELECT DISTINCT [MATTER_UNO] FROM [TAT_TIME] WHERE [TRAN_DATE] >= '2018-
01-01'
)

Office
Clocktimizer Field Aderant Field Remarks
Key HBL_OFFICE.OFFC_CODE
Name HBL_OFFICE.OFFC_DESC

Practice Group
Clocktimizer Field Aderant Field Remarks
Key HBL_DEPT.DEPT_CODE
Name HBL_DEPT.DEPT_NAME

33
Appendix

Employee
Clocktimizer uses the hba_persnl_modd table for historical values. The transaction date
of the time card will be used to determine which entry of the hba_persnl_modd table will
be used. Clocktimizer can include cost base and/or standard rates from the timerate .

Clocktimizer Field Aderant Field Remarks


Key HBM_PERSNL.EMPL_UNO

FirstName HBM_PERSNL.INITIALS

LastName HBM_PERSNL.EMPLOYEE_NAME

Office HBA_PERSNL_MODD.OFFC

PracticeGroup HBA_PERSNL_MODD.DEPT

ProfitCenter HBA_PERSNL_MODD.PROF

Title HBA_PERSNL_MODD.TBL_RANK.RANK_DESC

Client
Clocktimizer supports Aderant User Defined Fields on the client level. We need the
vist and udfindex values for each user-defined value to add them.

Clocktimizer Field Aderant Field Remarks


Key HBM_CLIENT.CLIENT_CODE

Name HBM_CLIENT.CLIENT_NAME

Matter
Clocktimizer Aderant Field Remarks
Field
Key HBM_MATTER.MATTER_CODE

Name HBM_MATTER.MATTER_NAME

34
Appendix

CurrencyCode TBM_MATTER.CURRENCY_CODE If no currency is specified, the default


currency will be used. The default currency
can be configured.
Office HBM_MATTER.OFFC

PracticeGroup HBM_MATTER.DEPT

Type HBM_MATTER.MATT_TYPE_CODE

OpenDate HBM_MATTER.0PEN_DATE

CloseDate HBM_MATTER.CLOSE_DATE

RateLevelCode TBM_MATTER.RATE_LEVEL

Time Card
Note: Deleted time cards are excluded (wip_status in ('x', 'n')).

Clocktimizer Aderant Field Remarks


Field
Key TAT_TIME.TIME_UNO

Date TAT_TIME.TRAN_DATE

DateBilled BLT_BILL.BILL_DATE

DateWritten TAT_TIME.POST-DATE

Hours TAT_TIME.BASE_HRS

RecordedVAlue TAT_TIME.BASE_AMT Also known as worked value

BilledValue TAT_TIME.BILLED_AMT Pre-billed value (ENTRY_STATUS = ‘P’ is


not included)
Action TBL_ACTION.ACTION_DESC

Phase TBL_PHASE.PHASE_DESC

Task TBL—TASK.TASK_DESC

Status TAT_TIME.ENTRY_STATUS

35
Appendix

Tables
These tables are required by the data extract:
▪ HBL_OFFICE
▪ HBL_DEPT
▪ HBM_PERSNL
▪ HBL_PERSNL_TYPE
▪ TBM_PERSNL
▪ TBL_RANK
▪ HBA_PERSNL_MODD
▪ TBL_RANK
▪ HBL_PROF_CTR
▪ HBM_CLIENT
▪ HBM_MATTER
▪ TBM_MATTER
▪ TBH_MATTER_SUMM
▪ HBL_MATT_TYPE
▪ TAT_TIME
▪ TAT_TEXT
▪ HBM_MATTER
▪ TAL_ACTION
▪ TBL_PHTASK
▪ TBL_PHASE
▪ TBL_TASK
▪ BLT_BILL
▪ CDL_COST
▪ CDT_DISB

36
Appendix

Elite 3E Data Extract


This section describes how the Clocktimizer data model is mapped to the Elite 3E data
model.

Data Size
The number of time cards in the extract can be determined by running the following
query:
WHERE [Matter] IN
(
SELECT DISTINCT [Matter] FROM [Timecard] WHERE [WorkDate] >= '2018-01-01'
)

Confidentiality
Matters and clients can be marked as clients confidential in 3E. Clocktimizer can
handle confidential data in two ways:

▪ Display client names, matter names, and time card narratives for confidential
matters and clients, just like for regular matters.
▪ Mask confidential client names, matter names, and time card narratives.

Office
Clocktimizer Field 3E Field Remarks
Key Office.Code

Name Office.Description

Practice Group
Elite 3E uses sections and Departments as organizational units. By default,
Clocktimizer will use the Department table as the practice group, but it is also possible
to use the Section table instead.

37
Appendix

Clocktimizer Field 3E Field Remarks


Key Department.Code or Section.Code

Name Department.Description or Section.Description

Employee
Clocktimizer uses the TkprDate table for historical values. The transaction date of the
time card will be used to determine which entry of the TkprDate table will be used.
Clocktimizer can include cost base rates from the TkprRateDate table . We need to
know the value of the RateType field to configure this field.

Clocktimizer Field 3E Field Remarks


Key Timekeeper.Number and TkprDate.Number

DisplayName Timekeeper.DisplayName

Office TkprDate.Office

PracticeGroup TkprDate.Department or TkprDate.Section

Title TkprDate.Title.Description

StartDate TkprDateDate.EffStart

RateClass TkprDate.RateClass.Description

CostBaseCurrency TkprRateDate.Currency Optional


CostBaseRate TkprRateDate.DefaultRate Optional

Client
Clocktimizer 3E Field Remarks
Field
Key Client.Number
Name Client.DisplayName See confidentiality
RelatedMatter RelMattIndex.Name See confidentiality
Key Matter.Code

38
Appendix

CurrencyCode Matter.Currency If no currency is specified, the


default currency will be used. The
default currency can be configured.
Status Matter.MattStatus
OpenDate Matter.OpenDate
CloseDate Matter.CloseDate
Type MattType.Description
Sector MattCategory.Description
Office MattDate.Office
PracticeGroup MattDate.Department or
MattDate.Section
Manager MattDate.RspTkpr , The managing time keeper of the
MattDate.SpvTkpr , or matter
MattDate.BillTkpr
Originator MattDate.BillTkpr , The originating time keeper of the
MattDate.SpvTkpr, or matter. By default, the BillTkpr
MattDate.RspTkpr field is used for this

Matter
Clocktimizer uses the MattDate fgtable for historical values. The transaction date of the
time card will be used to determine which entry of the MattDate table will be used.

Clocktimizer 3E Field Remarks


Field
Key Matter.Code
Name Matter.Name See confidentiality
RelatedMatter RelMattIndex.Name See confidentiality
Key Matter.Code
CurrencyCode Matter.Currency If no currency is specified, the
default currency will be used. The
default currency can be configured.
Status Matter.Status
OpenDate Matter.OpenDate
CloseDate Matter.CloseDate
Type MattType.Description
Sector MattCategory.Description
Office MattDate.Office

39
Appendix

PracticeGroup MattDate. Department or


MattDate.Section
Manager MattDate.RspTkpr, The managing time keeper of the
MattDate.SpvTkpr, or matter
MattDate.BillTkpr
Originator MattDate.BillTkpr, The originating time keepr of the
MattDate.SpvTkpr, or matter. By default, the BillTkpr
MatttDate.RspTkpr field is used for this

TimeCard
By default, non-billable time cards (as determined by Matter.IsNonBillable are not
included in the extract. Time cards are only included if TimeCard.IsActive = 1.

Clocktimizer 3E Field Remarks


Field
Key TimeBill.TimeBillIndex and
TimeCard.TimeCardIndex
Narrative Narrative_UnformattedText See confidentiality
Date TimeCard.WorkDate
DateBilled TimeBill.CurrDate
DateWritten TimeCard.PostDate
Currency TimeBill.Currency or By default, the currency from the
Matter.Currency TimeBill field is used. If this has not
been set, the currency of the matter is
used instead.
Hours TimeBill.WorkHrs or
TimeCard.WorkHrs
RecordedValue TimeBill.WorkAmt or Also known as worked value
TimeCard.WorkAmt
WipValue TimeCard.WipAmt Time cards are only considered Work in
Progress if
Time.Card.WipRemoveDate is NULL
BilledValue TimeBill.BillAmt
StandardValue TimeBill.StdAmt or Also known as value against rack rate
Time.Card.StdAmt
PaidValue SUM(TimeRcpt.CollAmt) Also known as collected value
TimeType Timecard.TimeType
TransactionType Timecard.TransactionType

40
Appendix

Action Action.Description
Phase Phase.Description
Task Task.Description

Tables
These tables are required by the Clocktimizer Extract:
▪ Office
▪ Section
▪ Department
▪ PracticeGroup
▪ Timekeeper
▪ TkprDate
▪ TkprRateDate
▪ RateClass
▪ Title
▪ Client
▪ CliAttribute
▪ CliCategory
▪ Matter
▪ MattType
▪ MattCategory
▪ MattAttribute
▪ MattDate
▪ Timebill
▪ Timecard
▪ TimeRcpt
▪ Phase
▪ Task
▪ Activity

41
Appendix

Elite Enterprise Data Extract


This section describes how the Clocktimizer data model is mapped to the Elite
Enterprise data model.
You can find a Google sheet document called Data Mapping Explanation with these
fields at the link below.
Download it, keep only the fields relevant for the correct financial system and send the
file to the customers so it is easier for them to fill in the information required.
https://drive.google.com/drive/folders/1dcO1dxVs7nGV_pzOFEVE_7kfx_NhCKFq

Data Size
The number of time cards in the extract can be determined by running the following
query:
SELECT COUNT(tindex) FROM timecard WHERE tmatter in (
SELECT tmatter FROM timecard
LEFT OUTER 30IN matter ON tmatter = mmatter
WHERE tworkdt > '2016-01-01'
AND mnonbill IS NULL
)

Where ‘2016-01-01’ is the horizon. The line AND mnobill IS NULL can be omitted if
non-billable matters are included.

Customizations
▪ Time Keeper rates: If standard and/or cost base rates are stored in the
timerate table, we can add them to the data extract. For this, we need to know
the names of the fields and type of rate they store. For example, tkrt01 contains
the standard rate.
▪ Exchange rates: We can use exchange rates from the currates table. We need
to know:
 The default currency and
 The value of the trtype field. Usually, this is H(istorical) or M(onthly).

Office
Clocktimizer Field Enterprise Field Remarks

42
Appendix

Key location.locode

Name location.ldesc

Practice Group
Clocktimizer Field Enterprise Field Remarks
Key deptlab.delcode

Name deptlab.head1 See confidentiality

Employee
Clocktimizer uses the htkeep table for historical values. The transaction date of the
time card will be used to determine which entry of the htkeep table will be used.
Clocktimizer can include cost base and/or standard rates from the timerate.

Clocktimizer Field Enterprise Field Remarks


Key timekeep.tkinit

FirstName timekeep.tkfirst

LastName timekeep.tklast

Office htkeep.htloc

PracticeGroup htkeep.htdept

Title htkeep.tiglmask or timerate.tkrt02

CostBaseCurrency timerate.tkrtcur Optional


CostBaseRate timerate.tkrt01 or timerate.tkrt02 Optional
StandardCurrency timerate.tkrtcur Optional
StandardRate timerate.tkrt01 or timerate.tkrt02 Optional

Client
Cloctkimizer supports Elite Enterprise User Defined Fields on the client level. We need
the vlst and udfindex values for each user defined value to add them.

43
Appendix

Clocktimizer Field Enterprise Field Remarks


Key client.clnum

Name client.clname1

Manager client.corgaty

Matter
Clocktimizer uses the hmatter table for historical values. The transaction date of the
time card will be used to determine which entry of the hmatter table will be used.
Cloctkimizer supports Elite Enterprise User Defined Fields on the client level. We need
the vlst and udfindex values for each user defined value to add them.

Clocktimizer Enterprise Field Remarks


Field
Key matter.mmatter
Name Matter.mdesc1,
matter.mdesc2, and
matter.mdesc3
RelatedMatter matter.mrelated
CurrencyCode matter.mcurrency If no currency is specified, the default
currency will be used. The default currency
can be configured.
Language matter.mlang It must be ISO-639-2 two-letter language
code.
Office matter.mloc
OpenDate matter.mopendt
CloseDate matter.mclosedt
PracticeGroup matter.mdept
Manager hmatter.hmsaty The managing time keeper of the matter.
Originator hmatter.hmbaty The originating time keeper of the matter.

Time Card
By default, non-billable time cards, as determined by matter.mnonbill are not included
in the exctract. Deleted time cards are excluded ( tstatus IN (‘ADE’, ‘D’, ‘E’) ).

44
Appendix

Clocktimizer Enterprise Field Remarks


Field
Key timecard.tindex
Date timecard.tworkdt
DateBilled timecard.tbiper.pebedt
DateWritten N/A
Hours timecard.tworkhrs
RecordedValue timecard.tworkdol Also known as worked value
WipValue timecard.tworkdol or Time cards are only considered work in progress
NULL if timecard.tbiper is NULL or tstatus IN
(‘NB’, ‘NPB’, ‘P’, ‘PB’, ‘WA’)
BilledValue timecard.tbilldol
Action actcode.actname
Status timecard.tstatus

Tables
These are the Elite Enterprise tables that are used by our data extract:
▪ location
▪ deptlab
▪ timekeep
▪ htkeep
▪ title
▪ timerate
▪ accrate
▪ client
▪ matter
▪ hmatter
▪ timecard
▪ timedesc
▪ actcode
▪ periodt
▪ udf
▪ udfvlst
▪ curates

45

You might also like