Deployment of the xProcess Web Server

This page contains instructions for installing the xProcess web server, which is distributed as a java web application. For your convenience, we supply the server configured in its own instance of Apache Tomcat and a java runtime environment. All you have to do is unzip, enter configuration details in a properties file, then start the server.

The default port for the Web Server is 8081.


Prerequisites

1. Network access to the SVN repository containing xProcess data source.

2. SVN account created for the xProcess Web Server. This must be a different account from the one used by the xProces workflow server (if installed).

3. Java servlet container. Each server has been tested with Apache Tomcat v5.5.20. For your convenience the server is distributed with Tomcat and a java runtime environment. All you have to do is unzip, enter configuration details in a properties file, then start the server.

Order of deployment

See Getting Started for a complete overview of how to set up xProcess for a team. This is a summary of the work that should be done before configuring the Web Server:

1. Configure SVN repository in a place with network access from web server, workflow server, and all users who will use the rich-client.

2. Create SVN accounts as follows:

3. Before you start the xProcess Web Server there must be a datasource in the Repository. Use the xProcess Rich Client to create a datasource and:

4. Configure the web server and make sure that users can successfully log in. (detailed on the rest of this page)

Example

In our example we have a shared data source in an SVN repository with this url: http://myserver/svn/projects/jupiter/ds1

We will be installing the servers on a linux box, in a directory /servers/ On a windows machine this might be C:/servers.

We have created SVN login accounts for our servers: web-server/web-server.

Java environment

The web server requires a Java 6 runtime, and is usually distributed with one. No further downloads are necessary. By default when Tomcat launches it starts to look for a JDK within the Tomcat directory itself.
For further information about the Java runtime, see http://java.sun.com/javase/

xProcess Web Server

The web server provides the participant web client and the scheduler server (a controller for preserving unconfirmed effort).

  1. Unzip xprocess-web-X.X.X.zip into a suitable directory, e.g. /servers/xprocess-web
    You should have two subdirectories:
     /servers/xprocess-web/conf
     /servers/xprocess-web/tomcat
  2. Configure the xProcess properties of your server.
    Open the configuration file web.properties which can be found in /conf. Set propetries as required and save the file. When using relative paths, . is /tomcat/bin.

    property description
    repository.url the url of your xProcess Data Source in SVN repository. In our example this is http://myserver/svn/projects/jupiter/ds1
    repository.user account for the web server to access the SVN repository. In our example this is web-server
    repository.password password for access to SVN repository. In our example this is web-server
    local.dir path to the local root directory where the server will create a local working copy of Data Source, and log files. The default is ../../, the install directory
    license.path path to xProcess license. The default is ../../conf/license.lic
    logging.file.level logging level for log files. Default is FINEST.
    logging.console.level logging level for the server console. Default is FINEST.
    scheduler.server whether the web server is to be used as the Scheduler Server. The default is true.
    If set to false another machine in the network should be configured to take this role.
    scheduler.server.cron a cron expression indicating a time when all projects will be rescheduled as part of the scheduler server routine. A time just after midnight is recommended. Default is 0 0 1 * * ?
    See http://quartz.sourceforge.net/ for documentation.
    license.manager.users.path path to the file that defines the users who can access the web client. The default is ../../conf/users.xml See section 3 for details of the format of this file.
    update.trigger.start time in milliseconds between server statup and the first SVN update. Recommend is: 60000
    update.trigger.repeat time in milliseconds between SVN updates. Recommend is: 60000
  3. Configure the users who are going to use the web client. This is done in a file whose path was specified by the license.manager.users.path property in web.properties.
    1. The datasource url must match the repository.url property in web.properties. In our example this is http://myserver/svn/projects/jupiter/ds1
    2. For each participant, add a line like this:
        <role accountname="user1" perspective="participant" />
    3. Here is an example of users.xml:
      <?xml version="1.0" encoding="UTF-8"?>
      <xprocess>
        <datasource url="http://location/of/repository ">
        
          <!-- admin -->
          <role accountname="user1" perspective="admin" />
      	
          <!-- participant -->
          <role accountname="user1" perspective="participant" />
      	
          <!-- executive -->
          <role accountname="user1" perspective="executive" />
      	
        </datasource>
      </xprocess>
    4. The admin perspective has access to trigger a reschedule and a VCS update.
  4. Copy your license file to conf/license.lic.
  5. Start your server - run the startup script.
    1. On linux this is: /servers/xprocess-web/tomcat/bin/startup.sh
    2. On windows this is: C:/servers/xprocess-web/tomcat/bin/startup.bat
  6. Browse to http://localhost:8081/ You should see the default Tomcat server home page, with links to documentation and server configuration information.
  7. Browse to the web client url. Lets say the web client is deployed on a server with the url http://plans.mycompany.com. The base url for the web client would be : http://plans.mycompany.com:8081/xprocess
  8. Confirm that a user who has already been configured in the data source can log on successfully (the data source is the one found at repository.url, and was configured using the xProcess Rich Client, as per the prequisites.)
  9. The server can be shutdown by running the shutdown script.

Troubleshooting

If you launch the xProcess Web Server and find you made a mistake in a configuration file, after you correct the mistake:

This will check-out a fresh version of your Datasource.