ARCWAY CockpitServer Installation

English

ARCWAY AGPotsdamer Platz 10D-10785 Berlin

Tel. +49 (30) 800 97 83-0Fax +49 (30) 800 97 83-100E-Mail info@arcway.com

ii

DISCLAIMER

Please direct questions about ARCWAY Cockpit or comments on this document to:

Customer SupportARCWAY AGPotsdamer Platz 1010785 Berlin+49.30.8009783.333

© 2004 - 2011 ARCWAY AG. All rights reserved. Unpublished - rights reserved under the Copyright Laws of Ger-many.

THIS PRODUCT CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF ARCWAY CORPORATION. USE,DISCLOSURE, AND/OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OFARCWAY CORPORATION. ACCESS IS LIMITED TO AUTHORIZED USERS. USE OF THIS PRODUCT IS SUBJECT TO THETERMS AND CONDITIONS OF THE USER‘S LICENSE AGREEMENT WITH ARCWAY CORPORATION.THE CONTENT OF THIS PUBLICATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULARPURPOSE OR NON-INFRINGEMENT. THIS PUBLICATION COULD INCLUDE INACCURACIES OR TYPOGRAPHICALERRORS.

ARCWAY AG reserves the right to revise this publication or withdraw it at any time without prior notice.

ARCWAY and Cockpit are trademarks or registered trademarks of ARCWAY Corporation.Java is a trademark of Sun Microsystems, Inc.Eclipse is a trademark of Eclipse Foundation, Inc.Microsoft, Windows, Windows 2000, Windows XP, Windows Vista, Windows 2003 Server MS Word, MS Excel, MSProject are trademarks or registered trademarks of Microsoft Corporation.MS SQL Server 2000 is a trademark of Microsoft Corporation.DB2 is a trademark of IBM Corporation.Linux is a registered trademark of Linus Torvalds.Fedora is a trademark of Red Hat, Inc.Mandrake is a trademark of Mandrakesoft S.A.SUSE is a trademark of SUSE AG, a Novell business.Adobe SVG Viewer is a trademark of Adobe Systems, Inc.All other company or product names are trademarks or registered trademarks of their respective owners.

Document 0001-V2-EN last edited on July 21, 2011

Table of Contents

Introduction........................................................................................... 1

System Requirements ............................................................................. 2Default Installation ...................................................................................................... 2

ARCWAY Cockpit Software.................................................................... 2

Default Installation - Windows................................................................ 4Step 1 – Installing Java SDK ......................................................................................... 4Step 2 – Setting JAVA_HOME Environment Variable.................................................... 4Step 3 – Installing Tomcat ........................................................................................... 5Step 4 – Configuring the Tomcat Properties ................................................................ 6Step 5 – Installing the ARCWAY License Server and the ARCWAY Cockpit Server ...... 7Step 6 – Installing the licenses ..................................................................................... 8Step 7 – Verifying Installation ...................................................................................... 8

Default Administrator Account .........................................................................................................9Check - Create a new Project ........................................................................................................11

Default Installation – Linux/Unix............................................................ 11Step 1 – Installing Java SDK ....................................................................................... 11Step 2 – Setting JAVA_HOME Environment Variable.................................................. 12Step 3 – Installing Tomcat .........................................................................................12Step 4 – Configuring the Tomcat Properties ..............................................................13

Configure the main memory value .................................................................................................14Step 5 – Installing the ARCWAY License Server and the ARCWAY Cockpit Server .....14Step 6 – Installing the licenses ................................................................................... 15Step 7 – Verifying Installation ....................................................................................15

Default Administrator Account .......................................................................................................16Check - Create a new Project ........................................................................................................18

Backup and Restore ............................................................................. 18Server Backup............................................................................................................18

Using the Cockpit Client to dump the Server ................................................................................18Using the Command Line Tool to dump the Server ......................................................................18Restoring the Server .........................................................................................................................19

Project Backup........................................................................................................... 19Using the Cockpit Client to dump a project ..................................................................................19Restoring Projects .............................................................................................................................20

Server Administration........................................................................... 20Customizing the Configuration Using Tomcat ........................................................... 20Installing the ARCWAY License Server ....................................................................... 22Installing the ARCWAY Cockpit Server ...................................................................... 22

Pre-Configured Servers ....................................................................................................................22Deployment ......................................................................................................................................23

Configuration............................................................................................................23License Server ...................................................................................................................................23Database ...........................................................................................................................................23File System ........................................................................................................................................27File Archive .......................................................................................................................................27Log ....................................................................................................................................................29Client Update ...................................................................................................................................29User Repository / LDAP Integration / SSO. .....................................................................................31

4

Troubleshooting................................................................................... 32Problems related to Tomcat....................................................................................... 32

I N S T A L L I N G C O C K P I T S E R V E R

1

Introduction

This document describes the installation of the Cockpit server. The server provides the central

storage for projects. The following prerequisites are required for installing a Cockpit server:

ARCWAY Cockpit server und ARCWAY Cockpit license web application archives

Java Servlet-Container (according to Servlet specifications 2.3 or 2.4 or 2.5)

A storage location for the data maintained by the ARCWAY Cockpit Server

The server bases like the client on Java. For operating the Cockpit server Java and a Servlet

Container are required. Recommended are the provided versions of the Java 2 Software Devel-

opment Kit (ORACLE J2SE RE 6.0) and of the Apache Tomcat 6.0 Servlet Container.

Note: If you are working with the Professional Edition of Cockpit, you do not need a server.

The descriptions in this document cover only the Enterprise Edition.

This document is organized as follows: The section System Requirements covers the envi-

ronments that are suitable to run ARCWAY Cockpit server. The section Default Installation

describes the installation of ARCWAY Cockpit server on a Windows platform using Tomcat as

Servlet container and HSQL as database. The following section, finally, describes the general

steps required to install ARCWAY Cockpit server. It is intended that this description be used as

