Accessing Ad Hoc Correspondence

When accessing Ad Hoc Correspondence, a request that includes a Message ID is sent to the SSSP application. The Message ID identifies the document that is opened in 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=<messageID> &domain=<applicationDomain>&submit=<submitURL>&close=<closeURL> &submitEnabled=true|false&locale=<Locale>&editorButtons=top|bottom &editorAutoOpen=true|false&manageMetadata=true|false &previewType=paginated|unpaginated&inlineEdit=true|false

Where:

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

•	<Port> – The port the Java application server listens to. Default is 8080.

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

•	?guid=<messageID> – The Message ID that identifies the document to open in Ad Hoc Correspondence.

•	&domain=<applicationDomain> – The application domain to access. Required if the Ad Hoc application is connected to several application domains.

•	&submit=<submitURL> – 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 open.

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

•	&close=<closeURL> – 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 open.

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

•

&submitEnabled=true|false – Specifies whether submit is enabled 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 chooses to edit a document in Correspondence Reviewer, submitEnabled=false is automatically added to the URL when the document opens in Ad Hoc Correspondence.

Note:

When Ad Hoc Correspondence is run in “one-to-many mode”, i.e. when documents are delivered to several recipients, you must disable submit (submitEnabled=false).

•	&locale=<Locale> – The locale 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.

•	&editorButtons=top|bottom – The location of the Save and Close buttons in the Ad Hoc text editor. Available options are top and bottom (above or below the text editor area). This parameter is optional. If not specified, the buttons are below the text editor area.

•	&editorAutoOpen=true|false – Specifies whether the Ad Hoc text editor opens automatically when a new text fragment is added to the document. This parameter is optional. If not specified, the Ad Hoc text editor does not open automatically.

•	&manageMetadata=true|false – Specifies whether to enable usage of variable fields in the Ad Hoc text editor. This parameter is optional. If not specified, variable fields are disabled in the Ad Hoc text editor.

•	&previewType=paginated|unpaginated – Specifies whether to display the document in paginated mode or unpaginated mode. This parameter is optional.

•	&inlineEdit=true|false – Specifies whether to enable inline editing of texts in the Ad Hoc preview. See Inline editing in Ad Hoc Correspondence for more information about requirements and limitations.

Example 2

URL encoding

In this example, the following is assumed:

•	URL to access Ad Hoc Correspondence:

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

•	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=<messageID>&close=http%3A%2F%2Fwww.streamserve.com%2F