Document Management Web (DOCMAW)

This document describes how to set up Document Management Web (DOCMAW) and how to prepare your system to support a successful installation.

Content

Firewall Settings

Since DOCMAW does not use passive FTP, if there is a firewall between the web server (the application server where FNDWEB is installed) and the FTP server, then the firewall must be configured support "active" (not passive) FTP. The reason for this is that the Java FTP library used does not support passive FTP transfers.

Handling very large files

The session time-out for a Web client should be increased to a sufficient amount, depending on the sizes of the files to be transferred. This also depends on the speed of the data transfer between the client machine and the extended server. This time-out can be set in the file web.xml located in IFS_HOME\jboss-eap-4.3\jboss-as\server\<instance>\deploy\fndweb.ear\b2e.war\WEB-INF\.

The connection time-out of the FTP servers (FTP repositories) should be increased to a sufficient amount, depending on the sizes of the files to be transferred for all types of clients.

Note: Handling very large files might lower the performance of the client, server machines and network.

Required SYSCFG_* System Parameters for database storage

When handling document files stored in the database, DOCMAW cannot access the files directly. This is instead done by the application server. In order to access these files, the web and application server shares a common folder, where both servers must have read and write access. This path is configured using the system parameters SYSCFG_SHARED_PATH_APPSERVER and SYSCFG_SHARED_PATH_FNDWEB, respectively.

These two values should contain a path which should point to the folder where the web server and application server can exchange files. There are two scenarios to think about:

Note: It is important that the user account running the actual web and application servers has read and write access to the shared path. For example, if one or both servers is running as services then it is the system account, or the account specified on the service, that needs to have access. If the servers are running interactively it should be the user account that started the server. Also, the folder must exist for it to work.

For information on how to change these values (you need a special system privilege) please refer to this section for component Document Management (DOCMAN).

Note: Database storage of document files will not work if this isn't configured correctly.

Required activity for database storage

In order to implement Database storage, DOCMAW needs to access the activity DatabaseStorageHelper in IFS Extended Server. This activity must therefore be granted to all users that needs to download or upload document files stored in the database. In the database folder of DOCMAW there is an inser script called security_docman_database_storage_helper.ins that can be used to create a role to be granted this activity. This role shoud then be added to the role of the end users that need to check in and check out files using the web client. If you plan to use only FTP repositories there is no need for setting up this.

System Parameters

This table describes system parameters set in the file DocmawConfig.xml (found under WEB-INF\config in each WAR). The proper way to change these values is through the Installer, in the step where you configure the web client instances. All parameters have good default values so normally you do not need to change any of them.

Parameter Description Value
DOCUMENT_TEMP_ROOT Is used together with DOCUMENT_TEMP_DIRECTORY as a place to store temporary files that DOCMAW generates. The default value points at APPLICATION/TEMP_PATH and normally, you do not need to change that. The default sub folder docmaw under DOCUMENT_TEMP_ROOT will be created automatically if it doesn't exist (and if the application has write permissions there). <File Path>
DOCUMENT_TEMP_DIRECTORY Is used together with DOCUMENT_TEMP_ROOT as a place to store temporary files that DOCMAW generates. The default value points at APPLICATION/TEMP_PATH and normally you do not need to change that. The default sub folder docmaw under DOCUMENT_TEMP_ROOT will be created automatically if it doesn't exist (and if the application has write permissions there). <File Path>
DOCUMENT_TEMP_EXPIRE_HOURS Tells the system how old a file can be before it is removed from the temporary file directories. This check is done each time a document is checked in or out. Set it to 1 or higher. 1 or higher
DOC_REF_URL Never change this. Used by the web client to know which page to open when the user clicks the Documents action menu command. docmaw/DocReference.page
EXTENDED_SERVER Used by Instant View to know which application server to connect to when viewing a document. This value is empty by default, which means that Instant View will use the root URL from where the Web Client EAR is running, only set a value for this parameter if you know that it must be different from this. http(s)://<server>:<port>