Clock In Center – User’s Guide
[ Clock-In User’s Guide | Clock-In FAQ ] 

$FolderPass = “”;

Enter a random password of 10 alphanumeric characters. This variable will be used to name the folder your data files are stored in. Data files include your encrypted password files and your configuration settings.

Top


Installation

• Open all scripts and make sure the first line points to Perl (Scripts being used on a WINDOWS server do not need the path to Perl)

• Upload all scripts to any executable folder (cgi-bin) and CHMOD the files to 755 (Scripts being used on a WINDOWS server do not need to be CHMODed)

• In your web browser, type in the URL that points to the [scriptname]_setup.cgi file and load the page. For example:

http://www.yourserver.com/cgi-bin/[scriptname]_setup.cgi

• Enter a username and password that will be used to access the admin section. If the setup process was successfully completed, you will see a link to the admin section on the success page. Click on it and you’re done. If any problems were encountered, follow the instructions returned.

If set up is successful, the [scriptname]_setup.cgi script then tries to delete itself. This is to ensure no-one else can come along and re-run the set up. Make sure the [scriptname]_setup.cgi file has been deleted from your server.

Please note, Shared Secure Servers and most Free Servers make it difficult or impossible to resolve the root path using a CGI script. Without the root path, the Set Up Script will not run it’s full course. In this case you have two options :

1) Download our free E-Vars script and install it on your server. CHMOD it to 755 then call it using your browser. It will list your server’s environment and other useful information. Try to determine your path from the information presented then enter in the $DefaultData variable located near the top of the [scriptname]_cfg.cgi file.

2) We offer custom installation for a reasonable fee of $25. We’ll set up the script for you and send you the log in details which you can change once logged in. If we cannot set up the script, we will refund both the installation fee and the cost of the script. To order custom installation, fill in our Secure Order form and enter $25 in the “Custom Quote” field just below the list of products. Please also enter your FTP information and web site address near the bottom of the form.

Top


License and Disclaimer

The following constitutes an agreement between you (the end user/purchaser) and us, PerlScripts JavaScripts.com (A wholly owned subsidiary of InterActive Scripts). By purchasing and using our software, products or services you agree to and accept the licensing agreement stated on this page. All documentation, goods and services are provided “as is” and without warranty. We hereby disclaim all warranties relating to any documentation, goods and services, whether express or implied, including warranties of suitability. In no event shall we be liable for any direct, indirect or consequential damages resulting in loss of revenue or data, incurred by you or any of our products, information or services. We reserve the right to revise the terms and conditions stated on this page at any time without notice. You agree to be bound by such revisions, and you are encouraged to periodically revisit this page to review the then current terms and conditions.

We grant you the right to use one copy of the software, product or service purchased, for testing and familiarization purposes. We also grant you the right to implement, install and use one copy of the software, product or service purchased on a single web site domain for use by one entity once the evaluation copy is removed / deleted.

By purchasing a product you are also subscribing to our periodic newsletter which will notify you of new software releases, updates and special offers. In accordance with United States and International anti-spamming laws, an unsubscribe link that removes you from all future mailings will accompany each e-mail notification.

For taxation purposes, we must keep accurate transaction and installation records. At the time of software installation, you will be asked to enter information such as your web site’s domain name and your product’s serial number. This information is used to validate copies of our software.

We reserve all rights. Written permission must be obtained from us before you may copy, reproduce, publish, modify or alter in any way, any media, software, documents or products, in part or in whole, contained within our web site or traded by us. All media, software, documents and products are the property of PerlScriptsJavaScripts.com. We retain ownership and copyright of software products purchased from us and all copies of the software. As a licensee you may make one copy of the software product solely for backup purposes. Removal of any copyright messages, publicly visible or otherwise without prior written permission from us is expressly forbidden. Unauthorized reproduction of any of our software, documents or products is prohibited by Federal and International laws and subject to criminal prosecution.