a template to derive installation procedures for a concrete environment. The section

Configuration describes how to configure ARCWAY Cockpit Server running in a Tomcat

container and how to archive servers and projects. The last section Troubleshooting meets

frequently arising problems.

2

System Requirements

S E R V E R

P R O C E S S O R 1 GHz x86 Processo r recommended *

M E M O R Y Minimum 512 MB, recommended 1 GB *

F R E E D I S K S P A C E Minimum 1 GB* *

P L A T T F O R M Suppor ted Platfo rms are: WindowsXP *,Windows Vi sta*, Windows 7*, Windows2003 Server , Windows 2008 Server and Linux;should run on other Java enabled plat forms aswel l

S O F T W A R E J2SDK 1.5 .0 or h igher , Java Serv l e t Container(both sh ipped with in the insta l la t ion package)

* For up to 10 users

** Typical value, actual value depends on usage

Default Installation

The default installation uses a HSQL database (included in installation package) and stores files

in the local file system. The HSQL database also uses the file system to store its files

ARCWAY Cockpit Software

Up-to-date installation material for the „ARCWAY Cockpit 3.4 Enterprise Edition“ product can

be found on the products download site:

http://download.arcway.net/COCKPIT-Client/v340/index.html

The information located on this site includes the installation archives as well as accompanying

information such as the current version of this document.

3

We can also provide you with a installation CD. Please ask our support team to get hold of a

installation CD and we will provide you with a current snapshot of the contents of the above

download site.

If you did get hold of a installation CD please insert it into your CD-ROM drive and click on the

file index.html in to CD’s root directory to view the contents of the CD.

4

Default Installation - Windows

This section describes the installation of an ARCWAY Cockpit Server that uses HSQL as data-

base and runs in a Tomcat on a Microsoft Windows system.

Step 1 – Installing Java SDK

For the standard Installation the Java Developer Kit (JDK) in version 1.5 or higher is required.

For installation on a 64-bit Operating System a 64-bit Java SDK is required while a 32-bit Java

SDK is required for installation on a 32-bit Operating System. This step can be skipped if a suit-

able Java SDK is already installed.

Suitable JDK installation archives can be found on the ARCWAY Cockpit download site. You

can perform a Standard install using the provided Java SDK Installers.

Please go to this site for installation instructions:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Step 2 – Setting JAVA_HOME Environment Variable

Note:

If you to use a current version of Apache Tomcat such as Tomcat 6 or later, setting

JAVA_HOME environment variable is no longer required. You can skip this this step if you per-

form a standard install ation using the provided Version of Apache Tomcat 6.

The JAVA_HOME environment variable must be set to point to the directory where the Java

SDK is installed. For setting the environment variable, right click the My Computer icon on

your desktop and select Properties in the context menu. On the Advanced tab click the

button Environment Variables. Now click New… in the section for System variables.

This will launch the dialog to set a system variable. Enter JAVA_HOME in the field Variable

Name and the name of the directory where you installed the Java SDK in the field Variable

Value.

5

Step 3 – Installing Tomcat

Now it is time to install Tomcat, the Servlet container that will later run the ARCWAY Cockpit

Server. please proceed to the next step if a suitable Tomcat Version is is already installed on

your system,.

Suitable Tomcat installation archives can be found on the ARCWAY Cockpit download site.

Click on Tomcat Installer to launch the Tomcat installer.

Tomcat will look for the installed Java SDKs. It will first search in the location specified in

JAVA_HOME and will prompt you for some installation options:

Please check the field labeled Service. This will install Tomcat as a service. As a service it will

automatically be started when Windows starts.

6

Next you will be asked for a destination directory and, shortly after that, for a port, user name

and password:

The user name and password are needed for the administrator login to Tomcat. Do not skip

this step and remember the chosen user name and password carefully. The port will be the port

at which Tomcat and the ARCWAY Cockpit server can be reached.

Do not modify this port number in the default installation. If you change the port number, you

may continue with this installation procedure, but you will need to configure the ARCWAY

Cockpit Server manually after the deployment and before the verification. In particular, you

need to configure the URL of the ARCWAY Cockpit License Server and the database. Please

refer to the respective section Fehler! Ungültiger Eigenverweis auf Textmarke..

Finally, after you have specified all settings the installation will begin.

Step 4 – Configuring the Tomcat Properties

Now you have to configure the memory parameters within the Tomcat properties. You will find

a Tomcat icon in the system tray when Tomcat is running. Open the context menu via clicking

the icon with the right mouse button and select Configure…. This opens the dialog for con-

figuring the Tomcat properties. Activate the tab Java and enter a value for Maximum mem-

ory pool that is suitable for your computer or at least 512 MB. The recommended minimum

of 512 MB refers to a 32-bit installation. Installations on 64-bit machines do typically require

more RAM to perform similar operations. Hence, at least 768 MB should be configured for 64-

bit installations.

If the computer is a dedicated Cockit Server it is recommended to increase the value further

such that Tomcat is able to use half of the installed RAM.

7

Step 5 – Installing the ARCWAY License Server andthe ARCWAY Cockpit Server

The last step is deploying the ARCWAY License Server and ARCWAY Cockpit Server.

Click on the Server Package link that can be found in the Default Installation

section of the ARCWAY Cockpit download site. Copy the contents of this folder into the di-

rectory[Tomcat Home]\webapps.

Note: do NOT copy the files into [Tomcat Home]\server\webapps!

The .war’s provided on the download site are already preconfigured to work out-of-the-box.

The insertion of the WebApplication archive (“*.war” files) into the directory [Tomcat

Home}\webapps disposes Tomcat to unpack its content into the accordantly named directory.

Afterwards the directory should have this content:

8

Attention:

If you download the web application archives („.war“ Files) using a web browser the

browser will potentially modify the file extension of these files into „.zip“. In this case you need

