Professional Documents
Culture Documents
OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide
OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide
OpenText StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide
2
Ad Hoc Correspondence and
Correspondence Reviewer
User Guide
Rev B
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide
Rev B
Open Text SA
40 Avenue Monterey, Luxembourg, Luxembourg L-2163
Tel: +352 264566-1
Copyright ©2014 Open Text SA and/or Open Text ULC. All Rights Reserved.
Open Text is a trademark or registered trademark of Open Text SA and/or Open Text ULC. The list of trademarks is not
exhaustive of other trademarks, registered trademarks, product names, company names, brands and service names
mentioned herein are property of Open Text SA and/or Open Text ULC or other respective owners.
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 User Guide Rev B
4
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
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 Composition Center.
A typical Ad Hoc user is a business user at a department with frequent customer
interaction that requires documents to be created on an unplanned basis. For
example, a business user at a bank, at a call center, or in a claims department.
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.
An example of a Reviewer user is a business manager at a department with
frequent customer interaction. The business manager can review customer
correspondence and approve or reject the documents involved.
In this section
• Scenarios on page 6
• Technical overview on page 11
• User documentation on page 14
• Implementation and configuration tasks on page 15
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
6 Scenarios
About Ad Hoc Correspondence and Correspondence Reviewer
Scenarios
There are two main business scenarios for Ad Hoc Correspondence and
Correspondence Reviewer – the on-demand scenario and the batch scenario.
In both scenarios, the web applications are integrated into the business workflow
of the customer. The final documents are formatted and distributed by a
StreamServer application according to the configuration made in Design Center.
On-demand scenario
In Ad Hoc Correspondence, a new personalized document is created for a
specific customer. Correspondence Reviewer can be used to review the document
before it is formatted and distributed to the customer.
Batch scenario
A document is created from a batch of input data sent to a StreamServer
application. In Correspondence Reviewer, the document is reviewed before it is
formatted and distributed to the customer. Ad Hoc Correspondence can be used
to edit the document before it is approved.
In this section
• On-demand scenario – Creating a letter on page 7
• On-demand scenario – Reviewing the letter on page 8
• Batch scenario – Reviewing an invoice on page 9
• Batch scenario – Editing the invoice on page 10
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Scenarios 7
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
8 Scenarios
About Ad Hoc Correspondence and Correspondence Reviewer
Note: Any notifications mentioned in this scenario (for example, about a letter
being ready for review) are handled within the business workflow of the
company, using the OpenText StreamServe Notifications SDK (Software
Development Kit).
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Scenarios 9
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
10 Scenarios
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Technical overview 11
About Ad Hoc Correspondence and Correspondence Reviewer
Technical overview
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
12 Technical overview
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Technical overview 13
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
14 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 User Guide Rev B
Implementation and configuration tasks 15
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
16 Implementation and configuration tasks
About Ad Hoc Correspondence and Correspondence Reviewer
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
17
This section includes information on how to configure a Design Center Project for
Ad Hoc Correspondence and Correspondence Reviewer.
The procedures apply to the Ad Hoc and Reviewer applications, as well as to
customized web applications developed using the OpenText StreamServe web
service SDK.
Prerequisites
• An existing Design Center Project, including at least one document type.
• For Ad Hoc Correspondence, the Project must include at least one Template
Engine or StoryTeller Process that is Composition Center enabled.
Notes
• Document definitions based on PageOUT Processes cannot be used with
Ad Hoc Correspondence.
• Document definitions based on StoryTeller and Template Engine cannot be
mixed in the same Ad Hoc document.
In this section
• Resource set configuration on page 18
• Runtime configuration on page 25
• Platform configuration on page 27
Related topics
• Composition Center configurations for Ad Hoc Correspondence on page 33
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
18 Resource set configuration
Design Center configurations
In this section
• Enabling the Message context for a metadata on page 19
• Configuring exception rules on page 20
• Importing fonts to be used in the Ad Hoc text editor on page 24
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Resource set configuration 19
Design Center configurations
Exception
Metadata used in editable or available texts in Ad Hoc Correspondence does not
require the Message context. In the Ad Hoc application, the end-user can edit text
strings containing metadata values, but cannot change the actual metadata
values in the Message storage.
Prerequisites
The metadata is added to a document type in a resource set connected to the
Runtime configuration and is assigned a value.
Note: To save space in the repositories and improve search performance, you
should not add more metadata than required, and you should not use the
Message context unless the metadata really needs to be available.
Related topics
• Document type contexts in the Document types and metadata documentation
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
20 Resource set configuration
Design Center configurations
Exception
When creating a new document in Ad Hoc Correspondence (the on-demand
scenario), the corresponding Message is automatically paused and no exception
rule is required. However, to review the document in Correspondence Reviewer,
an exception rule is still required. If the exception rule is fulfilled, the document
is displayed in Correspondence Reviewer.
Post requisites
When a rule resource is configured, you must select the resource in the Runtime
configuration. If you select several rule resources in the Runtime configuration,
the exception rules are evaluated, one by one, until one rule is fulfilled or all rules
are evaluated. The first rule that is fulfilled is displayed in Correspondence
Reviewer as the reason for review.
In this section
• Adding a rule resource on page 21
• Configuring a rule function on page 22
Related topics
• Service-enabling a Message on page 25
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Resource set configuration 21
Design Center configurations
Figure 7 The rule resource name and the reason for review
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
22 Resource set configuration
Design Center configurations
Prerequisites
• The rule resource is added to a resource set connected to the Runtime
configuration.
• The metadata is added to the document type, and the Message context is
enabled for the metadata.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Resource set configuration 23
Design Center configurations
In this example, an exception rule pauses all documents with the value YOUNG for
the metadata CATEGORY. The documents can then be reviewed in Correspondence
Reviewer. Documents for other values for CATEGORY are formatted and
distributed to the output destination without being paused.
In the resource set, a new rule resource called Category is YOUNG.xml is
created. The name (Category is YOUNG) is exposed as the reason for review in
Correspondence Reviewer.
In the Rule Editor, the rule function below is created.
Note: To protect the exception rule from future changes to the metadata name,
the metadata GUID (a86199fd-5f5a-4e53-a3af-47c72ae6321f ) is used
instead of the metadata name (CATEGORY).
$Category = GetMetaDataMessage("a86199fd-5f5a-4e53-a3af-
47c72ae6321f");
if ($Category == "YOUNG")
return "true";
else
return "false";
Related topics
• Enabling the Message context for a metadata on page 19
• GetMetaDataMessage in the Scripting Reference
• IsDocDefAvailable in the Scripting Reference
• AbortMessageOnMissingDocDef in the Scripting Reference
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
24 Resource set configuration
Design Center configurations
Note: Arial Italic is also used outside the Ad Hoc text editor, in the
placeholder Drag text fragment here. This placeholder is used in
empty sections, which are configured in StoryTeller but not filled
with content in Composition Center.
To import a font
1 In Design Center, open a resource set connected to the Platform.
2 Right-click the resource set, and select Import Font. The Select Fonts dialog
box opens.
3 Specify the font to import, and click OK. The new resource is added to the
resource set.
Related topics
• Adding fonts to the Ad Hoc text editor in the Ad Hoc Correspondence and
Correspondence Reviewer Administrator’s Guide
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Runtime configuration 25
Design Center configurations
Runtime configuration
Web services are used to create, preview and release documents based on the
Runtime configuration.
To make this possible, you must enable the corresponding Messages in the
Message storage to be invoked through service requests. These settings are made
in the Runtime configuration.
In this section
• Service-enabling a Message on page 25
Service-enabling a Message
In the Runtime configuration, you must enable the Messages in the Message
storage to be invoked through service requests.
Prerequisites
An exception rule is configured.
Note: If you exclusively create new documents in Ad Hoc Correspondence (the
on-demand scenario), no exception rule is required.
To service-enable a Message
1 In Design Center, open the Runtime configuration.
2 Right-click the Message and select Settings.
3 In the Runtime Message Settings dialog box, select the Service tab.
4 Select Service to service enable the Message.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
26 Runtime configuration
Design Center configurations
5 In the Enable service support for content types area, disable the preview
formats not to be available in Composition Center. For more information,
see Service-enabling the Message in the Composition Center documentation.
6 If you do not intend to use automatically created preview output
connectors, clear Use default preview connector.
7 In the Service name text box, enter a descriptive name for the service.
The name must be unique within the application domain.
8 Select the Rule resource for the exception rule.
• If you select several rule resources, the exception rules are evaluated,
one by one, until one rule is fulfilled or all rules are evaluated. The first
rule that is fulfilled is displayed in Correspondence Reviewer as the
reason for review.
• If you exclusively create new documents in Ad Hoc Correspondence,
you can leave the Rule option clear.
9 Optional – From the Base service input connector on drop-down list, select
an existing input connector in the Platform configuration from which the
service input connectors used at create requests inherit some settings.
10 Click OK.
Related topics
• Using default preview output connectors on page 28
• Configuring preview output connectors manually on page 29
• For a complete description of all the options in the dialog box, see Runtime
Message Settings dialog box in the Design Center documentation.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Platform configuration 27
Design Center configurations
Platform configuration
Preview output connector configuration
When displaying documents in web applications, preview output connectors are
used. If certain prerequisites are fulfilled, you can use default preview
connectors, which are automatically created and selected at preview service
requests. If the prerequisites are not fulfilled, you must manually create and
select the preview connectors.
In this section
• Using default preview output connectors on page 28
• Configuring preview output connectors manually on page 29
• Configuring input and output queues on page 32
• Configuring an expiry time for documents on page 32
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
28 Platform configuration
Design Center configurations
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Platform configuration 29
Design Center configurations
Compression LZW
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
30 Platform configuration
Design Center configurations
GetRequestedPreview This function is only available for preview calls from web
ContentType() service clients.
Returns a string containing an optionally requested
content type for a response to a preview request. The
returned value can be used to select an appropriate
connector for the preview Process.
The applications requires the following content types:
• Ad Hoc Correspondence – image/tiff
• Correspondence Reviewer – application/pdf
• Composition Center:
– For print preview – application/pdf
– For email/web preview – text/html
Example 2 Selecting output connector depending on type of preview and content type
A company wants to use settings other than the ones used by the default preview
output connectors, which means they must manually create and select the
preview connectors.
The company also wants to use different driver options for the previews in
Correspondence Reviewer and in Composition Center.
The Design Center Platform includes the following output connectors in the
production layer:
• PreviewAdHoc – For the TIFF preview in Ad Hoc Correspondence.
• PreviewReviewer – For the PDF preview in Correspondence Reviewer.
• PreviewCompC – For the PDF preview in Composition Center.
• FileOUT – For the final release of the document.
In the runtime configuration, the Message is service-enabled, and the
Use default preview connector option is cleared.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Platform configuration 31
Design Center configurations
The script below is run before the Process and selects the output connector that is
used.
if (IsPreview())
{
$ContentType = GetRequestedPreviewContentType();
if (GetPreviewTypeEx() == 1)
{
if ($ContentType == "image/tiff")
{
$connector = "PreviewAdHoc";
}
else if ($ContentType == "application/pdf")
{
$connector = "PreviewRviewer";
}
}
else if (GetPreviewTypeEx() == 4)
{
$connector = "PreviewCompC";
}
}
else
{
$connector = "FileOUT";
}
preproclog(0, " **** OUTCONNECTOR : " +$connector);
Related topics
• Creating output connectors for document previews (optional) in the Composition
Center documentation
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
32 Platform configuration
Design Center configurations
To configure queues
You configure input and output queues in the Manage Queues dialog box in the
Platform configuration.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
33
In this section
• Selecting the appropriate process type on page 34
• Managing texts to be administered in Ad Hoc Correspondence on page 35
• Attaching stories to a document definition on page 40
• Applying rules to document definitions on page 41
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
34 Selecting the appropriate process type
Composition Center configurations for Ad Hoc Correspondence
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Managing texts to be administered in Ad Hoc Correspondence 35
Composition Center configurations for Ad Hoc Correspondence
In this section
• Making a text editable in Ad Hoc Correspondence on page 35
• Attaching text fragments to a document definition on page 35
• Categorizing text fragments on page 36
• Write protecting text attachments on page 39
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
36 Managing texts to be administered in Ad Hoc Correspondence
Composition Center configurations for Ad Hoc Correspondence
Create new category The new category is added to the category filter in
Ad Hoc Correspondence when it is assigned to a
text.
Rename category The category is renamed in the category filter in
Ad Hoc Correspondence.
Delete category The category is removed from the category filter in
Ad Hoc Correspondence.
Assign category to text The category filter in Ad Hoc Correspondence is
updated with the new category/text reference.
Remove category from text The category/text reference is removed from the
category filter in Ad Hoc Correspondence.
In this section
• Adding, renaming and deleting categories on page 37
• Assigning categories to text fragments on page 37
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Managing texts to be administered in Ad Hoc Correspondence 37
Composition Center configurations for Ad Hoc Correspondence
To rename a category
1 In the Manage Categories dialog box, select the category and click Rename.
2 Enter a new name for the category and click OK.
To delete a category
1 In the Manage Categories dialog box, select the category and click Delete.
2 Click OK to confirm.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
38 Managing texts to be administered in Ad Hoc Correspondence
Composition Center configurations for Ad Hoc Correspondence
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Managing texts to be administered in Ad Hoc Correspondence 39
Composition Center configurations for Ad Hoc Correspondence
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
40 Attaching stories to a document definition
Composition Center configurations for Ad Hoc Correspondence
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Applying rules to document definitions 41
Composition Center configurations for Ad Hoc Correspondence
Notes
• Document definitions based on different Process types, e.g. StoryTeller and
Template Engine, cannot be mixed in the same Ad Hoc document.
• Unpaginated documents may only contain one document definition.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
42 Applying rules to document definitions
Composition Center configurations for Ad Hoc Correspondence
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
43
In this section
• Service versioning concept on page 44
• Redeploying the existing version of the Project on page 45
• Deploying a new version of the Project on page 47
Related topics
• For detailed information about how different Project modifications affect
published Composition Center document definitions, see Modifying the
Design Center Project in the Composition Center documentation.
• For more information about services and service versioning scenarios, see
the OpenText StreamServe Service Versioning Guidelines, available at
OpenText Knowledge Center.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
44 Service versioning concept
Modifying the Design Center Project
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Redeploying the existing version of the Project 45
Modifying the Design Center Project
Note: Not all Project changes can be applied to paused Messages. For example,
if you add a new section to the StoryTeller template, this section will not
be rendered in paused Messages.
Note: Some updates are always reflected when applying Project changes to
paused Messages. For example, if you remove a section from the
StoryTeller template, this section will no longer be rendered in paused
Messages.
Do not modify the Service name in the Runtime Message settings dialog
box and redeploy the Project to the same StreamServer application.
If the Service name is modified, you can no longer preview and release
the paused documents in the Ad Hoc and Reviewer applications. End of
warning
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
46 Redeploying the existing version of the Project
Modifying the Design Center Project
• If you add a field, the paused Messages are not affected. However, if you
add the new field to the StoryTeller document, the field will be empty in the
paused Messages.
If you delete or rename a field used in StoryTeller, you must open and
update the StoryTeller document accordingly. If not, the output
documents will be corrupt. End of warning
Note: If you concatenate several Events, you cannot do any Event changes
without creating a new version of the Project and thereby increase the
StoryTeller template version.
Related topics
For information about Project modifications resulting in an updated StoryTeller
template version, see Modifications and template versions in the Composition Center
documentation.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
Deploying a new version of the Project 47
Modifying the Design Center Project
Note: If both the original and the new StreamServer applications scan the same
folder for input data, we recommend that you disable the input
connectors for the original StreamServer application. For more
information, see the Control Center documentation.
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B
48 Deploying a new version of the Project
Modifying the Design Center Project
OpenText™ StreamServe 5.6.2 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B