Any use of software and accompanying documentation on our Web site is subject to the terms of a software license agreement between you and us. You must read this license agreement in it’s entirety and agree to it’s terms prior to installing or using the software. All ownership rights and rights not implied are reserved. We reserve the right to revoke these permissions and terminate this agreement at anytime or at it’s own discretion without reasonable notice. We reserve the right temporarily or permanently discontinue any software product or the support associated the product at anytime or at it’s own discretion without reasonable notice. You agree and accept that we shall not be liable to you or to any third party for any such cessation.

You agree that any issue or dispute that may arise between PerlScriptsJavaScripts.com and yourself in respect to this web site or it’s goods or services will be resolved and governed by and within the courts and laws of Melbourne Australia. If your local laws do not allow for such an agreement, you must delete all copies of products supplied to you by us and you are hereby notified of the termination of this license.

Top


Getting Started / Creating Logs

Once you have installed and set up the script, log in to the program using the username and password you entered during the set up process and click on the “Settings” link in the admin control panel. Click on each of the gray colored links for a description of it’s purpose. Enter your preferred default settings, edit the e-mail template and press the “Save Settings” button. As you become familiar with the program and the need arises, you can and will modify or update your settings. Just enter something simple for the moment.

Click on the “Summary” link in the control panel. To create your first log file, select “Create New” from the “Action Table” (see Figure 1 below), select the person this log should be assigned to (if you have no members yet, “Admin” will be the only option and refers to you, the program owner), enter a name for this log file (eg. “My Log 01/01/02”) and press the “Create new” button.

The page will reload with the Action Table having been updated. You just created a new log file. You can now Clock in or add sales items to that file. Keep reading for more useful tips and instructions.

Figure 1


Top


Time Zone changes

Each user can set their own time zone. One user’s setting will have no effect on another user’s setting. To set your time zone select “Time Zone” from the first select menu and enter the offset in the small box beneath the select menus (to the left of the button). The offset should be in the format of “hh:mm”. For example, if your server’s time is ahead of your time by 2 hours and thirty minutes, you would enter:

-2:30

If you are head of your server, enter :

2:30

All users change time zones this way. Press the button to record the change. All times logged (even those logged prior to the time zone change) will be updated on the fly. That is, while the raw log files remain the same, the times printed to screen reflect each user’s offset.

Top


Creating New

Before clocking in or out, you must create a new log. This can be achieved by selecting “Create New” from the first select menu. Once you have selected this option, the second select menu is updated and lists all users including you, the administrator. Select the person this log should be assigned to from the second select menu. If you do not make a selection, the log will be assigned to you. You must now enter a name for this log (which can be changed at a later date). Press the button to create the log.

Top


Clocking In / Out

Once you’ve created a log, you can being recording times and items. Times are recorded down to the second. To Clock in, select “Clock In” from the first select menu. Select a log from the second select menu. You may optionally enter a comment in the large box on the right. Press the button. You have now clocked in and the log file’s contents are printed to screen. You will notice that a timer has begun (in the small text box to the left of the button). Because of transmission times between the client (your browser) and the server, this timer will be a few seconds off the actual time recorded.

Clocking is out achieved through a similar fashion. When you’re ready to clock out, select “Clock Out” from the select menu. Select a log (if you have not navigated away from the clock in page, the same log is pre selected). You may optionally enter a comment in the large box on the right. Press the button. The page is refreshed and prints the contents of the log file.

Top


Viewing Logs

To view log files without clocking in or out, select “View” from the first select menu. Select a log from the second select menu and press the button. The log file’s contents are printed to screen with totals printed to the bottom of the page.

Top


Renaming

A file can be renamed at any time by any user. If one user renames a log, all users will see the change. You can name the log anything you like, a person’s name, the current date, the name of a project etc.. To rename a log, select “Rename” from the first select menu, select a log from the second select menu, enter the new name in the small box to the left of the button and press the button.

Top


Archiving

Archives can be shown or hidden from the second select menu. Each user has their own archive settings. If one user opts to hide archives, other user’s settings will not be effected. Once an account has been settled or at any time you wish to archive a log, select “Archive Log” from the first select menu, select a log from the second select menu and press the button. The selected log is now archived and disappears from the second select menu.

