Deploying only the dgaas.war on a WebSphere Application Server

If you want to improve performance and scalability of Document Builder, you can deploy the dgaas.war on a separate server from the rpeng.war creating a distributed environment. Or if you want to assign different heap sizes in a stand-alone environment, you can deploy the dgaas.war on a separate profile from the rpeng.war.

Before you begin

You must install WebSphere® Application Server V9.x and IBM® Engineering Lifecycle Optimization - Publishing (PUB) with the Document Builder feature before deploying Document Builder.
You must choose one of the following database vendors that you want to configure the connection with Document Builder on WebSphere Application Server:
  • IBM Db2®
  • Oracle
  • Microsoft SQL Server
For more information about the version-level supported for these database vendors, see the hardware and software requirements for Engineering Publishing, you can generate the system requirements for PUB from this page: http://www.ibm.com/software/reports/compatibility/clarity/softwareReqsForProduct.html.

You must have access to dgaas.war file in the Document_Builder_installdir directory.

About this task

The com.ibm.rpe.web.app.ear enterprise application is a bundle of the two web applications: rpeng.war and dgaas.war. For details, on all the deployment options for Document Builder on WebSphere Application Server, see Deploying Document Builder on WebSphere Application Server.

The deployment scenario and examples explain how to deploy only the dgaas.war web application on WebSphere Application Server.

Procedure

  1. Set global security.
  2. Set JVM.
  3. Set session management.
  4. Set the environment variable.
  5. Restart the server.
  6. For Db2: Configuring WebSphere Application Server with Db2 as a data source.
  7. For Oracle: Configuring WebSphere Application Server with Oracle as a data source.
  8. For SQL Server: Configuring WebSphere Application Server with SQL Server as a data source.
  9. Deploy only the dgaas.war on the server.
  10. Create a shared library for the dgaas application.
  11. For WebSphere Application Server V9.x: Associating shared libraries with server class loader.
  12. Configure the licensing variable.

Setting global security on WebSphere Application Server

Procedure

  1. Start the WebSphere Application Server.
  2. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  3. Expand Security and click Global security.
  4. In the Application security section, verify that the Enable application security check box is selected.
  5. In the Java™ 2 security section, clear all of the options. If the Warn if applications are granted custom permissions option is selected and cannot be edited:
    1. Select the Use Java 2 security to restrict application access to local resources option. The Warn if applications are granted custom permissions becomes enabled.
    2. Clear the Warn if applications are granted custom permissions option.
    3. Clear the Use Java 2 security to restrict application access to local resources option.
  6. Click Apply.
  7. Click Save to save changes directly to the master configuration.

Results

This is a screen capture of the global security page in the WebSphere Application Server

Setting JVM

About this task

Set the heap size and define the following Java virtual machine (JVM) settings in the custom properties for your application server:
  • DGAAS_CONCURRENT_LIMIT=20
  • com.ibm.websphere.jaxrs.server.DisableIBMJAXRSEngine=true
  • org.eclipse.emf.common.util.URI.archiveSchemes=wsjar wszip jar zip

Procedure

  1. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  2. Expand Servers > Server Types and click WebSphere application servers.
  3. In the Application servers section, click your server link, for example server1.
  4. In the Configuration tab, under the Server Infrastructure section, expand Java and Process Management and click Process definition link.
  5. To adjust the heap size, on the Configuration tab, enter the desired heap size in the Maximum heap size field. The maximum heap size should be incremented to not exceed 50 % of the overall physical memory. For example. for demonstration purposes you can set the heap size to 512 MB, but for production, set a minimum of 2 GB. If concurrent document generation is set to a larger number, or if you are running large document generation jobs, set a larger heap size.
    Setting the maximum heap size for WAS full profile
  6. Under the Additional Properties section, click Java Virtual Machine link.
  7. Under the Additional Properties section, click Custom properties link.
  8. In the Custom properties table, click New.
  9. Under the General Properties section, for each entry specify the following values and click OK:
    Table 1. Custom JVM properties for WebSphere Application Server
    Name Value Description
    DGAAS_CONCURRENT_LIMIT 20
    Note: If the DGAAS_CONCURRENT_LIMIT is not set, the value defaults to 10 as the concurrent limit.
    (Optional) If you want to perform concurrent document generation using the Document Builder, specify a number that is the maximum limit of users.

    If you are deploying the rpeng.war and dgaas.war files on different application servers or machines, then you must set the DGAAS_CONCURRENT_LIMIT on the same server where you want to deploy the dgaas.war application.

    com.ibm.websphere.jaxrs.server.DisableIBMJAXRSEngine true Disable IBM JAXRS
    org.eclipse.emf.common.util.URI.archiveSchemes wsjar wszip jar zip  
  10. Click Save to save changes directly to the master configuration.

