Xpert.ivy 4.2. Server Guide

Transcription

1 Xpert.ivy 4.2 Server Guide

2 Xpert.ivy 4.2: Server Guide Copyright ivyteam AG

3

4 Table of Contents 1. Preface... 1 Audience Introduction... 2 Overview... 2 Installation Environment... 2 Server Types... 3 Xpert.ivy Standard Server... 3 Xpert.ivy Cluster Server... 3 What server type do I need?... 4 Server Platforms... 4 System Administrator Tasks... 5 System Administrator Skills and Responsibilities... 5 Installation... 6 Migration... 6 Patching... 6 Configuration... 6 Integration with IIS... 6 Integration with Apache... 6 Tomcat Configuration... 7 Administration... 7 Active Directory Integration... 7 Monitoring... 7 Setup of External Tools... 7 Server Backup... 7 Backup of Databases... 7 Uninstallation... 7 Workflow Administrator Tasks... 7 Workflow Administrator Skills and Responsibilities... 8 User Creation... 8 Role Assignment... 8 Permission Assignment... 8 Controlling of Running Cases and Tasks... 8 Cleanup of Cases... 8 Checking of Workflow History... 9 Checking of Runtime Logs Installation Upgrading from an older version Standard Server Installation Steps Cluster Installation Steps Installation of the first Xpert.ivy Cluster Server node Installation of another Xpert.ivy Cluster Server node on a different machine Installation of another Xpert.ivy Cluster Server Node on the same machine Install Xpert.ivy Server Installed Files and Directories Installing a Licence Installation of Patches Installation of Hot Fixes Configuration How to start the Server Configuration application Launch from Server Control Center Direct Launch Launch in Headless Mode Server Configuration System Database System Administrators iv

5 Xpert.ivy Web Server Ports... Cluster... Server Control Center... Start / Stop server... Configuring Windows Service (Windows only)... Testing the Server... Server List Configuration... Configure Tomcat... Web Server Integration... Integration Directory... Apache HTTP Server 2.2 Integration... Example... Change context URI /ivy/... Microsoft Internet Information Server (IIS)... IIS 6 (Windows Server 2003)... IIS 7 (Windows Server 2008)... Change context URI /ivy/... Single Sign On... Xpert.ivy Cluster Server, Load Balancing and Sticky Sessions... Example... Server Administration... Opening the administration tool... Applications... Create new application... Configuring an External Security System... Configuration of Application Default Settings... Notification Settings... Content Creation Processes... Default Executed Processes... Process Models and Process Model Versions... The Concept of Versions... Creating Process Models and Process Model Versions... Manage Activation and Release State... Deploying a Project... Environments... Configuration of environments... Global Variables... External Databases... Web Services... Users and Roles... User list... Roles... Permissions... System Properties... Server infos... Runtime information... About... Monitoring... Logging... Runtime Log... Visual VM... Server Administration... Tool Reference... XpertIvyServer... Description... Launchers... XpertIvyServerConfig... Description... v

6 Xpert.ivy 4.2 Options... Launchers... XpertIvyServerService... Description... Options... Launchers... ServerControlCenter... Description... Launchers... RichDialogApplicationLauncher... Description... Options... Launchers... InstallService... Description... Launchers... Windows Program Launcher Configuration... Unix Launcher Configuration System Database... Database Drivers... MySQL... Information... Compatibility... Configuration... Creation... Driver... Oracle... Information... Compatibility... Configuration... Creation... Driver... Microsoft SQL Server... Information... Compatibility... Configuration... Creation... Driver... DB2 for z/os... Information... Compatibility... Configuration... Creation... Driver... DB2 for Linux/Unix/Windows (LUW)... Information... Compatibility... Configuration... Creation... Driver... DB2 for iseries (AS400)... Information... Compatibility... Configuration... Creation... Driver... Sybase SQL Anywhere... Information... vi

7 Xpert.ivy 4.2 Compatibility Configuration Creation Driver Postgre SQL Information Compatibility Configuration Creation Driver General concepts HTML Workflow UI End Page replacement Login Page replacement Sample HTML Workflow UI Project Notification Notification Process Design Notification Summary Miscellaneous Replacing default certificate for Rich Dialogs Replacing Java Runtime with newer version Troubleshooting Program / Server start problems JVM cannot allocate enough Memory Socket name not available on this system Logging Configure ULC logging on server and client vii

8 List of Figures 2.1. Xpert.ivy Server Installation Xpert.ivy Standard Server Xpert.ivy Cluster Server Xpert.ivy Server System Administrator Tasks Xpert.ivy Server Workflow Administrator Tasks Xpert.ivy Server Configuration System Database Tab Xpert.ivy Server Configuration Administrator Tab Xpert.ivy Server Configuration WebServer Tab Xpert.ivy Server Configuration Cluster Tab The Server Control Center Configuring Xpert.ivy Server as Windows service Create a new server in the server list Create a new service in the server list Xpert.ivy Cluster Node Details page Xpert.ivy Server info page Admin Tool External security system configuration dialog Application Default Settings Managing the activation state Managing the release state Deployment Deployment Wizard: Choose the project to deploy (directory or zip file) Deployment Wizard: Validating Project Deployment Wizard: Deploying Project Deployment Wizard: Release and Activate Process Model Version List of environments Set active environment for an application Environment details Details of a global variable Question to override the default value of the global variable Databases Configuring the connection of an external database Overview of roles and users List of all users Creating a new user Manage roles of a user User properties List of all roles Users of a role Editing the permissions of a user Overview of system properties Editing a system property Runtime information About Example for both notification process types Correct declaration of process start element for a "New task" notification Correct declaration of process start element for a "Daily summary" notification viii

