ObjectClarity.com

Download and install the TimeWriter component just as you would any other component though the Joomla! Administrator back-end.  Once it's installed select "ObjectClarity TimeWriter" from the Components menu. You should see the Admin menu pictured below.

Figure 1

From this menu you can identify users  that are allowed to use the TimeWriter system or perform a one-time import from an existing Mambotastic Timesheets system.  The Import is only available while your TimeWriter tables are completely empty so if you're interested this is your first step.  If you didn't use Mambotastic Timesheets just ignore this option as it will be disabled anyways.

Assign Users

After importing any data you need to select which users get to use TimeWriter.  Click on the "Grant Access" button and start selecting users.  Use the "Allow User" button in the toolbar to let selected users use the system.  Before leaving this screen you need to identify at least one user (probably yourself) as a TimeWriter Administrator.  Select the user(s) you want to be admin(s) and click the "Promote" toolbar button.

Note:  If you use a 3rd party SEF component you will need to exclude TimeWriter from SEF as it doesn't work when SEF is enabled for it.

Now that your Admin user has been selected and your user have been allowed access to the system you're ready to visit the front-end. 

It should be noted that the TimeWriter Admin designation simply allows a user to add Companies and Projects from the Front-end of the Joomla! website.  It does not allow viewing or editing of timesheet entries for other users.

Ok, this is your first visit to the front-end of your website since installing ObjectClarity TimeWriter.  You should have a new menu item.  It's automatically added to "mainmenu" during the installation process.  If you do not see it you're probably not using "mainmenu" and will need to add one manually - again same as any other component.

Login to the Joomla! site as one of the users to which you granted TimeWriter Admin access.  Then click the "ObjectClarity TimeWriter" menu item to view the calendar for the current month.

Calendar

Notice at the top right corner is a link to Reports.  The reports menu also includes menu items for adding the Companies and Projects that we need to setup next.  Click the Reports link and look at the list of items.  At the bottom is the section for TimeWriter Admins only. 

Reports menu for a TimeWriter Admin

Click on Manage Companies.  You will presented with an empty list of Companies.   Use the New link at the top to start adding your first Company.

Add a Company by clicking New in the top right

Adding a new Company

Enter the name and details for your first company.  Make sure the Company is published and hit Save.  Return to the  Reports menu using the link in the top right.

Next add a Project by clicking on Manage Projects.  This works the same as the Companies section with the exception of adding Users. 

Adding a Project

Once you've added a Project you'll need to assign users to it.  You can do this by clicking the Assign icon in the Project row.  See below for the sample Project row. 

Notice the three digits in the Summary column.  They represent:

1. the number of Users assigned to the Project
2. the number of Published Users assigned to the Project
3. the number of Project Managers on the Project

If you hover your mouse over the "?" beside the word Summary in the header, you can quickly review what each number represents.

One Project added

At the Manage Project Users page choose which users are able to write time against the Project and nominate a Project Manager.  The Project Manager will see an additional section in the reports menu that includes Multi-User reports.  These reports will allow a Project Manger to report on entries written against only those projects on which they are designated as PM.

Added four Users and one Project Manager

At this point each user assigned to the Project is able to view the Calendar and is able to enter time against the Project by clicking on the dates. 

...This document is a work in progress.