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