NOTE: It is strongly recommended to install Tomcat into a directory which name and path
do not contain spaces.

MS Access

If you want actiTIME to work with MS Access database, you will need
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.

Installing actiTIME (General Instructions)

Unzip installation package (for actiTIME Basic this file is named actitime2015_windows.zip) into a local directory.
Subdirectory 'actiTIME' will appear. Note that if you extract the archive into the
'<tomcat home>\webapps' you will only need to restart Tomcat server.
Otherwise you will have to configure Tomcat to make it able to run
actiTIME in another directory.

Enter the 'actiTIME' directory.

If you want actiTIME to work with MS Access database,
launch one of the following scripts without parameters:

setup_access_vista.vbs if you are using Windows Vista

setup_access_win7.vbs if you are using Windows 7, 8, or 8.1

setup_access.vbs otherwise

If you want actiTIME to work with MySQL database server you must create a
MySQL user account with all privileges on the database that will be
created during the subsequent steps of installation. The default name of
this database is 'actiTIME'. You can choose any other name, but then you
have to specify this name as a parameter for the installation script.

Also, it is necessary to run the following query in MySQL under the 'root'
user account or under any other user with SUPER privilege:

SET GLOBAL log_bin_trust_function_creators = 1;

This is required to allow actiTIME to create its stored functions in
the database. After the installation is complete, you can run the
following query to revert the configuration changes:

<MYSQLPATH> - the path to the MySQL executables (a directory
where the 'mysql.exe' and 'mysqldump.exe' files are placed).
If the path is not specified, installation script will ask for
it when running.

<USERNAME> - the MySQL user name under which actiTIME will create and
use the database. If not specified, setup script will
ask for it when running.

<PASSWORD> - the password of user <USERNAME>. If not specified,
setup script will ask for it when running.

<HOST> - host name of the the server where MySQL server runs.
If not specified the local host is assumed.
Required if actiTIME has to use a remote MySQL database.

<PORT> - port on which MySQL server is running. If not specified
the default MySQL port will be used.

<DBNAME> - the name of the database to be created. If not specified
'actitime' will be used as the database name.

NOTE: If the script finds the previous version of the actiTIME database then
it will back up the database to the actiTIME.mysql4.sql.backup_[current date] file.

Make necessary activities to the Tomcat application server if you want to
run actiTIME in non-default configuration (different port, virtual host etc.).

If you want to configure actiTIME to work via secure connections
(HTTPS) you can use Tomcat's facilities, but it will significantly
decrease the system performace since Tomcat's HTTPS module is built on
Java and requires considerable computational resources.

It is better to use Tomcat together with Apache web server
(http://httpd.apache.org/).
In this case secure requests will be processed without serious loss of
performance. Apache HTTP server will handle HTTPS requests, decrypt them
and then transfer decrypted data forwards to Tomcat. To make it work this
way see the Tomcat and Apache documentation.

If you want to run Tomcat with "-security" option, you will need to add
special permissions to $CATALINA_HOME/conf/catalina.policy file (or
$CATALINA_HOME/conf/tomcat.policy depending on the Tomcat version).
Set of permissions depends on Tomcat version and its configuration.

Examples of lines to add for different server versions are listed below:

// actiTIME requires permissions to access an SMTP server to send email notifications.
// Please replace <SMTP_HOST> below with name or IP address of your SMTP server.
// It must be equal to the one specified in actiTIME General Settings.
permission java.net.SocketPermission "<SMTP_HOST>:25", "connect,resolve";

// actiTIME requires permissions to access an SMTP server to send email notifications.
// Please replace <SMTP_HOST> below with name or IP address of your SMTP server.
// It must be equal to the one specified in actiTIME General Settings.
permission java.net.SocketPermission "<SMTP_HOST>:25", "connect,resolve";

// actiTIME requires permissions to access an SMTP server to send email notifications.
// Please replace <SMTP_HOST> below with name or IP address of your SMTP server.
// It must be equal to the one specified in actiTIME General Settings.
permission java.net.SocketPermission "<SMTP_HOST>:25", "connect,resolve";

<ACCESS_DRIVER_PATH> - shall be replaced with the value of the 'IzmDllPath' parameter taken from the '${catalina.home}/webapps/actitime/WEB-INF/classes/com/actimind/actitime/AT.properties' file.

Restart Tomcat.

Now you can access actiTIME via web browser
http://<server name>:8080/actiTIME if Tomcat is configured by
default and actiTIME is installed into the '<tomcat home>\webapps' directory).