9 List of Tables 3.1. Supported Xpert.ivy Server Platforms Installed Files and Directories Windows Programs Unix Programs Web Server Protocols Release states Activition states Default settings for logging XpertIvyServer Launchers XpertIvyServerConfig Options XpertIvyServerConfig Launchers XpertIvyServerService Options XpertIvyServerService Launchers ServerControlCenter Launchers RichDialogApplicationLauncher Options RichDialogApplicationLauncher Launchers InstallService Launchers Ivy Launch Control Properties MySQL Configuration MySQL Creation Parameter MySQL Driver Oracle Configuration Oracle Creation Parameter Oracle Driver Microsoft SQL Configuration Microsoft SQL Creation Parameter Microsoft SQL Driver DB2 for z/os Configuration DB2 for z/os Creation Parameter DB2 for z/os Driver DB2 for LUW Configuration DB2 for LUW Creation Parameter DB2 for LUW Driver DB2 for iseries Configuration DB2 for iseries Creation Parameter DB2 for iseries Driver Sybase SQL Anywhere Configuration Sybase SQL Anywhere Driver PostgreSQL Configuration PostgreSQL Creation Parameter PostgreSQL Driver... ix

10 Chapter 1. Preface Audience This guide is intended for System Administrators that need to install, configure and administrate the Xpert.ivy Server Workflow Administrators that have to manage the processes, users, tasks and cases running on the Xpert.ivy Server 1

11 Chapter 2. Introduction Overview Xpert.ivy consists of two parts. The Xpert.ivy Designer which allows you to build Web Applications and Rich Internet Applications (known under the term RIA). Web Applications are applications that run on a web server and communicate with the application users over a web browser (Internet Explorer, Firefox, etc.). Rich Internet Applications on the other hand are applications where the pure presentation layer of the user interface runs on the client and the logic of the UI and of the application runs on a server. The Xpert.ivy Designer allows you to build applications that can: Run as Web Application with a HTML UI Run as a Rich Internet Application in a JVM Read and write data from/to databases. Call web services to get and set data from/to external systems Be internationalized by using the content management system. Perform Business Process Management tasks let different user interact with business processes. The Xpert.ivy Server is responsible to execute applications in a productive environment. Once an application has been developed and tested with the Xpert.ivy Designer, it may be deployed to the Xpert.ivy Server. Installation Environment The following diagram shows the installation environment of an Xpert.ivy Server: Figure 2.1. Xpert.ivy Server Installation The Xpert.ivy Server needs a system database to store its configuration, users, roles and assigned permissions and the states, cases, tasks from the deployed applications. Next, it needs file directories where the deployed projects are stored. The Xpert.ivy Server integrates a Java Servlet Engine that is responsible to receive HTTP or HTTPS requests from client applications and to send back appropriate 2

12 Introduction responses (similar to a web server). The client applications itself are either Web Applications that run in a web browser or Rich Internet Applications that run in a Java Virtual Machine (JVM). Both kind of client applications communicate over HTTP or HTTPS directly with the Servlet Engine. Instead of this setup it is also possible to put standard web servers like Microsoft Internet Information Server (IIS) or the Apache Web Server in front of the Xpert.ivy Server. The web servers are then responsible to forward the requests to the Xpert.ivy Server Servlet Engine. Processes in client applications may access third party systems like databases, web services or application servers to read/write data or to make use of their functionality. Server Types There are two different Xpert.ivy server types: Xpert.ivy Standard Server (hereafter simply referred to as "Server") Xpert.ivy Cluster Server Xpert.ivy Standard Server The Xpert.ivy Standard Server is installed on a single server machine. A DBMS that can hold the Xpert.ivy system database is the only special infrastructure it needs. The deployed projects can be stored on a local harddisk on same machine that the Xpert.ivy Standard Server is running on. Figure 2.2. Xpert.ivy Standard Server Xpert.ivy Cluster Server The Xpert.ivy Cluster Server is built on a load balancer that receives requests from the clients and forwards them to multiple Xpert.ivy Cluster Nodes (i.e. server instances). The different nodes of an Xpert.ivy Cluster Server all share the same Xpert.ivy system database which is normally stored on a dedicated database server (however, this is not an absolute requirement). The deployed projects are stored on a file system that can be accessed by all cluster nodes. 3