To re-add archived logs to the second select menu select “Show Archives” from the first select menu and press the button. Each user has their own archive settings.

To hide archived logs from view, select “Hide Archives” from the first select menu and press the button. Again, this will not effect other user’s settings.

Top


Adding Items and Comments

Clock In Center allows you to add sales items, payments or comments. Negative and positive values are accepted and automatically calculated. Decimal values are also accepted and calculated. Entering the dollar sign ($) is optional, however it will appear in the comments area of the actual log. Total amounts owed will show up as negative or positive values. For example, if a client wishes to pay more than they owe, their balance will show up as a negative value.

Payments

If a balance stands at $100.34 and a payment was made, log in to the admin section and select “Add item or comment”. Select a log and enter the amount in the small box to the left of the button. Eg.

-100.34

You may optionally enter a comment, such as the transaction ID, press the button to submit the form. The log and amount owed will be updated.

Sales

If you sold a product or service that is not dependant on time stamps, log in to the admin section and select “Add item or comment”. Select a log and enter the cost of the sale in the small box to the left of the button. Eg.

$25.50

You may optionally enter a comment describing the product or service sold, press the button to submit the form. The log and amount owed will be updated.

Top


Showing / Hiding Archives

This feature is pertinent to each user (user specific). One user’s settings will not effect another’s. From the first select menu, select whether you wish to hide or show archives and press the button. Internet Explorer users (PC) will notice that archived logs are colored green.

Top


E-mailing

For an additional fee, this program can be set to automatically send out invoices at regular intervals (your server requires a cron tab). Logs can be e-mailed in either HTML or Plain Text format. Only the administrator may select the format. By Default, logs are e-mailed in the HTML format. To change this to Plain Text, click on the “Settings” link, select Plain Text as the Mail Format and press the button labelled “Update Configurations” to record the changes.

To e-mail a log, select “View” from the first select menu, select the log you wish to e-mail and press the button. The selected log is now displayed. Scroll to the “Bottom” of the log and click on the “E-mail this page” link. You are now taken to the “Clock In Messenger Port” where all users and their email addresses are listed. The e-mail address of the person assigned to this file is entered into the “To Email :” field for you. You may optionally enter your e-mail (or any other e-mail) address in the “CC : ” field (this will send a carbon copy of the invoice to you ).

The message to be sent, which can be edited, will also be pre filled with the selected work log. Your e-mail template is inserted above the work log. E-mail templates allow you to utilize Special Markers to insert a users name, username and password. You may wish to enter a link to your web site, payment form or Clock In Center. Be sure to test your template and keep in mind if using HTML format you should enter <br> (which is HTML for line break) anywhere you which to start a new line.

Top


Staff

Before assigning logs to users (staff members), you must create a user profile. Clock In Center allows you to enter a user specific rate and time zone. Enter the user’s details (see figure 2) and press the button labelled “Add new member”. The page will reload with a list of all current members below the “Add new member” form (see figure 3).

Figure 2


Figure 3


Top


Changing your password

Enables you to update or change the administration log in details. Enter your current log in details, enter your new log in details and press the button labelled “Change Pass”.



Top


Settings

Controls user privileges, e-mail templates and default values. Click on the gray colored links for a short description of each. Default values (such as the default hourly rate and time zones) are used until you update a users profile. If you set user privileges (such as deleting logs and entries) to “Yes”, users will see the extra options in the first select menu.

Top


Special Markers

Special Markers are read by the script and replaced with the relevant information. You can use the Special Markers in the e-mail template and default subject (found of the “Settings page”) as well as the message and subject of the e-mail you’re sending. This means, if you send out an e-mail with the markers, they will still be replaced. For example, to have the script print a users first name in e-mail messages sent out, you would use %%%FN%%%. The following is a list of markers used by Clock In Center.

%%%FN%%%           First Name
%%%LS%%%           Last Name
%%%UN%%%           Username
%%%PS%%%           Password
%%%FILENAME%%%     Name of log file