to change the file extension manually back into “.war”. If you miss this step Tomcat will not

recognize the archives as web application archives and will not unpack/deploy the Cockpit web

applications.

Step 6 – Installing the licenses

If you have bought a license, wich is designed for administration by the license server, you

should copy this license file into the directory [Tomcat

Home]\webapps\CockpitLicenseServer\Licenses.

Step 7 – Verifying Installation

You have installed the ARCWAY Cockpit Server and the license server so far. The servers are

reachable via the following URL’s:

http://[your IP]:[your Tomcat port]/CockpitServer/

e.g.: http://localhost:8080/CockpitServer

http://[IP]:[ Tomcat port]/CockpitLicenseServer/

e.g.: http://localhost:8080/CockpitLicenseServer/

9

A first simple check of the installation can be performed at this point:

Open a web browser and enter the server URLs mentioned above. If you see an error message

for any of the screens, the installation of the respective server has failed.

D e f a u l t A d m i n i s t r a t o r A c c o u n t

Upon first startup, ARCWAY Cockpit Server will automatically connect to the database and

create the tables it needs for operation. During this process it will also create the following

administrator user:

User Name: Administrator

Password: PSC

It is recommended to install the client and to connect to the server using this administrator

account. Once connected, you should use the user management to change the password. You

can also create further user accounts here.

For creating a connection to the just installed server select Server > Add… from the main

menu. A dialog opens (see below). You can choose any server name. The URL should be the

URL where the Cockpit Server is located.

10

If you have successfully registrated the server, an accordant entry appears in the Project

Navigator. After this it should be possible to connect to the server. Right click on the server

entry and select Connect from the context menu.

The user management can be accessed using the main menu entry Server > User Man-

agement.

11

C h e c k - C r e a t e a n e w P r o j e c t

For this test you need an ARCWAY Cockpit Client, that is properly licensed. First you have to

configure the server connection for this client and connect to the server. A detailed description

of the necessary steps can be found in the section above “Default Administrator Account”.

After that you should be able to create a new project on the server.

If you use ARCWAY Cockpit for the first time, it is advisable to create a new sample project

using one of the sample project templates available from http://www.arcway.com/downloads.

Downlaod the project template file to your local file system with the help of your browser. Now

you can install the sample project using drag&drop. Simply drop the “*.act” file on the serv-

er entry in the Project Navigator.

Default Installation – Linux/Unix

This section describes the installation of an ARCWAY Cockpit Server based on Linux or Unix

Systems.

Due to the differences between the different systems of Linux or Unix no detailed install-

process can be indicated. These steps just stand here to illustrate the main character and is

based on the install-process for Windows Systems.

Because of the differences of these systems, the first and the second install-step were worked

automatically, if you start with “Step 3 - Installing Tomcat “. Maybe you can ignore Step 1 and

Step 3 if you have installed the correct versions of Java and Tomcat.

Step 1 – Installing Java SDK

For the standard Installation the Java Developer Kit (JDK) in version 1.5 or higher is required.

For installation on a 64-bit Operating System, a 64-bit Java SDK is required while a 32-bit Java

SDK is required for installation on a 32-bit Operating System. Supported VM’s are Java 1.5 and

Java 1.6 of IBM or SUN. ARCWAY Cockpit doesn’t support GCC-Java/GCJ. You can also use

“JRockit VM (BEA)” or the VM of the “OpenSDK”, but there are no values of experiences. Ac-

tually we don’t know any problems and try to develop ARCWAY Cockpit in this way, that

these two are supported. This step can be skipped if a suitable Java SDK is already installed.

12

Suitable JDK installation archives can be found on the ARCWAY Cockpit download site. You

can perform a Standard install using the provided Java SDK Installers.

Please go to this site for installation instructions:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Step 2 – Setting JAVA_HOME Environment Variable

Normally one of the installed Java VM’s is select in the system as the default VM. Which of the

VM’s is select you can detect with the normal Command:

java –version

If the Command offers the wrong Java VM you need to look into the Manual of this system.

Normally there is a Command to configure the right Java VM on the system:

alternatives –config java

update-alternatives –config java

ln –s /usr/java /usr/jdk/<java-version>

Step 3 – Installing Tomcat

Tomcat is the servlet container that runs the cockpit ARCWAY server. To run ARCWAY cockpit

recommended a current build of Tomcat versions 5.5 or 6.0 is used. The use of current Tomcat

5.0 variants is also possible.

Here also recommended that the use of their system-specific software management tool to

install an appropriate Tomcat version. Depending on your distribution, a Tomcat installation

also consists of components which are spread over several installation packages. If you are

unsure which components are actually needed will help our support you, if you submit the

names of all packages to choose from Tomcat to the cockpit support.

After installing Tomcat on your system, there is a [Tomcat Home] directory. This directory is

important for the installation process. It typically has a name "tomcat" as, "tomcat5",

"tomcat6" and usually has the following content:

13

The represented as subdirectories directory entries are usually not directly in the [Tomcat Home]

directory contains. Instead, often only contain links to the actual locations. For example, the

"conf" entry is usually a link to a directory under "/ etc ". Depending on the system can also

depicted directory entries "logs" and "temp " are missing.

The precise location of the [Tomcat Home] directory is also system dependent. A typical loca-

tion is: "/ usr/share/tomcat5"

Further, in the installation of Tomcat usually a [Tomcat init script] with a name like "tomcat" or

"catalina"is installed, referred to hereafter referred more often. This [Tomcat init script] which

is used to start / Stopppen Tomcat is for System V based operating systems typically installed in

the directory "/ etc / init.d".

This guide assumes that Tomcat is configured to have offered his services to the port 8080. If

this is not the case, you can continue with the rest of these installation instructions, but will

then follow the configuration of the cockpit to adjust ARCWAY server. Specifically, you must

port number in the URL of the cockpit ARCWAY correct license server. A more detailed

instructions can be found in section #########################.