13 Introduction Figure 2.3. Xpert.ivy Cluster Server Xpert.ivy Cluster Nodes are typically installed on multiple server machines, but it is also possible to install more than one Xpert.ivy Cluster Node on a single server machine. The load balancer can be realized either by a hardware load balancer or by an IIS or Apache web server that distributes the incoming requests to the installed Xpert.ivy Cluster Nodes. What server type do I need? The Xpert.ivy Cluster Server has two major advantages compared to the Standard Server: Performance and scalability:an Xpert.ivy Cluster Server can serve more clients than the Xpert.ivy Standard Server. If your number of clients increases, you can add another server node to your Xpert.ivy Server Cluster. If you have a lot of sessions it may even be better to have two Xpert.ivy Cluster Nodes on the same server machine instead of having a single Standard Server. Because each session needs memory on the server and Xpert.ivy can handle two processes with medium memory footprints (i.e. Cluster Nodes) faster than one process with a large memory footprint (i.e. Single Server). High availability: In an Xpert.ivy Server Cluster installation, a single node may crash without affecting the other nodes, which still serve clients. However, if you require high availability of your Xpert.ivy Server you also need to ensure that all other components the server is depending on (Load Balancer, Database Server, File Share) have a high availability. The disadvantages of the Xpert.ivy Cluster Server compared the Standard Server are: higher complexity of the system higher hardware costs higher licence fees Server Platforms The Xpert.ivy Server supports the following platforms: 4

14 Introduction Windows (Intel x86) Windows (Intel x64) Linux (Intel x86) Linux (Intel x64) Linux (Power PC 32 Bit) Linux (Power PC 64 Bit) AIX (IBM PSeries, Power PC 32 Bit) AIX (IBM PSeries, Power PC 64 Bit) System Administrator Tasks The following figure shows the main tasks for which an Xpert.ivy Server system administrator is responsible for: Figure 2.4. Xpert.ivy Server System Administrator Tasks System Administrator Skills and Responsibilities An Xpert.ivy Server administrator is responsible for installing, configuring, administrating, monitoring and backing up an Xpert.ivy Server. The following skill set is required: Knowledge of the platform(s) (Server Hardware and Operating System) where the Xpert.ivy Server is/are installed. Knowledge of the database systems that the Xpert.ivy Server uses as it's system database. Basic knowledge of the TCP/IP protocol. Knowledge of web servers such as IIS or Apache if the Xpert.ivy Server is to be integrated with them. 5

15 Introduction Knowledge of Active Directory Server if it is to be used for user management. An Xpert.ivy Server system administrator is in most cases a member of the IT / infrastructure department. Installation Installing an Xpert.ivy Server. For more information about how to install an Xpert.ivy Server see chapter Installation Migration Migration of an old Xpert.ivy Server installation to a newer version. For more information about how to migrate Xpert.ivy Server to a newer version see section Upgrading from an older version in chapter Installation. Patching Patching of an existing Xpert.ivy Server installation. For more information about how to patch an Xpert.ivy Server installation see section Install Patch and Install Hot Fix in chapter Installation. Configuration Configuration of an Xpert.ivy Server. There are different levels of configuration: Offline configuration: You can configure an Xpert.ivy Server with the Xpert.ivy Server Configuration application. The server must be restarted to make the configuration changes active. Online configuration: With the Server Administration application you can configure system properties without the need to restart the server in order for the changes to take effect. Tomcat configuration: You can configure the internal Tomcat application server (session timeout) in the Tomcat configuration files. For more information about offline configuration see chapter Configuration. For more information about online configuration see section System Properties in chapter Server Administration For more information about tomcat configuration see section Tomcat Configuration in chapter Configuration. Integration with IIS Integration of Xpert.ivy Server into Microsoft Internet Information server. For more information about how to integrate with the Microsoft Internet Information server see chapter Integration. Integration with Apache Integration of Xpert.ivy Server into the Apache web server. 6

16 Introduction For more information about how to integrate with the Apache web server see chapter Integration. Tomcat Configuration Configuration of the Tomcat application server which is embedded into the Xpert.ivy Server. For more information about the Tomcat configuration see section Tomcat Configuration in chapter Configuration. Administration Creation and maintenance of applications, process models, process model versions. Configuration of external databases, etc. For more information about Xpert.ivy Server administration see chapter Server Administration. Active Directory Integration Configuration of an application, so that the users of the application are imported from and synchronized with a Microsoft Active Directory server. For more information about integration with Microsoft's Active Directory see section Configuring external security system in chapter Server Administration. Monitoring Monitoring of a running Xpert.ivy Server installation to identify failures and or problems in the applications. For more information about monitoring an Xpert.ivy Server see chapter Monitoring. Setup of External Tools Installation and set up of external tools that help checking the health of a running Xpert.ivy Server installation. Server Backup Backup of all files and resources that contain runtime information of an Xpert.ivy Server. Backup of Databases Backup of the system database and all external databases which are accessed by Xpert.ivy Server. Uninstallation Uninstallation of an Xpert.ivy Server. Workflow Administrator Tasks The following picture shows the main tasks that an Xpert.ivy Server workflow administrator is responsible for: 7

17 Introduction Figure 2.5. Xpert.ivy Server Workflow Administrator Tasks Workflow Administrator Skills and Responsibilities An Xpert.ivy Server workflow administrator is responsible for the creation of users, assigning of roles and permissions, controlling the state of the running cases and tasks, cleaning up cases, checking the workflow history and inspection of the runtime logs for problems. An Xpert.ivy Server workflow administrator must have the following skills: Knowledge of the running business processes. Knowledge of the business process roles. Knowledge of the users and their roles and permissions within the running business processes An Xpert.ivy Server workflow administrator is in most cases a member of the organisation department. User Creation Creation of authorized users for a running application. Role Assignment Assignment of roles to users. Permission Assignment Assignment of permissions to users and roles. Controlling of Running Cases and Tasks Controlling of the running cases and tasks of a workflow process. Unassigned tasks (tasks with no role or no user who is responsible for them) must be assigned by the workflow administrator to a user or role. Furthermore, it is possible that system tasks fail. In this case the workflow administrator is responsible to solve such a problem. Cleanup of Cases Finished cases should be cleaned up periodically. This reduces the disk space occupied by the system database uses. 8

