Custom Deployment of Publishing Document Builder on WebSphere Application Server Liberty Profile
You can customize the deployment of Publishing Document Builder on WebSphere® Application Server Liberty Profile.
Before you begin
By default, Derby database is created, if you want to change the database, you must
choose one of the following database vendors that you want to configure the connection with Publishing Document
Builder
on WebSphere Application Server
Liberty Profile:
- IBM Db2®
- Oracle
- Microsoft SQL Server
About this task
Note: If you are deploying Publishing Document
Builder along with
IBM
Engineering Lifecycle Management,
Publishing Document
Builder
must be deployed on a separate application server profile from ELM. See
this technote for details: https://www.ibm.com/support/docview.wss?uid=ibm10728091.
Procedure
Results
Remember: If you encounter an
UnauthorizedSessionRequestException
error
message in the web browser, verify that you completed the previous step, which adds the following
entry to the server.xml file:
<httpSession invalidateOnUnauthorizedSessionRequestException="true"></httpSession>
Example
<?xml version="1.0" encoding="UTF-8"?>
<server description="new server">
<!-- Enable features -->
<featureManager>
<feature>jsp-2.2</feature>
<feature>jndi-1.0</feature>
<feature>jpa-2.0</feature>
<feature>jdbc-4.0</feature>
<feature>servlet-3.0</feature>
<feature>appSecurity-2.0</feature>
</featureManager>
<!-- To access this server from a remote client add a host attribute to the following element, e.g. host="*" -->
<httpEndpoint id="defaultHttpEndpoint" httpPort="9081" httpsPort="9444" host="localhost"/>
<classloading useJarUrls="true"/>
<!-- User creation-->
<httpSession invalidateOnUnauthorizedSessionRequestException="true"/>
<classloading useJarUrls="true"/>
<webContainer deferServletLoad="false"/>
<include location="conf/basicUserRegistry.xml"/>
<include location="conf/application.xml"/>
<executor coreThreads="100"/>
<webAppSecurity ssoRequiresSSL="true" ssoUseDomainFromURL="true" ssoCookieName="rpeLtpaToken2"/>
<!--<webAppSecurity singleSignonEnabled="false" />-->
<applicationManager autoExpand="true"/>
<!--Database Configuration -->
<jdbcDriver id="db2-lib">
<library>
<fileset caseSensitive="false" dir="C:\Program Files\IBM\SQLLIB\java"/>
</library>
</jdbcDriver>
<dataSource id="rpeng" jdbcDriverRef="db2-lib" jndiName="jdbc/RPENG_DB">
<properties.db2.jcc databaseName="databasename" portNumber="portNumber" password="password" serverName="ipaddress" user="db2admin"/>
</dataSource>
<dataSource id="DGAAS_DB" jdbcDriverRef="db2-lib" jndiName="jdbc/DGAAS_DB">
<properties.db2.jcc databaseName="databasename" portNumber="portNumber" password="password" serverName="ipaddress" user="db2admin"/>
</dataSource>
</server>
For Oracle: An example of the server.xml file
configured to deploy Publishing Document
Builder:<?xml version="1.0" encoding="UTF-8"?>
<server description="new server">
<!-- Enable features -->
<featureManager>
<feature>jsp-2.2</feature>
<feature>jndi-1.0</feature>
<feature>jpa-2.0</feature>
<feature>jdbc-4.0</feature>
<feature>servlet-3.0</feature>
<feature>appSecurity-2.0</feature>
<feature>ssl-1.0</feature>
</featureManager>
<!-- To access this server from a remote client add a host attribute to the following element, e.g. host="*" -->
<httpEndpoint id="defaultHttpEndpoint" httpPort="9081" httpsPort="9444" host="localhost"/>
<keystore id="defaultKeyStore" password="password"/>
<classloading useJarUrls="true"/>
<httpSession cookieSecure="true invalidateOnUnauthorizedSessionRequestException="true"></httpSession>
<!-- User creation-->
<httpSession invalidateOnUnauthorizedSessionRequestException="true"/>
<classloading useJarUrls="true"/>
<webContainer deferServletLoad="false"/>
<include location="conf/basicUserRegistry.xml"/>
<include location="conf/application.xml"/>
<executor coreThreads="100"/>
<webAppSecurity ssoRequiresSSL="true" ssoUseDomainFromURL="true" ssoCookieName="rpeLtpaToken2"/>
<!--<webAppSecurity singleSignonEnabled="false" />-->
<applicationManager autoExpand="true"/>
<!--Database Configuration -->
<jdbcDriver id="OracleLib">
<library>
<fileset caseSensitive="false" dir="/oracle_jdbc" includes="*.jar"/>
</library>
</jdbcDriver>
<dataSource id="rpeng_db" jdbcDriverRef="OracleLib" jndiName="jdbc/RPENG_DB">
<properties.oracle password="password" URL="jdbc:oracle:thin:@//hostname:port/lib1" user="pub_user"/>
</dataSource>
<dataSource id="DGAAS_DB" jdbcDriverRef="OracleLib" jndiName="jdbc/DGAAS_DB">
<properties.oracle password="password" URL="jdbc:oracle:thin:@//hostname:port/lib1" user="pub_user"/>
</dataSource>
</server>
For SQL server: An example of the server.xml file
configured to deploy Publishing Document
Builder:<?xml version="1.0" encoding="UTF-8"?>
<server description="Document builder">
<!-- Enable features -->
<featureManager>
<feature>jsp-2.2</feature>
<feature>appSecurity-2.0</feature>
<feature>servlet-3.0</feature>
<feature>jndi-1.0</feature>
<feature>jpa-2.0</feature>
<feature>jdbc-4.0</feature>
</featureManager>
<keyStore id="defaultKeyStore" password="{xor}Nj0ycis6PjI=" type="PKCS12" location="ibm-team-ssl.p12"/>
<!-- To access this server from a remote client add a host attribute to the following element, e.g. host="*" -->
<httpEndpoint id="defaultHttpEndpoint" httpPort="9081" httpsPort="9444" hostName="*" host="*"/>
<httpSession invalidateOnUnauthorizedSessionRequestException="true" cookieSecure="true"/>
<classloading useJarUrls="true"/>
<webContainer deferServletLoad="false"/>
<include location="conf/basicUserRegistry.xml"/>
<include location="conf/application.xml"/>
<executor coreThreads="100"/>
<webAppSecurity ssoCookieName="rpeLtpaToken2" ssoUseDomainFromURL="true" ssoRequiresSSL="true"/>
<!--<webAppSecurity singleSignonEnabled="false" />-->
<applicationManager autoExpand="true"/>
<!--Database Configuration -->
<library id="MSJDBCLib">
<file name="C:\sqljdbc_8.4\enu\mssql-jdbc-8.4.1.jre8.jar" />
</library>
<dataSource id="RPENG" jndiName="jdbc/RPENG_DB">
<jdbcDriver libraryRef="MSJDBCLib"/>
<properties databaseName="databasename" serverName="ipaddres" portNumber="1433" password="password" user="sa"/>
</dataSource>
<dataSource id="DGAAS" jndiName="jdbc/DGAAS_DB">
<jdbcDriver libraryRef="MSJDBCLib"/>
<properties databaseName="databasename" serverName="ipaddres" portNumber="1433" password="password" user="sa"/>
</dataSource>
</server>
An example of the application.xml file configured to
deploy Publishing Document
Builder<?xml version="1.0"?>
-<server>
-<application location="${server.config.dir}/apps/rpeng.war" name="rpeng" id="rpeng" type="war">
<classloader apiTypeVisibility="spec,ibm-api,api" commonLibraryRef="rcl"/>
-<application-bnd>
-<security-role name="pub_user">
<group name="JazzGuests"/>
</security-role>
-<security-role name="pub_report_designer">
<group name="JazzUsers"/>
</security-role>
-<security-role name="pub_admin">
<group name="JazzAdmins"/>
</security-role>
</application-bnd>
</application>
-<application location="${server.config.dir}/apps/dgaas.war" name="dgaas" id="dgaas" type="war">
<classloader apiTypeVisibility="spec,ibm-api,api" commonLibraryRef="rcl"/>
-<application-bnd>
-<security-role name="pub_user">
<group name="JazzGuests"/>
</security-role>
-<security-role name="pub_report_designer">
<group name="JazzUsers"/>
</security-role>
-<security-role name="pub_admin">
<group name="JazzAdmins"/>
</security-role>
</application-bnd>
</application>
</server>
An example of the basicUserRegistry.xml file configured
to deploy Publishing Document
Builder<?xml version="1.0" encoding="UTF-8"?>
-<server>
<!--Licensed Materials - Property of IBM(c) Copyright IBM Corporation 2015. All Rights Reserved.Note to U.S. Government Users Restricted Rights:Use, duplication or disclosure restricted by GSA ADP ScheduleContract with IBM Corp. -->
-<featureManager>
<feature>appSecurity-2.0</feature>
</featureManager>
-<basicRegistry realm="Jazz" id="Jazz">
<user password="pub_admin" name="pub_admin"/>
<user password="pub_designer" name="pub_designer"/>
<user password="pub_user" name="pub_user"/>
-<group name="JazzAdmins">
<member name="pub_admin"/>
</group>
<group name="JazzProjectAdmins"> </group>
-<group name="JazzGuests">
<member name="pub_user"/>
</group>
-<group name="JazzUsers">
<member name="pub_designer"/>
</group>
</basicRegistry>
</server>
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 Publishing Document Builder URL listed on the https://hostname:port/rpeng/login.jsp page. See Publishing Document Builder URLs for an explanation of how each URL is used and tasks for configuring each of the features.