The port number is set in the following configuration file of the Tomcat server:

[Tomcat Home]/conf/server.xml

In it, a record is of the form, where you can see the port number:

Step 4 – Configuring the Tomcat Properties

When you start Tomcat using the [Tomcat init script] by this script some basic operating

parameters determined. This includes the parameters for the Java VM, which is used as a carrier

system for Tomcat. The parameter values are often not directly written in the [Tomcat init

script], but can also be found in data from files that are evaluated by the [Tomcat init script]

(for example "/ etc/tomcat5/tomcat5.conf ").

14

C o n f i g u r e t h e m a i n m e m o r y v a l u e

Usually, the default for the maximum will not be used for the operation of Tomcat amount of

memory reconfigured to operate as a cockpit server and must not suitable. This is the

maximum amount of memory to be used actually a parameter of Tomcat itself, but a

parameter for the operation of Tomcat used Java VM. Such Java VM parameters are usually in a

[Tomcat init script] in a shell variable called "JAVA_OPTS" accumulated and incorporated into

the sequence in the Java VM startup command. To operate as a cockpit servers should the Java

VM 512 MB is provided. These specified minimum quantity of 512 MB refers to the case where

a 32-bit Java runtime environment is used. 64-bit Java runtime environments need to perform

the same tasks in general much more memory. Therefore, when using a 64-bit runtime

environment, a higher value of at least 768 MB set. This would be the "JAVA_OPTS" a "-Xmx"

parameter immediately followed by a corresponding amount of expression such as "768m" for

768MB of memory to add:

JAVA_OPTS="$ JAVA_OPTS –Xmx768m“

If you are undecided is whether the setting is working, you can try to set a high value as

nonsensical "Xmx76800m. In this case, the value of the Java VM will be recognized as

nonsensical and a corresponding entry in the log file-s in the [Tomcat Home] / logs the result.

Step 5 – Installing the ARCWAY License Server and theARCWAY Cockpit Server

The last step is deploying the ARCWAY License Server and ARCWAY Cockpit Server.

Click on the Server Package link that can be found in the Default Installation

section of the ARCWAY Cockpit download site. Copy the contents of this folder into the di-

rectory[Tomcat Home]\webapps.

Note: do NOT copy the files into [Tomcat Home]\server\webapps!

The .war’s provided on the download site are already preconfigured to work out-of-the-box.

The insertion of the WebApplication archive (“*.war” files) into the directory [Tomcat

Home}\webapps disposes Tomcat to unpack its content into the accordantly named directory.

Afterwards the directory should have this content:

15

Attention:

If you download the web application archives („.war“ Files) using a web browser the

browser will potentially modify the file extension of these files into „.zip“. In this case you need

to change the file extension manually back into “.war”. If you miss this step Tomcat will not

recognize the archives as web application archives and will not unpack/deploy the Cockpit web

applications.

Step 6 – Installing the licenses

If you have bought a license, which is designed for administration by the license server, you

should copy this license file into the directory [Tomcat

Home]\webapps\CockpitLicenseServer\Licenses.

Step 7 – Verifying Installation

You have installed the ARCWAY Cockpit Server and the license server so far. The servers are

reachable via the following URL’s:

http://[your IP]:[your Tomcat port]/CockpitServer/

e.g.: http://localhost:8080/CockpitServer

http://[IP]:[ Tomcat port]/CockpitLicenseServer/

e.g.: http://localhost:8080/CockpitLicenseServer/

16

A first simple check of the installation can be performed at this point:

Open a web browser and enter the server URLs mentioned above. If you see an error message

for any of the screens, the installation of the respective server has failed.

D e f a u l t A d m i n i s t r a t o r A c c o u n t

Upon first startup, ARCWAY Cockpit Server will automatically connect to the database and

create the tables it needs for operation. During this process it will also create the following

administrator user:

User Name: Administrator

Password: PSC

It is recommended to install the client and to connect to the server using this administrator

account. Once connected, you should use the user management to change the password. You

can also create further user accounts here.

For creating a connection to the just installed server select Server > Add… from the main

menu. A dialog opens (see below). You can choose any server name. The URL should be the

URL where the Cockpit Server is located.

17

If you have successfully registrated the server, an accordant entry appears in the Project

Navigator. After this it should be possible to connect to the server. Right click on the server

entry and select Connect from the context menu.

The user management can be accessed using the main menu entry Server > User Man-

agement.

18

C h e c k - C r e a t e a n e w P r o j e c t

For this test you need an ARCWAY Cockpit Client that is properly licensed. First you have to

configure the server connection for this client and connect to the server. A detailed description

of the necessary steps can be found in the section above “Default Administrator Account”.

After that you should be able to create a new project on the server.

If you use ARCWAY Cockpit for the first time, it is advisable to create a new sample project

using one of the sample project templates available from http://www.arcway.com/downloads.

Download the project template file to your local file system with the help of your browser. Now

you can install the sample project using drag & drop. Simply drop the “*.act” file on the

server entry in the Project Navigator.

Backup and Restore

Server Backup

U s i n g t h e C o c k p i t C l i e n t t o d u m p t h e S e r v e r

To create a server backup with the help of a Cockpit Client, select the item Server > Ar-

chive… in the client main menu. The following dialog gives an overview of all servers that can

be archived. Select the desired server and enter a destination for storing the archive. Confirm

your input with OK. Now all projects will be downloaded from the server and put into a zip file

at the desired destination.

U s i n g t h e C o m m a n d L i n e T o o l t o d u m p t h eS e r v e r

There is also a “command line” client available that can be used to create a server backup. This

command line client does not require a Cockpit Client installation. Since it is completely imple-

mented in Java it can be used on any Platform where a Java Runtime Environment (JRE 1.5 or

higher) is installed.

Synopsis:

19

java -jar cockpit-dump.jar -s serverurl -f dumpfile [-o y|n] [-u

username -p password]