Results

This is a screen capture of the Comstom properties page from the administrative console of WebSphere Application Server

Setting session management

About this task

Define the following Session Management settings in the custom properties for your application server:
  • InvalidateOnUnauthorizedSessionRequestException=true

Procedure

  1. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  2. Expand Servers > Server Types and click WebSphere application servers.
  3. In the Application servers section, click your server link, for example server1.
  4. In the Configuration tab, under the Container Settings section, click Session management link.
  5. Under the Additional Properties section, click Custom properties link.
  6. In the Custom properties table, click New.
  7. Under the General Properties section, specify the following value and click OK:
    Table 2. Custom Session Management property for WebSphere Application Server
    Name Value Description
    InvalidateOnUnauthorizedSessionRequestException true In response to an unauthorized request, the session manager invalidates a session instead of issuing an UnauthorizedSessionRequestException error message.
  8. Click Save to save changes directly to the master configuration.

Results

This is a screen capture of the Session management properties page from the administrative console of WebSphere Application Server

Setting the environment variable

Procedure

  1. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  2. Expand Servers > Server Types and click WebSphere application servers.
  3. In the Application servers section, click your server link, for example server1.
  4. In the Configuration tab, under the Server Infrastructure section, expand Java and Process Management and click Process definition link.
  5. On the Configuration tab, under the Additional Properties section, click Environment Entries link.
  6. In the Environment Entries table, click New.
  7. Under the General Properties section, for each entry specify the following values, and click OK:
    Table 3. Environment variable properties for WebSphere Application Server
    Name Value Description
    TELELOGIC_LICENSE_FILE 27000@<License_Server> The license server value listed in the TELELOGIC_LICENSE_FILE system variable in the form of port@license_server_hostname_or_IP_address.
    VCAP_SERVICES {"sqldb":[{}]} When you use Db2, Oracle, or SQL Server as your database, you must set this environment variable.
    This is a screen captures of the Environment Entries page in the administrative console for WebSphere Application Server.
  8. Click Save to save changes directly to the master configuration.

Restart the WebSphere Application Server

About this task

Restart the WebSphere Application Server profile that you want to deploy Document Builder:

Procedure

  1. Stop the WebSphere Application Server.
  2. Start the WebSphere Application Server.

Configuring WebSphere Application Server with Db2 as a data source

You must set up aIBM Db2 database and configure the connection with Document Builder on WebSphere Application Server

Before you begin

You must create an Db2 database for the Document Builder. The database must have 16K pages and the UTF-8 code set. For example, to create a database called ELMDB with 16K pages and the UTF-8 code set, use the following command:
db2 CREATE DATABASE ELMDB AUTOMATIC STORAGE Yes USING CODESET UTF-8
    TERRITORY US COLLATE USING SYSTEM PAGESIZE 16384;
In this example, the database is named ELMDB. See the Db2 product documentation for information about creating a database.

Creating a JDBC provider

Procedure

  1. Start WebSphere Application Server.
  2. Open the administrative console in a browser: https://server:port/ibm/console and log in.

    For example: https://localhost:9043/ibm/console

  3. Select Resources > JDBC > JDBC Providers.
  4. Set the scope to be the cell.
    Cell
  5. Click New.
  6. In the Create new JDBC provider wizard, select:
    1. Database type: Db2
    2. Provider type: Db2 Universal JDBC Driver Provider
    3. Implementation type: XA data source
    4. Implementation name: Enter a name.
    Create new JDBC provider wizard
  7. Click Next.
  8. In the Enter database class path information section, enter the class path. Replace DB2UNIVERSAL_JDBC_DRIVER_PATH with the directory where your Db2 .jar files are located:
    <DB2UNIVERSAL_JDBC_DRIVER_PATH>/db2jcc.jar
    <DB2UNIVERSAL_JDBC_DRIVER_PATH>/db2jcc_license_cu.jar
    <DB2UNIVERSAL_JDBC_DRIVER_PATH>/db2jcc_license_cisuz.jar
  9. Enter the directory location for the "db2jcc.jar, db2jcc_license_cisuz.jar" file, which is saved as the WebSphere variable ${DB2UNIVERSAL_JDBC_DRIVER_PATH}, for example, C:\DB2.
  10. Enter the native library path, for example, C:\DB2.
  11. Click Apply.
    Enter database class path information
  12. Ensure that the native library path is correct and click Next.
    Native library path
  13. Review the summary page and click Finish.
    Native library path
  14. Save the changes to the master configuration.