18 Introduction Checking of Workflow History The workflow system maintains a history with a log entry for every workflow step. This history should be periodically checked for errors or unexpected behaviour. Checking of Runtime Logs The process model prints out certain events (errors, warnings etc) to the runtime logs. Those logs should be checked periodically to identify problems. 9

19 Chapter 3. Installation Upgrading from an older version Warning At the moment it is not yet possible to upgrade an Xpert.ivy Server 3.x installation to a 4.x installation. Standard Server Installation Steps It is recommended to read the Introduction chapter before installing an Xpert.ivy Server. The following list shows the necessary steps that are required to install and run an Xpert.ivy Server: 1. Gather all the information you need: The server platform the server will be installed on. The database system used to host the system database. Order a licence file for your installation. You need to know the host name of the machine you want to install the Xpert.ivy Server on. More information about the licence can be found in the section Install a Licence of the Installation chapter. If an integration with a web server is planned, then get all the necessary configuration information of the web server. If an integration with an Active Directory server is planned, then get all the necessary configuration information of the Active Directory. 2. Install all required operating systems, web servers and database systems. 3. Install the Xpert.ivy Server 4. Install your personal licence file 5. Configure the Xpert.ivy Server 6. Start the Xpert.ivy Server and test if it is running. If everything is fine so far, you can perform the following optional configuration steps: 1. Install Xpert.ivy Server as Windows Service or Unix Run Level Daemon if desired. 2. Integrate Xpert.ivy Server into web servers if necessary. 3. Configure Xpert.ivy Server system properties and create and configure applications. 10

20 Installation Demo Mode Xpert.ivy Server offers a demo mode for demonstration purposes. The demo mode allows you to install and start the Xpert.ivy Server without configuration and without a productive licence. To install and start an Xpert.ivy Server in demo mode simply execute the steps 3 and 6 from the list above. Warning The Xpert.ivy Server uses a memory database as system database in demo mode. This means that everything you configure and all cases that are created by any sessions in demo mode are lost when you shut down the server. Tip In demo mode you can login to the Server Administration using with the predefined user XpertIvy and password XpertIvy. Cluster Installation Steps The installation process of a Xpert.ivy Cluster Server node is very similar to the standard installation process. To save time you can copy the configuration from the first node you have installed to other nodes. See the next chapters to learn how to install the first node, and how to proceed to install further nodes either on different machines or on the same machine. Once you've installed all Xpert.ivy Cluster Server nodes you may want to integrate them into a web server that will act as single frontend. The web server can be configured to work as a load balancer that distributes the incoming requests evenly to the Xpert.ivy Cluster Server nodes. Consult the chapter Web Server Integration for more information. Installation of the first Xpert.ivy Cluster Server node Follow the standard installation process to install the first Xpert.ivy Cluster Server node. At point 4 you must make sure that you install a Xpert.ivy Enterprise Server licence. At point 5 an additional Cluster configuration tab will be displayed in the Server Configuration. Inside this tab use the Add local node button to add the new node to the list of nodes of the Xpert.ivy Cluster Server. Installation of another Xpert.ivy Cluster Server node on a different machine To install further Xpert.ivy Cluster Server nodes on other machines proceed as follows: 1. Install the Xpert.ivy Server 2. Copy the configuration directory inside the installation directory of the first Xpert.ivy Cluster Server node to the installation directory of the currently installing node. Overwriting all existing files. 3. Replace the licence file from the first Xpert.ivy Cluster Server node with the Xpert.ivy Enterprise Server licence for this node in the configuration directory. 4. Start the Server Configuration program. The system database and administrators and web server tab should display the values you have configured on the first node. Change to the Cluster tab and 11

