2 # 1) Create a database using the "CREATE DATABASE" mysql command.
3 # 2) Then, execute this script from command prompt with a command like this:
4 # mysql -h host -u user -p -D db_name < mysql.sql
6 # create database timetracker character set = 'utf8';
12 # Structure for table tt_teams. A team is a group of users for whom we are tracking work time.
13 # This table stores settings common to all team members such as language, week start day, etc.
15 CREATE TABLE `tt_teams` (
16 `id` int(11) NOT NULL auto_increment, # team id
17 `timestamp` timestamp default CURRENT_TIMESTAMP, # Modification timestamp. TODO: redo all timestamps to survive beyond 2038.
18 `name` varchar(80) default NULL, # team name
19 `currency` varchar(7) default NULL, # team currency symbol
20 `decimal_mark` char(1) NOT NULL default '.', # separator in decimals
21 `lang` varchar(10) NOT NULL default 'en', # language
22 `date_format` varchar(20) NOT NULL default '%Y-%m-%d', # date format
23 `time_format` varchar(20) NOT NULL default '%H:%M', # time format
24 `week_start` smallint(2) NOT NULL default 0, # Week start day, 0 == Sunday.
25 `tracking_mode` smallint(2) NOT NULL default 1, # tracking mode ("time", "projects" or "projects and tasks")
26 `project_required` smallint(2) NOT NULL default 0, # whether a project selection is required or optional
27 `task_required` smallint(2) NOT NULL default 0, # whether a task selection is required or optional
28 `record_type` smallint(2) NOT NULL default 0, # time record type ("start and finish", "duration", or both)
29 `bcc_email` varchar(100) default NULL, # bcc email to copy all reports to
30 `plugins` varchar(255) default NULL, # a list of enabled plugins for team
31 `lock_spec` varchar(255) default NULL, # Cron specification for record locking,
32 # for example: "0 10 * * 1" for "weekly on Mon at 10:00".
33 `workday_minutes` smallint(4) default 480, # number of work minutes in a regular working day
34 `custom_logo` tinyint(4) default 0, # whether to use a custom logo or not
35 `config` text default NULL, # miscellaneous team configuration settings
36 `status` tinyint(4) default 1, # team status
42 # Structure for table tt_roles. This table stores customized team roles.
44 CREATE TABLE `tt_roles` (
45 `id` int(11) NOT NULL auto_increment, # Role id. Identifies roles for all groups on the server.
46 `team_id` int(11) NOT NULL, # Team id the role is defined for.
47 `name` varchar(80) default NULL, # Role name - custom role name. In case we are editing a
48 # predefined role (USER, etc.), we can rename the role here.
49 `description` varchar(255) default NULL, # Role description.
50 `rank` int(11) default 0, # Role rank, an integer value between 0-324. Predefined role ranks:
51 # USER - 4, CLIENT - 16, COMANAGER - 68, MANAGER - 324.
52 # Rank is used to determine what "lesser roles" are in each group
53 # for sutuations such as "manage_users".
54 # It also identifies a role within a team (by its "rank").
55 # Value of rank is to be used in role field in tt_users table,
56 # just like standard roles now.
57 `rights` text default NULL, # Comma-separated list of rights assigned to a role.
58 # NULL here for predefined roles (4, 16, 68, 324 - manager)
59 # means a hard-coded set of default access rights.
60 `status` tinyint(4) default 1, # Role status.
64 # Create an index that guarantees unique active and inactive role ranks in each group.
65 create unique index role_idx on tt_roles(team_id, rank, status);
67 # Insert site-wide roles - site administrator and top manager.
68 INSERT INTO `tt_roles` (`team_id`, `name`, `rank`, `rights`) VALUES (0, 'Site administrator', 1024, 'administer_site');
69 INSERT INTO `tt_roles` (`team_id`, `name`, `rank`, `rights`) VALUES (0, 'Top manager', 512, 'track_own_time,track_own_expenses,view_own_reports,view_own_charts,view_own_invoices,manage_own_settings,view_users,track_time,track_expenses,view_reports,view_charts,override_punch_mode,override_own_punch_mode,override_date_lock,override_own_date_lock,swap_roles,approve_timesheets,manage_users,manage_projects,manage_tasks,manage_custom_fields,manage_clients,manage_invoices,manage_features,manage_basic_settings,manage_advanced_settings,manage_roles,export_data,manage_subgroups');
73 # Structure for table tt_users. This table is used to store user properties.
75 CREATE TABLE `tt_users` (
76 `id` int(11) NOT NULL auto_increment, # user id
77 `timestamp` timestamp default CURRENT_TIMESTAMP, # modification timestamp
78 `login` varchar(50) COLLATE utf8_bin NOT NULL, # user login
79 `password` varchar(50) default NULL, # password hash
80 `name` varchar(100) default NULL, # user name
81 `team_id` int(11) NOT NULL, # team id
82 `role_id` int(11) default NULL, # role id
83 `client_id` int(11) default NULL, # client id for "client" user role
84 `rate` float(6,2) NOT NULL default '0.00', # default hourly rate
85 `email` varchar(100) default NULL, # user email
86 `created` datetime default NULL, # creation timestamp
87 `created_ip` varchar(45) default NULL, # creation ip
88 `created_by` int(11) default NULL, # creator user_id (null for self)
89 `modified` datetime default NULL, # modification timestamp
90 `modified_ip` varchar(45) default NULL, # modification ip
91 `modified_by` int(11) default NULL, # modifier user_id
92 `accessed` datetime default NULL, # last access timestamp
93 `accessed_ip` varchar(45) default NULL, # last access ip
94 `status` tinyint(4) default 1, # user status
98 # Create an index that guarantees unique active and inactive logins.
99 create unique index login_idx on tt_users(login, status);
101 # Create admin account with password 'secret'. Admin is a superuser, who can create teams.
102 DELETE from `tt_users` WHERE login = 'admin';
103 INSERT INTO `tt_users` (`login`, `password`, `name`, `team_id`, `role_id`) VALUES ('admin', md5('secret'), 'Admin', '0', (select id from tt_roles where rank = 1024));
107 # Structure for table tt_projects.
109 CREATE TABLE `tt_projects` (
110 `id` int(11) NOT NULL auto_increment, # project id
111 `team_id` int(11) NOT NULL, # team id
112 `name` varchar(80) COLLATE utf8_bin NOT NULL, # project name
113 `description` varchar(255) default NULL, # project description
114 `tasks` text default NULL, # comma-separated list of task ids associated with this project
115 `status` tinyint(4) default 1, # project status
119 # Create an index that guarantees unique active and inactive projects per team.
120 create unique index project_idx on tt_projects(team_id, name, status);
124 # Structure for table tt_tasks.
126 CREATE TABLE `tt_tasks` (
127 `id` int(11) NOT NULL auto_increment, # task id
128 `team_id` int(11) NOT NULL, # team id
129 `name` varchar(80) COLLATE utf8_bin NOT NULL, # task name
130 `description` varchar(255) default NULL, # task description
131 `status` tinyint(4) default 1, # task status
135 # Create an index that guarantees unique active and inactive tasks per team.
136 create unique index task_idx on tt_tasks(team_id, name, status);
140 # Structure for table tt_user_project_binds. This table maps users to assigned projects.
142 CREATE TABLE `tt_user_project_binds` (
143 `id` int(11) NOT NULL auto_increment, # bind id
144 `user_id` int(11) NOT NULL, # user id
145 `project_id` int(11) NOT NULL, # project id
146 `rate` float(6,2) default '0.00', # rate for this user when working on this project
147 `status` tinyint(4) default 1, # bind status
151 # Create an index that guarantees unique user to project binds.
152 create unique index bind_idx on tt_user_project_binds(user_id, project_id);
156 # Structure for table tt_project_task_binds. This table maps projects to assigned tasks.
158 CREATE TABLE `tt_project_task_binds` (
159 `project_id` int(11) NOT NULL, # project id
160 `task_id` int(11) NOT NULL # task id
163 # Indexes for tt_project_task_binds.
164 create index project_idx on tt_project_task_binds(project_id);
165 create index task_idx on tt_project_task_binds(task_id);
169 # Structure for table tt_log. This is the table where time entries for users are stored.
170 # If you use custom fields, additional info for each record may exist in tt_custom_field_log.
172 CREATE TABLE `tt_log` (
173 `id` bigint NOT NULL auto_increment, # time record id
174 `timestamp` timestamp default CURRENT_TIMESTAMP, # modification timestamp
175 `user_id` int(11) NOT NULL, # user id
176 `date` date NOT NULL, # date the record is for
177 `start` time default NULL, # record start time (for example, 09:00)
178 `duration` time default NULL, # record duration (for example, 1 hour)
179 `client_id` int(11) default NULL, # client id
180 `project_id` int(11) default NULL, # project id
181 `task_id` int(11) default NULL, # task id
182 `invoice_id` int(11) default NULL, # invoice id
183 `comment` text, # user provided comment for time record
184 `billable` tinyint(4) default 0, # whether the record is billable or not
185 `paid` tinyint(4) default 0, # whether the record is paid
186 `status` tinyint(4) default 1, # time record status
190 # Create indexes on tt_log for performance.
191 create index date_idx on tt_log(date);
192 create index user_idx on tt_log(user_id);
193 create index client_idx on tt_log(client_id);
194 create index invoice_idx on tt_log(invoice_id);
195 create index project_idx on tt_log(project_id);
196 create index task_idx on tt_log(task_id);
200 # Structure for table tt_invoices. Invoices are issued to clients for billable work.
202 CREATE TABLE `tt_invoices` (
203 `id` int(11) NOT NULL auto_increment, # invoice id
204 `team_id` int(11) NOT NULL, # team id
205 `name` varchar(80) COLLATE utf8_bin NOT NULL, # invoice name
206 `date` date NOT NULL, # invoice date
207 `client_id` int(11) NOT NULL, # client id
208 `status` tinyint(4) default 1, # invoice status
212 # Create an index that guarantees unique invoice names per team.
213 create unique index name_idx on tt_invoices(team_id, name, status);
217 # Structure for table tt_tmp_refs. Used for reset password mechanism.
219 CREATE TABLE `tt_tmp_refs` (
220 `timestamp` timestamp default CURRENT_TIMESTAMP, # creation timestamp
221 `ref` char(32) NOT NULL default '', # unique reference for user, used in urls
222 `user_id` int(11) NOT NULL # user id
227 # Structure for table tt_fav_reports. Favorite reports are pre-configured report configurations.
229 CREATE TABLE `tt_fav_reports` (
230 `id` int(11) NOT NULL auto_increment, # favorite report id
231 `name` varchar(200) NOT NULL, # favorite report name
232 `user_id` int(11) NOT NULL, # user id favorite report belongs to
233 `report_spec` text default NULL, # future replacement field for all report settings
234 `client_id` int(11) default NULL, # client id (if selected)
235 `cf_1_option_id` int(11) default NULL, # custom field 1 option id (if selected)
236 `project_id` int(11) default NULL, # project id (if selected)
237 `task_id` int(11) default NULL, # task id (if selected)
238 `billable` tinyint(4) default NULL, # whether to include billable, not billable, or all records
239 `invoice` tinyint(4) default NULL, # whether to include invoiced, not invoiced, or all records
240 `paid_status` tinyint(4) default NULL, # whether to include paid, not paid, or all records
241 `users` text default NULL, # Comma-separated list of user ids. Nothing here means "all" users.
242 `period` tinyint(4) default NULL, # selected period type for report
243 `period_start` date default NULL, # period start
244 `period_end` date default NULL, # period end
245 `show_client` tinyint(4) NOT NULL default 0, # whether to show client column
246 `show_invoice` tinyint(4) NOT NULL default 0, # whether to show invoice column
247 `show_paid` tinyint(4) NOT NULL default 0, # whether to show paid column
248 `show_project` tinyint(4) NOT NULL default 0, # whether to show project column
249 `show_start` tinyint(4) NOT NULL default 0, # whether to show start field
250 `show_duration` tinyint(4) NOT NULL default 0, # whether to show duration field
251 `show_cost` tinyint(4) NOT NULL default 0, # whether to show cost field
252 `show_task` tinyint(4) NOT NULL default 0, # whether to show task column
253 `show_end` tinyint(4) NOT NULL default 0, # whether to show end field
254 `show_note` tinyint(4) NOT NULL default 0, # whether to show note column
255 `show_custom_field_1` tinyint(4) NOT NULL default 0, # whether to show custom field 1
256 `show_totals_only` tinyint(4) NOT NULL default 0, # whether to show totals only
257 `group_by` varchar(20) default NULL, # group by field
258 `status` tinyint(4) default 1, # favorite report status
264 # Structure for table tt_cron. It is used to email favorite reports on schedule.
266 CREATE TABLE `tt_cron` (
267 `id` int(11) NOT NULL auto_increment, # entry id
268 `team_id` int(11) NOT NULL, # team id
269 `cron_spec` varchar(255) NOT NULL, # cron specification, "0 1 * * *" for "daily at 01:00"
270 `last` int(11) default NULL, # UNIX timestamp of when job was last run
271 `next` int(11) default NULL, # UNIX timestamp of when to run next job
272 `report_id` int(11) default NULL, # report id from tt_fav_reports, a report to mail on schedule
273 `email` varchar(100) default NULL, # email to send results to
274 `cc` varchar(100) default NULL, # cc email to send results to
275 `subject` varchar(100) default NULL, # email subject
276 `report_condition` varchar(255) default NULL, # report condition, "count > 0" for sending not empty reports
277 `status` tinyint(4) default 1, # entry status
283 # Structure for table tt_clients. A client is an entity for whom work is performed and who may be invoiced.
285 CREATE TABLE `tt_clients` (
286 `id` int(11) NOT NULL AUTO_INCREMENT, # client id
287 `team_id` int(11) NOT NULL, # team id
288 `name` varchar(80) COLLATE utf8_bin NOT NULL, # client name
289 `address` varchar(255) default NULL, # client address
290 `tax` float(6,2) default '0.00', # applicable tax for this client
291 `projects` text default NULL, # comma-separated list of project ids assigned to this client
292 `status` tinyint(4) default 1, # client status
296 # Create an index that guarantees unique active and inactive clients per team.
297 create unique index client_name_idx on tt_clients(team_id, name, status);
301 # Structure for table tt_client_project_binds. This table maps clients to assigned projects.
303 CREATE TABLE `tt_client_project_binds` (
304 `client_id` int(11) NOT NULL, # client id
305 `project_id` int(11) NOT NULL # project id
308 # Indexes for tt_client_project_binds.
309 create index client_idx on tt_client_project_binds(client_id);
310 create index project_idx on tt_client_project_binds(project_id);
314 # Structure for table tt_config. This table is used to store configuration info for users.
315 # For example, last_report_email parameter stores an email for user last report was emailed to.
317 CREATE TABLE `tt_config` (
318 `user_id` int(11) NOT NULL, # user id
319 `param_name` varchar(32) NOT NULL, # parameter name
320 `param_value` varchar(80) default NULL # parameter value
323 # Create an index that guarantees unique parameter names per user.
324 create unique index param_idx on tt_config(user_id, param_name);
327 # Below are the tables used by CustomFields plugin.
330 # Structure for table tt_custom_fields. This table contains definitions of custom fields.
332 CREATE TABLE `tt_custom_fields` (
333 `id` int(11) NOT NULL auto_increment, # custom field id
334 `team_id` int(11) NOT NULL, # team id
335 `type` tinyint(4) NOT NULL default 0, # custom field type (text or dropdown)
336 `label` varchar(32) NOT NULL default '', # custom field label
337 `required` tinyint(4) default 0, # whether this custom field is mandatory for time records
338 `status` tinyint(4) default 1, # custom field status
344 # Structure for table tt_custom_field_options. This table defines options for dropdown custom fields.
346 CREATE TABLE `tt_custom_field_options` (
347 `id` int(11) NOT NULL auto_increment, # option id
348 `field_id` int(11) NOT NULL, # custom field id
349 `value` varchar(32) NOT NULL default '', # option value
355 # Structure for table tt_custom_field_log.
356 # This table supplements tt_log and contains custom field values for records.
358 CREATE TABLE `tt_custom_field_log` (
359 `id` bigint NOT NULL auto_increment, # cutom field log id
360 `log_id` bigint NOT NULL, # id of a record in tt_log this record corresponds to
361 `field_id` int(11) NOT NULL, # custom field id
362 `option_id` int(11) default NULL, # Option id. Used for dropdown custom fields.
363 `value` varchar(255) default NULL, # Text value. Used for text custom fields.
364 `status` tinyint(4) default 1, # custom field log entry status
370 # Structure for table tt_expense_items.
371 # This table lists expense items.
373 CREATE TABLE `tt_expense_items` (
374 `id` bigint NOT NULL auto_increment, # expense item id
375 `date` date NOT NULL, # date the record is for
376 `user_id` int(11) NOT NULL, # user id the expense item is reported by
377 `client_id` int(11) default NULL, # client id
378 `project_id` int(11) default NULL, # project id
379 `name` text NOT NULL, # expense item name (what is an expense for)
380 `cost` decimal(10,2) default '0.00', # item cost (including taxes, etc.)
381 `invoice_id` int(11) default NULL, # invoice id
382 `paid` tinyint(4) default 0, # whether the item is paid
383 `status` tinyint(4) default 1, # item status
387 # Create indexes on tt_expense_items for performance.
388 create index date_idx on tt_expense_items(date);
389 create index user_idx on tt_expense_items(user_id);
390 create index client_idx on tt_expense_items(client_id);
391 create index project_idx on tt_expense_items(project_id);
392 create index invoice_idx on tt_expense_items(invoice_id);
396 # Structure for table tt_predefined_expenses.
397 # This table keeps names and costs for predefined expenses.
399 CREATE TABLE `tt_predefined_expenses` (
400 `id` int(11) NOT NULL auto_increment, # predefined expense id
401 `team_id` int(11) NOT NULL, # team id
402 `name` varchar(255) NOT NULL, # predefined expense name, such as mileage
403 `cost` decimal(10,2) default '0.00', # cost for one unit
409 # Structure for table tt_monthly_quotas.
410 # This table keeps monthly work hour quotas for teams.
412 CREATE TABLE `tt_monthly_quotas` (
413 `team_id` int(11) NOT NULL, # team id
414 `year` smallint(5) UNSIGNED NOT NULL, # quota year
415 `month` tinyint(3) UNSIGNED NOT NULL, # quota month
416 `minutes` int(11) default NULL, # quota in minutes in specified month and year
417 PRIMARY KEY (`team_id`,`year`,`month`)
420 ALTER TABLE `tt_monthly_quotas`
421 ADD CONSTRAINT `FK_TT_TEAM_CONSTRAING` FOREIGN KEY (`team_id`) REFERENCES `tt_teams` (`id`) ON DELETE CASCADE ON UPDATE CASCADE;
425 # Structure for table tt_site_config. This table stores configuration data
426 # for Time Tracker site as a whole.
427 # For example, database version, code version, site language, etc.
429 CREATE TABLE `tt_site_config` (
430 `param_name` varchar(32) NOT NULL, # parameter name
431 `param_value` text default NULL, # parameter value
432 `created` datetime default NULL, # creation timestamp
433 `modified` datetime default NULL, # modification timestamp
434 PRIMARY KEY (`param_name`)
437 INSERT INTO `tt_site_config` (`param_name`, `param_value`, `created`) VALUES ('version_db', '1.17.53', now()); # TODO: change when structure changes.