Added group_id and org_id to tt_fav_reports table.
[timetracker.git] / mysql.sql
1 # Usage: 
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
5
6 # create database timetracker character set = 'utf8mb4';
7
8 # use timetracker;
9
10
11 #
12 # Structure for table tt_groups. A group is a unit of users for whom we are tracking work time.
13 # This table stores settings common to all group members such as language, week start day, etc.
14 #
15 CREATE TABLE `tt_groups` (
16   `id` int(11) NOT NULL auto_increment,                  # group id
17   `parent_id` int(11) default NULL,                      # parent group id
18   `org_id` int(11) default NULL,                         # organization id (id of top group)
19   `name` varchar(80) default NULL,                       # group name
20   `currency` varchar(7) default NULL,                    # currency symbol
21   `decimal_mark` char(1) NOT NULL default '.',           # separator in decimals
22   `lang` varchar(10) NOT NULL default 'en',              # language
23   `date_format` varchar(20) NOT NULL default '%Y-%m-%d', # date format
24   `time_format` varchar(20) NOT NULL default '%H:%M',    # time format
25   `week_start` smallint(2) NOT NULL default 0,           # Week start day, 0 == Sunday.
26   `tracking_mode` smallint(2) NOT NULL default 1,        # tracking mode ("time", "projects" or "projects and tasks")
27   `project_required` smallint(2) NOT NULL default 0,     # whether a project selection is required or optional
28   `task_required` smallint(2) NOT NULL default 0,        # whether a task selection is required or optional
29   `record_type` smallint(2) NOT NULL default 0,          # time record type ("start and finish", "duration", or both)
30   `bcc_email` varchar(100) default NULL,                 # bcc email to copy all reports to
31   `allow_ip` varchar(255) default NULL,                  # specification from where users are allowed access
32   `password_complexity` varchar(64) default NULL,        # password example that defines required complexity
33   `plugins` varchar(255) default NULL,                   # a list of enabled plugins for group
34   `lock_spec` varchar(255) default NULL,                 # Cron specification for record locking,
35                                                          # for example: "0 10 * * 1" for "weekly on Mon at 10:00".
36   `workday_minutes` smallint(4) default 480,             # number of work minutes in a regular working day
37   `custom_logo` tinyint(4) default 0,                    # whether to use a custom logo or not
38   `config` text default NULL,                            # miscellaneous group configuration settings
39   `created` datetime default NULL,                       # creation timestamp
40   `created_ip` varchar(45) default NULL,                 # creator ip
41   `created_by` int(11) default NULL,                     # creator user_id
42   `modified` datetime default NULL,                      # modification timestamp
43   `modified_ip` varchar(45) default NULL,                # modifier ip
44   `modified_by` int(11) default NULL,                    # modifier user_id
45   `status` tinyint(4) default 1,                         # group status
46   PRIMARY KEY (`id`)
47 );
48
49
50 #
51 # Structure for table tt_roles. This table stores group roles.
52 #
53 CREATE TABLE `tt_roles` (
54   `id` int(11) NOT NULL auto_increment,    # Role id. Identifies roles for all groups on the server.
55   `group_id` int(11) NOT NULL,             # Group id the role is defined for.
56   `org_id` int(11) default NULL,           # Organization id.
57   `name` varchar(80) default NULL,         # Role name - custom role name. In case we are editing a
58                                            # predefined role (USER, etc.), we can rename the role here.
59   `description` varchar(255) default NULL, # Role description.
60   `rank` int(11) default 0,                # Role rank, an integer value between 0-512. Predefined role ranks:
61                                            # User - 4, Supervisor - 12, Client - 16,
62                                            # Co-manager - 68, Manager - 324, Top manager - 512.
63                                            # Rank is used to determine what "lesser roles" are in each group
64                                            # for situations such as "manage_users".
65   `rights` text default NULL,              # Comma-separated list of rights assigned to a role.
66                                            # NULL here for predefined roles (4, 16, 68, 324 - manager)
67                                            # means a hard-coded set of default access rights.
68   `status` tinyint(4) default 1,           # Role status.
69   PRIMARY KEY  (`id`)
70 );
71
72 # Create an index that guarantees unique active and inactive role ranks in each group.
73 create unique index role_idx on tt_roles(group_id, rank, status);
74
75 # Insert site-wide roles - site administrator and top manager.
76 INSERT INTO `tt_roles` (`group_id`, `name`, `rank`, `rights`) VALUES (0, 'Site administrator', 1024, 'administer_site');
77 INSERT INTO `tt_roles` (`group_id`, `name`, `rank`, `rights`) VALUES (0, 'Top manager', 512, 'track_own_time,track_own_expenses,view_own_reports,view_own_charts,view_own_invoices,view_own_projects,view_own_tasks,manage_own_settings,view_users,track_time,track_expenses,view_reports,view_charts,view_own_clients,override_punch_mode,override_own_punch_mode,override_date_lock,override_own_date_lock,swap_roles,approve_timesheets,manage_own_account,manage_users,manage_projects,manage_tasks,manage_custom_fields,manage_clients,manage_invoices,override_allow_ip,manage_basic_settings,view_all_reports,manage_features,manage_advanced_settings,manage_roles,export_data,manage_subgroups,delete_group');
78
79
80 #
81 # Structure for table tt_users. This table is used to store user properties.
82 #
83 CREATE TABLE `tt_users` (
84   `id` int(11) NOT NULL auto_increment,            # user id
85   `login` varchar(50) COLLATE utf8mb4_bin NOT NULL,# user login
86   `password` varchar(50) default NULL,             # password hash
87   `name` varchar(100) default NULL,                # user name
88   `group_id` int(11) NOT NULL,                     # group id
89   `org_id` int(11) default NULL,                   # organization id
90   `role_id` int(11) default NULL,                  # role id
91   `client_id` int(11) default NULL,                # client id for "client" user role
92   `rate` float(6,2) NOT NULL default '0.00',       # default hourly rate
93   `email` varchar(100) default NULL,               # user email
94   `created` datetime default NULL,                 # creation timestamp
95   `created_ip` varchar(45) default NULL,           # creator ip
96   `created_by` int(11) default NULL,               # creator user_id (null for self)
97   `modified` datetime default NULL,                # modification timestamp
98   `modified_ip` varchar(45) default NULL,          # modifier ip
99   `modified_by` int(11) default NULL,              # modifier user_id
100   `accessed` datetime default NULL,                # last access timestamp
101   `accessed_ip` varchar(45) default NULL,          # last access ip
102   `status` tinyint(4) default 1,                   # user status
103   PRIMARY KEY (`id`)
104 );
105
106 # Create an index that guarantees unique active and inactive logins.
107 create unique index login_idx on tt_users(login, status);
108
109 # Create admin account with password 'secret'. Admin is a superuser who can create groups.
110 DELETE from `tt_users` WHERE login = 'admin';
111 INSERT INTO `tt_users` (`login`, `password`, `name`, `group_id`, `role_id`) VALUES ('admin', md5('secret'), 'Admin', '0', (select id from tt_roles where rank = 1024));
112
113
114 #
115 # Structure for table tt_projects.
116 #
117 CREATE TABLE `tt_projects` (
118   `id` int(11) NOT NULL auto_increment,            # project id
119   `group_id` int(11) NOT NULL,                     # group id
120   `org_id` int(11) default NULL,                   # organization id
121   `name` varchar(80) COLLATE utf8mb4_bin NOT NULL, # project name
122   `description` varchar(255) default NULL,         # project description
123   `tasks` text default NULL,                       # comma-separated list of task ids associated with this project
124   `status` tinyint(4) default 1,                   # project status
125   PRIMARY KEY (`id`)
126 );
127
128 # Create an index that guarantees unique active and inactive projects per group.
129 create unique index project_idx on tt_projects(group_id, name, status);
130
131
132 #
133 # Structure for table tt_tasks.
134 #
135 CREATE TABLE `tt_tasks` (
136   `id` int(11) NOT NULL auto_increment,            # task id
137   `group_id` int(11) NOT NULL,                     # group id
138   `org_id` int(11) default NULL,                   # organization id
139   `name` varchar(80) COLLATE utf8mb4_bin NOT NULL, # task name
140   `description` varchar(255) default NULL,         # task description
141   `status` tinyint(4) default 1,                   # task status
142   PRIMARY KEY (`id`)
143 );
144
145 # Create an index that guarantees unique active and inactive tasks per group.
146 create unique index task_idx on tt_tasks(group_id, name, status);
147
148
149 #
150 # Structure for table tt_user_project_binds. This table maps users to assigned projects.
151 #
152 CREATE TABLE `tt_user_project_binds` (
153   `id` int(11) NOT NULL auto_increment, # bind id
154   `user_id` int(11) NOT NULL,           # user id
155   `project_id` int(11) NOT NULL,        # project id
156   `group_id` int(11) default NULL,      # group id
157   `org_id` int(11) default NULL,        # organization id
158   `rate` float(6,2) default '0.00',     # rate for this user when working on this project
159   `status` tinyint(4) default 1,        # bind status
160   PRIMARY KEY (`id`)
161 );
162
163 # Create an index that guarantees unique user to project binds.
164 create unique index bind_idx on tt_user_project_binds(user_id, project_id);
165
166
167 #
168 # Structure for table tt_project_task_binds. This table maps projects to assigned tasks.
169 #
170 CREATE TABLE `tt_project_task_binds` (
171   `project_id` int(11) NOT NULL,        # project id
172   `task_id` int(11) NOT NULL,           # task id
173   `group_id` int(11) default NULL,      # group id
174   `org_id` int(11) default NULL         # organization id
175 );
176
177 # Indexes for tt_project_task_binds.
178 create index project_idx on tt_project_task_binds(project_id);
179 create index task_idx on tt_project_task_binds(task_id);
180 create unique index project_task_idx on tt_project_task_binds(project_id, task_id);
181
182
183 #
184 # Structure for table tt_log. This is the table where time entries for users are stored.
185 # If you use custom fields, additional info for each record may exist in tt_custom_field_log.
186 #
187 CREATE TABLE `tt_log` (
188   `id` bigint NOT NULL auto_increment,             # time record id
189   `user_id` int(11) NOT NULL,                      # user id
190   `group_id` int(11) default NULL,                 # group id
191   `org_id` int(11) default NULL,                   # organization id
192   `date` date NOT NULL,                            # date the record is for
193   `start` time default NULL,                       # record start time (for example, 09:00)
194   `duration` time default NULL,                    # record duration (for example, 1 hour)
195   `client_id` int(11) default NULL,                # client id
196   `project_id` int(11) default NULL,               # project id
197   `task_id` int(11) default NULL,                  # task id
198   `invoice_id` int(11) default NULL,               # invoice id
199   `comment` text,                                  # user provided comment for time record
200   `billable` tinyint(4) default 0,                 # whether the record is billable or not
201   `paid` tinyint(4) default 0,                     # whether the record is paid
202   `created` datetime default NULL,                 # creation timestamp
203   `created_ip` varchar(45) default NULL,           # creator ip
204   `created_by` int(11) default NULL,               # creator user_id
205   `modified` datetime default NULL,                # modification timestamp
206   `modified_ip` varchar(45) default NULL,          # modifier ip
207   `modified_by` int(11) default NULL,              # modifier user_id
208   `status` tinyint(4) default 1,                   # time record status
209   PRIMARY KEY (`id`)
210 );
211
212 # Create indexes on tt_log for performance.
213 create index date_idx on tt_log(date);
214 create index user_idx on tt_log(user_id);
215 create index group_idx on tt_log(group_id);
216 create index client_idx on tt_log(client_id);
217 create index invoice_idx on tt_log(invoice_id);
218 create index project_idx on tt_log(project_id);
219 create index task_idx on tt_log(task_id);
220
221
222 #
223 # Structure for table tt_invoices. Invoices are issued to clients for billable work.
224 #
225 CREATE TABLE `tt_invoices` (
226   `id` int(11) NOT NULL auto_increment,            # invoice id
227   `group_id` int(11) NOT NULL,                     # group id
228   `org_id` int(11) default NULL,                   # organization id
229   `name` varchar(80) COLLATE utf8mb4_bin NOT NULL, # invoice name
230   `date` date NOT NULL,                            # invoice date
231   `client_id` int(11) NOT NULL,                    # client id
232   `status` tinyint(4) default 1,                   # invoice status
233   PRIMARY KEY (`id`)
234 );
235
236 # Create an index that guarantees unique invoice names per group.
237 create unique index name_idx on tt_invoices(group_id, name, status);
238
239
240 #
241 # Structure for table tt_tmp_refs. Used for reset password mechanism.
242 #
243 CREATE TABLE `tt_tmp_refs` (
244   `created` datetime default NULL,                 # creation timestamp
245   `ref` char(32) NOT NULL default '',              # unique reference for user, used in urls
246   `user_id` int(11) NOT NULL                       # user id
247 );
248
249
250 #
251 # Structure for table tt_fav_reports. Favorite reports are pre-configured report configurations.
252 #
253 CREATE TABLE `tt_fav_reports` (
254   `id` int(11) NOT NULL auto_increment,                  # favorite report id
255   `name` varchar(200) NOT NULL,                          # favorite report name
256   `user_id` int(11) NOT NULL,                            # user id favorite report belongs to
257   `group_id` int(11) default NULL,                       # group id
258   `org_id` int(11) default NULL,                         # organization id
259   `report_spec` text default NULL,                       # future replacement field for all report settings
260   `client_id` int(11) default NULL,                      # client id (if selected)
261   `cf_1_option_id` int(11) default NULL,                 # custom field 1 option id (if selected)
262   `project_id` int(11) default NULL,                     # project id (if selected)
263   `task_id` int(11) default NULL,                        # task id (if selected)
264   `billable` tinyint(4) default NULL,                    # whether to include billable, not billable, or all records
265   `invoice` tinyint(4) default NULL,                     # whether to include invoiced, not invoiced, or all records
266   `paid_status` tinyint(4) default NULL,                 # whether to include paid, not paid, or all records
267   `users` text default NULL,                             # Comma-separated list of user ids. Nothing here means "all" users.
268   `period` tinyint(4) default NULL,                      # selected period type for report
269   `period_start` date default NULL,                      # period start
270   `period_end` date default NULL,                        # period end
271   `show_client` tinyint(4) NOT NULL default 0,           # whether to show client column
272   `show_invoice` tinyint(4) NOT NULL default 0,          # whether to show invoice column
273   `show_paid` tinyint(4) NOT NULL default 0,             # whether to show paid column
274   `show_ip` tinyint(4) NOT NULL default 0,               # whether to show ip column
275   `show_project` tinyint(4) NOT NULL default 0,          # whether to show project column
276   `show_start` tinyint(4) NOT NULL default 0,            # whether to show start field
277   `show_duration` tinyint(4) NOT NULL default 0,         # whether to show duration field
278   `show_cost` tinyint(4) NOT NULL default 0,             # whether to show cost field
279   `show_task` tinyint(4) NOT NULL default 0,             # whether to show task column
280   `show_end` tinyint(4) NOT NULL default 0,              # whether to show end field
281   `show_note` tinyint(4) NOT NULL default 0,             # whether to show note column
282   `show_custom_field_1` tinyint(4) NOT NULL default 0,   # whether to show custom field 1
283   `show_work_units` tinyint(4) NOT NULL default 0,       # whether to show work units
284   `show_totals_only` tinyint(4) NOT NULL default 0,      # whether to show totals only
285   `group_by1` varchar(20) default NULL,                  # group by field 1
286   `group_by2` varchar(20) default NULL,                  # group by field 2
287   `group_by3` varchar(20) default NULL,                  # group by field 3
288   `status` tinyint(4) default 1,                         # favorite report status
289   PRIMARY KEY (`id`)
290 );
291
292
293 #
294 # Structure for table tt_cron. It is used to email favorite reports on schedule.
295 #
296 CREATE TABLE `tt_cron` (
297   `id` int(11) NOT NULL auto_increment,         # entry id
298   `group_id` int(11) NOT NULL,                  # group id
299   `cron_spec` varchar(255) NOT NULL,            # cron specification, "0 1 * * *" for "daily at 01:00"
300   `last` int(11) default NULL,                  # UNIX timestamp of when job was last run
301   `next` int(11) default NULL,                  # UNIX timestamp of when to run next job
302   `report_id` int(11) default NULL,             # report id from tt_fav_reports, a report to mail on schedule
303   `email` varchar(100) default NULL,            # email to send results to
304   `cc` varchar(100) default NULL,               # cc email to send results to
305   `subject` varchar(100) default NULL,          # email subject
306   `report_condition` varchar(255) default NULL, # report condition, "count > 0" for sending not empty reports
307   `status` tinyint(4) default 1,                # entry status
308   PRIMARY KEY (`id`)
309 );
310
311
312 #
313 # Structure for table tt_clients. A client is an entity for whom work is performed and who may be invoiced.
314 #
315 CREATE TABLE `tt_clients` (
316   `id` int(11) NOT NULL AUTO_INCREMENT,            # client id
317   `group_id` int(11) NOT NULL,                     # group id
318   `org_id` int(11) default NULL,                   # organization id
319   `name` varchar(80) COLLATE utf8mb4_bin NOT NULL, # client name
320   `address` varchar(255) default NULL,             # client address
321   `tax` float(6,2) default '0.00',                 # applicable tax for this client
322   `projects` text default NULL,                    # comma-separated list of project ids assigned to this client
323   `status` tinyint(4) default 1,                   # client status
324   PRIMARY KEY (`id`)
325 );
326
327 # Create an index that guarantees unique active and inactive clients per group.
328 create unique index client_name_idx on tt_clients(group_id, name, status);
329
330
331 #
332 # Structure for table tt_client_project_binds. This table maps clients to assigned projects.
333 #
334 CREATE TABLE `tt_client_project_binds` (
335   `client_id` int(11) NOT NULL, # client id
336   `project_id` int(11) NOT NULL # project id
337 );
338
339 # Indexes for tt_client_project_binds.
340 create index client_idx on tt_client_project_binds(client_id);
341 create index project_idx on tt_client_project_binds(project_id);
342
343
344 #
345 # Structure for table tt_config. This table is used to store configuration info for users.
346 # For example, last_report_email parameter stores an email for user last report was emailed to.
347 #
348 CREATE TABLE `tt_config` (
349   `user_id` int(11) NOT NULL,            # user id
350   `param_name` varchar(32) NOT NULL,     # parameter name
351   `param_value` varchar(80) default NULL # parameter value
352 );
353
354 # Create an index that guarantees unique parameter names per user.
355 create unique index param_idx on tt_config(user_id, param_name);
356
357
358 # Below are the tables used by CustomFields plugin.
359
360 #
361 # Structure for table tt_custom_fields. This table contains definitions of custom fields.
362 #
363 CREATE TABLE `tt_custom_fields` (
364   `id` int(11) NOT NULL auto_increment,    # custom field id
365   `group_id` int(11) NOT NULL,             # group id
366   `type` tinyint(4) NOT NULL default 0,    # custom field type (text or dropdown)
367   `label` varchar(32) NOT NULL default '', # custom field label
368   `required` tinyint(4) default 0,         # whether this custom field is mandatory for time records
369   `status` tinyint(4) default 1,           # custom field status
370   PRIMARY KEY  (`id`)
371 );
372
373
374 #
375 # Structure for table tt_custom_field_options. This table defines options for dropdown custom fields.
376 #
377 CREATE TABLE `tt_custom_field_options` (
378   `id` int(11) NOT NULL auto_increment,    # option id
379   `field_id` int(11) NOT NULL,             # custom field id
380   `value` varchar(32) NOT NULL default '', # option value
381   PRIMARY KEY  (`id`)
382 );
383
384
385 #
386 # Structure for table tt_custom_field_log.
387 # This table supplements tt_log and contains custom field values for records.
388 #
389 CREATE TABLE `tt_custom_field_log` (
390   `id` bigint NOT NULL auto_increment, # custom field log id
391   `log_id` bigint NOT NULL,            # id of a record in tt_log this record corresponds to
392   `field_id` int(11) NOT NULL,         # custom field id
393   `option_id` int(11) default NULL,    # Option id. Used for dropdown custom fields.
394   `value` varchar(255) default NULL,   # Text value. Used for text custom fields.
395   `status` tinyint(4) default 1,       # custom field log entry status
396   PRIMARY KEY  (`id`)
397 );
398
399 create index log_idx on tt_custom_field_log(log_id);
400
401
402 #
403 # Structure for table tt_expense_items.
404 # This table lists expense items.
405 #
406 CREATE TABLE `tt_expense_items` (
407   `id` bigint NOT NULL auto_increment,    # expense item id
408   `date` date NOT NULL,                   # date the record is for
409   `user_id` int(11) NOT NULL,             # user id the expense item is reported by
410   `group_id` int(11) default NULL,        # group id
411   `org_id` int(11) default NULL,          # organization id
412   `client_id` int(11) default NULL,       # client id
413   `project_id` int(11) default NULL,      # project id
414   `name` text NOT NULL,                   # expense item name (what is an expense for)
415   `cost` decimal(10,2) default '0.00',    # item cost (including taxes, etc.)
416   `invoice_id` int(11) default NULL,      # invoice id
417   `paid` tinyint(4) default 0,            # whether the item is paid
418   `created` datetime default NULL,        # creation timestamp
419   `created_ip` varchar(45) default NULL,  # creator ip
420   `created_by` int(11) default NULL,      # creator user_id
421   `modified` datetime default NULL,       # modification timestamp
422   `modified_ip` varchar(45) default NULL, # modifier ip
423   `modified_by` int(11) default NULL,     # modifier user_id
424   `status` tinyint(4) default 1,          # item status
425   PRIMARY KEY  (`id`)
426 );
427
428 # Create indexes on tt_expense_items for performance.
429 create index date_idx on tt_expense_items(date);
430 create index user_idx on tt_expense_items(user_id);
431 create index group_idx on tt_expense_items(group_id);
432 create index client_idx on tt_expense_items(client_id);
433 create index project_idx on tt_expense_items(project_id);
434 create index invoice_idx on tt_expense_items(invoice_id);
435
436
437 #
438 # Structure for table tt_predefined_expenses.
439 # This table keeps names and costs for predefined expenses.
440 #
441 CREATE TABLE `tt_predefined_expenses` (
442   `id` int(11) NOT NULL auto_increment, # predefined expense id
443   `group_id` int(11) NOT NULL,          # group id
444   `org_id` int(11) default NULL,        # organization id
445   `name` varchar(255) NOT NULL,         # predefined expense name, such as mileage
446   `cost` decimal(10,2) default '0.00',  # cost for one unit
447   PRIMARY KEY  (`id`)
448 );
449
450
451 #
452 # Structure for table tt_monthly_quotas.
453 # This table keeps monthly work hour quotas for groups.
454 #
455 CREATE TABLE `tt_monthly_quotas` (
456   `group_id` int(11) NOT NULL,            # group id
457   `org_id` int(11) default NULL,          # organization id
458   `year` smallint(5) UNSIGNED NOT NULL,   # quota year
459   `month` tinyint(3) UNSIGNED NOT NULL,   # quota month
460   `minutes` int(11) default NULL,         # quota in minutes in specified month and year
461   PRIMARY KEY (`group_id`,`year`,`month`)
462 );
463
464
465 #
466 # Structure for table tt_site_config. This table stores configuration data
467 # for Time Tracker site as a whole.
468 # For example, database version, code version, site language, etc.
469 #
470 CREATE TABLE `tt_site_config` (
471   `param_name` varchar(32) NOT NULL, # parameter name
472   `param_value` text default NULL,   # parameter value
473   `created` datetime default NULL,   # creation timestamp
474   `modified` datetime default NULL,  # modification timestamp
475   PRIMARY KEY  (`param_name`)
476 );
477
478 INSERT INTO `tt_site_config` (`param_name`, `param_value`, `created`) VALUES ('version_db', '1.18.19', now()); # TODO: change when structure changes.