21 Installation use the Add local node button to add the node to the list of nodes of the Xpert.ivy Cluster Server. Save your changes. 5. Start the Xpert.ivy Cluster Server node and test if it is running. Installation of another Xpert.ivy Cluster Server Node on the same machine To install further Xpert.ivy Cluster Server nodes on the same machine where a node is already installed proceed as follows: 1. Install the Xpert.ivy Server 2. Copy the configuration directory inside the installation directory of the first Xpert.ivy Cluster Server node to the installation directory of the currently installing node. Overwrite all existing files. 3. Replace the licence file from the first Xpert.ivy Cluster Server node with the Xpert.ivy Enterprise Server licence for this node in the configuration directory. Note Every cluster node needs its own licence file even if nodes run on the same machine. 4. Start the Server Configuration program. The system database and administrators tab should display the values you have configured for the first node. Change to the WebServer tab and specify different port numbers than those you have specified for the other nodes on this machine. Change to the Cluster tab and use the Add local node button to add the node to the list of nodes of the Xpert.ivy Cluster Server. Save your changes. 5. Start the Xpert.ivy Cluster Server node and test if it is running. Install Xpert.ivy Server To install the Xpert.ivy Standard Server (Standalone Edition) extract the correct zip file for your platform to the directory where you want to install the Xpert.ivy Server. In case of an Application Server you deploy the Enterprise Archive (ear) version of Xpert.ivy, so that we handle this installation in chapter Xpert.ivy deployment. The following platforms are supported: Table 3.1. Supported Xpert.ivy Server Platforms CPU Architecture Operation System Application Server Installation File Intel x86 Windows - XpertIvyServer4.X.Y.Z_Windows_x8 Intel x86 Linux - XpertIvyServer4.X.Y.Z_Linux_x86.z Intel x64 Windows - XpertIvyServer4.X.Y.Z_Windows_x6 Intel x64 Linux - XpertIvyServer4.X.Y.Z_Linux_x64.z PPC 32 bit Linux - XpertIvyServer4.X.Y.Z_Linux_PPC3 PPC 32 bit AIX - XpertIvyServer4.X.Y.Z_Aix_PPC32. PPC 64 bit Linux - XpertIvyServer4.X.Y.Z_Linux_PPC6 PPC 64 bit AIX - XpertIvyServer4.X.Y.Z_Aix_PPC64. Multiple multiple Windows, Z/OS WebSphere AS XpertIvyServer4.X.Y.Z.ear 12 ZIP

22 Installation Note Note, that the installation procedure implies sufficient administration and access rights on the system. For example the access to drive C: on a Windows Server 2008 system is very restrictive that you might install the programs on drive D: instead. Installed Files and Directories After the installation the following files and folders are located in the Xpert.ivy Server installation folder: Table 3.2. Installed Files and Directories Folder or File Name Description application/ ServerConfiguration/ Contains the Xpert.ivy Server configuration application System/ Contains the Xpert.ivy Server administration application bin/ Contains programs to start and configure the Xpert.ivy Server clientlib/ Contains libraries that are deployed to the client machines signed/ linux/ Linux specific libraries linux_native/ Native Linux libraries windows/ Windows libraries windows_native/ Native libraries specific Windows Contains the Xpert.ivy Server configuration data configuration/ demo.lic Demo licence file keystore Keystore with the default signature of the Xpert.ivy Server (for https/ssl) log4jconfig.xml Logging configuration serverconfig.xml System database configuration servercontrolcenter.configuration Server Control Center configuration doc/ HTML documentation html/ pdf/ 13 server

23 Installation Folder or File Name Description PDF documentation server Java Runtime Environment for Xpert.ivy Server jre/ lib/ classes/ Used to install single Java classes patch/ Used to install patches ivy/ All Java libraries of Xpert.ivy Server shared/ All 3rd party Java libraries required by Xpert.ivy Server logs/ Contains the log files newandnoteworthy/ Contains new and noteworthy features of the latest Xpert.ivy Server and Designer releases migrationnotes/ Contains migration notes of the latest Xpert.ivy Server and Designer releases webapps/ Contains the Xpert.ivy Server web interface ivy/ info/ Contains the info web pages WEB-INF/ Contains the web.xml file wf/ Contains the workflow web interface work/ Contains temporary files that are created and used by the Xpert.ivy Server NewAndNoteworthy.html Overview / entry point for list of new and noteworthy features in this release MigrationNotes.html Overview / entry point for migration of last to current release Readme.html Important information about this server release ReleaseNotes.txt Release notes with bug fixes and new features 14

24 Installation Windows Programs The bin folder of a windows installation contains the following native dynamic link libraries and executable files: Table 3.3. Windows Programs File Description Example.ilc Example of an ivy launch control file. For more information see section Windows Program Launcher Configuration. JavaWindowsServiceHandler.dll Library that contains native methods to register, unregister, configure, start and stop windows services JVMLauncher.dll Library containing code to launch the Java virtual machine. NTEventLogAppender.dll Library that implements native methods to log into the windows event log. RichDialogApplicationLauncher.exe Launch Rich Dialogs like native client applications. For more information see section RichDialogApplicationLauncher. RichDialogApplicationLauncherC.exeSame as RichDialogApplicationLauncher.exe but additionally logs any output to a console window. ServerControlCenter.exe Program that allows to configure, start and stop the Xpert.ivy Server. It also permits to configure the Windows services. For more information see section ServerControlCenter. ServerControlCenterC.exe Same as ServerControlCenter.exe but additionally logs any output to a console window. XpertIvyServer.exe Starts the Xpert.ivy Server. For more information see section XpertIvyServer. XpertIvyServerC.exe Same as XpertIvyServer.exe but additionally logs any output to a console window. XpertIvyServerConfig.exe Program to configure the Xpert.ivy Server. For more information see section XpertIvyServerConfig. XpertIvyServerConfigC.exe Same as XpertIvyServerConfig.exe but additionally logs any output to a console window. XpertIvyServerService.exe Executable of the Window service. For more information see section XpertIvyServerService. Unix Programs The bin folder of a unix installation contains the following script files: Table 3.4. Unix Programs File Description InstallService.sh Script to install the Xpert.ivy Server as a daemon. For more information see section InstallService. 15

