Current Version: 2.0Updated: August 2014
Thank you for purchasing TimeZone V.2.
If you have any questions that are beyond the scope of this help file, please do not hesitate to email me via my Code Canyon Profile.
I am always happy to help if you have any questions relating to TimeZone.
For the latest version of this document, please visit the Online Version.
Easy to get started and use, TimeZone is a simple, easy to use, web-based Employee Management & Time Clock system written in PHP. Whether you are an individual doing independent work, a small business
or team TimeZone has the features you need to manage all of your employees. Clock in, clock out in real time. Whenever and wherever work takes you.
A Note Before We Get Started
Please read through this entire document BEFORE attempting an installation, or Data Export/Import. If you are planning to export your data from TimeZone V.1, Do NOT delete anything in your old installed
version until after you have exported/imported your data, and everything checks out. It is a good rule of thumb to ALWAYS make backups of everything before making ANY changes.
In this version of TimeZone, I wanted to add in a way that you can import your data from your current version of TimeZone into the updated version V.2. I looked at many ways to accomplish this, and added
in what I think is the best. Keep in mind you can only import limited types of data. I hope this makes transitioning from the last version to the new as easy as possible. Exporting and importing you data
is covered in detail in this documentation.
A. Pre-installation Top
1. Unzip TimeZone and have a look around.
Unzip the TimeZone file and take a look at the file structure. You should see 9 folders and 2 files.
2. Create a Database.
First step is to create a MySQL database, and if you do not have a default one, a database user. This process is explained in great detail on many websites and web hosts.
Once you have the database set up, you will need:
The hostname - Usually (but not always - check with your web host) 'localhost'
The database name - ie. timezone
The database username - ie: database_user
The database password - ie: database_password
3. Upload TimeZone
Upload all the files you unzipped to your webhost, keeping the file system intact.
Be sure to CHMOD the avatars & documents folders to 755
You should now have the following folders/files on your host account:
B. Installation Top
Run the Online Setup Wizard
Installation is quite easy and only takes a few minutes.
Once TimeZone has finished uploading, simply go to http://www.yoursite.com/timezone/ (or wherever subfolder you uploaded it to) and follow the on-screen instructions.
Easy to do, just follow the defaults and plug in your specific information.
1. Server Configuration Check
TimeZone REQUIRES PHP 5.x & MySQLi Connection, and mcrypt_encrypt / mcrypt_decrypt.
There is a Server Configuration Check that will display before you will be able to install TimeZone. If all checks out, great, click the button "Start the Installation".
If not, you will not see the "Start the Installation" button and will not be able to install TimeZone. Check with you host, and see if there is anything they can do for you.
2. Database Configuration & Time Zone
TimeZone requires a MySQLi connection in order to run.
Once you have input your database information, click on the "On to Step 2" button.
If you run into any errors here, simply empty the database of any tables that have been created, delete the config.php file from the folder you uploaded TimeZone to, and try again.
If everything was configured correctly, you will see the following:
3. TimeZone Settings
Again, follow the defaults and plug in your site's specific information. You can set your Administrator password and Site name to be anything you would like. Once completed, be sure to hit
"On to Step 3" to save your settings.
Installation URL: This should be auto-filled for you*.
*If the Installation URL is not auto-filled, you will need to enter it manually.
This is needed for email notifications. Include any sub-folder TimeZone may be installed in. (ie. http://www.mydomain.com/timezone/)
Look at your browser's URL bar, and use that (remove the install/install.php from the end) as your Installation URL.
If you have any questions on this, please do not hesitate to email me via my Code Canyon Profile.
4. The Primary Admin Account
Complete the Primary Admin Account form. This is the main, "Superuser" for TimeZone. This Admin Account cannot be deleted through the web UI, only from within the database (ie. PHPMyAdmin).
Once you have filled in the information for the Primary Admin, click the "Complete Install" button to complete the installation.
Once installation is completed, you will need to go back into your FTP application, and either rename or delete the installation folder on your webhost before you can log in as Administrator.
For security reasons please, DELETE or RENAME the "install" folder, otherwise you will not be able to log in as Administrator.
C. Data Export from TimeZone V.1 Top
If this is your first time using TimeZone, you do not need to do anything special. The Export/Import feature will not effect TimeZone in any way. You can skip to section E.
In TimeZone V.2, I have included an export/import feature to make transferring your data to the new version as easy as possible. Keep in mind you can only import limited types of data.
Also, If you choose to import your old data, you will need to do this BEFORE you add any new data through TimeZone.
Once you have added any records beyound the install, you will no longer be able to import your old data. This is to prevent duplicate ID's in the database.
1. Upload the export folder to your current (V.1) version of TimeZone
In the zip file you downloaded from CodeCanyon, you will find a folder named "TimeZone V1 Data Export". Inside of that folder is the "export" folder you will need to upload to
your current version of TimeZone. Upload it to the main, parent folder.
2. Export Your Data
Once you have uploaded the export folder, complete the export process. Go to your current install of TimeZone
(ie. http://mydomain.com/timezone-V1) and type in "/export"
to the end of the URL (ie. http://mydomain.com/timezone-V1/export). You should see the following:
Click on each of the Export Buttons for the data you want to export. You will get a prompt to either save, or open the CSV File. Save the file to a location on your computer.
You will then upload these CSV files to the new version of TimeZone. You do not have to export all data, you may just want to export your Employees and nothing else. You can export/import
as much data as you need. If you are familiar with CSV files, you could also adjust the exports to your needs. The CSV files the export produces DO NOT have any column headers. Just keep that
in mind should you decide to edit the files before importing them into the new version.
D. Importing your TimeZone V.1 Data Top
Now that you have exported you TimeZone V.1 data, you can now import it to your new install of TimeZone V.2. Start by logging in as the Primary Admin (The Admin account you created
when installing). Click on the Manage menu link, then on Site Settings.
Once the Site Settings page has loaded, click on the right-hand tab Import Data.
1. Start Importing Your Data
This page is set up the same as the export page you all ready used. For each type of data there is a button to upload the corresponding CSV file.
Click on the Import button for the file you want to upload. In this example I will import my Employee data from the CSV file I exported earlier. Browse for the CSV file you saved, then click
the Import Employees button.
Once the data has been imported, you will see the following message:
Do this for the remaining data types you want to import. You can always double-check that the data imported correctly by visiting the specific page for that data type - "Active Employees" for Employee
data import and so on. If you have any questions about exporting/importing, please do not hesitate to contact me through my
E. Settings — Explained Top
Once TimeZone is installed and any data you want imported, you can update the Site Settings after logging in as the Primary Admin. Go to Site Settings page from the Manage dropdown menu.
All Sensitive Employee data is encrypted in the database.
Personal Information Fields include Social Security Number (SSN) and Date of Birth (DOB) to be available for use by Managers & Admins Only.
If you change the name of the Avatar or Business Documents folder, be sure you also update the Site Settings to reflect the changes. Otherwise, Uploading will not work.
F. Localization Top
TimeZone is translation ready. All Localization files are located in the folder named "language".
Any language files you may want to use will need to be translated from English.
If you have any questions on this, please do not hesitate to email me via my Code Canyon Profile.
G. Advanced — Custom Styling Top
1. Custom Styling
While TimeZone already has a modern flat interface based on Twitter's Bootstrap (version 3.2.0), many of you will want to integrate it into your own design. This is very
easy, however, you will need to be able to write HTML/CSS code. For those that aren't versed, here is a quick overview. The easiest way to change the look is by editing the default CSS files named "timezone.css"
and "custom.css". Next is to edit the page files, located in the "pages" folder.
TimeZone uses two background images. bg.png for the body background & bg-alt.png for the header background. TimeZone's Logo image is 174px X 25px.
All icons are generated from an Icon Font: Font Awesome (version 4.1.0). Check out all of Font Awesome's icons & usage at:
All icons & images can be changed to your liking.
H. Help & Support Top
Please, if you have any questions, run into any issues or just need some help, do not hesitate to contact me.
I believe in providing the best support possible, and I monitor my email just about 24/7.
If you are thinking of giving TimeZone anything less then 5 Stars, please tell me what I can do to make it a 5 Star experience for you.
I love to hear feedback, and welcome any suggestions you may have to make TimeZone better.
I. A Note About FTP Top
If you are having problems with TimeZone after successfully installing and logging in the for the first time you should check your FTP software settings.
I have found in many cases that numerous FTP programs are not uploading files correctly.
Check your FTP program to see if it is uploading files in ASCII - which is causing the file code to be uploaded in one long line.
Try changing it to Binary and uploading the files again. Upload everything except the install folder and the config file (or better yet, if you have not started using TimeZone,
just wipe the install and the database and reinstall a fresh copy).
I use CuteFTP for my uploads and ran into this problem a few months ago when all of the sudden everything I was working on just seemed to stop working as expected.