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