Configure Remote Document Search

This page is an overview of the Remote Document Search integration feature, which passes a URL in your browser to link directly to a search application within Autoform DM.

Passing parameters into this URL also enables the search application to return a specific document or collection of documents.

Warning

This integration is deprecated. We recommend the REST API which is more secure and feature rich.

Behavior

The results table is shown by default, even if there is only one record.

Adjust the dm.remotesearch.autoshowsingle flag to revert to the previous behavior of showing the document.

See Set Configuration Flag Values in node.properties for more information.

URL Syntax

The syntax for the URL is:

http://<servername>:<port>/pdm/action/remoteSearchAction.do?ID=<applicationID>

Appropriately replace <servername>, <port>, and <applicationID>.

For example: http://demo.efstech.co.uk:8110/pdm/action/remoteSearchAction.do?ID=236223201689

To add parameters, add <inputnumber>=<inputvalue> for each one. Appropriately replace <inputnumber> and <inputvalue>.

For example:

http://demo.efstech.co.uk:8110/pdm/action/remoteSearchAction.do?ID=236223201689&input1=642&input2=test

Note

The input identifiers for each query key can be discovered by viewing the search configuration on the Query Keys tab of the Autoform DM administration web application.

Passing Login Information

A username and password can be passed in the URL, along with a checksum, in order to bypass the normal login screen.

Warning

Secure protocols, such as HTTPS, should be used to ensure that sensitive data is protected.

In this case, the remote.jsp endpoint must be used, which has a slightly different URL:

https://<servername>:<port>/pdm/remote.jsp?ID=<applicationID>...

Appropriately replace <servername>, <port>, and <applicationID>.

Note

action is not present in the URL.

In addition to the input parameters, the following parameters can be passed:

• j_username: This is the plain text username. For example, admin

• j_password: This is the plain text password. For example, password (note that security is assured through the use of TLS)

• checksum: This must contain all the search input parameters MD5 hashed together along with the pre-shared key: tatvotse

Example

Application ID: 123456789

Username: admin

Password: password

Input1: test

Input2: 1234

Pre-shared key: tatvotse

checksum: (test1234tatvotse) = 4092cea31f93f2e492b684c9b12fbdd1

The URL would be:

https://localhost/pdm/remote.jsp?ID=123456789&j_username=admin&j_password=password&input1=test&input2=1234&checksum=4092cea31f93f2e492b684c9b12fbdd1

Note

For testing purposes, a tool for generating MD5 hashes is available.