URL to Ad Hoc Correspondence

Note:

Because the web browser shares session context between tabs, it is not supported to run Ad Hoc Correspondence in more than one tab in the web browser.

The URL to access Ad Hoc Correspondence looks like the following:

http://<Host>:<Port>/<Name>_adhoc/?guid=<Message_ID>&domain=<Application domain>&submit=http://<Submit_URL>&close=http://<Close_URL>&submitEnabled=<Submit true or false>&locale=<Locale>

Where:

•	<Host> – Is the host name or IP address of the computer that runs the Java application server.

•	<Port> – Is the port that the Java application server listens to, by default 8080.

•	<Name>_adhoc – Is the name of the Ad Hoc application, set by the management gateway when deploying the web application. See Deployment in Control Center.

•	<Message_ID> – Is the Message ID that identifies the specific document that is opened in Ad Hoc Correspondence.

•	domain=<Application domain> – Is the application domain to be accessed. This parameter is required if the Ad Hoc application is connected to several application domains.

•	<Submit_URL> – Is the URL the end-user is directed to after submitting the document. For example, back to the hosting system. This parameter is optional. If not specified, the document is submitted and closed but Ad Hoc Correspondence remains in the web browser.

If <Submit_URL> contains parameters, these parameters must be URL encoded. See Example 2.

•	<Close_URL> – Is the URL the end-user is directed to after closing the document. For example, back to the hosting system. This parameter is optional. If not specified, the document is closed but Ad Hoc Correspondence remains in the web browser.

If <Close_URL> contains parameters, these parameters must be URL encoded. See Example 2.

•

<Submit true or false> – Is a parameter that specifies if submit is enabled or disabled in Ad Hoc Correspondence. If submitEnabled=false, the Submit button is disabled and submit must be handled from Correspondence Reviewer or within the business workflow of the customer. This parameter is optional. If not specified, submit is enabled in Ad Hoc Correspondence.

When the end-user choose to edit a document in Correspondence Reviewer, submitEnabled=false is automatically added to the URL when the document opens in Ad Hoc Correspondence.

•	<Locale> – Is the locale that is used in Ad Hoc Correspondence. This parameter is optional. If no locale is specified in the URL, the preferred locale configured for the web browser is used. If a non-supported locale is specified, an English locale is used.

Example 2

URL encoding

In this example, the following is assumed:

•	URL to access Ad Hoc Correspondence:

http://localhost:8081/<Name>_adhoc/?guid=<Message_ID>

•	URL the end-user is directed to when closing a document:

http://www.streamserve.com/

When URL encoded, this URL looks like the following:

http%3A%2F%2Fwww.streamserve.com%2F

The complete URL to access Ad Hoc Correspondence, and to direct a end-user further when closing a document looks like the following:

http://localhost:8081/<Name>_adhoc/?guid=<Message_ID>&close=http%3A%2F%2Fwww.streamserve.com%2F