25 Installation File Description RichDialogApplicationLauncher.sh Script to launch Rich Dialogs like native client applications. For more information see section RichDialogApplicationLauncher. ServerControlCenter.sh Script to launch the server control center that allows to configure, start and stop the Xpert.ivy Server. For more information see section ServerControlCenter. XpertIvyServer.sh Script that starts the Xpert.ivy Server. For more information see section XpertIvyServer. XpertIvyServerConfig.sh Launches the Xpert.ivy Server Configuration program that allows to configure the Xpert.ivy Server. For more information see section XpertIvyServerConfig. XpertIvyServerService Template script that is used by InstallService.sh to copy to /etc/init.d. launcherserver.sh Script to launch a Java program. Installing a Licence By default a demo licence is installed that allows you to run the Xpert.ivy Server in demo mode. You have to install a personal or corporate licence in order to run Xpert.ivy Server in a production environment. Note The licence file contains the name of the host where the server is installed on. The licence will only work if the name of the machine exactly matches the name stored in the licence file. To install a licence file follow the steps below: 1. Copy the licence file *.lic to the directory configuration/. 2. Change the extension of your old licence files to anything, but *.lic (e.g. from foo_bar_another_license.lic to foo_bar_another_license.lic.old ). Tip You may leave demo.lic in the configuration folder, because this license is taken only if no other license files are found. Installation of Patches There may be patches for an Xpert.ivy Server installation that are delivered as *.jar files. To install such a patch simply copy the *.jar file to the lib/patch directory. Installation of Hot Fixes Hotfixes are necessary, whenever you deal with a problem that is very urgent for you to be fixed or you urgently need a new functionality and do not want to wait until the next official version is released. The hotfix is delivered as a single file or as a *.zip file. To install the hotfix, you usually just have to copy the single file into a folder in the lib/classes directory. Hotfix releases will always come with exact instructions for installation. 16

26 Chapter 4. Configuration How to start the Server Configuration application There are several possibilities to launch the Xpert.ivy Server Configuration application: Note Note, that the configuration procedure implies sufficient administration and access rights. For example on a Windows Server 2008, you have to run the Server Configuration tool with the "Run as Administrator" option. Launch from Server Control Center After starting the ServerControlCenter, select a server entry from the server list on the left side and press the Server button in the configuration area to start the configuration program. Windows: Start the ServerControlCenter.exe in the bin directory of the Xpert.ivy Server installation directory. Linux/AIX: Start the ServerControlCenter.sh shell script in the bin directory of the Xpert.ivy Server installation directory to start the ServerControlCenter program. Direct Launch You can start the Xpert.ivy Server Configuration program directly. Windows: Start the XpertivyServerConfig.exe in the bin directory of the Xpert.ivy Server installation directory. Linux/AIX: Start the XpertivyServerConfig.sh shell script in the bin directory of the Xpert.ivy Server installation directory. Launch in Headless Mode You can start the Xpert.ivy Server Configuration with the option -headless to start the program in the headless mode. Headless mode is useful if you operate in a non graphical user interface environment. If you start the program with the -headless option, a rich dialog application server is started. Once the server is up and running, it prints out a URL to the console. You can now use another computer, to start a web browser and type in the provided URL. The web browser will start the Xpert.ivy Server Configuration user interface using Java Webstart. You can use it to configure the Xpert.ivy Server as explained in the this chapter. When you are finished with the configuration, switch back to your server and press a key in your console to stop the rich dialog application server. Windows: Use the XpertivyServerConfigC.exe in the bin directory of the Xpert.ivy Server installation directory with the option -headless to start the Xpert.ivy Server Configuration in headless mode. Linux/AIX: Use the XpertivyServerConfig.sh shell script in the bin directory of the Xpert.ivy Server installation directory with the option -headless to start the Xpert.ivy Server Configuration in headless mode. 17

27 Configuration Server Configuration The Xpert.ivy Server Configuration application's user interface is divided into three tabs. On the first tab the system database can be configured and created. On second tab system administrators can be registered. This tab is only enabled if a valid system database is configured on the first tab. On the third tab the web server protocols and ports can be configure. This tab is also only enabled if a valid system database is configured. Click Save to store the modified data on all tabs and to close the window. Hit Cancel to exit the application without saving any changes. The configuration on the System Database tab is stored in the configuration file configuration/serverconfig.xml. The configurations on the other tabs are stored in the system database that is configured on the first tab. Note The changes that you make with the Server Configuration do not become active unless you restart the server. System Database On the System Database tab the Xpert.ivy Server system database can be configured, created or dropped: 18

28 Configuration Figure 4.1. Xpert.ivy Server Configuration System Database Tab First choose the database system and the JDBC driver you want to use. At the moment the Xpert.ivy Server supports the following database systems: MySQL Oracle Microsoft SQL Server DB2 for z/os DB2 for Linux/Unix/Windows (LUW) 19

29 Configuration DB2 for iseries (AS400) Sybase SQL Anywhere Postgre SQL The choice of the second step depends on the database system and JDBC driver you have chosen in the first section. Click on the database system links above to find information about how to configure the connection settings. In a third step you can configure additional connection properties. Use the buttons on the right to add, edit or delete the properties. Click on the database system links above to find information which additional connection properties are available for the database system that you have chosen. At the bottom of the page the state of the connection is visible. Use the buttons on the right to create a new system database according to the configuration you entered or to drop the currently active system database. System Administrators On the Administrators tab you can configure users that have the right to administrate the Xpert.ivy Server: Figure 4.2. Xpert.ivy Server Configuration Administrator Tab Use the buttons on the right to create new administrators, delete administrators of to change the password of an administrator. 20