-s serverurl

The url of the ARCWAY Cockpit Server to be dumped

e.g.: http://localhost:8080/CockpitServer/

-f dumpfile

The name of the file that shall be used to store the serverdump

e.g.: CockpitServerDump-20080509.zip

-o y|n

overwrite the dumpfile if it already exists

y: overwrite

n: do not overwrite, but abort

currently defaults to n

-u username

The name of the ARCWAY Cockpit Server User that will be used to log in to the

ARCWAY Cockpit Server. This User must have sufficient privileges to create a server

dump, i.e. the User must be the user 'Administrator', a member of the group 'Admin-

istrators' or must have 'Operator' or 'Administrate System' Permission.

This parameter must be omitted if the ARCWAY Cockpit Server is configured for Sin-

gle Sign-On.

-p password

The password of the ARCWAY Cockpit Server user specified by “–u”.

This parameter must be omitted if the ARCWAY Cockpit Server is configured or Single

Sign-On.

R e s t o r i n g t h e S e r v e r

To restore a server backup select Server > Restore… from the Cockpit Client main menu.

Select the server that shall be overwritten and the zip file that contains the server archive in the

following dialog. Confirm your input with OK to restore the server with the help of the backup.

Project Backup

U s i n g t h e C o c k p i t C l i e n t t o d u m p a p r o j e c t

To create a project backup with the help of a Cockpit Client select the item Project > Ar-

chive… in the client main menu. The following dialog gives an overview of all projects that

can be archived. Select the desired project and enter a destination for storing the archive. Con-

firm your input with OK. Now the selected project will be downloaded from the server and put

into a zip file at the desired destination.

20

R e s t o r i n g P r o j e c t s

To restore a project backup select Project > Restore… from the Cockpit Client main

menu and select the zip file that contains the project archive in the following dialog.

It is possible to restore the archive as a new project or as stored within the file. Note that exist-

ing projects of the same name will be overwritten when selecting the option “as dumped”.

When selecting the option “as new project” a name for the project has to be entered.

Confirm your input with OK to restore the project with the help of the backup.

Server Administration

Customizing the Configuration Using Tomcat

This section explains how to configure ARCWAY Cockpit Server running in a Tomcat Servlet

container. It is assumed that you have already deployed the ARCWAY Cockpit Server into the

Tomcat Servlet container and that Tomcat has unpacked the WAR archives. If you have not

deployed ARCWAY Cockpit Server so far, you may wish to return to the Default Installation

steps 1 through 4.

The configuration can be altered using the Tomcat Administration tool. The Tomcat Admini-

stration tool is available at:

http://[your IP]:[Tomcat Port]/admin

e.g. http://localhost:8080/admin/

You need to login with the administrator account created during installation of Tomcat. After

the login you will see the administration panel. Please navigate to:

21

Tomcat Server->Service (Tomcat Standalone)->Host (localhost) …

->Context (/CockpitServer)

Next, open Resources -> Environment Entries

Click on the entry you wish to change and you will be directed to a page to enter the entry.

22

For more information on the entries and their purpose, please refer to the previous section.

When you are satisfied with your changes and wish to commit them, you need to press Com-

mit Changes. This will write the changes you made to the Tomcat configuration file. After

the changes have been written to that file, the Cockpit Web Applications need to be restarted

for the changes to take effect.

Installing the ARCWAY License Server

The ARCWAY License Server manages the licenses for ARCWAY Cockpit server. The

ARCWAY License Server must be deployed into a Servlet container and the license obtained

with your copy of ARCWAY Cockpit must be copied into the Licenses directory of the de-

ployed application. Copy the license file into the folder

[ServletContainer Home]\webapps\CockpitLicenseServer\Licenses

Installing the ARCWAY Cockpit Server

P r e - C o n f i g u r e d S e r v e r s

ARCWAY Cockpit comes with two pre-configured servers. One whose configuration is opti-

mized for “HSQL” databases and another for external MS SQL Servers. These configurations

can be accessed by following the respective links on the index.html file on the ARCWAY

Cockpit CD.

23

D e p l o y m e n t

First the WAR archives need to be deployed. Some servers provide a “deploy” tool for this

objective, otherwise it’s quite enough to copy the WAR archives into the accordant directory.

The WAR archives can be found by flowing the configuration-specific links on the in-

dex.html file on the ARCWAY Cockpit CD.

Configuration

Before the ARCWAY Cockpit server can be deployed, at least the license server and the data-

base connection to be used must be configured. Configuration is done by means of editing

env_entry items in the web.xml file of ARCWAY Cockpit server.

Please note that the following variables may be used in env_entry items that have the type

String:

V A R I A B L E S@ ( D o c u m e n t R o o t ) A b s o l u t e p a t h t o w e b a p p l i c a -

t i o n ’ s r o o t d i r e c t o r y ( f i l e s y s t e m )@ ( W e b a p p D i r N a m e ) N a m e o f t h e l a s t d i r e c t o r y c o n -

t a i n e d i n @ ( D o c u m e n t R o o t )

L i c e n s e S e r v e r

Configuring the license server is straightforward. All you need to do is to specify the URL at

which the license server can be reached. To do so set the parameter

AC1/ServerParameter/FloatingLicenseManager/licenseServerAddress

A C 1/ S e r v e r P a r a m e t e r

/ F l o a t i n g L i c e n s e M a n a g e r/ l i c e n s e S e r v e r A d d r e s s

D E S C R I P T I O N U R L o f t h e L i c e n s e S e r v e rT Y P E S t r i n gE X A M P L E h t t p : / / l o c a l h o s t : 8 0 8 0 / …

… C o c k p i t L i c e n s e S e r v e r

D a t a b a s e

To configure the database you need to specify the database to use, the URL where to reach the

database and the user and password to connect to the database.

24

ARCWAY Cockpit server files UNICODE coded files into the configurated database. Please