Creating a data source for the dgaas application

Procedure

  1. Go to the JDBC provider that you just created.
    1. Click Data sources and click New.
      Data sources link
    2. In the Data source name field, enter dgaas.
    3. In the JNDI name field, enter DGAAS_DB and click Next.
      Enter basic data source information
  2. Enter database specific properties for the data source and click Next.
    1. Set the Driver Type value to 4.
    2. In the Database Name field, enter the database name.
    3. In the Server Name field, enter the host name of the machine where Db2 is running.
    4. In the Port Number field, enter the port number for your Db2 database.
      Enter database specific properties for the data source
  3. In the Setup security aliases section, click Next.
  4. Review the summary page and click Finish.
    Data source summary
  5. Save the changes to the master configuration.

Creating an authentication data entry

Procedure

  1. Go to the PUB JDBC provider and click Data sources.
  2. On the data source page, click the dgaas data source.
  3. In the Related Items section, click JAAS-J2C authentication data.
  4. Click New.
  5. Enter the authentication details for your database:
    • For Db2: Enter the Db2 alias, user ID and password, and click OK.
      New authentication data
    • For Oracle: Enter the Oracle alias, user ID and password, and click OK
      New authentication data
  6. Save the changes to the master configuration.
  7. Go back to your dgaas data source.
  8. In the Security settings, select the ELMDB database for the following options:
    1. Authentication alias for XA recovery
    2. Component-managed authentication alias
    3. Container-managed authentication alias
    Security settings
  9. Click OK and save.
  10. Go to the dgaas data source again and click Test Connection to test the data source.
    Test connection successful

Configuring WebSphere Application Server with Oracle as a data source

You must set up a Oracle database and configure the connection with Document Builder on WebSphere Application Server

Before you begin

  • To create and set up an Oracle database, the user who is preparing the database must have database administration authority over the database and that the database, tablespace storage, and appropriate storage configuration is created by a user with system administration authority.
  • Depending on the version of Oracle that you use, the required Java Database Connectivity (JDBC) driver is ojdbc8.jar .
  • To generate a list of supported database versions and JDBC drivers, see http://www.ibm.com/software/reports/compatibility/clarity/softwareReqsForProduct.html.
  • The configuration parameters and tablespace options used in this topic are examples and might not entirely apply to your environment. For example, if you cannot use the AUTOEXTEND setting, then the files must be large enough to allow for growth. Or if you cannot use the UNLIMITED size quota for your database user, then make sure to allow enough space for rapid growth.
  • The database that you create for the Document Builder application must be formatted to use UTF-8 as the character set. By default, Oracle does not create a database with the UTF-8 character set. When you create a new database, ensure that you select AL32UTF8 in the Oracle DB setup.

Create a database and table space

Before you begin

If you are deploying the rpeng.war and dgaas.war files on separate servers or machines, you must create a single database and table space on the same machine you plan to deploy dgaas.war.

