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