consider this when you create the databases and activate the UNICODE assistance in you da-

tabase administration system.

First configure the database to use by setting the

AC1/ServerParameter/Database/dbConnectionClass parameter. This parameter

can take the values

„NativeDB2“ IBM DB2 version 8.1

„NativeHSQLDB“ http://hsqldb.org

„NativeOracle“ Oracle 10g

„NativeSQLServer“ Microsoft SQL Server 2000

„NativeSQLServer2005“ Microsoft SQL Server 2005

„NativeMYSQLCJ“ MySQL version 4.1 or later

(Note: upper and lower case are important).

Next, you need to set the database URL and put the Database specific JDBC-Driver Files in

place.

The database URL is set via the parameter

AC1/ServerParameter/Database/dbName, which uses a proprietary format to

specify the URL.

The driver files need to be placed into the directory “WEB-INF/lib” folder of the

Cockpit Server Web-Application under configuration (see example screenshot below):

In case of “NativeHSQLDB” the value of dbName is prependend with the string

jdbc:hsqldb: to form a valid HSQL DB URL. The dbName fraction of such a URL may be

the specification of a destination in the file system following the format:

Conf igur ing HSQLDB

25

H S Q L D A T A B A S EE X A M P L E ( D B N A M E ) C : / D a t a / C o c k p i t / H s q l D BR E S U L T I N G U R L j d b c : h s q l d b : C : / D a t a / C o c k p i t / H s q l

D BJ D B C - D R I V E R F I L E S h s q l d b . j a r

In case of “NativeSQLServer2000” the database URL is constructed from the given

dbName as follows: The String “jdbc:microsoft:sqlserver:” is prepended and string

“;SelectMethod=Cursor” is appended to the value of dbName to form a valid database

URL for the Microsoft JDBC Driver.

M S S Q L S E R V E R D A T A B A S EE X A M P L E ( D B N A M E ) / / a r c s e r v 1 : 1 4 3 3 ; D a t a b a s e N a m e =

C o c k p i t T e s tR E S U L T I N G U R L j d b c : m i c r o s o f t : s q l s e r v e r : / / a r c s e r v

1 : 1 4 3 3 ; D a t a b a s e N a m e = C o c k p i t T e st ; S e l e c t M e t h o d = C u r s o r

J D B C - D R I V E R F I L E S m s b a s e . j a rm s u t i l . j a rm s s q l s e r v e r . j a r

In case of “NativeSQLServer2005” the database URL is constructed from the given

dbName as follows: The string “jdbc:microsoft:sqlserver:” is prepended to the value

of dbName to form a valid database URL for the Microsoft JDBC Driver.

M S S Q L S E R V E R D A T A B A S EE X A M P L E ( D B N A M E ) / / a r c s e r v 1 : 1 4 3 3 ; D a t a b a s e N a m e =

C o c k p i t T e s tR E S U L T I N G U R L j d b c : m i c r o s o f t : s q l s e r v e r : / / a r c s e r v

1 : 1 4 3 3 ; D a t a b a s e N a m e = C o c k p i t T e st ; S e l e c t M e t h o d = C u r s o r

J D B C - D R I V E R F I L E S m s b a s e . j a rm s u t i l . j a rm s s q l s e r v e r . j a r

In case of “NativeDB2” the database URL is constructed from the given dbName as follows:

The string “jdbc:db2:” is prepended to the value of dbName to form a valid database URL

for the IBM DB2 Database.

I B M D B 2 D A T A B A S EE X A M P L E ( D B N A M E ) / / l o c a l h o s t : 5 0 0 0 0 / C o c k p i tR E S U L T I N G U R L j d b c : d b 2 : / / l o c a l h o s t : 5 0 0 0 0 / C o c k p

i tJ D B C - D R I V E R F I L E S I B M ’ s J D B C T y p e 4 D r i v e r “ j c c -

D r i v e r ”d b 2 j c c . j a rd b 2 _ l i c e n s e _ c u . j a rd b 2 _ l i c e n s e _ c i s u z . j a r

Hint:

The default value for the database parameter LOGFILSIZ which defines the size of the transac-

tion protocol is very low and proved to be too small for a typical Cockpit Server installation. In

Conf iguring MSSQL Server 2000

Conf igur ing MSSQL Server 2005

Conf igur ing I BMDB2

26

these cases the default value specified a transaction log size of 1MB (250 pages, 4kB each). It is

recommended to reserve 100 MB for the transaction log.

In case of “NativeOracle” the database URL is constructed from the given dbName as fol-

lows: The string”jdbc:oracle:thin:” is prepended to the value of dbName to form a

valid database URL for the Oracle JDBC-Driver.

O R A C L E D A T A B A S EE X A M P L E ( D B N A M E ) @ 1 9 2 . 1 6 8 . 3 5 . 2 1 5 : 1 5 2 1 : T e s t C o c k p

i tR E S U L T I N G U R L j d b c : o r a c l e : t h i n : @ 1 9 2 . 1 6 8 . 3 5 . 2 1 5

: 1 5 2 1 : T e s t C o c k p i tJ D B C - D R I V E R F I L E S o j d b c 1 4 _ g . j a r

In case of “NativeMYSQLCJ” the database URL is constructed from the given dbName as

follows: The string ”jdbc:mysql:” is prepended to the value of dbName to form a valid

database URL for the MySQL JDBC-Driver.

S Q L - S E R V E R D A T A B A S EE x a m p l e ( D B N a m e ) / / 1 9 2 . 1 6 8 . 3 5 . 2 0 8 / C o c k p i t D BR e s u l t i n g U R L j d b c : m y s q l : / / 1 9 2 . 1 6 8 . 3 5 . 2 0 8 / C o c k

p i t D BJ D B C - D R I V E R F I L E S T h e D r i v e r i s a J a v a - a r c h i v e - f i l e ,

