Permalink
Browse files

+Added a README in markup

+Added a more current DB dump
+Added a system installer
  • Loading branch information...
1 parent 35fe535 commit a548c571e42609d8c04048c833881a33d61a3345 @jtanderson committed Mar 9, 2012
View
@@ -0,0 +1,24 @@
+Kayako Equipment Tracking System
+================================
+
+This system is a standalone web-application with the goal
+of aiding users of the Kayako Fusion service software to better regulate the influx of end-user equipment.
+The software is not a replacement for any part of the Kayako Fusion system - it's most standard use case is
+this: A user arrives at the Service Desk, Help Desk, etc. with her laptop, charger, and a peripheral such
+as an external hard driver. All this equipment is now the responsibility of the technicians assisting this
+troubled person. Unfortunately, if this is a frequent occurrence, it would be shocking if somethings of
+hers was *not* mixed up with somebody else equipment, lost, or otherwise. Using our Kayako Equipment
+Tracking System, the diligent service technician pulls up the application, enters the user's information and
+logs each separate piece of equipment she brought. The system then creates a ticket on the Kayako Fusion
+server to reflect the main issue of the hardware and item each piece of equipment related to that issue.
+The system then creates a barcode with the Kayako Fusion Display ID (e.g. KF-2213-J) and generates a barcode
+which the technician can then print out and affix to the user's equipment. It can then be scanned directly
+into the Kayako Fusion Software's search function to determine its exact purpose and owner.
+
+One can visit the project page on the [Kayako Forge](http://forge.kayako.com/projects/client-equipment-management) for
+a more complete wiki, calendar, forum, issue tracking, and roadmap.
+
+Note that support *is not* planned in the far future, as hopefully this (or just the concept) can be ported
+directly to a Kayako Fusion module and dropped into an existing server.
+
+[Developer Site](http://www.ratiocaeli.com)
View
@@ -5,7 +5,7 @@
| -------------------------------------------------------------------
| This file will contain the settings needed to access your database.
|
-| For complete instructions please consult the 'Database Connection'
+| For complete instructions please consult the "Database Connection"
| page of the User Guide.
|
| -------------------------------------------------------------------
@@ -26,43 +26,32 @@
| ['cachedir'] The path to the folder where cache files should be stored
| ['char_set'] The character set used in communicating with the database
| ['dbcollat'] The character collation used in communicating with the database
-| NOTE: For MySQL and MySQLi databases, this setting is only used
-| as a backup if your server is running PHP < 5.2.3 or MySQL < 5.0.7.
-| There is an incompatibility in PHP with mysql_real_escape_string() which
-| can make your site vulnerable to SQL injection if you are using a
-| multi-byte character set and are running versions lower than these.
-| Sites using Latin-1 or UTF-8 database character set and collation are unaffected.
-| ['swap_pre'] A default table prefix that should be swapped with the dbprefix
-| ['autoinit'] Whether or not to automatically initialize the database.
-| ['stricton'] TRUE/FALSE - forces 'Strict Mode' connections
-| - good for ensuring strict SQL while developing
|
| The $active_group variable lets you choose which connection group to
-| make active. By default there is only one group (the 'default' group).
+| make active. By default there is only one group (the "default" group).
|
| The $active_record variables lets you determine whether or not to load
| the active record class
*/
-$active_group = 'default';
-$active_record = TRUE;
+// The following values will probably need to be changed.
+$db['default']['username'] = "root";
+$db['default']['password'] = "";
+$db['default']['database'] = "db_kayako";
-$db['default']['hostname'] = 'localhost';
-$db['default']['username'] = 'kayako';
-$db['default']['password'] = 'kayakodev';
-$db['default']['database'] = 'db_kayako';
-$db['default']['dbdriver'] = 'mysql';
-$db['default']['dbprefix'] = '';
+// The following values can probably stay the same.
+$db['default']['hostname'] = "localhost";
+$db['default']['dbdriver'] = "mysql";
+$db['default']['dbprefix'] = "";
$db['default']['pconnect'] = TRUE;
$db['default']['db_debug'] = TRUE;
$db['default']['cache_on'] = FALSE;
-$db['default']['cachedir'] = '';
-$db['default']['char_set'] = 'utf8';
-$db['default']['dbcollat'] = 'utf8_general_ci';
-$db['default']['swap_pre'] = '';
-$db['default']['autoinit'] = TRUE;
-$db['default']['stricton'] = FALSE;
+$db['default']['cachedir'] = "";
+$db['default']['char_set'] = "utf8";
+$db['default']['dbcollat'] = "utf8_general_ci";
+$active_group = "default";
+$active_record = TRUE;
/* End of file database.php */
-/* Location: ./application/config/database.php */
+/* Location: ./application/config/database.php */
@@ -0,0 +1,243 @@
+-- phpMyAdmin SQL Dump
+-- version 3.4.9
+-- http://www.phpmyadmin.net
+--
+-- Host: localhost
+-- Generation Time: Mar 08, 2012 at 03:21 PM
+-- Server version: 5.5.19
+-- PHP Version: 5.3.8
+
+SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";
+SET time_zone = "+00:00";
+
+--
+-- Database: `db_kayako`
+--
+DROP DATABASE `db_kayako`;
+CREATE DATABASE `db_kayako` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+USE `db_kayako`;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_APISetting`
+--
+
+DROP TABLE IF EXISTS `TB_APISetting`;
+CREATE TABLE IF NOT EXISTS `TB_APISetting` (
+ `PK_APISettingNum` bigint(255) NOT NULL AUTO_INCREMENT,
+ `U_Title` varchar(255) DEFAULT NULL,
+ `Value` varchar(255) DEFAULT NULL,
+ `Display_Title` varchar(255) DEFAULT NULL,
+ PRIMARY KEY (`PK_APISettingNum`),
+ UNIQUE KEY `U_Title` (`U_Title`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=4 ;
+
+--
+-- Dumping data for table `TB_APISetting`
+--
+
+INSERT INTO `TB_APISetting` (`PK_APISettingNum`, `U_Title`, `Value`, `Display_Title`) VALUES
+(1, 'APIKey', '', 'API Key'),
+(2, 'SwiftURL', '', 'Swift URL'),
+(3, 'APISecretKey', '', 'API Secret Key');
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_Department`
+--
+
+DROP TABLE IF EXISTS `TB_Department`;
+CREATE TABLE IF NOT EXISTS `TB_Department` (
+ `PK_DepartmentNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `U_DepartmentTitle` varchar(255) DEFAULT NULL,
+ `DepartmentFusionID` bigint(20) NOT NULL,
+ PRIMARY KEY (`PK_DepartmentNum`),
+ UNIQUE KEY `U_Title_UNIQUE` (`U_DepartmentTitle`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=3 ;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_Equipment`
+--
+
+DROP TABLE IF EXISTS `TB_Equipment`;
+CREATE TABLE IF NOT EXISTS `TB_Equipment` (
+ `PK_EquipmentNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `FK_TicketNum` bigint(20) NOT NULL,
+ `Type` varchar(45) DEFAULT NULL,
+ `Model` varchar(45) DEFAULT NULL,
+ `Brand` varchar(45) DEFAULT NULL,
+ `Notes` text,
+ PRIMARY KEY (`PK_EquipmentNum`),
+ KEY `TB_Equipment_FK_TicketNum` (`FK_TicketNum`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=2 ;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_Priority`
+--
+
+DROP TABLE IF EXISTS `TB_Priority`;
+CREATE TABLE IF NOT EXISTS `TB_Priority` (
+ `PK_PriorityNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `U_PriorityTitle` varchar(255) DEFAULT NULL,
+ `PriorityFusionID` bigint(20) NOT NULL,
+ PRIMARY KEY (`PK_PriorityNum`),
+ UNIQUE KEY `U_Title_UNIQUE` (`U_PriorityTitle`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=13 ;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_Setting`
+--
+
+DROP TABLE IF EXISTS `TB_Setting`;
+CREATE TABLE IF NOT EXISTS `TB_Setting` (
+ `PK_SettingNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `U_Title` varchar(255) DEFAULT NULL,
+ `Default` varchar(255) DEFAULT NULL,
+ PRIMARY KEY (`PK_SettingNum`),
+ UNIQUE KEY `U_Title` (`U_Title`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=3 ;
+
+--
+-- Dumping data for table `TB_Setting`
+--
+
+INSERT INTO `TB_Setting` (`PK_SettingNum`, `U_Title`, `Default`) VALUES
+(1, 'DefaultTicketPriority', 'Normal'),
+(2, 'DefaultTicketDepartment', 'General');
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_Ticket`
+--
+
+DROP TABLE IF EXISTS `TB_Ticket`;
+CREATE TABLE IF NOT EXISTS `TB_Ticket` (
+ `PK_TicketNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `FK_PriorityNum` bigint(20) NOT NULL,
+ `FK_DepartmentNum` bigint(20) NOT NULL,
+ `FirstName` varchar(45) DEFAULT NULL,
+ `LastName` varchar(45) DEFAULT NULL,
+ `Issue` text,
+ `Phone` varchar(45) DEFAULT NULL,
+ `Email` varchar(45) DEFAULT NULL,
+ `TicketFusionID` varchar(45) DEFAULT NULL,
+ `TicketDisplayID` varchar(255) DEFAULT NULL,
+ `Deadline` date DEFAULT NULL,
+ `Subject` varchar(45) DEFAULT NULL,
+ `FullFusionText` text,
+ `Staff` varchar(45) DEFAULT NULL,
+ `CreatedDT` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ `BarcodeImagePath` varchar(255) DEFAULT NULL,
+ PRIMARY KEY (`PK_TicketNum`),
+ KEY `fk_TB_Ticket_TB_Priority1` (`FK_PriorityNum`),
+ KEY `fk_TB_Ticket_TB_Department1` (`FK_DepartmentNum`),
+ KEY `TicketDisplayID` (`TicketDisplayID`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=100 ;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_TicketUser`
+--
+
+DROP TABLE IF EXISTS `TB_TicketUser`;
+CREATE TABLE IF NOT EXISTS `TB_TicketUser` (
+ `PKa_TicketNum` bigint(20) NOT NULL,
+ `PKb_UserNum` bigint(20) NOT NULL,
+ PRIMARY KEY (`PKa_TicketNum`,`PKb_UserNum`),
+ KEY `TB_Ticket_PKa_UserNum` (`PKb_UserNum`),
+ KEY `TB_Ticket_PKa_TicketNum` (`PKa_TicketNum`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_User`
+--
+
+DROP TABLE IF EXISTS `TB_User`;
+CREATE TABLE IF NOT EXISTS `TB_User` (
+ `PK_UserNum` bigint(20) NOT NULL AUTO_INCREMENT,
+ `First` varchar(45) NOT NULL DEFAULT '',
+ `Last` varchar(45) NOT NULL DEFAULT '',
+ `Password` varchar(255) NOT NULL DEFAULT '',
+ `Email` varchar(45) NOT NULL DEFAULT '',
+ `U_Username` varchar(45) NOT NULL,
+ PRIMARY KEY (`PK_UserNum`),
+ UNIQUE KEY `TB_User_U_Username` (`U_Username`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=7 ;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `TB_UserSetting`
+--
+
+DROP TABLE IF EXISTS `TB_UserSetting`;
+CREATE TABLE IF NOT EXISTS `TB_UserSetting` (
+ `PKa_UserNum` bigint(20) NOT NULL,
+ `PKb_SettingNum` bigint(20) NOT NULL,
+ `Value` varchar(255) DEFAULT NULL,
+ PRIMARY KEY (`PKa_UserNum`,`PKb_SettingNum`),
+ KEY `TB_UserSetting_PKb_SettingNum` (`PKb_SettingNum`),
+ KEY `TB_UserSetting_PKa_SettingNum` (`PKa_UserNum`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+-- --------------------------------------------------------
+
+--
+-- Table structure for table `ci_sessions`
+--
+
+DROP TABLE IF EXISTS `ci_sessions`;
+CREATE TABLE IF NOT EXISTS `ci_sessions` (
+ `session_id` varchar(40) NOT NULL DEFAULT '0',
+ `previous_id` varchar(40) NOT NULL DEFAULT '0',
+ `ip_address` varchar(16) NOT NULL DEFAULT '0',
+ `user_agent` varchar(50) NOT NULL,
+ `last_rotate` int(10) unsigned NOT NULL DEFAULT '0',
+ `last_write` int(10) unsigned NOT NULL DEFAULT '0',
+ `user_data` text NOT NULL,
+ PRIMARY KEY (`session_id`,`previous_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+
+--
+-- Constraints for dumped tables
+--
+
+--
+-- Constraints for table `TB_Equipment`
+--
+ALTER TABLE `TB_Equipment`
+ ADD CONSTRAINT `fk_TB_Equipment_TB_Ticket1` FOREIGN KEY (`FK_TicketNum`) REFERENCES `TB_Ticket` (`PK_TicketNum`) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+--
+-- Constraints for table `TB_Ticket`
+--
+ALTER TABLE `TB_Ticket`
+ ADD CONSTRAINT `fk_TB_Ticket_TB_Department1` FOREIGN KEY (`FK_DepartmentNum`) REFERENCES `TB_Department` (`PK_DepartmentNum`) ON DELETE NO ACTION ON UPDATE NO ACTION,
+ ADD CONSTRAINT `fk_TB_Ticket_TB_Priority1` FOREIGN KEY (`FK_PriorityNum`) REFERENCES `TB_Priority` (`PK_PriorityNum`) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+--
+-- Constraints for table `TB_TicketUser`
+--
+ALTER TABLE `TB_TicketUser`
+ ADD CONSTRAINT `fk_TB_Ticket_has_TB_User_TB_Ticket` FOREIGN KEY (`PKa_TicketNum`) REFERENCES `TB_Ticket` (`PK_TicketNum`) ON DELETE NO ACTION ON UPDATE NO ACTION,
+ ADD CONSTRAINT `fk_TB_Ticket_has_TB_User_TB_User1` FOREIGN KEY (`PKb_UserNum`) REFERENCES `TB_User` (`PK_UserNum`) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+--
+-- Constraints for table `TB_UserSetting`
+--
+ALTER TABLE `TB_UserSetting`
+ ADD CONSTRAINT `fk_TB_User_has_TB_Setting_TB_Setting1` FOREIGN KEY (`PKb_SettingNum`) REFERENCES `TB_Setting` (`PK_SettingNum`) ON DELETE NO ACTION ON UPDATE NO ACTION,
+ ADD CONSTRAINT `fk_TB_User_has_TB_Setting_TB_User1` FOREIGN KEY (`PKa_UserNum`) REFERENCES `TB_User` (`PK_UserNum`) ON DELETE NO ACTION ON UPDATE NO ACTION;
View
@@ -0,0 +1,35 @@
+CodeIgniter Installer
+======================
+
+General Information
+--------------------
+
+CI Installer is a starting point for giving your downloadable CodeIgniter
+application an installer.
+
+If you're making a CI app that is designed to be downloaded and self-hosted,
+CI Installer provides an easy way for the user to get the database structure and
+configuration in place.
+
+NOTE: This is to be used as a starting point. You will have to customize it to
+make it work for your application, and you might have to dig into the code
+a little bit. It's pretty simple, so if you have a basic understanding of PHP
+you shouldn't have trouble.
+
+General Instructions
+---------------------
+
+1. Download CI Installer, rename the folder to 'install' and put it in the root
+directory of your CI install (as a sibling to the /system folder).
+2. Make an SQL dump of your desired database structure and intial data and paste
+it into assets/install.sql
+3. Open up index.php and change "Your App" in the <title> to your app's name.
+4. If your CI application folder is a sibling of your system folder instead of a
+child (this is common), do a find/replace to replace 'application' with
+'application' in each of this project's files.
+- In index.php, around line 37 change 'welcome' to the URL of the page
+(in CodeIgniter) that you want the user to be redirected to after installing.
+- Visit http://example.com/path/to/yourapp/install and see how it goes.
+
+If you have problems or have recommendations, please file an issue at
+http://github.com/mikecrittenden/ci-installer/ or else it won't get fixed!
Oops, something went wrong.

0 comments on commit a548c57

Please sign in to comment.