Help Index

Help Contents

GEBS Reporting » Private: GEBS Reporting Web Publisher » Learn More » Installing and Upgrading » Apache Tomcat 6.0 or later

Apache Tomcat 6.0 or later

Pre – installation tasks

IBM Rational Publishing Engine must be installed on the server machine before deploying the ReportingArena Web Publisher. Make sure that a supported server container such as Apache Tomcat V6.0 or later is configured to run with a supported IBM Java Runtime Environment V6.0 or later on 32 bit.

Procedure

Open a web browser and enter the URL to view the list of the web applications hosted on the server. This URL is typically http://servername:port/manager/html/list. The server and port might vary, depending on the server configuration.

Install the RA Web Publisher REST Service component.

In the Deploy section, go to WAR file to deploy subsection, click Browse button to browse for a WAR file. Select the webpublisher-rest-services.war file and click Deploy.

The webpublisher-rest-services will be deployed but it will not start because the Rational Publishing Engine API’s libraries are missing. Locate the webapps directory of the Apache Tomcat where the webpublisher-rest-services application was deployed. Locate the installation directory of the IBM Rational Publishing Engine. Copy all the files from the lib directory of the IBM Rational Publishing Engine installation directory in the webapps\webpublisher-rest-services\WEB-INF\lib\.

Now start the /webpublisher-rest-services application and it will work.

Install the RA Web Publisher UI component.

In the Deploy section, go to WAR file to deploy subsection, click Browse button to browse for a WAR file. Select the webpublisher-webui.war file and click Deploy.

The webpublisher-webui.war will be deployed and it will start.

Configuring the Web UI Component

Locate the webapps\webpublisher-webui\WEB-INF\classes\ directory. The entries in the file application.properties must be edited to have proper values:

### file system resource manager properties

rest.services_host – the name of the machine running the server where the webpublisher-rest-services application was deployed (default localhost)

rest.services_port_number – the name of the machine running the server where the webpublisher-rest-services application was deployed (default 8080)

rest.services_context – the context path of the Web Publisher REST Service (default /webpublisher-rest-services)

admin_role – the name of the administrator role of Web Publisher application (default webpublisher_admin)

specdesigner_role – the name of the specification role of Web Publisher application (default webpublisher_specdesigner)

template_designer_role – the name of the template designer role of Web Publisher application (default webpublisher_templatedesigner)

master_role – the name of the master role of Web Publisher application (default webpublisher_master)

authentication_type – can be BASIC or FORM-BASED (default FORM-BASED)

protocol – the protocol (default http)

master_user_name – default rawp_master

master_user_password – default rawp_master

Configuring the REST Service Component

Locate the file system directory of the Web Publisher REST Service component at:  <CATALINA_HOME>\webapps\webpublisher-rest-services.

In the Web Publisher REST Service directory go to \WEB-INF\classes\execution.properties  file. The entries in this file must be edited to have proper values:

<div >

maxConcurrentExecutions – the number of executions that can run concurrently; this number must be smaller or equal to the number of RPE licensesautomaticUserActivityIntervalCheck – the time interval at which the system checks user activity and decides whether to release the Web Publisher license for a user or not (expressed in milliseconds)

licenseTimeOut – specifies the time-out period for each Web Publisher floating license assigned to a Web Publisher user;  if the user does not perform any action for a period equal to licenseTimeOut, the license assigned to this user will be released (expressed in milliseconds)

defPath – specifies the address of the license server or the location of the license file on the local machine (for trial version)

defVersion – Web Publisher license version

defProdName – Web Publisher license product name

RAECdefVersion – RAEC license version

RAECdefProdName – RAEC license product name

RAPCdefVersion – RAPC license version

RAPCdefProdName – RAPC license product name

REALM Configuration

A Realm is a “database” of usernames and passwords that identify valid users of a web application (or set of web applications), plus an enumeration of the list of roles associated with each valid user. You can think of roles as similar to groups in Unix-like operating systems, because access to specific web application resources is granted to all users possessing a particular role (rather than enumerating the list of associated usernames). A particular user can have any number of roles associated with their username.

UserDatabaseRealm is an implementation of the Tomcat 6 Realm interface that uses a JNDI resource to store user information. By default, the JNDI resource is backed by an XML file. It is not designed for large-scale production use. At startup time, the UserDatabaseRealm loads information about all users, and their corresponding roles, from an XML document (by default, this document is loaded from $CATALINA_BASE/conf/tomcat-users.xml)

Adding/Setting users.

To add or edit users, the file $CATALINA_BASE/conf/tomcat-users.xml must to be edited.

Before adding a user, we have to define the roles associated with Web Publisher.

Roles:

Insert the following roles in the <tomcat-users> section:

  • for publisher rights
    • <role rolename=”webpublisher_client” />
  • for template designer rights
    • <role rolename=”webpublisher_templatedesigner” />
  • for specification designer rights
    • <role rolename=”webpublisher_specdesigner” />
  • for administrator rights
    • <role rolename=”webpublisher_admin” />
  • for running the application using the FORM-BASED authentication, the rawp master role is required
    • <role rolename=”webpublisher_master” />

 

In order to run the application using FORM-BASED authentication, the following user must be defined in the <tomcat-users> file:

<user username=”rawp_master” password=”rawp_master” roles=”webpublisher_client,webpublisher_master” />

To create a user with default rights (a user that can publish documents or schedule document executions, see executions history but have no administrative rights), you need to add an entry like this in your <tomcat-users> file:

<user username=”demo” password=”demo” roles=”webpublisher_client” />

To create a user with template designer rights (a user that can add/share templates or stylesheets), you need to add an entry like this in your <tomcat-users> file:

<user username=”template” password=”template” roles=”webpublisher_templatedesigner” />

To create a user with specification designer rights (a user that can create/import/share/configure document specifications, publish documents, schedule executions or view executions history), you need to add an entry like this in your <tomcat-users> file:

<user username=”designer” password=”designer” roles=”webpublisher_specdesigner” />

To create a user with administrative rights(a user that can publish documents, administrate current executions, create categories for organizing document specifications), you need to add an entry like this in your <tomcat-users> file:

<user username=”admin_client” password=”XXX” roles=”webpublisher_client,webpublisher_admin” />

As you can see, the ADMINISTRATOR is the only one that can and should have both roles: webpublisher_client and webpublisher_admin.

Note: The server must be restarted in order that the user settings have effect.

Note: Once a user has been authenticated, the user (and his or her associated roles) is cached within Tomcat for the duration of the user’s login. For BASIC authentication, that means until the user closes their browser. The cached user is not saved and restored across session’s serializations.

On Linux, the following environment variables must be set before starting the server:

RPE_HOME – The path to the root folder of the Rational Publishing Engine installation

LD_LIBRARY_PATH – The path to the lib folder in the Rational Publishing Engine installation