w h i c h n a m e b e g i n s w i t h " m y s q l -c o n n e c t o r - j a v a " a n d e n d s w i t h" . j a r " .T w o E x a m p l e s :- m y s q l - c o n n e c t o r - j a v a - 3 . 1 . 6 . j a ro r- m y s q l - c o n n e c t o r - j a v a - 3 . 1 . 1 2 -b i n . j a r

Eventually you need to specify the database user with the parameter

AC1/ServerParameter/Database/dbUser and the password in the parameter

AC1/ServerParameter/Database/dbPassword.

The database schema, as well as, the initial content of the database will be created automati-

cally at the first startup of the Cockpit Server. Hence no additional preparation of the database

is necessary.

ARCWAY Cockpit server files UNICODE coded files into the configurated database. Please

consider this when you create the databases and activate the UNICODE assistance in you da-

tabase administration system.

Conf igur ing Orac le

Conf igur ingMySQL

User and Password

Database conf igu -rat ion parameters

27

A C 1/ S e r v e r P a r a m e t e r

/ D a t a b a s e/ d b C o n n e c t i o n C l a s s

D E S C R I P T I O N T h i s p a r a m e t e r i s u s e d t o s e l e c t t h e d a -t a b a s e d r i v e r t o c o n n e c t t o t h e d a t a b a s e

T Y P E S t r i n gE X A M P L E “ N a t i v e H S Q L D B ” o r “ N a t i v e S Q L S e r v e r ” o r

“ N a t i v e D B 2 ”

A C 1 / S e r v e r P a r a m e t e r / D a t a b a s e / d b N a m eD E S C R I P T I O N D a t a b a s e U R L ( p a r t o f )T Y P E S t r i n gE X A M P L E “ / / a r c s e r v 1 : 1 4 3 3 ; D a t a b a s e N a m e = C o c k p i t T

e s t ”

A C 1 / S e r v e r P a r a m e t e r / D a t a b a s e / d b U s e rD E S C R I P T I O N T h e u s e r t h e a p p l i c a t i o n u s e s t o c o n n e c t

t o t h e d a t a b a s eT Y P E S t r i n gE X A M P L E “ C o c k p i t u s e r ”

A C 1 / S e r v e r P a r a m e t e r / D a t a b a s e / d b P a s s w o r dD E S C R I P T I O N T h e p a s s w o r d o f t h e d a t a b a s e u s e r t h e

a p p l i c a t i o n u s e s t o c o n n e c t t o t h e d a t a -b a s e

T Y P E S t r i n gE X A M P L E “ 4 5 h j 5 6 ”

F i l e S y s t e m

To configure the temporary folder you need to set the parameter

AC1/ServerParameter/tempFolder.

A C 1 / S e r v e r P a r a m e t e r / t e m p F o l d e rD E S C R I P T I O N N a m e o f t h e d i r e c t o r y u s e d t o s t o r e t e m -

p o r a r y f i l e s . I t i s u s e d t o s t o r e c o p i e s o fp l a n - f i l e s w h i c h a r e t r a n s f e r r e d t o / f r o mt h e a r c h i v e

T Y P E S t r i n gE X A M P L E “ C : \ T e m p ”

F i l e A r c h i v e

A Cockpit Server is responsible for storing plans in different versions. The Cockpit server can

either use the built-in archive implementation called “Simple File System Archive” or can use an

external archive system accessible via a standard WebDAV interface.

28

It is important to enable support for exactly one archive. This means that exactly one of the

following parameters must be set to “true”. (The other one must be set to “false” respec-

tively.)

AC1/ServerParameter/simplefilesysstemarchive/archiveEnabled

AC1/ServerParameter/webdavarchive/archiveEnabled

The configuration of the different archives vary:

To configure the archive folder you need to set the parameter

AC1/ServerParameter/simplefilesysstemarchive/archiveRoot.

This folder will be used as the root of a directory hierarchy which contain the files comprising

the archive.

You need to specify the WebDAV-URL of a content management system that has a WebDAV

interface and provides versioning support (DeltaV extension to WebDAV). Additonally you need

to specify a username and password for accessing the Server.

A C 1/ S e r v e r P a r a m e t e r

/ s i m p l e f i l e s y s s t e m a r c h i v e/ a r c h i v e R o o t

D E S C R I P T I O N T h e r o o t d i r e c t o r y c o n t a i n i n g t h e a r c h i v eo f P l a n - F i l e s

T Y P E S t r i n gE X A M P L E “ C : \ A r c h i v e ”

A C 1/ S e r v e r P a r a m e t e r

/ w e b d a v a r c h i v e/ a r c h i v e E n a b l e d

D E S C R I P T I O N F l a g t o a c t i v a t e W e b D A V a r c h i v e s u p p o r t .D e f a u l t v a l u e : f a l s e

T Y P E B o o l e a nE X A M P L E “ f a l s e ”

A C 1/ S e r v e r P a r a m e t e r

/ w e b d a v a r c h i v e/ a r c h i v e U R L

D E S C R I P T I O N T h e U R L o f t h e W e b D A V S e r v e r . T h e U R Li d e n t i f i e s t h e r o o t c o l l e c t i o n u n d e rw h i c h t h e a r c h i v e d P l a n s a r e s t o r e d

T Y P E S t r i n gE X A M P L E “ h t t p : / / l o c a l h o s t : 8 0 8 0 / s l i d e / f i l e s ”

A C 1/ S e r v e r P a r a m e t e r

/ w e b d a v a r c h i v e/ a r c h i v e U s e r n a m e

D E S C R I P T I O N T h e n a m e ( u s e r n a m e ) o f t h e u s e r t h e a p -p l i c a t i o n u s e s t o c o n n e c t t o t h e W e b D A VS e r v e r

F i le System Ar -chive

WebDAV Archive

29

T Y P E S t r i n gE X A M P L E “ r o o t ”

A C 1/ S e r v e r P a r a m e t e r

