Archi: Plug-In For Archicad
Archi: Plug-In For Archicad
Archi: Plug-In For Archicad
ArchiTime
vers. 1.0
™
Cigraph S.r.l.
Via Orsato, 38 - (I) 30175 VE/Marghera
Tel. +39 041 932 388
Cigraph Fax +39 041 920 031 Cigraph
www.cigraph.com
ArchiTime
Plug-in for statistical annalysis of time
designing in ArchiCAD
A Plug-in is a software component that allows ArchiCAD to provide new
functions in addition to the standard characteristics.
ArchiCAD allows you to manage the plug-ins automatically, starting them up
and closing them through the menu bar. Indeed, once the Plug-in has been
installed, a new menu will appear in the menu bar. This menu will behave like
any other ArchiCAD menu. It will allow you to access the Plug-in palette and
therefore to access all of its tools.
In fact, you will not even realize that you are using a Plug-in: it will still be
similar to using your ArchiCAD, but with more functions.
System Requirements
The configuration is established by the configuration requested for ArchiCAD.
However if you do not have enough storage space for the libraries, a
warning message will be displayed.
In this case, more storage space in the Disk Operating System can be made
available by closing other applications or decreasing the storage space
assigned to ArchiCAD.
ArchiCAD Version
The Plug-in is compatible with ArchiCAD 7.0 (we suggest you use the 7.0 V3-
R3 release) and does not work with older versions of ArchiCAD.
User Guide
1
• Windows: the Add-Ons folder must be in the same folder as the ArchiCAD
application. If positioned elsewhere, ArchiCAD will not be able to access it.
ArchiCAD verifies the presence of Plug-ins when booting up. If the Plug-ins are
not found in the correct place, you must quit the program and place them in
the correct location and then restart ArchiCAD.
For temporary use, you may run the Plug-in requested via the Load Add-On…
command present in the Tools menu.
2 ArchiTime
Welcome to ArchiTime
Welcome!
Allow me to introduce myself, I am ArchiTime, one of Cigraph’s plug-in’s. If
you want I can discretely accompany you throughout all your ArchiCAD
designed projects, supplying you with useful statistics and information on how
you have used the program and on the time spent creating your project.
How often have you asked yourself how much time both you and your
colleagues spend in front of the computer creating your project? As you can
undoubtedly see, this type of information is of great value when calculating
the time and costs of creating a project, the use of the program and how this
can influence the total costs of the work.
All this can serve as pure statistical and informative data and as well as for
evaluating the economic costs of adding data into your project which at
present, is one of the main factors that influence your prices if the work is
intended for third parties.
ArchiTime will help you in this.
ArchiTime is activated each time you work on a project, it will keep track of
all the operations carried out (based on the type of item on operation) and the
time spent in each work session (divided by the worksheet window used and
by daily work). It will supply a detailed account on all information gathered
(in combination with explanatory graphs) that can be printed or saved in text
format for post-elaborations on calculation sheets or specially dedicated
applications.
No effort is required on your part: ArchiTime will directly work for you in the
background, you can forget about it until you need to access the information
required.
User Guide
3
How to use ArchiTime
Working with ArchiTime is very easy: you only have to remember to activate
it when starting a new project…then it will do all the rest by itself!
It seems amazing, but this is all the effort required from you: just remember to
activate ArchiTime each time you start a project you want to monitor.
Lets have a detailed look at how to begin the project monitoring procedure
and where and how to save the information gathered by ArchiTime.
Starting ArchiTime
Don’t be shocked by the term “start”, it simply means opening the document
to be monitored (usually a new project as there is little sense in monitoring a
project that is partially completed) and start ArchiTime by using the Start
ArchiTime command. This is the only window present in the menu of this plug-
in.
The first time you start ArchiTime, you will see a simple dialogue box
visualizing the contents of the ArchiTime folder (the one where the plug-in is
located). The folder lists all the reports created (ArchiTime reports end with a
.tim extension).
4 ArchiTime
You can name the report linked to the project being worked (ArchiTime will
suggest naming the open project “untitled” if the project does not yet have a
name). Confirming the name with OK, will create the new report in the
ArchiTime folder. The selection/creation window will be closed and the
ArchiTime Palette toolbox will appear.
From this moment there is virtually no need to do anything else, easy isn’t it?
Note: The ArchiTime reports (*.tim) are always saved in the folder where the plug-in
is located: do not move the reports into other positions as ArchiTime
automatically organizes the reports located inside the folder.
If you have to elaborate the project on another computer, remember to copy
the report that relates to the project (along with the ArchiTime plug-in
obviously) into the ArchiTime folder on the new computer: ArchiTime will
automatically find the report that relates to the project, nothing will be lost.
For mnemonic reasons, we suggest you name the report with the same project
name to which it refers: this avoids confusion and facilitates the report search.
User Guide
5
Confirm the control restart, with OK, ArchiTime will again visualize the report
selection window, automatically highlighting the report name that relates to
the opened project (unless the project has been cancelled or renamed):
Note: Alternatively, you can also create a new report by selecting the option Use a
new report: ArchiTime will restart the underlying field of text where you can
type the new report name.
If you have renamed the report (and ArchiTime cannot find it under the same
name, select the renamed report form the proposed list.
When creating a new report or selecting another one, ArchiTime will
automatically memorize the information so that the next time it will be
automatically selected.
6 ArchiTime
The ArchiTime Palette Toolbox
The ArchiTime palette is comprised of seven icons that access the seven plug-
in functions:
Note: The ArchiTime palette is visualized as soon as ArchTime is started and cannot
be closed in any way (this is a design feature of the plug-in).
The palette will close automatically as soon as the project is closed.
User Guide
7
There are two main reasons and these depend on the way ArchiTime works.
Remember that ArchiTime continues keeping track of the time spent in front of
the project worksheet windows (Floor plan, Section/Elevation 3D window etc)
both when you are working and when you are not or, when you are
temporarily using another program.
If you have to leave your workstation for any reason (everyone needs a coffee
break every now and then!) or, if you leave ArchiCAD in the background to
use your e-mail to check your post, you will not want this time added to the
open project, so ArchiTime can be paused.
Do not worry, you will not run the risk of resuming work on the project and
forget to restart the monitoring: ArchiTime will visualize a warning message
that you have paused it as soon as you beginning working on the project.
8 ArchiTime
Report in Text Format
Clicking the Report in Text Format icon of the ArchiTime palette opens a text
window where ArchiTime will visualize the report of the current monitor.:
The contents of this text window, just as all the ArchiCAD text windows (e.g.
the project list window) can be printed or saved in text format to be opened in
other programs (e.g. on a spreadsheet) for any eventual elaborations.
Do not worry about closing the window as it is automatically controlled by
ArchiTime: each time you click on Report in Text Format of the ArchiTime
palette, the contents of the window will be visualized again, showing the
latest up-dated figures.
Note: For a detailed explanation of the information visualized in the report, refer to
the chapter “Information on ArchiTime reports”.
User Guide
9
Formatted Report
Clicking on the Formatted Report icon of the ArchiTime palette, opens a
“special” Section/Elevation window in which ArchiTime will visualize the
current monitor report using a parametrical library item, that lists the collected
data in a graphic format that can be personalized:
10 ArchiTime
Let us look at some details that relate to this window.
The first time you recall this window using the icon on the palette Toolbox,
ArchiTime will insert a very small Section/Elevation in the plan naming it
“ArchiTime Report”, this permits the use of a window to automatically insert
“ArchiTime.gsm” - the special item of the parametrical library permitting the
visualization of the report list.
Do not worry if you accidentally cancel the Section/Elevation positioned in
the plan: ArchiTime will notice and insert it once again the first time you recall
the Formatted Report.
Do not edit the ArchiTime.gsm object inserted into the section: any change
has to be made by selecting the object and using ArchiTime, otherwise the
data visualized could be wrong!
Even in this case you do not have to worry: ArchiTime will automatically up-
date/resolve the “error” the first time you reopen the Formatted Report by
using the related key on the palette Toolbox (the regeneration can occur with
the ArchiTime Report in the foreground).
Note: For a detailed explanation of the information visualized in the report, refer to
the chapter “Information on ArchiTime reports”.
User Guide
11
Formatted Report Settings
You can configure the graphical aspect and the contents of the formatted
report by clicking on the Formatted Report Settings icon of the ArchiTime
palette.
This settings key works in the following way:
1. If you use it after having selected the ArchiTime.gsm object inserted into
the ArchiTime Report window, you will only personalize the instance of the
selected object (i.e. you will modify the aspect and the contents of the
selected report).
2. If you use it without selecting an ArchiTime.gsm object, you will
personalize the ArchiTime settings: ArchiTime will save the configuration
and use it for all formatted reports created on future projects.
ArchiTime will visualize the following dialogue window as soon as you click
on the Formatted Report Settings:
12 ArchiTime
On the top left, you can configure the font used in the report by choosing the
type of text from the pop-up list, typing its size and selecting the pen to be
used:
On the right of the font options you can choose both the pen to draw the
items (the icons that identify the data) and for drawing the grid:
User Guide
13
Show/Hide total elapsed time in worksheet window graphics.
On the lower left of the window, the following series of options permit you to
personalize the aspect of the two graphic options:
- Choice of graphics for the histogram columns.
- Pen color for the histogram columns.
- Histogram and pie chart fill.
- Pen color for the pie chart sections.
The last two fields on the bottom left permit you to set your hourly rate and the
currency used for the report:
ArchiTime elaborates the data as soon as you confirm the settings using OK.
Note: For a detailed explanation of the information visualized in the report, refer to
the chapter “Information on ArchiTime reports”.
14 ArchiTime
Comparing Reports
It could be useful to compare the reports of various projects to gain statistics
from the various works. ArchiTime Compare Reports allows you to do this.
As soon as you click on the Compare reports icon, ArchiTime will visualize a
dialogue window where you will be able to select and compare up to ten
reports:
ArchiTime will visualize on top, the complete route of the folder containing the
reports (as we have mentioned this is the folder containing the plug-in).
All the reports contained in the folder (*.tim documents) are listed on the left.
The reports correctly selected for comparing are listed on the right.
To add/select a report for comparing:
1. click on the report name to be added highlighting it from the list on the left;
2. click on the > Add > key located under the report selection list.
User Guide
15
ArchiTime adds the report selected to the list on the right and deactivates its
name from the list on the left.
To remove/de-select a report for comparing:
3. click on the name of the report to be removed, highlighting it from the list
on the right;
4. click on the > Remove > key under the list of reports already selected.
ArchiTime removes the selected report from the list on the right and reactivates
its name in the list on the left.
Once the selection is concluded (maximum 10 reports), confirm the settings
with OK.
ArchiTime will visualize the comparison of the selected reports by opening a
new drawing window (named ArchiTime_Drawing):
The contents of this drawing window, just as all ArchiCAD drawing windows
(e.g. formatted project list windows), can be printed or saved in various
formats (RTF, PLN, PMK) for any eventual re-elaborations.
Closing the drawing window will cause its data to be lost but it will again be
available using the Compare Reports function.
16 ArchiTime
Suggestion: You can only access the compare report window if ArchiTime is activated. To
create a comparison you can do the following:
Note: The graphical aspect of the listed reports reflects the current ArchiTime
settings: click on the Formatted Report Settings icon to modify it (see related
paragraph) without selecting anything, and continue with the procedure for
the creation of the comparison as described above.
User Guide
17
On-line Help
However easy it is to use, you may need to refresh your memory on how
ArchiTime works: use the last icon of the ArchiTime toolbox palette On-line
Help to visualize the plug-in help pages that briefly illustrate ArchiTime’s
functions.
As soon as you click on the On-line Help, an image of ArchiTime will be
visualized, clicking ? will access the on-line help pages:
18 ArchiTime
Use << and >> to scroll through the pages and click OK to close the help
window.
User Guide
19
Information on ArchiTime reports
In this chapter, we will illustrate which information gathered by ArchiTime is
visualized in the report windows and saved in *.tim type documents.
Item Operations
Each time you modify an ArchiCAD project, ArchiTime will memorize the
operation in its report.
The memorized information refers to:
- the TYPE of item;
- the ACTION on the item;
- the STORY to which the item belongs;
- the worksheet WINDOW where the action took place;
- the NUMBER of elaborated items.
This information is divided into working days and summarized as a final total
in the visualized reports and *.tim memorized documents.
20 ArchiTime
The TYPE of items
ArchiTime will monitor your activity on any type of useable ArchiCAD item:
- Walls
- Columns
- Beams
- Windows
- Doors
- Objects/Lamps
- Slabs
- Roof
- Meshes
- Zones
- Fills
- Lines
- Circles/Arches/Ellipses
- Splines
- Figure
- HotSpots
- Sections/Elevations
- Camera
- Text/Labels
The only items not monitored (caused by API development limitations) are the
quotas. In any case, the time taken to insert these quotas is monitored in the
User Guide
21
section relating to elapsed time (see following paragraph) and is therefore no
great loss to the final analysis of the project.
22 ArchiTime
ArchiTime will keep track of the three operations (NEW, EDITED, MODIFIED)
and will indicate in the report that three items have been elaborated.
Elapsed time
As we have already mentioned, ArchiTime will keep track of the elapsed time
in each window of the project.
Remember that whether or not you are working, ArchiTime continues to count
the time spent in front of the project worksheet windows (Floor plan, Sections/
Elevations, 3D window etc) even if you are temporarily using another
program. It is therefore important to remember to pause ArchiTime when you
stop working on the open project (see paragraph Pause and Play).
User Guide
23