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