30 Configuration Defining an address for the administrators is recommended. Notifications of critical events like license limits reached are sent to these addresses. Warning This tab is only enabled if you have configured a connection to a valid system database. Web Server Ports On the Web Server tab you can configure which protocols the internal web server of Xpert.ivy Server should support and on which IP ports the web server is listening: Figure 4.3. Xpert.ivy Server Configuration WebServer Tab The following protocols are supported: Table 4.1. Web Server Protocols Protocol Description HTTP HTTP protocol. HTTPS HTTP protocol over secure socket layer (SSL). AJP Apache Jakarta Protocol. This protocol is used for the communication of the embedded Servlet Engine with external WebServers like IIS or Apache. 21

31 Configuration Warning This tab is only enabled if you have configured a connection to a valid system database. Note In case you disable HTTP port, then the specified port will still opened by the server for internal purposes. Even though the server will refuse connections from remote hosts. Cluster Note This tab is only visible if you have installed a Xpert.ivy Enterprise Server licence. On the Cluster tab you have to configure some information according the local cluster node: Figure 4.4. Xpert.ivy Server Configuration Cluster Tab Use the Add local node button to add this server installation as a new cluster node to the list of cluster nodes in your Xpert.ivy Cluster Server. You have to configure an IP Address and an IP Port that will be used by the cluster to communicate with this node. Note A Cluster node is uniquely identify by the host it is running on and a local identifier. The local identifier is a unique number that identifies nodes running on the same host 22

32 Configuration (machine). Both values are provided by the installed licence. Therefore, every cluster node needs its own license file. The button Remove node can be used to remove any cluster node from the list of cluster nodes. Server Control Center The Server Control Center integrates all tools to configure the server, the (Windows) service and to start/stop the installed Xpert.ivy Server. To open the Server Control Center application, go to your Xpert.ivy Server installation directory and launch the ServerControlCenter.exe or ServerControlCenter.sh program located in the bin folder. Start / Stop server To start the Xpert.ivy Server, simply choose the Xpert.ivy Server in the list on the left side and then press the green start button. Alternatively you can choose the Xpert.ivy Server [Console] from the list to start the server within a console to which some information about the server is logged. Please note that closing this console window will terminate the Xpert.ivy Server without shutting it down properly. To stop the server, click the red stop button. Figure 4.5. The Server Control Center Configuring Windows Service (Windows only) If you've installed the Xpert.ivy Server under a Windows operating system, you can register it as a Windows service. To do so, select the entry Xpert.ivy Server [Windows Service] from the list on the left and press the button Windows Service on the right. A dialog will open, prompting you for additional configuration data: 23

33 Configuration Figure 4.6. Configuring Xpert.ivy Server as Windows service First of all press Register Service to register the service and to enable the rest of the configuration sections. Now you may configure the user under which the service (and therefore the Xpert.ivy Server) will be executed. This can be either the system user or any other user with sufficient rights to start services and access the Xpert.ivy Server installation directory (read and write). By default, the service start kind is Manually. To start the server each time Windows is booted, choose the setting Automatically The last thing that can be configured are the services that the Xpert.ivy server depends on. This might be the database management system on which the system database is located or the web server in which Xpert.ivy is integrated (IIS or Apache). All the services that you add in this list will be started before Xpert.ivy and if any of these services fail to start, Xpert.ivy won't start too. After you have finished the configuration, click Ok. Now you will be able to start the server from the control center or you may also use the Windows Service Management Console. Testing the Server Once you've started the Xpert.ivy Server, try to open the following address in your preferred web browser: If a web page with the Xpert.ivy logo appears, the installation and configuration of the Xpert.ivy Server was successful and you may continue with the next chapter. Server List Configuration The list with the server types on the right may be extended by users. You may add other Xpert.ivy server installations and you even can integrate other third party tools to start them from the Server Control Center. Note The indication whether the program behind an entry in the server list is running or not is only shown for the Xpert.ivy server binaries of the installation the Server Control Center belongs to and for any Windows services (including the Xpert.ivy server services). This applies too for the show console setting because only Xpert.ivy server binaries can be started in a console (third party applications cannot). 24