Procedure

  1. As a system administrator, create a database, for example ELMDB with UTF-8 encoding for Document Builder.
    1. Start the Database Configuration Assistant wizard and on the Welcome page click Next.
    2. On the Operations page, select Create a Database and then click Next.
    3. On the Templates page, select Custom Database and click Next.
    4. In both the Global Database Name and SID fields, enter a name for the content storage database; for example, ELMDB. Click Next.
    5. To configure the database control, enter the required information for alert notification and optionally enable the daily disk backup schedule. To continue without database control configuration, clear the check box next to Configure Enterprise Manager and then click Next.
    6. On the Database Credentials page, choose an option for your user account, and then click Next.
      Note: Oracle password complexity policy requires that passwords have minimum of 8 characters in length. In addition, the password must contain at least one uppercase character, one lowercase character, and one digit.
    7. On the next page, select a storage type and location for database files. Click Next.
    8. On the next page, choose a recovery option for the database, and then click Next.
    9. On the next page, specify whether or not to add the Sample Schemas to your database. Click Next.
    10. On the next page, click the Character Sets tab and select Use Unicode (AL32UTF8). Click Next.
      Note: Setting the character set to Unicode (AL32UTF8) enables you to store multiple language groups.
    11. On the Database Storage page verify or change the database objects and click Next.
    12. On the next page, click Finish to create the database.
    13. In the Confirmation window that opens, optionally save the page as an HTML file, and then click OK. A progress bar is displayed to show the database creation progress.
  2. Open an SQL *Plus window and log in as SYSTEM or SYSDBA.
  3. Navigate to [OracleInstallDir]/dbhome_1/bin, for example /u01/app/oracle/product/12.1.0/dbhome_1/bin and enter the following command, where password is your password and ELMDB is the database name that you created :
    ./sqlplus sys/[password]@ELMDB as sysdba
    Log in to Oracle
  4. Create a tablespace for Document Builder.

    To create a tablespace for Document Builder, enter the following command. Replace PUB with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, ELMDB with the database name you created in step 1, and PUB.DBF with the datafile name that you want to create.

    CREATE TABLESPACE PUB 
    DATAFILE 'ORACLE_BASE/oradata/ELMDB/PUB.DBF' 
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
    For example:
    CREATE TABLESPACE PUBDB_TS DATAFILE '/u01/app/oracle/oradata/ELMDB/PUBDB_TS.dbf' SIZE 1G
            AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
  5. Create a temporary tablespace for Document Builder. To create a temporary tablespace, enter the following command. Replace PUB_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, ELMDB with the database name you created in step 1, and PUB_TEMP.DBF with the temporary file name that you want to create.
    CREATE TEMPORARY TABLESPACE PUB_TEMP 
    TEMPFILE 'ORACLE_BASE/oradata/ELMDB/PUB_TEMP.DBF' 
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;
    For example:
    CREATE TEMPORARY TABLESPACE PUBDB_TEMP TEMPFILE
            '/u01/app/oracle/oradata/ELMDB/PUBDB_TEMP.DBF' SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT
            LOCAL UNIFORM SIZE 1M
  6. Log in to the Oracle Enterprise Manager Database Control portal as sys user. Click Storage > Tablespaces and verify that the tablespace you created are displayed and accessible.
    Oracle Enterprise Manager
  7. After the tablespaces are created, a special Oracle user must be created for each application to use the Oracle database. In this example, a user called PUB_USER is created and granted permission. The Oracle database user must be able to create database objects in its tablespace (either unlimited or with a space quota) with privileges to create session, table, procedure, and views. To create an Oracle database user for each new tablespace, enter the following command. Replace USER_NAME with the user that you want to create, PASSWORD with the password of the user, PUBDB_TS with the tablespace name you created in step 4, and PUBDB_TEMP with the temporary tablespace that you want to create.
    CREATE USER  USER_NAME IDENTIFIED BY PASSWORD DEFAULT TABLESPACE PUBDB_TS QUOTA UNLIMITED ON
          PUBDB_TS TEMPORARY TABLESPACE PUBDB_TEMP;
    For example:
    CREATE USER  PUB_USER IDENTIFIED BY RPEt3st123 DEFAULT TABLESPACE PUBDB_TS QUOTA UNLIMITED
            ON PUBDB_TS TEMPORARY TABLESPACE PUBDB_TEMP;
  8. To grant the required permissions to the tablespace, enter the following commands:
    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO PUB_USER
  9. Now log in to SQL *Plus Editor using PUB_USER and ensure that you can authenticate successfully, for example:
    ./sqlplus.sh pub_user/RPEt3st123@ELMDB

Creating a JDBC provider

