Introduced org_id field in tt_clients 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 = 'utf8';
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 utf8_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   `name` varchar(80) COLLATE utf8_bin NOT NULL, # project name
121   `description` varchar(255) default NULL,      # project description
122   `tasks` text default NULL,                    # comma-separated list of task ids associated with this project
123   `status` tinyint(4) default 1,                # project status
124   PRIMARY KEY (`id`)
125 );
126
127 # Create an index that guarantees unique active and inactive projects per group.
128 create unique index project_idx on tt_projects(group_id, name, status);
129
130
131 #
132 # Structure for table tt_tasks.
133 #
134 CREATE TABLE `tt_tasks` (
135   `id` int(11) NOT NULL auto_increment,         # task id
136   `group_id` int(11) NOT NULL,                  # group id
137   `name` varchar(80) COLLATE utf8_bin NOT NULL, # task name
138   `description` varchar(255) default NULL,      # task description
139   `status` tinyint(4) default 1,                # task status
140   PRIMARY KEY (`id`)
141 );
142
143 # Create an index that guarantees unique active and inactive tasks per group.
144 create unique index task_idx on tt_tasks(group_id, name, status);
145
146
147 #
148 # Structure for table tt_user_project_binds. This table maps users to assigned projects.
149 #
150 CREATE TABLE `tt_user_project_binds` (
151   `id` int(11) NOT NULL auto_increment, # bind id
152   `user_id` int(11) NOT NULL,           # user id
153   `project_id` int(11) NOT NULL,        # project id
154   `rate` float(6,2) default '0.00',     # rate for this user when working on this project
155   `status` tinyint(4) default 1,        # bind status
156   PRIMARY KEY (`id`)
157 );
158
159 # Create an index that guarantees unique user to project binds.
160 create unique index bind_idx on tt_user_project_binds(user_id, project_id);
161
162
163 #
164 # Structure for table tt_project_task_binds. This table maps projects to assigned tasks.
165 #
166 CREATE TABLE `tt_project_task_binds` (
167   `project_id` int(11) NOT NULL, # project id
168   `task_id` int(11) NOT NULL     # task id
169 );
170
171 # Indexes for tt_project_task_binds.
172 create index project_idx on tt_project_task_binds(project_id);
173 create index task_idx on tt_project_task_binds(task_id);
174
175
176 #
177 # Structure for table tt_log. This is the table where time entries for users are stored.
178 # If you use custom fields, additional info for each record may exist in tt_custom_field_log.
179 #
180 CREATE TABLE `tt_log` (
181   `id` bigint NOT NULL auto_increment,             # time record id
182   `user_id` int(11) NOT NULL,                      # user id
183   `group_id` int(11) default NULL,                 # group id
184   `date` date NOT NULL,                            # date the record is for
185   `start` time default NULL,                       # record start time (for example, 09:00)
186   `duration` time default NULL,                    # record duration (for example, 1 hour)
187   `client_id` int(11) default NULL,                # client id
188   `project_id` int(11) default NULL,               # project id
189   `task_id` int(11) default NULL,                  # task id
190   `invoice_id` int(11) default NULL,               # invoice id
191   `comment` text,                                  # user provided comment for time record
192   `billable` tinyint(4) default 0,                 # whether the record is billable or not
193   `paid` tinyint(4) default 0,                     # whether the record is paid
194   `created` datetime default NULL,                 # creation timestamp
195   `created_ip` varchar(45) default NULL,           # creator ip
196   `created_by` int(11) default NULL,               # creator user_id
197   `modified` datetime default NULL,                # modification timestamp
198   `modified_ip` varchar(45) default NULL,          # modifier ip
199   `modified_by` int(11) default NULL,              # modifier user_id
200   `status` tinyint(4) default 1,                   # time record status
201   PRIMARY KEY (`id`)
202 );
203
204 # Create indexes on tt_log for performance.
205 create index date_idx on tt_log(date);
206 create index user_idx on tt_log(user_id);
207 create index group_idx on tt_log(group_id);
208 create index client_idx on tt_log(client_id);
209 create index invoice_idx on tt_log(invoice_id);
210 create index project_idx on tt_log(project_id);
211 create index task_idx on tt_log(task_id);
212
213
214 #
215 # Structure for table tt_invoices. Invoices are issued to clients for billable work.
216 #
217 CREATE TABLE `tt_invoices` (
218   `id` int(11) NOT NULL auto_increment,         # invoice id
219   `group_id` int(11) NOT NULL,                  # group id
220   `name` varchar(80) COLLATE utf8_bin NOT NULL, # invoice name
221   `date` date NOT NULL,                         # invoice date
222   `client_id` int(11) NOT NULL,                 # client id
223   `status` tinyint(4) default 1,                # invoice status
224   PRIMARY KEY (`id`)
225 );
226
227 # Create an index that guarantees unique invoice names per group.
228 create unique index name_idx on tt_invoices(group_id, name, status);
229
230
231 #
232 # Structure for table tt_tmp_refs. Used for reset password mechanism.
233 #
234 CREATE TABLE `tt_tmp_refs` (
235   `created` datetime default NULL,                 # creation timestamp
236   `ref` char(32) NOT NULL default '',              # unique reference for user, used in urls
237   `user_id` int(11) NOT NULL                       # user id
238 );
239
240
241 #
242 # Structure for table tt_fav_reports. Favorite reports are pre-configured report configurations.
243 #
244 CREATE TABLE `tt_fav_reports` (
245   `id` int(11) NOT NULL auto_increment,                  # favorite report id
246   `name` varchar(200) NOT NULL,                          # favorite report name
247   `user_id` int(11) NOT NULL,                            # user id favorite report belongs to
248   `report_spec` text default NULL,                       # future replacement field for all report settings
249   `client_id` int(11) default NULL,                      # client id (if selected)
250   `cf_1_option_id` int(11) default NULL,                 # custom field 1 option id (if selected)
251   `project_id` int(11) default NULL,                     # project id (if selected)
252   `task_id` int(11) default NULL,                        # task id (if selected)
253   `billable` tinyint(4) default NULL,                    # whether to include billable, not billable, or all records
254   `invoice` tinyint(4) default NULL,                     # whether to include invoiced, not invoiced, or all records
255   `paid_status` tinyint(4) default NULL,                 # whether to include paid, not paid, or all records
256   `users` text default NULL,                             # Comma-separated list of user ids. Nothing here means "all" users.
257   `period` tinyint(4) default NULL,                      # selected period type for report
258   `period_start` date default NULL,                      # period start
259   `period_end` date default NULL,                        # period end
260   `show_client` tinyint(4) NOT NULL default 0,           # whether to show client column
261   `show_invoice` tinyint(4) NOT NULL default 0,          # whether to show invoice column
262   `show_paid` tinyint(4) NOT NULL default 0,             # whether to show paid column
263   `show_ip` tinyint(4) NOT NULL default 0,               # whether to show ip column
264   `show_project` tinyint(4) NOT NULL default 0,          # whether to show project column
265   `show_start` tinyint(4) NOT NULL default 0,            # whether to show start field
266   `show_duration` tinyint(4) NOT NULL default 0,         # whether to show duration field
267   `show_cost` tinyint(4) NOT NULL default 0,             # whether to show cost field
268   `show_task` tinyint(4) NOT NULL default 0,             # whether to show task column
269   `show_end` tinyint(4) NOT NULL default 0,              # whether to show end field
270   `show_note` tinyint(4) NOT NULL default 0,             # whether to show note column
271   `show_custom_field_1` tinyint(4) NOT NULL default 0,   # whether to show custom field 1
272   `show_work_units` tinyint(4) NOT NULL default 0,       # whether to show work units
273   `show_totals_only` tinyint(4) NOT NULL default 0,      # whether to show totals only
274   `group_by1` varchar(20) default NULL,                  # group by field 1
275   `group_by2` varchar(20) default NULL,                  # group by field 2
276   `group_by3` varchar(20) default NULL,                  # group by field 3
277   `status` tinyint(4) default 1,                         # favorite report status
278   PRIMARY KEY (`id`)
279 );
280
281
282 #
283 # Structure for table tt_cron. It is used to email favorite reports on schedule.
284 #
285 CREATE TABLE `tt_cron` (
286   `id` int(11) NOT NULL auto_increment,         # entry id
287   `group_id` int(11) NOT NULL,                  # group id
288   `cron_spec` varchar(255) NOT NULL,            # cron specification, "0 1 * * *" for "daily at 01:00"
289   `last` int(11) default NULL,                  # UNIX timestamp of when job was last run
290   `next` int(11) default NULL,                  # UNIX timestamp of when to run next job
291   `report_id` int(11) default NULL,             # report id from tt_fav_reports, a report to mail on schedule
292   `email` varchar(100) default NULL,            # email to send results to
293   `cc` varchar(100) default NULL,               # cc email to send results to
294   `subject` varchar(100) default NULL,          # email subject
295   `report_condition` varchar(255) default NULL, # report condition, "count > 0" for sending not empty reports
296   `status` tinyint(4) default 1,                # entry status
297   PRIMARY KEY (`id`)
298 );
299
300
301 #
302 # Structure for table tt_clients. A client is an entity for whom work is performed and who may be invoiced.
303 #
304 CREATE TABLE `tt_clients` (
305   `id` int(11) NOT NULL AUTO_INCREMENT,         # client id
306   `group_id` int(11) NOT NULL,                  # group id
307   `org_id` int(11) default NULL,                # organization id
308   `name` varchar(80) COLLATE utf8_bin NOT NULL, # client name
309   `address` varchar(255) default NULL,          # client address
310   `tax` float(6,2) default '0.00',              # applicable tax for this client
311   `projects` text default NULL,                 # comma-separated list of project ids assigned to this client
312   `status` tinyint(4) default 1,                # client status
313   PRIMARY KEY (`id`)
314 );
315
316 # Create an index that guarantees unique active and inactive clients per group.
317 create unique index client_name_idx on tt_clients(group_id, name, status);
318
319
320 #
321 # Structure for table tt_client_project_binds. This table maps clients to assigned projects.
322 #
323 CREATE TABLE `tt_client_project_binds` (
324   `client_id` int(11) NOT NULL, # client id
325   `project_id` int(11) NOT NULL # project id
326 );
327
328 # Indexes for tt_client_project_binds.
329 create index client_idx on tt_client_project_binds(client_id);
330 create index project_idx on tt_client_project_binds(project_id);
331
332
333 #
334 # Structure for table tt_config. This table is used to store configuration info for users.
335 # For example, last_report_email parameter stores an email for user last report was emailed to.
336 #
337 CREATE TABLE `tt_config` (
338   `user_id` int(11) NOT NULL,            # user id
339   `param_name` varchar(32) NOT NULL,     # parameter name
340   `param_value` varchar(80) default NULL # parameter value
341 );
342
343 # Create an index that guarantees unique parameter names per user.
344 create unique index param_idx on tt_config(user_id, param_name);
345
346
347 # Below are the tables used by CustomFields plugin.
348
349 #
350 # Structure for table tt_custom_fields. This table contains definitions of custom fields.
351 #
352 CREATE TABLE `tt_custom_fields` (
353   `id` int(11) NOT NULL auto_increment,    # custom field id
354   `group_id` int(11) NOT NULL,             # group id
355   `type` tinyint(4) NOT NULL default 0,    # custom field type (text or dropdown)
356   `label` varchar(32) NOT NULL default '', # custom field label
357   `required` tinyint(4) default 0,         # whether this custom field is mandatory for time records
358   `status` tinyint(4) default 1,           # custom field status
359   PRIMARY KEY  (`id`)
360 );
361
362
363 #
364 # Structure for table tt_custom_field_options. This table defines options for dropdown custom fields.
365 #
366 CREATE TABLE `tt_custom_field_options` (
367   `id` int(11) NOT NULL auto_increment,    # option id
368   `field_id` int(11) NOT NULL,             # custom field id
369   `value` varchar(32) NOT NULL default '', # option value
370   PRIMARY KEY  (`id`)
371 );
372
373
374 #
375 # Structure for table tt_custom_field_log.
376 # This table supplements tt_log and contains custom field values for records.
377 #
378 CREATE TABLE `tt_custom_field_log` (
379   `id` bigint NOT NULL auto_increment, # cutom field log id
380   `log_id` bigint NOT NULL,            # id of a record in tt_log this record corresponds to
381   `field_id` int(11) NOT NULL,         # custom field id
382   `option_id` int(11) default NULL,    # Option id. Used for dropdown custom fields.
383   `value` varchar(255) default NULL,   # Text value. Used for text custom fields.
384   `status` tinyint(4) default 1,       # custom field log entry status
385   PRIMARY KEY  (`id`)
386 );
387
388 create index log_idx on tt_custom_field_log(log_id);
389
390
391 #
392 # Structure for table tt_expense_items.
393 # This table lists expense items.
394 #
395 CREATE TABLE `tt_expense_items` (
396   `id` bigint NOT NULL auto_increment,    # expense item id
397   `date` date NOT NULL,                   # date the record is for
398   `user_id` int(11) NOT NULL,             # user id the expense item is reported by
399   `group_id` int(11) default NULL,        # group id
400   `client_id` int(11) default NULL,       # client id
401   `project_id` int(11) default NULL,      # project id
402   `name` text NOT NULL,                   # expense item name (what is an expense for)
403   `cost` decimal(10,2) default '0.00',    # item cost (including taxes, etc.)
404   `invoice_id` int(11) default NULL,      # invoice id
405   `paid` tinyint(4) default 0,            # whether the item is paid
406   `created` datetime default NULL,        # creation timestamp
407   `created_ip` varchar(45) default NULL,  # creator ip
408   `created_by` int(11) default NULL,      # creator user_id
409   `modified` datetime default NULL,       # modification timestamp
410   `modified_ip` varchar(45) default NULL, # modifier ip
411   `modified_by` int(11) default NULL,     # modifier user_id
412   `status` tinyint(4) default 1,          # item status
413   PRIMARY KEY  (`id`)
414 );
415
416 # Create indexes on tt_expense_items for performance.
417 create index date_idx on tt_expense_items(date);
418 create index user_idx on tt_expense_items(user_id);
419 create index group_idx on tt_expense_items(group_id);
420 create index client_idx on tt_expense_items(client_id);
421 create index project_idx on tt_expense_items(project_id);
422 create index invoice_idx on tt_expense_items(invoice_id);
423
424
425 #
426 # Structure for table tt_predefined_expenses.
427 # This table keeps names and costs for predefined expenses.
428 #
429 CREATE TABLE `tt_predefined_expenses` (
430   `id` int(11) NOT NULL auto_increment, # predefined expense id
431   `group_id` int(11) NOT NULL,          # group id
432   `name` varchar(255) NOT NULL,         # predefined expense name, such as mileage
433   `cost` decimal(10,2) default '0.00',  # cost for one unit
434   PRIMARY KEY  (`id`)
435 );
436
437
438 #
439 # Structure for table tt_monthly_quotas.
440 # This table keeps monthly work hour quotas for groups.
441 #
442 CREATE TABLE `tt_monthly_quotas` (
443   `group_id` int(11) NOT NULL,            # group id
444   `year` smallint(5) UNSIGNED NOT NULL,   # quota year
445   `month` tinyint(3) UNSIGNED NOT NULL,   # quota month
446   `minutes` int(11) default NULL,         # quota in minutes in specified month and year
447   PRIMARY KEY (`group_id`,`year`,`month`)
448 );
449
450
451 #
452 # Structure for table tt_site_config. This table stores configuration data
453 # for Time Tracker site as a whole.
454 # For example, database version, code version, site language, etc.
455 #
456 CREATE TABLE `tt_site_config` (
457   `param_name` varchar(32) NOT NULL, # parameter name
458   `param_value` text default NULL,   # parameter value
459   `created` datetime default NULL,   # creation timestamp
460   `modified` datetime default NULL,  # modification timestamp
461   PRIMARY KEY  (`param_name`)
462 );
463
464 INSERT INTO `tt_site_config` (`param_name`, `param_value`, `created`) VALUES ('version_db', '1.18.09', now()); # TODO: change when structure changes.