/ w e b d a v a r c h i v e/ a r c h i v e P a s s w o r d

D E S C R I P T I O N T h e P a s s w o r d o f t h e a r c h i v e u s e r t h e a p -p l i c a t i o n u s e s t o c o n n e c t t o t h e W e b D A VS e r v e r

T Y P E S t r i n gE X A M P L E “ r o o t ”

L o g

A C 1 / S e r v e r P a r a m e t e r / L o g F i l e / l o g F i l e P a t h

D E S C R I P T I O N T h e n a m e o f t h e l o g f i l e

T Y P E S t r i n g

E X A M P L E “ C : \ T e m p \ L o g \ C o c k p i t . l o g ”

A C 1 / S e r v e r P a r a m e t e r / L o g F i l e / m a x F i l e L e n g t h

D E S C R I P T I O N M a x i m u m s i z e o f l o g f i l e i n b y t e s

T Y P E I n t

E X A M P L E “ 2 0 0 0 0 0 0 0 0 ”

C l i e n t U p d a t e

A C 1/ S E R V E R P A R A M E T E R/ E C L I P S E C L I E N T U P D A T E/ U P D A T E S I T E R E P O S I T O R Y L O C A T I O N

D E S C R I P T I O N Cl ien t Update Sto rage locat ion

The Cockpi t server can provide c l i en t sof tware , Th isParameter states where these updates can be on theserver . I t i s recommended to store these updates in ad i rectory on the server s f i le system. In th i s case theparameter value has the fo l lowing fo rm : „di r :path -name”. Al ternat ive l y the sto rage locat ion can bespeci f i ed to be access ib l e v i a a ur l .

T Y P E Str ing

30

E X A M P L E S “di r :D: \cockp i t \updat e-s i te”

“ur l :http : / /update.arcway.net /updates/ cockpi t /3 .1 / ”

A C 1/ S E R V E R P A R A M E T E R/ E C L I P S E C L I E N T U P D A T E/ U P D A T E C O N S T R A I N T S R E P O S I T O R Y L O C A T I O N

D E S C R I P T I O N Storage locat ion for update const ra in ts and cl i en t -userinst ruct ions

The server can provide const ra int s that must be metby c l i ent s that want to connect to the cockpi t server .Further more i t can provide related ins t ruct ions forthe user s of the c l i ent s .

In order to use th i s mechanisms one needs to spec i fy astorage locat ion where a di rectory s t ructu re of thefo l lowing form can be found:

The f i l es cal led „compat ib i l i tyconst ra ints .xml“ containsoftware compat ib i l i ty const ra ints whi l e „mes-sage.h tml“ f i les contain inst ruct ions for the users ofthe c l i ent s .

I f a c l i ent does not comply with the „manda-tory“compat ib i l i t y const ra int s the „mandatory“ mes-sage wi l l be d i sp layed on the cl i en t and the cl ien tsoftware wi l l be rest ra ined to cl i ent so ftware updatedownload. I f the c l i en t meets the „mandatory“ con-st ra int s but not the „recommended“ const ra ints the„recom mended“ message wi l l be d isp layed on cl ien ts ide . P lac ing a message in the root fo lder wi l l havethe effect that th i s message wi l l be d i sp layed on cl ien ts ide even i f the Cl i ent so ftware meets both the „ man-dato ry“ and the „recommended“ const ra ints.

„compat ib i l i t yconstra in ts .xml“ – Fi l es can be obtainedfrom the ARCWAY Cockp i t Support Team.

I t i s recommended to sto re the update-constra int s in ad i rectory on the server s f i le system. In th i s case theparameter value has the fo l lowing fo rm : „di r :path -name”. Al ternat ive l y the sto rage locat ion can bespec i f i ed to be access ib l e v i a a ur l .

T Y P E Str ing

31

E X A M P L E “di r :D: \cockp i t \update-constra int s ”

U s e r R e p o s i t o r y / L D A P I n t e g r a t i o n / S S O .

A C 1 / S E R V E R P A R A M E T E R / U S E R R E A L M C O N F I G / …D E S C R I P T I O N T h e s e v a l u e s n e e d t o b e c h a n g e d i n o r d e r

t o c o n n e c t t h e C o c k p i t S e r v e r t o a e x i s t -i n g U s e r D a t a b a s e w h i c h i s a c c e s s i b l e v i aa L D A P i n t e r f a c e .I f y o u i n t e n d t o u s e t h i s i n t e g r a t i o n a s kt h e A R C W A Y C o c k p i t S u p p o r t T e a m f o rm o r e i n f o r m a t i o n .s u p p o r t @ a r c w a y . c o m

32

Troubleshooting

Problems related to Tomcat

I f o r g o t t h e p a s s w o r d f o r T o m c a t

You may look up the password by opening the file [Tomcat Home]/conf/tomcat-

users.xml

I a m n o t s u r e w h e t h e r T o m c a t i s r u n n i n g

You may verify that Tomcat is running by going to http://[ip]:[Tomcat Port]/ (e.g.

http://localhost:8080/) which will display a welcome screen when Tomcat is running

A c l i e n t c a n n o t c o n n e c t t o s e r ve r b e c a u s e l i c e n s e i s n o t v a l i d

You can check with a web browser, if the license server is running.

Take the URL

http://[your ip]:[your Tomcat Port]/CockpitLicenseServer/

A welcome page shows the license information, if the license server is running.

If your license is not valid, please contact ARCWAY to get a valid license file.

Copy the new file in the folder

[Servlet Home]\webapps\CockpitLicenseServer\Licenses

and reboot the license server. You can do this in the Tomcat Management Console or by re-

starting Tomcat.

A c l i e n t c a n n o t c o n n e c t t o t h e s e r v e r b e c a u s e o f a “P r o b l e m w i t hs e r v e r c onn e c t i o n ”

Please check, if you have really added a trailing “/“ on the server URL.