34 Configuration Add opens a dialog to choose the type for the new entry. For integration of another Xpert.ivy server binary or a third party tool, choose the first option (ivyteam based Server), if you intend to integrate a Xpert.ivy server as a Windows service or any other Windows service, then choose the second option (Windows Service based server. Figure 4.7. Create a new server in the server list In the configuration dialog for a normal application you can set the base name and/or refine with the instance name (in the server list the instance name is printed in brackets after the name). Add the server binary (or your third party tool) in the server start executable and the configuration utility in the field configuration program (or the configuration program of your third party application). If and only if you choose the console based binaries (the ones with "C" at the end of the file name, e.g. XpertIvyServerC.exe) then tick the check box Show console. It has no effect on all other binaries. Figure 4.8. Create a new service in the server list In the configuration dialog for adding/editing a service entry, you can choose an already existing service from the combo box or set the service name when you did not already register the service. Set the configuration program and the service binary similarly to the description above. For simply starting/stopping existing services from the Server Control Center, it is not necessary to define the service binary Note The name in this dialog must be exactly the same name that is used to register the service. Otherwise the lookup will not work. Remove removes the selected entry from the list and Edit allows to edit the configuration for the selected entry in the server list. Configure Tomcat In case you deploy Xpert.ivy as module on an Application server there will be no tomcat started (skip this chapter) 25

35 Configuration The directory webapps/ivy/web-inf/ contains a file web.xml which is the configuration file of the embedded Tomcat application server. In there you can set the timeout for the session. If a session (i.e. a user interaction with an application) is inactive for this amount of time, then the session will be closed. To adapt the default value look for the section below in the file and change the value accordingly: <session-config> <session-timeout>30</session-timeout> </session-config> Warning Be very careful when changing the contents of this file. A wrong configuration or an invalid syntax in the file may harm the stability and correctness of your Xpert.ivy Server installation. 26

36 Chapter 5. Web Server Integration It is possible to integrate the Xpert.ivy Server into a Apache HTTP or Microsoft IIS web server installation. In those cases the Apache HTTP or Microsoft IIS web server receives all requests from the clients and forwards them to the Xpert.ivy Server which handles them. This allows to integrate the processes and applications that you are running on a Xpert.ivy Server into a company or web portal. The integration is technically solved by using Tomcat Connectors. More technical details about those connectors can be found on the Apache Tomcat web site. Integration Directory All necessary files that you need to integrate a Xpert.ivy Server into a Web Server can be found in the following directories inside the Xpert.ivy Server installation directory: Apache HTTP Server for Windows: webserver/apache/win/x86 Apache HTTP Server for Linux (x86): webserver/apache/linux/x86 Apache HTTP Server for Linux (x64): webserver/apache/linux/x64 IIS for Windows (x86): webserver/iis/x86/ IIS for Windows (x64): webserver/iis/x64/ The directory that matches the platform and webserver where you plan to integrate the Xpert.ivy Server will be called integration directory in this chapter. Apache HTTP Server 2.2 Integration 1. If your Apache HTTP Server is not running on the same host as the Xpert.ivy Server then copy the integration directory to the host where your Apache HTTP Server is running. All next steps have to be done on the host the Apache HTTP Server is running on. 2. Open the file mod_jk.conf inside the integration directory in a text editor and replace all occurrences of <path> with the path of the integration directory. Warning Note that you have to specify paths using / (slash) as directory delimiter in Apache HTTP Server configuration files even on Windows machines. On Windows machines replace the normal \ (backslashes) directory delimiters with / (slash) to ensure the configuration can be correctly read by Apache HTTP Server. Ensure that the path parameters in the Apache configuration files are surrounded by double quotes character ("), otherwise you will have problems if your paths contains spaces or other special characters. 3. Open the configuration file inside the Apache HTTP Server installation directory (mostly httpd.conf) in a text editor. At the end of the file enter the following lines: # # Xpert.ivy Server Integration # Include "<path>/mod_jk.conf" 27

37 Web Server Integration Once again replace <path> with the path of the integration directory. 4. If you have configured virtual hosts in your apache configuration you have to map the URI /ivy/ * in all virtual host you want to integrate Xpert.ivy Server into. This can be done by copying the following line from the mod_jk.conf file to the appropriate virtual host definitions: JkMount /ivy/* XpertIvyServer Copy this to the appropriate virtual host definitions, e.g.: <VirtualHost *:80> ServerAdmin webmaster@ivy.soreco.wan DocumentRoot "C:/Program Files (x86)/apache Software Foundation/Apache2.2/ ServerName ivy.soreco.wan ServerAlias ErrorLog "logs/ivy.soreco.wan-error.log" CustomLog "logs/ivy.soreco.wan-access.log" common JkMount /ivy/* XpertIvyServer </VirtualHost> 5. If your Apache HTTP Server is not running on the same host as the Xpert.ivy Server or if you have changed the AJP port of the Xpert.ivy Server then open the file worker.properties inside the integration directory in a text editor. Change the following line if you have changed the AJP port to another value than 8009: worker.xpertivyserver.port=8009 Change the value localhost in the following line to the host where your Xpert.ivy Server is running if your Apache HTTP Server is not running on the same host as the Xpert.ivy Server: worker.xpertivyserver.host=localhost 6. Restart your Apache HTTP Server. 7. Check if the integration is working by opening a web browser on the address host>/ivy/ Example Let's assume that your Apache HTTP Server is running on a Windows machine with the host name apache and the installation directory is c:\programme\apache\. Your Xpert.ivy Server is running on the host ivyserver and the installation directory is c:\programme\ivy and you have changed the AJP port to You have copied all files from the integration directory c: \programme\ivy\webserver\apache\win\x86 on the ivyserver host to c:\programme \apache\ivy on the apache host. Your configuration files must now look like the following ones: c:\programme\apache\conf\httpd.conf : The following lines have been added at the end: # # Xpert.ivy Server Integration # Include c:/programme/apache/ivy/mod_jk.conf c:\programme\apache\ivy\mod_jk.conf : # Load mod_jk module 28