Try to login as user 'admin' with password 'manager'.

Configuring mail server parameters

After 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.

Installing actiTIME Under IIS

Normally IIS can not execute Java Servlets and Java Server Pages (JSPs) actiTIME is based on.
However, it's possible to configure IIS so that it redirects HTTP requests to configured URLs to
Tomcat Web server. This way IIS can serve clients of a Java-based web application.

To enable this interoperability between IIS and Tomcat Web Server, an additional component -
'JK ISAPI Redirector plug-in for IIS' should be installed on the same machine with IIS.
Then IIS and Tomcat Web Server should be configured to work through this component.

This document contains step-by-step instructions on how to install JK ISAPI Redirector plug-in for
IIS and configure IIS and Tomcat Web server properly. IIS and Tomcat Web Server should be installed
before performing the steps below.

Run the installer by executing the downloaded file and follow the installation wizard steps.
By default the files are installed into the "C:\Program Files\Apache Software Foundation\Jakarta Isapi Redirector"
directory (hereafter referred to as [JK Redirector Dir]).

You will need to modify two files in the "[JK Redirector Dir]/conf" folder:

uriworkermap.properties - tells IIS what requests to redirect to Tomcat

#/admin/*=wlb
#/manager/*=wlb
#/jsp-examples/*=wlb
#/servlets-examples/*=wlb
/actitime/*=wlb
# Optionally filter out all .jpeg files inside that context
# For no mapping the url has to start with exclamation (!)

#!/servlets-examples/*.jpeg=wlb

#
# Mount jkstatus to /jkmanager
# For production servers you will need to
# secure the access to the /jkmanager url
#
/jkmanager=jkstatus

The actiTIME mapping (e.g. '/actitime/*') must be the same as the context path of actiTIME under Tomcat.
In the example above the mapping '/actitime/*' means that actiTIME in available at 'http://my.server.com/actitime/'
under Tomcat Web Server.

workers.properties.minimal

In this file you need to modify the 'worker.ajp13w.host' property. This property should be set to the host name
or the IP address of the machine where Tomcat (with actiTIME) is running. If Tomcat is running on the same
machine as IIS, you can leave this property set to localhost. If you have specified host name other than
localhost, please make sure the IIS machine can correctly resolve it to the appropriate IP address.

Also, if you have modified the port for the Tomcat AJP Connector on step 2,
you will need to modify the 'worker.ajp13w.port' property as well.

You will find the example of the file contents below for the situation when Tomcat
and IIS servers are running on the same machine, and the default port (8009)
is used for AJP connections:

# workers.properties.minimal -
#
# This file provides minimal jk configuration properties needed to
# connect to Tomcat.
#
# The workers that jk should create and work with
#

worker.list=wlb,jkstatus

#
# Defining a worker named ajp13w and of type ajp13
# Note that the name and the type do not have to match.
#
worker.ajp13w.type=ajp13
worker.ajp13w.host=localhost
worker.ajp13w.port=8009

#
# Defining a load balancer
#

worker.wlb.type=lb
worker.wlb.balance_workers=ajp13w

#
# Define status worker
#

worker.jkstatus.type=status

4. Configuring IIS

Open your Windows Control Panel

Open the Administrative Tools

Open the Internet Information Services Manager.

You should see a window similar to the one below
(note: The 'jakarta' virtual directory under the "Default Web Site" folder was created
by the isapi_redirect.msi installer):

Create a virtual directory for actiTIME in IIS.

Right-click on the default Web site and select "Virtual Directory" from the "New" menu.

Press Next and set the alias value to the context name (without slashes) that was set for actiTIME in Tomcat.
In our example this context name is 'actitime':

On the next screen browse to the directory containing your 'isapi_redirect.dll' file
(in our case it is located in the '[JK Redirector Dir]\bin' folder) and press Next.

Make sure that the following permissions are set: read, run, and execute.

Continue through the Virtual Directory Wizard until you reach the end and then press Finish.

Add the ISAPI Redirector to the default Web site: right-click on the default Web site
and select the Properties item.

In the opened window select the 'ISAPI Filters' tab.

If you see the "jakarta" filter created, you can press Ok and skip steps 7 and 8.
Otherwise, press Add and proceed with the next steps.

Enter a filter name and browse to the location of the 'isapi_redirect.dll' file.
The following screen-shot shows the values that should be entered:

Press OK in the 'Add/Edit Filter Propertie' dialog and OK button in the
'Default Web Site Properties' window (after that you are back to the Internet Information Services dialog).

Right click on the 'Web Service Extension' Folder and select 'Add a new Web service extension:' item:

Enter the following line into the 'Extension name' field in the opened window: Jakarta Isapi Redirector.

Press 'Add :' near the 'Required files' field and browse to the 'isapi_redirect.dll' file

Press OK until you are back to the 'Web Service Extention' folder.

Select the "Jakarta Isapi Redirector" on the right panel and press Allow:

Right click on the 'Local computer' folder (on the left panel) and select 'Save Configuration to Disk'
from the 'All Tasks' menu:

The IIS configuration is complete now.
Restart IIS to put the changes into effect.

After IIS is restarted, you can try to login into actiTIME.
(the actiTIME URL should look like this: http://my.iis.server/actitime/).

Upgrading actiTIME from a Previous Version

We have done our best to ensure that your data stays safe.
However it is strongly recommended that you make a backup of actiTIME files prior to upgrading actiTIME.

If current installation works with MySQL database, then it is also recommended that you backup actiTIME database.
Please refer to the backup instruction.

Stop the Tomcat server.

actiTIME no longer supports Java SDK 1.4, so please make sure Java 2 SDK 5.0
or higher is installed. Otherwise you should upgrade it. You can check the installed
Java version using the following command:

java -version

Delete all files from the directory 'actiTIME\WEB-INF\lib'
where 'actiTIME' is the directory where actiTIME is installed.

Unzip the installation package (for actiTIME Basic this file is named actitime2015_windows.zip)
to the parent directory of the 'actiTIME' directory (directory where actiTIME is installed).
This will overwrite files of existing actiTIME installation with their new versions.

Enter the 'actiTIME' directory.

If current installation works with MS Access database launch
one of the following scripts without parameters:

setup_access_vista.vbs if you are using Windows Vista

setup_access_win7.vbs if you are using Windows 7, 8, or 8.1

setup_access.vbs otherwise

If current installation works with MySQL database server run the following
query in MySQL under the 'root' user account or under any other user with
SUPER privilege:

SET GLOBAL log_bin_trust_function_creators = 1;

then launch one of the following scripts:

setup_mysql_vista.vbs if you are using Windows Vista

setup_mysql_win7.vbs if you are using Windows 7, 8, or 8.1

setup_mysql.vbs otherwise

Both these scripts have the same launch format:

(script name).vbs [/mysqlpath <MYSQLPATH>]

where

<MYSQLPATH> - the path to the MySQL executables (a directory
where the 'mysql.exe' and 'mysqldump.exe' files are placed).
If the path is not specified, installation script will ask for
it when running.

Prior to updating database structure setup script backups database
and saves data in a file in the 'actiTIME' directory.

For MySQL file name
isactiTIME.mysql4.sql.backup_<YYYYMMDDhhmmss>

For MS Access file
name isactiTIME.access97.mdb.backup_<YYYYMMDDhhmmss>.

Where

<YYYYMMDDhhmmss> is date and time when script was run.

Delete all files from the Tomcat cache directory<tomcat>\work\<Engine Name>\<Host Name>\actiTIME\

Where

<tomcat> is the directory where Tomcat is installed.

<Engine Name> - name of the Tomcat engine configured for your installation.
Usually is 'Standalone' or 'Catalina'.

<Host Name> - name of the virtual host
configured for your Tomcat installation.

Start the Tomcat server.

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:

Stop the Tomcat server.

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

Start the Tomcat server.

Restore procedure:

Stop the Tomcat server.

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