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, # creator 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, # modifier 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 `user_id` int(11) NOT NULL, # user id
175 `date` date NOT NULL, # date the record is for
176 `start` time default NULL, # record start time (for example, 09:00)
177 `duration` time default NULL, # record duration (for example, 1 hour)
178 `client_id` int(11) default NULL, # client id
179 `project_id` int(11) default NULL, # project id
180 `task_id` int(11) default NULL, # task id
181 `invoice_id` int(11) default NULL, # invoice id
182 `comment` text, # user provided comment for time record
183 `billable` tinyint(4) default 0, # whether the record is billable or not
184 `paid` tinyint(4) default 0, # whether the record is paid
185 `created` datetime default NULL, # creation timestamp
186 `created_ip` varchar(45) default NULL, # creator ip
187 `created_by` int(11) default NULL, # creator user_id
188 `modified` datetime default NULL, # modification timestamp
189 `modified_ip` varchar(45) default NULL, # modifier ip
190 `modified_by` int(11) default NULL, # modifier user_id
191 `status` tinyint(4) default 1, # time record status
195 # Create indexes on tt_log for performance.
196 create index date_idx on tt_log(date);
197 create index user_idx on tt_log(user_id);
198 create index client_idx on tt_log(client_id);
199 create index invoice_idx on tt_log(invoice_id);
200 create index project_idx on tt_log(project_id);
201 create index task_idx on tt_log(task_id);
205 # Structure for table tt_invoices. Invoices are issued to clients for billable work.
207 CREATE TABLE `tt_invoices` (
208 `id` int(11) NOT NULL auto_increment, # invoice id
209 `team_id` int(11) NOT NULL, # team id
210 `name` varchar(80) COLLATE utf8_bin NOT NULL, # invoice name
211 `date` date NOT NULL, # invoice date
212 `client_id` int(11) NOT NULL, # client id
213 `status` tinyint(4) default 1, # invoice status
217 # Create an index that guarantees unique invoice names per team.
218 create unique index name_idx on tt_invoices(team_id, name, status);
222 # Structure for table tt_tmp_refs. Used for reset password mechanism.
224 CREATE TABLE `tt_tmp_refs` (
225 `timestamp` timestamp default CURRENT_TIMESTAMP, # creation timestamp
226 `ref` char(32) NOT NULL default '', # unique reference for user, used in urls
227 `user_id` int(11) NOT NULL # user id
232 # Structure for table tt_fav_reports. Favorite reports are pre-configured report configurations.
234 CREATE TABLE `tt_fav_reports` (
235 `id` int(11) NOT NULL auto_increment, # favorite report id
236 `name` varchar(200) NOT NULL, # favorite report name
237 `user_id` int(11) NOT NULL, # user id favorite report belongs to
238 `report_spec` text default NULL, # future replacement field for all report settings
239 `client_id` int(11) default NULL, # client id (if selected)
240 `cf_1_option_id` int(11) default NULL, # custom field 1 option id (if selected)
241 `project_id` int(11) default NULL, # project id (if selected)
242 `task_id` int(11) default NULL, # task id (if selected)
243 `billable` tinyint(4) default NULL, # whether to include billable, not billable, or all records
244 `invoice` tinyint(4) default NULL, # whether to include invoiced, not invoiced, or all records
245 `paid_status` tinyint(4) default NULL, # whether to include paid, not paid, or all records
246 `users` text default NULL, # Comma-separated list of user ids. Nothing here means "all" users.
247 `period` tinyint(4) default NULL, # selected period type for report
248 `period_start` date default NULL, # period start
249 `period_end` date default NULL, # period end
250 `show_client` tinyint(4) NOT NULL default 0, # whether to show client column
251 `show_invoice` tinyint(4) NOT NULL default 0, # whether to show invoice column
252 `show_paid` tinyint(4) NOT NULL default 0, # whether to show paid column
253 `show_ip` tinyint(4) NOT NULL default 0, # whether to show ip column
254 `show_project` tinyint(4) NOT NULL default 0, # whether to show project column
255 `show_start` tinyint(4) NOT NULL default 0, # whether to show start field
256 `show_duration` tinyint(4) NOT NULL default 0, # whether to show duration field
257 `show_cost` tinyint(4) NOT NULL default 0, # whether to show cost field
258 `show_task` tinyint(4) NOT NULL default 0, # whether to show task column
259 `show_end` tinyint(4) NOT NULL default 0, # whether to show end field
260 `show_note` tinyint(4) NOT NULL default 0, # whether to show note column
261 `show_custom_field_1` tinyint(4) NOT NULL default 0, # whether to show custom field 1
262 `show_totals_only` tinyint(4) NOT NULL default 0, # whether to show totals only
263 `group_by` varchar(20) default NULL, # group by field
264 `status` tinyint(4) default 1, # favorite report status
270 # Structure for table tt_cron. It is used to email favorite reports on schedule.
272 CREATE TABLE `tt_cron` (
273 `id` int(11) NOT NULL auto_increment, # entry id
274 `team_id` int(11) NOT NULL, # team id
275 `cron_spec` varchar(255) NOT NULL, # cron specification, "0 1 * * *" for "daily at 01:00"
276 `last` int(11) default NULL, # UNIX timestamp of when job was last run
277 `next` int(11) default NULL, # UNIX timestamp of when to run next job
278 `report_id` int(11) default NULL, # report id from tt_fav_reports, a report to mail on schedule
279 `email` varchar(100) default NULL, # email to send results to
280 `cc` varchar(100) default NULL, # cc email to send results to
281 `subject` varchar(100) default NULL, # email subject
282 `report_condition` varchar(255) default NULL, # report condition, "count > 0" for sending not empty reports
283 `status` tinyint(4) default 1, # entry status
289 # Structure for table tt_clients. A client is an entity for whom work is performed and who may be invoiced.
291 CREATE TABLE `tt_clients` (
292 `id` int(11) NOT NULL AUTO_INCREMENT, # client id
293 `team_id` int(11) NOT NULL, # team id
294 `name` varchar(80) COLLATE utf8_bin NOT NULL, # client name
295 `address` varchar(255) default NULL, # client address
296 `tax` float(6,2) default '0.00', # applicable tax for this client
297 `projects` text default NULL, # comma-separated list of project ids assigned to this client
298 `status` tinyint(4) default 1, # client status
302 # Create an index that guarantees unique active and inactive clients per team.
303 create unique index client_name_idx on tt_clients(team_id, name, status);
307 # Structure for table tt_client_project_binds. This table maps clients to assigned projects.
309 CREATE TABLE `tt_client_project_binds` (
310 `client_id` int(11) NOT NULL, # client id
311 `project_id` int(11) NOT NULL # project id
314 # Indexes for tt_client_project_binds.
315 create index client_idx on tt_client_project_binds(client_id);
316 create index project_idx on tt_client_project_binds(project_id);
320 # Structure for table tt_config. This table is used to store configuration info for users.
321 # For example, last_report_email parameter stores an email for user last report was emailed to.
323 CREATE TABLE `tt_config` (
324 `user_id` int(11) NOT NULL, # user id
325 `param_name` varchar(32) NOT NULL, # parameter name
326 `param_value` varchar(80) default NULL # parameter value
329 # Create an index that guarantees unique parameter names per user.
330 create unique index param_idx on tt_config(user_id, param_name);
333 # Below are the tables used by CustomFields plugin.
336 # Structure for table tt_custom_fields. This table contains definitions of custom fields.
338 CREATE TABLE `tt_custom_fields` (
339 `id` int(11) NOT NULL auto_increment, # custom field id
340 `team_id` int(11) NOT NULL, # team id
341 `type` tinyint(4) NOT NULL default 0, # custom field type (text or dropdown)
342 `label` varchar(32) NOT NULL default '', # custom field label
343 `required` tinyint(4) default 0, # whether this custom field is mandatory for time records
344 `status` tinyint(4) default 1, # custom field status
350 # Structure for table tt_custom_field_options. This table defines options for dropdown custom fields.
352 CREATE TABLE `tt_custom_field_options` (
353 `id` int(11) NOT NULL auto_increment, # option id
354 `field_id` int(11) NOT NULL, # custom field id
355 `value` varchar(32) NOT NULL default '', # option value
361 # Structure for table tt_custom_field_log.
362 # This table supplements tt_log and contains custom field values for records.
364 CREATE TABLE `tt_custom_field_log` (
365 `id` bigint NOT NULL auto_increment, # cutom field log id
366 `log_id` bigint NOT NULL, # id of a record in tt_log this record corresponds to
367 `field_id` int(11) NOT NULL, # custom field id
368 `option_id` int(11) default NULL, # Option id. Used for dropdown custom fields.
369 `value` varchar(255) default NULL, # Text value. Used for text custom fields.
370 `status` tinyint(4) default 1, # custom field log entry status
376 # Structure for table tt_expense_items.
377 # This table lists expense items.
379 CREATE TABLE `tt_expense_items` (
380 `id` bigint NOT NULL auto_increment, # expense item id
381 `date` date NOT NULL, # date the record is for
382 `user_id` int(11) NOT NULL, # user id the expense item is reported by
383 `client_id` int(11) default NULL, # client id
384 `project_id` int(11) default NULL, # project id
385 `name` text NOT NULL, # expense item name (what is an expense for)
386 `cost` decimal(10,2) default '0.00', # item cost (including taxes, etc.)
387 `invoice_id` int(11) default NULL, # invoice id
388 `paid` tinyint(4) default 0, # whether the item is paid
389 `created` datetime default NULL, # creation timestamp
390 `created_ip` varchar(45) default NULL, # creator ip
391 `created_by` int(11) default NULL, # creator user_id
392 `modified` datetime default NULL, # modification timestamp
393 `modified_ip` varchar(45) default NULL, # modifier ip
394 `modified_by` int(11) default NULL, # modifier user_id
395 `status` tinyint(4) default 1, # item status
399 # Create indexes on tt_expense_items for performance.
400 create index date_idx on tt_expense_items(date);
401 create index user_idx on tt_expense_items(user_id);
402 create index client_idx on tt_expense_items(client_id);
403 create index project_idx on tt_expense_items(project_id);
404 create index invoice_idx on tt_expense_items(invoice_id);
408 # Structure for table tt_predefined_expenses.
409 # This table keeps names and costs for predefined expenses.
411 CREATE TABLE `tt_predefined_expenses` (
412 `id` int(11) NOT NULL auto_increment, # predefined expense id
413 `team_id` int(11) NOT NULL, # team id
414 `name` varchar(255) NOT NULL, # predefined expense name, such as mileage
415 `cost` decimal(10,2) default '0.00', # cost for one unit
421 # Structure for table tt_monthly_quotas.
422 # This table keeps monthly work hour quotas for teams.
424 CREATE TABLE `tt_monthly_quotas` (
425 `team_id` int(11) NOT NULL, # team id
426 `year` smallint(5) UNSIGNED NOT NULL, # quota year
427 `month` tinyint(3) UNSIGNED NOT NULL, # quota month
428 `minutes` int(11) default NULL, # quota in minutes in specified month and year
429 PRIMARY KEY (`team_id`,`year`,`month`)
432 ALTER TABLE `tt_monthly_quotas`
433 ADD CONSTRAINT `FK_TT_TEAM_CONSTRAING` FOREIGN KEY (`team_id`) REFERENCES `tt_teams` (`id`) ON DELETE CASCADE ON UPDATE CASCADE;
437 # Structure for table tt_site_config. This table stores configuration data
438 # for Time Tracker site as a whole.
439 # For example, database version, code version, site language, etc.
441 CREATE TABLE `tt_site_config` (
442 `param_name` varchar(32) NOT NULL, # parameter name
443 `param_value` text default NULL, # parameter value
444 `created` datetime default NULL, # creation timestamp
445 `modified` datetime default NULL, # modification timestamp
446 PRIMARY KEY (`param_name`)
449 INSERT INTO `tt_site_config` (`param_name`, `param_value`, `created`) VALUES ('version_db', '1.17.59', now()); # TODO: change when structure changes.