OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator S Guide
OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator S Guide
OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator S Guide
2
Ad Hoc Correspondence and
Correspondence Reviewer
Administrator’s Guide
Rev C
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide
Rev C
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for
the accuracy of this publication.
3
Contents
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
4
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
5
Ad Hoc Correspondence
Ad Hoc Correspondence enables an organization to create ad hoc customer
correspondence. The application is used to write new personalized documents to
specific customers, or to edit existing documents before they are formatted and
distributed to customers. The document templates used in Ad Hoc
Correspondence are document definitions, published in StreamStudio
Composition Center.
Correspondence Reviewer
Correspondence Reviewer helps an organization to create quality assured
correspondence. The application is used to review documents before they are
formatted and distributed to customers. Reviewed documents can be approved,
rejected, edited, or deleted.
In this section
• User documentation on page 6
• Implementation and configuration tasks on page 7
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
6 User documentation
About Ad Hoc Correspondence and Correspondence Reviewer
User documentation
Ad Hoc Correspondence and Correspondence Reviewer User Guide
The user guide gives an overview of the scenarios (on-demand and batch), the
technical solution and the configurations required in Design Center and
StreamStudio Composition Center. You also find information on how to use the
Ad Hoc and Reviewer applications.
The user guide is intended for developers, such as StreamServe consultants.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Implementation and configuration tasks 7
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
8 Implementation and configuration tasks
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
9
Prerequisites
Before the installation and deployment, the following must be installed:
• A Java application server.
• A Java Runtime Environment, installed on the same computer as the Java
application server.
• A web browser (to access the Ad Hoc and Reviewer applications).
For supported software and versions, see the Supported platforms and software
documentation.
In this section
• Recommended settings on page 10
• Deploying the applications on page 11
• Removing the applications on page 13
Related topics
• Technical overview in the Ad Hoc Correspondence and Correspondence Reviewer
User Guide.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
10 Recommended settings
Installing the applications
Recommended settings
Screen resolution
• Recommended screen resolution – At least 1280 x 1024 pixels.
• Minimum screen resolution – 1024 x 768 pixels.
• Run the applications in a maximized browser window.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Deploying the applications 11
Installing the applications
If Control Center is not available, you can deploy the web applications via the
command line utilities. For more information, see the Command line utilities
documentation. End of tip
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
12 Deploying the applications
Installing the applications
The webportal.properties files are generated when you link the Ad Hoc and
Reviewer application to an application domain and reside in the following
directory:
<Portal root>\<Name>_adhoc\WEB-INF\spring\properties
<Portal root>\<Name>_reviewer\WEB-INF\spring\properties
<Portal root>\sssp\domains
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Removing the applications 13
Installing the applications
Prerequisites
To be able to remove the WAR file and the corresponding folder for an SSSP
application, you must stop the Java application server.
Post requisites
After removing the files and folders from the portal root, you may also want to
remove the files installed by the StreamStudio setup. For example, by using the
Add or Remove programs functionality in Windows. Note that this function
uninstalls all StreamStudio files.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
14 Removing the applications
Installing the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
15
If you redeploy the WAR files for the web applications, for example to
apply a hotfix, any customizations that you have made to the property
files are overwritten.
To keep customizations, you can use an external directory outside the
portal root for the property files. For more information, see Keeping
customized configuration files in the Control Center documentation.End of
warning.
In this section
• Customizing Ad Hoc Correspondence on page 16
• Customizing Correspondence Reviewer on page 23
Related topics
• Accessing the applications on page 27
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
16 Customizing Ad Hoc Correspondence
Customizing the applications
Prerequisites
Before updating the adhoc.properties file, you should back up the file.
In this section
• Adding fonts to the Ad Hoc text editor on page 17
• Enabling or disabling spell checking in the Ad Hoc text editor on page 18
• Enabling non-ASCII characters in story names on page 19
• Managing table styles on page 20
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Customizing Ad Hoc Correspondence 17
Customizing the applications
Related topics
• The new font must also be available to the StreamServer application. See
Importing fonts to be used in the Ad Hoc text editor in the Ad Hoc Correspondence
and Correspondence Reviewer User Guide.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
18 Customizing Ad Hoc Correspondence
Customizing the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Customizing Ad Hoc Correspondence 19
Customizing the applications
-Dfile.encoding=utf-8
Related topics
For detailed information about Java application server configurations, see the
user documentation for the Java application server.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
20 Customizing Ad Hoc Correspondence
Customizing the applications
In this section
• Customizing table styles for Ad Hoc Correspondence on page 20
• Adding new table styles on page 21
• Example – Adding new table styles on page 21
Requirements
• To customize styles, you should be familiar with the Cascading Style Sheet
(CSS) language.
• You must verify that the customized styles are presented as expected. Since
the text editor does not always display the correct formatting, you must
close the editor and preview the table in the Ad Hoc document.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Customizing Ad Hoc Correspondence 21
Customizing the applications
.divisionGreenRecordTable{
color:#228b22;
width:300pt;
}
Do not set style formatting directly on table elements since that affects
all tables in the application. End of warning.
Prerequisites
Before updating the content.css file, you should back up the file.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
22 Customizing Ad Hoc Correspondence
Customizing the applications
Since the heading row differs from the other table rows, you must define two new
classes in the style sheet file – one class for the body rows and another class for
the heading row.
To use the CorpGreenHeading style, the end-user clicks in the heading row,
opens the Table row properties dialog box and selects the CorpGreenHeading
style. Now the table has the following layout:
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Customizing Correspondence Reviewer 23
Customizing the applications
Prerequisites
Before updating the reviewer.properties file, you should back up the file.
In this section
• Customizing columns in the documents list on page 24
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
24 Customizing Correspondence Reviewer
Customizing the applications
You can re-arrange or remove the default columns, and you can add new
columns with user defined metadata.
You customize the columns by editing the reviewer.properties file.
Restrictions
• The total number of columns must not exceed 30.
• The minimum width of each column is 150 pixels. If you add more columns
than fit in the web browser, the end-user must use the scroll-bar to see all
columns.
• The new columns are not available in the filter area for limiting searches.
Prerequisites
• If user defined metadata is used, the Message context must be enabled for
this metadata in Design Center. See Enabling the Message context for a
metadata in the Ad Hoc Correspondence and Correspondence Reviewer User
Guide.
• If the user defined metadata is not shared to all document types in the
Design Center Project, you must enable the service gateway to handle non-
strict validation. See To enable non-strict validation for the service gateway on
page 25.
• The GUIDs for the metadata must be available.
– The GUIDs for user defined metadata are available in the Design
Center resource set (select View > Export GUIDs in the Metadata Group
Editor).
– The GUIDs for predefined system metadata are available in the table
below.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Customizing Correspondence Reviewer 25
Customizing the applications
ID 6B84E18B-F03C-350C-E040-007F0200026D
TypeID 6B84E18B-F03F-350C-E040-007F0200026D
Note: We do not recommend you to add a column for
TypeID, since this will display the GUIDs for the
document types rather than the names.
Document type names are by default displayed
using the TypeName metadata below.
TypeName B818E360-E05F-4230-9113-BD610987337E
Name 6B84E18B-F03D-350C-E040-007F0200026D
Revision 6C8B0907-0646-2843-E040-007F02005164
CreationTime 6B84E18B-F047-350C-E040-007F0200026D
ModifyTime 6B84E18B-F048-350C-E040-007F0200026D
ExpiringTime 6B84E18B-F044-350C-E040-007F0200026D
State 6B84E18B-F042-350C-E040-007F0200026D
ServiceName 6B84E18B-F03E-350C-E040-007F0200026D
RuleName 5DCB3480-CE30-4B68-B26C-47081188FB8B
RuleID 6C8B0907-0647-2843-E040-007F02005164
Comment 6F6EEB26-252D-CCDB-E040-007F02007C09
ErrorCode 8D4625F5-40C5-4914-90FC-A013CC03FAF0
ErrorMessage BE2F42C9-5D5A-4AEF-A7F3-F5AC8710F94D
Error 5997CABE-3C8F-469B-A32E-AC1EEC9AD622
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
26 Customizing Correspondence Reviewer
Customizing the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
27
Parameters in URLs
A system administrator must configure the URLs used to access the Ad Hoc and
Reviewer applications. Apart from accessing applications, the URLs can also
contain other parameters. For example:
• For Ad Hoc Correspondence, forward parameters used when submitting
and closing documents.
• For the Correspondence Reviewer, parameters for filtering and sorting
document searches.
By using different parameters for different end-users, personalized settings can
be made in the URLs. For example, by filtering Reviewer searches, you can
prepare the document list for each end-user to display only the documents to be
reviewed by a specific end-user.
Note: In Correspondence Reviewer, the end-user can override the filtering and
sorting defined in the URL. This means that the end-user can further filter
the list or clear the filtering in order to access all documents.
In this section
• Accessing the SSSP application on page 28
• Accessing Ad Hoc Correspondence on page 29
• Accessing Correspondence Reviewer on page 32
Related topics
• Customizing the applications on page 15
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
28 Accessing the SSSP application
Accessing the applications
Batch scenario
In a batch scenario, the SSSP application is accessed from the Ad Hoc or the
Reviewer application. The URL to the SSSP application is set in the property files
for the applications, see Customizing the applications on page 15.
No further configuration to access the SSSP application is required for the batch
scenario.
Related topics
See the programming guide for the REST Service API included in the OpenText
StreamServe web service SDK (Software Development Kit) for information on
how to:
• Retrieve Ad-hoc-enabled document definitions from the runtime repository
and list them in the user interface of the hosting system.
• Develop the HTTP POST request that triggers the creation of a Message in
the Message storage based on a selected document definition and a selected
data source.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Accessing Ad Hoc Correspondence 29
Accessing the applications
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 on page 11.
• ?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 on page 30.
• &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 on page 30.
• &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.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
30 Accessing Ad Hoc Correspondence
Accessing the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Accessing Ad Hoc Correspondence 31
Accessing the applications
StoryTeller specifics
If a StoryTeller Process is used as template for a document definition you must
prepare the preview connector for inline styles. The default behavior for
StoryTeller is to reference a css file and not to use inline styles. To change to inline
styles you must edit the driver settings for the unpaginated preview connector.
What to edit depends on whether you have a custom or default preview
connector:
• Custom preview connector – set Inline CSS = Yes in the HTML unpaginated
driver settings.
• Default preview connector – edit defaultpreviewconnectors.xml in the
following directory:
<StreamServe
Installation>\Applications\StreamServer\<version>\Server\bin
To edit defaultpreviewconnectors.xml
1 Open defaultpreviewconnectors.xml in a text editor.
2 Locate the following section: <option name="Inline CSS">No</option>
3 Change to: <option name="Inline CSS">Yes</option>
4 Save the file and restart the StreamServer application for the changes to
take effect.
Limitations
• Inline editing is only applicable to unpaginated preview.
• Text and paragraph formatting is preserved when inline editing is enabled.
This means styles, font size, font color etc. cannot be modified when editing
inline texts.
• Inline editing is only supported for desktop browsers (Internet Explorer,
Firefox and Google Chrome) and not for tablet devices.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
32 Accessing Correspondence Reviewer
Accessing the applications
http://<Host>:<Port>/<Name>_reviewer/?domain=<Application
domain>&restore=true&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>_reviewer – Is the name of the Reviewer application, set by the
management gateway when deploying the web application. See Deployment
in Control Center on page 11.
• domain=<Application domain> – Is the application domain to be accessed.
This parameter is required if the Reviewer application is connected to
several application domains.
• restore=true – Is a parameter used to return the end-user to the same
view in Correspondence Reviewer after editing a document in Ad Hoc
Correspondence.
When an end-user chooses to edit a document in Correspondence Reviewer,
this parameter is automatically added to the URL. When the end-user closes
the document in Ad Hoc Correspondence, the end-user automatically
returns to the same view in Correspondence Reviewer.
Note: To return to the same view, the web browser must be configured to
allow cookies to be saved.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Accessing Correspondence Reviewer 33
Accessing the applications
You can filter and sort the searches in the URL to Correspondence Reviewer. By
using different URLs for different end-users, you can prepare the document list
so only documents specific to each end-user are displayed.
Note: In Correspondence Reviewer, the end-user can override the filtering and
sorting defined in the URL. This means that the end-user can further filter
the list or clear the filtering in order to access all documents.
http://<URL_Reviewer>?sortBy=<Parameter>&sortDir=<Direction>
&search={statements:[<Statement_1>,…,<Statement_n>]}
Where:
• <URL_Reviewer> – Is the URL to Correspondence Reviewer.
• <Parameter> – Is the parameter to filter and sort the searches by.
See Parameters on page 33.
• <Direction> – Is the direction to sort searches in.
See Sorting directions on page 34.
• [Statement_1,…,Statement_n] – Is an array of search statements.
See Search statements on page 35.
In the following example, documents created between the 12th of May and 20th
of October 2012 that are rejected, are listed in Correspondence Reviewer.
The documents are sorted in descending order by creation date, with the most
recent documents at in the top of the list.
http://<URL_Reviewer>?sortBy=CreationTime&sortDir=desc
&search={statements:[{attr:’State’, op:’eq’, val:’REJECTED’},
{attr:’CreationTime’, op:’range’, val:’05/12/2012..10/20/2012’}]}
Parameters
When filtering and sorting searches, you can use the parameters below
(predefined system metadata).
Parameter Description
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
34 Accessing Correspondence Reviewer
Accessing the applications
Parameter Description
Sorting directions
When sorting searches, you can use the following parameters:
Parameter Description
Note: You cannot apply sorting on the parameters Type and RuleID.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Accessing Correspondence Reviewer 35
Accessing the applications
Search statements
The syntax that is used in search statements is:
Where:
• <Parameter> – Is the parameter to search by. For example, ’State’.
See Parameters on page 33.
• <Operator> – Is one of the following operators used for comparison:
– ’eq’ – Equals (for exact match of <Parameter>).
– ’range’ – Range (when <Parameter> belongs to a range of values).
The operator can be used for dates and numbers. For example,
’10..20.55’ for numbers or ’01/20/2012..01/25/2012’ for dates.
• <Value> – Is the value <Parameter> is compared with. The value must
have the same format as <Parameter>. For example, ’REJECTED’.
Note: Since date formats are locale specific, you must use the locale for the
computer with the web browser. For example, for a computer with a
US locale, the date format must be ’MM/DD/YYYY’.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
36 Accessing Correspondence Reviewer
Accessing the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
37
This section contains information about the services and log files that are
monitored when running Ad Hoc Correspondence and Correspondence
Reviewer.
In this section
• Checking status of services on page 38
• Checking log files on page 39
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
38 Checking status of services
Monitoring the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Checking log files 39
Monitoring the applications
In this section
• Using the SSSP log file on page 40
• Enabling SOAP logging for the service gateway on page 41
• Disabling SOAP faults at missing metadata on page 42
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
40 Checking log files
Monitoring the applications
Related topics
For information about:
• The StreamServer and service gateway application logs in Control Center,
see the Control Center documentation.
• The StreamStudio log file, see the StreamStudio Administrator’s Guide.
The adhoc.log and reviewer.log files are found in the same directory
as the sssp.log file.
Since the Ad Hoc Correspondence and Correspondence Reviewer are
web clients, running in a web browser, these files only contain
information about errors occurring at start-up. For example, if an error
occurs the first time an Ad Hoc document is loaded, you may find
useful information here.
For detailed information, you should always check the sssp.log file.
End of tip.
Log levels
The SSSP log has four different levels for the severity of the content:
• ERROR – Displays severe errors.
• WARN – Displays non-fatal errors that might need investigation.
• INFO – Displays informational messages.
• DEBUG – Mainly for developers.
The settings can be changed in the log4j.properties file, located in the
following directory:
<Portal root>\sssp\WEB-INF
For example, for Apache Tomcat:
<TOMCAT_HOME>\webapps\sssp\WEB-INF
After changing the settings, you must restart the Java application server for the
changes to take effect.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Checking log files 41
Monitoring the applications
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
42 Checking log files
Monitoring the applications
If you do not consider missing metadata to be an error, you can disable SOAP
faults from being returned at missing metadata.
Related topics
• Filtering and sorting searches on page 32
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
43
In this section
• Server errors on page 44
• Formatting errors on page 45
• Delivery errors on page 46
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
44 Server errors
Handling errors when using the applications
Server errors
If the StreamServer application goes down after a Message has been paused, the
corresponding document cannot be opened in Ad Hoc Correspondence or
approved in Correspondence Reviewer.
Symptom
Ad Hoc Correspondence
A document cannot be previewed if the StreamServer application is down, which
means the end-user cannot open the document in Ad Hoc Correspondence. If the
StreamServer application goes down after a document was opened, the
document cannot be submitted. A web service error occurs and the end-user is
asked to contact the system administrator.
Correspondence Reviewer
If the end-user tries to approve a document in Correspondence Reviewer, a web
service error occurs and the end-user is asked to contact the system
administrator.
When the end-user refreshes the document list, the state of the document is
updated to Failed. On the Metadata tab, in the Comments field, the end-user
receives information on how to proceed. For example, that the approve operation
failed and the end-user should try again later.
Since the StreamServer application is down, no information about the error is
presented in the ErrorMessage field.
Solution
A system administrator must restart the StreamServer application.
When the StreamServer application is up and running, the end-user can open the
document in Ad Hoc Correspondence. A document that previously failed to be
submitted must be submitted by the end-user again.
In Correspondence Reviewer, the failed document is not automatically resent.
The document remains in the documents list (with processing state Failed) and
must be approved by the end-user again.
Note: StreamStudio Reporter cannot be used to resend failed documents from
the Message storage.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
Formatting errors 45
Handling errors when using the applications
Formatting errors
A formatting error occurs when the StreamServer application fails to format a
Message. The Message remains in the Message storage and the corresponding
document cannot be formatted or distributed to the customer.
Symptom
Ad Hoc Correspondence
Since no document can be previewed if the formatting fails, the end-user cannot
open the corresponding document in Ad Hoc Correspondence. A web service
error occurs and the end-user is asked to contact the system administrator.
Correspondence Reviewer
If the end-user tries to approve a document in Correspondence Reviewer, a web
service error occurs and the end-user is asked to contact the system
administrator.
When the end-user refreshes the document list, the state of the document is
updated to Failed. On the Metadata tab, error information from the StreamServer
application is presented in the ErrorCode and ErrorMessage fields.
Solution
A system administrator must consult the log files to find the cause of the error.
See Checking log files on page 39. The error must then be corrected.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C
46 Delivery errors
Handling errors when using the applications
Delivery errors
If an error occurs after a Message is formatted and delivered to the output queue
(and any retries configured for the output queue are exhausted), the job fails. For
example, if the delivery fails due to an email or FTP error. As a result, the
corresponding document is not delivered to the customer.
Symptom
Ad Hoc Correspondence
When the end-user submits the document in Ad Hoc Correspondence, the
document closes. The end-user is not informed about the failed job. The failed job
must be handled through the ordinary error handling as described below.
Correspondence Reviewer
When the end-user approves the document in Correspondence Reviewer, the
document is removed from the list in Corresponding Reviewer. The end-user is
not informed about the failed job. The failed job must be handled through the
ordinary error handling as described below.
Solution
As a system administrator, you must attend to failed jobs to ensure that the
documents are properly delivered to the customers.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide Rev C