Chapter - 3 : Troubleshooting the Client


Here are some things to check if the Docupresentment Client is not communicating with Docupresentment Server.

Note: The test connection from client to server will fail if the port numbers are not valid. Use unused port numbers to avoid this issue.

Checking the DOCCLIENT.XML File

First, make sure the docclient.xml file is set up correctly. Here is an example docclient.xml file, including all of the queue sections with ActiveMQ active:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

<section name="DocumentClient" version="12.7.1">

<section name="messaging">

<!--JMS / ActiveMQ Section-->

<!--Remove 'DISABLE-' to enable this section. Only one queue section can exist at a time.-->

<section name="queue">

<entry name="marshaller.class">com.docucorp.messaging.data.marshaller.SOAPMIMEDSIMessageMarshaller</entry>

<entry name="queuefactory.class">com.docucorp.messaging.jms.DSIJMSJNDIMessageQueueFactory</entry>

<entry name="jms.inputqueue.connectstring">resultq</entry>

<entry name="jms.outputqueue.connectstring">requestq</entry>

<entry name="jms.qcf.name">queueConnectionFactory</entry>

<entry name="jms.initial.context.factory">org.apache.activemq.jndi.ActiveMQInitialContextFactory</entry>

</section>

<!--HTTP Section-->

<!--Remove 'DISABLE-' to enable this section. Only one queue section can exist at a time.-->

<section name="DISABLE-queue">

<entry name="marshaller.class">com.docucorp.messaging.data.marshaller.SOAPMIMEDSIMessageMarshaller</entry>

<entry name="queuefactory.class">com.docucorp.messaging.http.DSIHTTPMessageQueueFactory</entry>

<entry name="http.url">http://localhost:49352</entry>

<entry name="http.reuse.ports">15</entry>

<entry name="inputqueue.maxwaitseconds">30</entry>

</section>

<!--MQSeries Section-->

<!--Remove 'DISABLE-' to enable this section. Only one queue section can exist at a time.-->

<section name="DISABLE-queue">

<entry name="marshaller.class">com.docucorp.messaging.data.marshaller.SOAPMIMEDSIMessageMarshaller</entry>

<entry name="queuefactory.class">com.docucorp.messaging.mqseries.DSIMQMessageQueueFactory</entry>

<entry name="mq.queue.manager"></entry>

<entry name="mq.inputqueue.name">RESULTQ</entry>

<entry name="mq.inputqueue.maxwaitseconds">5</entry>

<entry name="mq.outputqueue.name">REQUESTQ</entry>

<!-- Remove 'DISABLE-' from the following line to use in TCP/IP 'client' mode. -->

<!-- Leave disabled to use in 'bindings' mode. -->

<entry name="DISABLE-mq.tcpip.host">127.0.0.1</entry>

<entry name="mq.queue.channel">SYSTEM.DEF.SVRCONN</entry>

<entry name="mq.tcpip.port">1414</entry>

<entry name="mq.conn.userid">appUserid</entry>

<entry name="mq.conn.password">appPassword</entry>

</section>

<!--MSMQ Section-->

<!--Remove 'DISABLE-' to enable this section. Only one queue section can exist at a time.-->

<section name="DISABLE-queue">

<entry name="marshaller.class">com.docucorp.messaging.data.marshaller.SOAPMIMEDSIMessageMarshaller</entry>

<entry name="queuefactory.class">com.docucorp.messaging.msmq.DSIMSMQMessageQueueFactory</entry>

<entry name="msmq.server.name">localhost</entry>

<entry name="msmq.inputqueue.name">private$\RESULTQ</entry>

<entry name="msmq.outputqueue.name">private$\REQUESTQ</entry>

<entry name="msmq.timeout">30000</entry>

<entry name="msmq.expiry">1800000</entry>

</section>

</section>

<!-- messaging section -->

</section>

<!-- DocumentClient -->

</configuration>

Checking the CLASSPATH and other Environment Variables

The following values are added to the CLASSPATH variable when you install the Docupresentment Client:

CLASSPATH=C:\docclnt\clientlib\DocucorpMsg.jar;C:\docclnt\clientlib\DocumentServer.jar;
C:\docclnt\clientlib\commons-collections.jar;C:\docclnt\clientlib\commons-fileupload.jar;C:\docclnt\clientlib\commons-pool.jar;C:\docclnt\clientlib\DocuCorpUtil.jar;
C:\docclnt\clientlib\DSIJavaMsg.jar;C:\docclnt\
clientlib\IDSJSP.jar;C:\docclnt\clientlib\jdom.jar;
C:\docclnt\clientlib\xerces.jar;C:\docclnt\clientlib\log4j.jar;

The following values are added to the PATH variable when you install the Docupresentment Client:

PATH=C:\docclnt;C:\docclnt\jre\bin\client;C:\docclnt\jre\bin;e:\docclnt\.\.install4j

These values are added to the following variables when you install the Docupresentment Client:

ids_client_configuration=C:\docclnt\docclient.xml
java_endorsed_dirs=C:\docclnt\clientlib\endorsed

logging_client_configuration=C:\docclnt\logclientconf.xml

Installing Third-Party JAR Files

Note: If you are using IBM MQ (WebSphere MQ or MQ Series) or ActiveMQ for the queuing method, you must make the IBM MQ or ActiveMQ jar files available to Docupresentment. See the “Installing Third-Party Jar Files” section of the Docupresentment Guide for more information.

Installing the Docupresentment with a Response File

You can run the Docupresentment in unattended mode from the command line. To do this you must create a response file to provide the information the installer needs. A response file is a text file which contains the information a user would typically provide while running the Setup wizard or responding to command-line prompts. This information is in name=value format.

To create a response file that contains the necessary data, first run the command-line installer in one of these ways:

  • Using default mode, with no arguments. After the installation finishes, the installer creates a response file named response.varfile.
  • Using the command-line installation with the -console parameter. This lets you specify the name you want to assign to the response file.

After the installation finishes, the installer creates the response file and stores it in the.install4j directory. This file contains name=value data captured during the installation process. You can edit this file if necessary to modify the values. Here is an example:

#install4j response file for (application/version)

#Wed Mar 16 16:53:12 EDT 2011

sys.languageId=en

sys.installationDir=d\:\\(application/version)

You can then pass this response file to the installer using the -varfile parameter. For example, to run the installer in unattended mode using a response file, include these parameters:

-q -console -c -varfile varfilename

Parameter Description
-q Runs the installer in unattended mode.
-console If the installer is executed in unattended installation mode (-q) and you include -console as the second parameter, a console is allocated on Windows that displays the output of the installer.
-c Runs the installer in the console mode.
-varfile Varfilename specifies the name of the response.varfile to use. You can include a full path.
Note:

For more information about response files and install4j installations, go to this website:

http://resources.ej-technologies.com/install4j/help/doc/

Here is an example:

(application/version).exe -q -console -c -varfile

response.varfile

Here is an example of the output you will see:

Extracting files...

Downloading ...

Extracting files...

Finishing installation..