Online Documentation

Administration Guide: Auto Installation Package

Contents

• • System Requirements
  • Installing actiTIME
  • Starting / Stopping actiTIME
  • Repairing actiTIME Installation
  • Upgrading actiTIME from a Previous Version
  • Database Backup Instructions: MS Access
  • Database Backup Instructions: MySQL
  • Uninstalling actiTIME

System Requirements

1. OS / Platforms

   actiTIME Auto installation package supports MS Windows platform only. The following versions are supported: Windows 7, Vista, 2008, 2003, XP, and 2k.

2. Databases

   actiTIME Auto installation package supports both MS Access and MySQL databases. The database to use is selected during the installation.

   System requrements depend on the database you are going to use:

   • MS Access

     If you select to use MS Access database, actiTIME Auto installation package will require Microsoft Data Access Objects(DAO) 3.0 or later installed.

     Microsoft DAO is installed as a part of MS Access 97 or higher as well as a part of Windows XP or later. You can also install Microsoft DAO as a part of Microsoft Jet 4.0 Database Engine as described at http://support.microsoft.com/kb/239114/

     Please choose the MS Access database only if the expected number of actiTIME users is less than ten (10). Otherwise, please consider using the MySQL database platform to avoid performance degradation and collisions when updating data.

   • MySQL

     There are no specific system requrements for the case when MySQL database is selected. actiTIME Auto installation package will download and install MySQL during the actiTIME installation.

     You may speed up the installation process, if you download the MySQL Noinstall ZIP Archive package v5.0.* in advance.

Installing actiTIME

You will need local administrator privileges to install actiTIME.

To install actiTIME Auto installation package run the installer on the target computer and follow the instructions you will be provided with.

After the installation login as user 'admin' with password 'manager' to configure system users.

When you successfully logged in actiTIME, go to Settings --> General Settings and scroll down to the end of the page. You will find the Email Notifications sections. Here you will need to specify your mail server parameters in order to make actiTIME email notifications work.

Please specify correct values for the following mandatory fields:

• Outgoing mail server (SMTP) - name or address of your mail server.
• port - mail server port (usually 25)
• Address of your actiTIME installation - address you used to login to actiTIME on the previous step (ex. http://<server name>:8080/actiTIME). This address is required to enable links from email messages back to actiTIME
• Send error notifications to - email address of your system or network administrator who will be notified if actiTIME detects issues when sending email messages.

If you don't know what are the correct values please consult your System or Network Administrator.

Starting / Stopping actiTIME

You will need local administrator privileges to initiate actiTIME startup and shutdown.

To start actiTIME:

• Double click on the "Start actiTIME" desktop shortcut, OR
• Choose "Start actiTIME" menu option (from the "actiTIME" menu group), OR
• Start actiTIME service from the services management console

To stop actiTIME:

• Double click on the "Stop actiTIME" desktop shortcut, OR
• Choose "Stop actiTIME" menu option (from the "actiTIME" menu group), OR
• Stop actiTIME service from the services management console

If an error occurs during the startup / shutdown sequence, review the event log for presence of additional information about the error.

Repairing actiTIME Installation

You will need local administrator privileges to repair actiTIME installation.

To repair actiTIME installation, launch the actiTIME Auto installation package installer, choose the "Repair / Reconfigure" option and follow the instructions provided.

Upgrading actiTIME from a Previous Version

You will need local administrator privileges to upgrade actiTIME.

• Upgrading actiTIME installed using Auto installation Package

  To upgrade actiTIME installation, launch the actiTIME Auto installation package installer on the target computer and follow the instructions you will be provided with.

  Note: before starting the upgrade procedure, make sure that the services management console is closed.

• Upgrading actiTIME installed using Custom Installation Package

  You can upgrade actiTIME installed using Custom Installation Package only if it is configured to use MS Access database

  The actiTIME Auto installation package includes all the software required to run the actiTIME web application. Among other it includes preconfigured servlet container. Therefore it is not recommended to upgrade using this package if there are special requirements for the web server and servlet container configuration, such as HTTPS support, basic authentication, integration with Apache or IIS web server, etc. In this case consider upgrade using a custom installation package.

  To upgrade actiTIME the following steps should be performed:

  1. Shutdown the actiTIME web application

  2. Make sure that you do not have MS Access running with actiTIME database file opened in it

  3. Launch actiTIME Auto installation package installer

  4. Follow the installation instructions to the Database configuration screen

  5. On the Database configuration screen choose the option "Copy data from the existing database" and specify there the path to the existing actiTIME database file (in most cases this path will be detected and prefilled automatically)

  6. Click the "Next" button and continue actiTIME setup

  The Installer will create a new database file and copy data into it from the existing actiTIME database. Your old database file will not be modified.

  Please note that you should not try to run your old actiTIME installation after the upgrade because the ODBC driver will be configured to use the new database file and the old version of actITIME is incompatible with the new database file format.

• Configuring mail server parameters

  Login to actiTIME, go to Settings --> General Settings and scroll down to the end of the page. You will find the Email Notifications sections. Here you will need to specify your mail server parameters in order to make actiTIME email notifications work.

  Please specify correct values for the following mandatory fields:

  • Outgoing mail server (SMTP) - name or address of your mail server.
  • port - mail server port (usually 25)
  • Address of your actiTIME installation - address you used to login to actiTIME on the previous step (ex. http://<server name>:8080/actiTIME). This address is required to enable links from email messages back to actiTIME
  • Send error notifications to - email address of your system or network administrator who will be notified if actiTIME detects issues when sending email messages.

  If you don't know what are the correct values please consult your System or Network Administrator.

Database Backup Instructions: actiTIME With MS Access Database

Backup procedure:

1. Stop actiTIME.

2. Go to the '<actiTIME installation directory>\database' folder and make a backup copy of the 'actitime.mdb' file.

3. Start actiTIME.

Restore procedure:

1. Stop actiTIME.

2. Go to the '<actiTIME installation directory>\database' folder and replace the 'actitime.mdb' file with its backup copy.

3. Start actiTIME.

Database Backup Instructions: actiTIME With MySQL Database

Backup procedure:

1. Start actiTIME.

2. Open CMD.

3. Go to the '<actiTIME folder>/database/MySQL/bin' folder.

4. Create a dump of the existing actiTIME data by running the following command:

   mysqldump -u <username> -p<password> -P <port_number> actitime > actitime_data.sql
   
   

   where

   <username> is the name of the user who has all the necessary rights to administer the database.

   <password> is the password of this user (please note that there should be NO space between '-p' and 'password').

   <port_number> is the port used by MySQL.

   You will find these parameters in the '<actiTIME installation directory>\actitime.config' file. They are specified in the strings "DBUser" and "DBPassword".

   The port number is specified in the line "DBurl":

   DBurl=jdbc:mysql://<host>:<port_number>/<dbname>

   
   

   After the execution of this command MySQL will create a file with dump of actiTIME data called 'actitime_data.sql'.

Restore procedure:

1. Start actiTIME.

2. Open CMD.

3. Go to the '<actiTIME folder>/database/MySQL/bin' folder.

4. Restore your actiTIME data by running the following commands:

   mysqladmin -f -u <username> -p<password> -P <port_number> drop actitime
   
   

   After this command the current data will be dropped.

   mysqladmin -f -u <username> -p<password> -P <port_number> create actitime
   
   mysql -u <username> -p<password> -P <port_number> actitime < actitime_data.sql
   
   

   where

   <username> is the name of the user who has all the necessary rights to administer the database.

   <password> is the password of this user (please note that there should be NO space between '-p' and 'password').

   <port_number> is the port used by MySQL.

   You will find these parameters in the '<actiTIME installation directory>\actitime.config' file. They are specified in the strings "DBUser" and "DBPassword".

   The port number is specified in the line "DBurl":

   DBurl=jdbc:mysql://<host>:<port_number>/<dbname>

   
   

   actitime_data.sql is the file containing the backup of your actiTIME data.

5. Restart actiTIME.

Uninstalling actiTIME

You will need local administrator privileges to uninstall actiTIME.

To uninstall actiTIME choose the "Uninstall actiTIME" menu option or launch actiTIME uninstallation from the standard "Add or Remove Programs" dialog.