Procedure

  1. Start WebSphere Application Server.
  2. Open the administrative console in a browser: https://server:port/ibm/console and log in.

    For example: https://localhost:9043/ibm/console

  3. Select Resources > JDBC > JDBC Providers.
  4. Select the node and server scope.
    Cell
  5. Click New.
  6. In the Create new JDBC provider wizard, select:
    1. Database type: Oracle
    2. Provider type: Oracle JDBC Driver
    3. Implementation type: XA data source
    4. Implementation name: Enter a name, for example PUB_Oracle.
    Create new JDBC provider wizard
  7. Click Next.
  8. In the Enter database class path information section, ensure that the class path section point to the ojdbc8.jar location. If it is showing ojdbc7.jar , then update it as ojdbc8.jar, and click Apply.For example:
    ${ORACLE_JDBC_DRIVER_PATH}/odjbc8.jar 
  9. Enter the directory location for the "ojdbc8.jar" file, which is saved as the WebSphere variable ${ORACLE_JDBC_DRIVER_PATH}, for example, /oracle_jdbc .
    Enter database class path information
  10. Review the summary page and click Finish.
    Native library path
  11. Save the changes to the master configuration.

Creating a data source for the dgaas application

Procedure

  1. Go to the JDBC provider that you just created.
    1. Click Data sources and click New.
      Data sources link
    2. In the Data source name field, enter DGAAS.
    3. In the JNDI name field, enter DGAAS_DB and click Next.
      Enter basic data source information
  2. Enter database specific properties for the data source and click Next.
    1. In the URL field, enter the URL of the Oracle database , for example jdbc:oracle:thin:@[server]:1521/ELMDB.
    2. Clear the Use this data source in container managed persistence (CMP) check box and click Next .
      Enter database specific properties for the data source
  3. In the Setup security aliases section, click Next.
  4. Review the summary page and click Finish.
    Data source summary
  5. Save the changes to the master configuration.

Creating an authentication data entry

Procedure

  1. Go to the PUB_Oracle JDBC provider and click Data sources.
  2. On the data sources page, click the DGAAS data source.
  3. In the Related Items section , click JAAS-J2C authentication data.
  4. Click New.
  5. Enter the Oracle alias, user ID and password, and click OK.
    New authentication data
  6. Save the changes to the master configuration.
  7. Go back to your DGAAS data source.
  8. In the Security settings, select the ELMDB database for the following options:
    1. Authentication alias for XA recovery
    2. Component-managed authentication alias
    3. Container-managed authentication alias
    Security settings
  9. Click OK and save.
  10. Go to the DGAAS data source again and click Test Connection to test the data source.
    Test connection successful

Configuring WebSphere Application Server with SQL Server as a data source

Before you begin

Create a database

Procedure

As a system administrator, create a database, for example PUBWASDB for Document Builder.

Creating a JDBC provider

Procedure

  1. Start WebSphere Application Server.
  2. Open the administrative console in a browser: https://server:port/ibm/console and log in.

    For example: https://localhost:9043/ibm/console

  3. Select Resources > JDBC > JDBC Providers.
  4. Set the scope to be the cell.
  5. Click New.
  6. In the Create new JDBC provider wizard, select:
    1. Database type: SQL Server
    2. Provider type: Microsoft SQL Server JDBC Driver
    3. Implementation type: XA data source
    4. Implementation name: Enter a name, for example Microsoft SQL Server JDBC Driver (XA).
    Create new JDBC provider wizard
  7. Click Next.
  8. In the Enter database class path information section, ensure that the class path section points to the sqljdbc41.jar location and click Apply. For example:
    ${MICROSOFT_JDBC_DRIVER_PATH}/sqljdbc41.jar 
  9. Enter the directory location for the sqljdbc41.jar file, which is saved as the WebSphere variable ${MICROSOFT_JDBC_DRIVER_PATH}, for example, C:\sqljdbc_6.0\enu\jre7 .
  10. Enter the native library path for the sqljdbc41.jar file, for example C:\sqljdbc_6.0\enu\jre7
    Enter database class path information
  11. Review the summary page and click Finish.
    Native library path
  12. Save the changes to the master configuration.

Creating a data source for the dgaas application

Procedure

Repeat the steps in Creating a data source for the rpeng application, setting DGAAS as the Data source name and DGAAS_DB as the JNDI name.

Creating an authentication data entry

Procedure

  1. Go to the Microsoft SQL Server JDBC Driver JDBC provider and click Data sources.
  2. On the data sources page, click the rpeng data source.
  3. In the Related Items section , click JAAS-J2C authentication data.
  4. Click New.
  5. Enter the alias, user ID and password, and click OK.
  6. Save the changes to the master configuration.
  7. Go back to your rpeng data source.
  8. In the Security settings, select the ELMDB database for the following options:
    1. Authentication alias for XA recovery
    2. Component-managed authentication alias
    3. Container-managed authentication alias
    Security settings
  9. Click OK and save.
  10. Go to the rpeng data source again and click Test Connection to test the data source.
  11. Repeat steps 7-10 with the dgaas data source.

Deploying only the dgaas.war on WebSphere Application Server

Before you begin

Verify the following assets are created:
  • A database for Engineering Publishing in Db2, Oracle, or SQL Server
  • A DGAAS data source with the JNDI name: DGAAS_DB

Procedure

  1. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  2. Expand Applications and click New Application.
  3. Click New Enterprise Application.
  4. In the Preparing for the application installation window, specify the path to dgaas.war on a local or remote file system:
    • If you are using a local file, select Local file system.
    • If you are using a remote file, select Remote file system.
    Type or click Browse to specify the path to the dgaas.war file. By default, the archive file is located in Document_Builder_install_dir\dgaas.war.
  5. Click Next.
  6. Select Fast Path - Prompt only when additional information is required and click Next.
  7. In the Select these installation options page, accept the default settings, and click Next.
    This is a screen capture of the Select these install options page in the administrative console for WebSphere Application Server
  8. In the Map modules to servers page, select the DGaaS module and click Next.
  9. In the Map resource references to resources page, you must specify the data source for the DGaaS module.
    1. For the DGaaS module entry, in the Target Resource JNDI Name column, click Browse.
      This is a screen capture of the Map resource references to resources page in the administrative console of WebSphere Applicaiton Server.
    2. In the New Application page, select the DGAAS option with the JNDI name set to DGAAS_DB.
      This is a screen capture of the New Application page of the administrative console for WebSphere Application Server.
    3. Click Apply.
    4. Click Next.
    This is a screen capture of the Map resource refernces to resources page in the administrative console for WebSphere Application Server.
  10. In the Map virtual hosts for Web modules page, select DGaaS and click Next.
  11. In the Map context roots for Web modules page and under the Context Root column, type dgaas and click Next.
    This is a screen capture of the Map context roots for Web modules page in the administrative console in the WebSphere Application Server.
  12. If the Metadata for modules page displays, accept the default settings and click Next.
    This is a screen capture of the Metadata for modules page.
  13. Review the Summary, and click Finish.
    This is a screen capture of the Summary page in the administrative console in the WebSphere Application Server.
  14. To confirm that your dgaas.war web application is deployed on the server successfully, search for the following output message that displays in the process log:
    Application dgaas_war installed successfully.
  15. Click Save to save changes directly to the master configuration.
    This is a screen capture of the process log page of the administrative console for WebSphere Application Server.
  16. Expand Applications > Application Types and click WebSphere enterprise applications. The dgaas_war application you added is listed as the application name you entered.
  17. In the Name column, click dgaas_war link.
    This is a screen capture of the Enterprise Applications page of the administrative console for WebSphere Application Server.
  18. In the Detail Properties section, click Class loading and update detection link.
  19. Under the Class loader order section, select Classes loaded with parent class loader first.
    This is an image of the Classes loaded with parent class loader first option.
  20. Verify the context roots of the dgaas_war application:
    1. Under the Web Module Properties section, click Context Root for Web Modules.
    2. Verify that the context root specified for the web modules matches the following values, and then click OK:
      Table 4. Verifying context roots for dgaas.war application
      Web module URI Context Root
      DGaaS dgaas.war, WEB-INF/web.xml dgaas
      This is a screen capture of the Context Root page in the administrative console for WebSphere Application Server
    3. On the Configuration tab, click OK.
  21. Click Save to save changes directly to the master configuration.
  22. Start the dgaas.war web application on the server:
    1. Select the dgaas_war check box and click Start.
    2. If the dgaas.war web application starts on the server successfully, the following message displays:
      Application dgaas_war on server server_name and node node_name started succesfully.  The collection may need to be refreshed to show the current status.
      This is a screen capture of the Enterprise applications page of the administrative console for WebSphere Application Server.

Creating a shared library for the dgaas application

Procedure

  1. Go to the Shared libraries page.
  2. Click Environment > Shared libraries in the console navigation tree.
  3. Select a shared library scope. Change the scope of the collection table to see what shared libraries are in a particular cell, node or server. Select the Node and Server option.
    Shared libraries scope page
  4. Click New.
  5. Specify the name, for example, dgaas.ear.
  6. Specify the class path for the following .jar files:
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\guava-15.0-cdi1.0.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\hk2-api-2.5.0-b42.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\hk2-locator-2.5.0-b42.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\hk2-utils-2.5.0-b42.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\javassist-3.22.0-CR2.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\javax.annotation-api-1.2.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\javax.json.bind-api-1.0.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\javax.ws.rs-api-2.1.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-client.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-common.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-container-servlet.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-container-servlet-core.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-hk2.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-media-jaxb.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-media-json-binding.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-media-multipart-2.26.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-media-sse.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\jersey-server.jar
    [WAS_HOME]\profiles\[profile_name]\installedApps\[cell_name]\dgaas_war.ear\dgaas.war\WEB-INF\lib\mimepull-1.9.3.jar
    Replace [WAS_HOME], [profile_name] and [cell_name] with the appropriate values for your environment.
  7. Under the Class Loading section, select or clear the check box depending on the version-level of the server:
    • For WebSphere Application Server V9.x: Clear the Use an isolated class loader for this shared library check box.
      Shared libraries page for container-wide shared library
    • For WebSphere Application Server V8.x: Select the Use an isolated class loader for this shared library check box.
      Shared libraries page for container-wide shared library
  8. Click OK.
  9. Click Save to update your changes to the master configuration.

For WebSphere Application Server V9.x: Associating shared libraries with server class loader

Before you begin

Complete this task if you are using version 9.x of WebSphere Application Server. If you are using version 8.x of WebSphere Application Server, skip to Associate shared libraries with applications task.

Procedure

  1. Open the administrative console in a browser: https://server:port/ibm/console

    For example: https://localhost:9043/ibm/console

  2. Expand Server > Server Types and click WebSphere application server.
  3. In the Application servers section, click your server link, for example server1.
  4. Under the Server Infrastructure section, expand Java and Process Management and click the Class loader link.
  5. Click New.
  6. Under Class loader order, select Classes loaded with parent class loader first.
  7. Click OK.
  8. Click Save to save changes directly to the master configuration.
  9. Click on the newly created or an existing class loader:
    Image of the class loader.
  10. Under Additional Properties, select Shared library references.
    Image of the class loader' shared library references.
  11. Click Add.
  12. Under the Library name, select the shared library created in the previous Creating a shared library for the dgaas application task. For example, dgaas.ear.
    Image of the class loader' shared library references.
  13. Click OK.
  14. Click Save to save changes directly to the master configuration.

Configuring the licensing variable

Procedure

  1. Set the TELELOGIC_LICENSE_FILE environment variable on your application server.

    The default format for the license server path in the environment variable is port_number@hostname.

    For example, you can create an environment variable for the license file in WebSphere Application Server on the Environment Entries page:
    Adding the Telelogic environment variable
    For Linux, the registry is found in $HOME/.flexlmrc for TELELOGIC_LICENSE_FILE.
  2. Restart WebSphere Application Server.

Results

You can confirm that the Document Builder is deployed by opening the following URL in a browser: http://server:port/rpeng/
Tip: You might encounter the following error message in the web browser:
Error 500: com.ibm.websphere.servlet.session.UnauthorizedSessionRequestException:
    SESN0008E: A user authenticated as anonymous has attempted to access a session owned by
    user:defaultWIMFileBasedRealm/uid=pub_designer,o=defaultWIMFileBasedRealm.
To resolve this error message, verify that you set the InvalidateOnUnauthorizedSessionRequestException session management property to true in the custom properties for WebSphere Application Server. For more details, see the Setting session management section of this topic.

You can log in by providing the user name and password of the appropriate user, such as pub_admin, pub_designer or pub_user and click Log in.

This is a screen capture of the web app log in screen.

The following IBM Engineering Lifecycle Optimization - Publishing Document Builder page should display in your browser:

Web app home page

You can verify the status of the document generation node by entering http://server:port/dgaas/debug in a browser.

Web app home page

What to do next

Optionally, you can deploy and run the Newskeeper sample application that uses document generation service technology for generating documents, and provides a storage interface for document generation service assets and documents. For more details, see Running the Newskeeper sample.

Configure the Document Builder listed on the http://server:port/rpeng/ page. See Document Builder URLs for an explanation of how each URL is used and tasks for configuring each of the features.

Feedback