[groupi] INSTALL.txt README.txt

  • From: Beau <treppb01@xxxxxxxxxxxxxxxxxx>
  • To: groupi@xxxxxxxxxxxxx
  • Date: Wed, 07 Oct 2009 21:50:40 +0800

Based on what was available to me, i wrote these. I was unable to finish the INSTALLDESKTOP.txt, as i can't find the installer when i build it?. Is the latest version in the svn.

I Think you might want to cut these down maybe michelle?. I'm not sure if i made them too long.

You are reading the install document for the Aiku Desktop Application. For 
information on installing the Aiku Mobile Application. Please consult the 
INSTALL.TXT within the Mobile applications source folder.

To build/run the Aiku Desktop Application you will need:
1) Visual Studio.
2) A Windows Based Operating System
3) The .NET 3.0 Framework Installed.


1) Install the above programs. The installation of them is beyond the scope of 
this document.

2) Open the ProffesionalComputing.csproj File. 


1) The Program will uninstall like any other Windows Program. To Remove just 
use "Add/Remove Programs" in the Windows Control Panel.


1)You will need a suitable made save file created from the device to run the 
2) Run the Program, select the project the file will belong to, and add the xml 
file to the project.s

You are reading the install document for the Aiku Mobile Application. For 
information on installing the Aiku Desktop Application. Please consult the 
INSTALL.TXT within the Desktop applications source folder.

To run the Aiku Mobile Application you will need:
1) Visual Studio Professional 2008. The express version is not adequate to 
build the Aiku Mobile Application.

2) The Windows Mobile 5.0 Pocket PC SDK. Available from 

3) Active Sync 4.5 or greater installed.

4) If your device does not have it installed you will need The Compact Net 
Framework 2.0. Note that visual studio can be used to install this to the 


1) Install the above programs. The installation of them is beyond the scope of 
this document.

2) Open the Aiku.sln File. 

3) Select the Deployment project inside the solution.

4) Run "Build Deployment". Build->Build Deployment. This will build the cab 
file needed to install the program.

4i) If you do not have the Compact Net Framework installed, you can run 
Debug->Deploy, and select the Windows Mobile 5.0 Pocket PC Device R2. This will 
push the compact framework onto the device and install it, Assuming the device 
is connected to the PC. Note: you can install the framework another way, this 
is just the easiest.

5) Transfer the resulting cab file. (in the folder deployment/release or 
deployment/debug depending on your settings). The transfer of files to Windows 
Mobile Devices is beyond the scope of this document.

6)Navigate to the cab file on the Windows Mobile Device and run it. This will 
install the program to the device, and create a shortcut in the "Programs" 
folder so it can be run.


1) The Program will uninstall like any other Windows Mobile Program. To Remove 
just use "Add/Remove Programs" in the Windows Mobile 5 settings menu.


1) To run the program select it from the list. You should then be able to run 
any of the tests outlined in the acceptance test report.

This is the readme document for the Aiku Mobile/Desktop Applications. For 
instructions on installing and building these programs please see the relevant 
INSTALL documents.

This system is designed to digitise the data entry of recording Archaeological 
sites. This allows less paper to be used, and presents a consistent recording 
structure for the sites. The system saves the recorded data, and allows it to 
be imported into a database, removing the data entry portion of recording a 

This project was started by Group I in the Professional Computing Class in 
second semester in 2009 at the University of Western Australia.

It was requested by the Eureka Archaeological Consulting Group run from 
Archaeology at the University of Western Australia.

The system was manufactured by.

Beau Trepp - Team Leader/Mobile Application GUI Coder/ Mobile Application Lead/ 
Save Library            coder.
Lorin Tauss - GPS Library Coder/ Documentation.
Michelle Le - Documentation
Xiaohang Ma - Testing/Database Coding.
Kianoush Arkhavan Karbasi - Desktop Application GUI/ Database Coding.
Rishabh Thukral - Save File Design/ Save Library Coder.

The system can be divided into two logical parts. The Mobile Application, which 
records the data and stores it to be inserted later, and the Desktop 
Application, which inserts the saved data into a database. Each section 
consists of it's own smaller subsections. One notable subsection is the Save 
Library, which is shared between the two programs.

The save format used by both applications is an xml format. This contains tags 
for all the required data, such as site name, gps co-ordinates etc. There are 
also optional tags, which can contain one or many items. Such tags are boundary 
points, or sample squares, as at any point in the recording process there may 
be zero or many of these items. For more detail about the xml. Please see the 
sf1.xsd schema file, or the sample1.xml file in the SaveLibrary Directory of 
the source code.

The Mobile Application has 3 subsections. These are the GPS Library, for 
reading gps data, the Save Library , for saving the recorded data, and the GUI 
which provides a interface between the two. 

The GPS Library provides a level of abstraction between the Technical sides of 
the gps data and the user interface code. It creates an object which updates 
itself whenever new gps data arrives. This object can be called on to receive 
the last known gps co-ordinate. If the co-ordinate is out of date, the object 
will throw an exception indicating so. This allows the program rest of the 
program to run if the data becomes out of date, either from a lost satellite, 
or the serial communication ending for some unknown reason. The exception can 
be caught by the calling code when it tries to obtain a gps co-ordinate, be it 
the GUI section, or another program which wishes to use this library. The gps 
co-ordinates are updated whenever a new one is transmitted from the GPS. So the 
point obtained from grabbing the gps co-ordinates are the latest received by 
the device.

The Save Library hides the xml processing from the GUI or other application 
that uses it. All the functionality for creating, loading, or deleting a node 
in the xml is run from this code. This code is also shared between the Mobile 
Application and the Desktop Application. It contains no operating system 
specific code. It does however rely on features in the .NET Framework. Only 
device capable of running the .NET Framework is capable of running this 
library, and reading and or writing files in a format readable by the Mobile 
application and Desktop application. This library should be used when ever 
reading or writing the save files, as the code will make the exact same 
formatted files, so the save files will be consistent.

The Mobile GUI is the bridge between the reading of the GPS data, and the 
saving of it. It also allows the user to describe what the GPS point is in 
relation to. It has many pages allowing the input of archaeological data. The 
Interface has been designed to allow other pages to be added. For instance the 
site overview page, can have more tabs added to either include more point 
types, or a site view page which would draw all the points in relation to each 
other. This section of the program tries to catch fixable exceptions from the 
other libraries, and prompt the user on how they wish to correct it. In some 
cases however, the exceptions are not fixable, so the program will terminate.

The Desktop Application consists of 3 parts. The GUI, the Data Base 
connectivity, and the Save Library. This Save Library code is the same save 
library code used for the Mobile device, keeping the implementations consist to 
reduce the chances that the xml files will be incompatible.

The Data Base Connectivity itself comprises of two parts. The Data Access 
Layer, where all database access is done, and the Business Logic Layer, where 
verification of the data takes place. This separates the pure connectivity and 
insertion of data into the database, from the logic that ensures this data is 
valid. The separation of these layers allows bugs to be traced down quicker, as 
they will either be a insertion or retrieval error, or a logic error.

The GUI behaves in the same way as the Mobile GUI. This allows people to open 
saved files and review them. This allows a files values to be fixed before they 
are inserted into the database, as the values recorded in the field may be 
prone to errors. It also allows you to create a new site, in the cases where it 
was recorded on paper and needs to be transferred into the database. It 
performs calculations on the in-putted data, such as calculating the area of a 
site based on it's boundary points. It also alerts the user if a value is 
invalid, or if it was unable to commit the site to the database, eg. when the 
site already exists in the database.

To Build or Run the Program, please see the INSTALL files for each application.

Other related posts: