StreamServe Persuasion SP5 Ad Hoc Correspondence and Correspondence Reviewer

Transcription

1 StreamServe Persuasion SP5 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B

2 StreamServe Persuasion SP5 Ad Hoc Correspondence and Correspondence Reviewer User Guide Rev B STREAMSERVE, INC. ALL RIGHTS RESERVED United States patent #7,127,520 No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of StreamServe, Inc. Information in this document is subject to change without notice. StreamServe Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. All registered names, product names and trademarks of other companies mentioned in this documentation are used for identification purposes only and are acknowledged as property of the respective company. Companies, names and data used in examples in this document are fictitious unless otherwise noted. StreamServe, Inc. offers no guarantees and assumes no responsibility or liability of any type with respect to third party products and services, including any liability resulting from incompatibility between the third party products and services and the products and services offered by StreamServe, Inc. By using StreamServe and the third party products mentioned in this document, you agree that you will not hold StreamServe, Inc. responsible or liable with respect to the third party products and services or seek to do so. The trademarks, logos, and service marks in this document are the property of StreamServe, Inc. or other third parties. You are not permitted to use the marks without the prior written consent of StreamServe, Inc. or the third party that owns the marks. Use of the StreamServe product with third party products not mentioned in this document is entirely at your own risk, also as regards the StreamServe products. StreamServe Web Site

3 Contents 3 About Ad Hoc Correspondence and Correspondence Reviewer... 5 Scenarios...6 On-demand scenario Creating a letter... 7 On-demand scenario Reviewing the letter... 8 Batch scenario Reviewing an invoice... 9 Batch scenario Editing the invoice Technical overview...11 Processing states in the Message storage User documentation...14 Implementation and configuration tasks...15 Design Center configurations Resource set configuration...19 Enabling the Message context for a metadata Configuring exception rules Adding a rule resource Configuring a rule function Importing fonts to be used in the Ad Hoc text editor Runtime configuration...26 Service-enabling a Message Platform configuration...28 Using default preview output connectors Configuring preview output connectors manually Creating preview output connectors Selecting preview output connectors Configuring input and output queues Configuring an expiry time for documents Composition Center configurations for Ad Hoc Correspondence Enabling a document definition for Ad Hoc Correspondence...36 Making a text editable...38 Making a text available...39 Setting rules for document definitions...40 Using Ad Hoc Correspondence Ad Hoc Correspondence user interface...42 Ad Hoc Correspondence procedures...44 Editing a text Using tables in a text Modifying tables Merging and splitting table cells in the same row Applying predefined styles Table icons and dialog boxes Inserting a text Deleting a text Closing a document Submitting a document... 55

4 4 Using Correspondence Reviewer Correspondence Reviewer user interface Correspondence Reviewer procedures Filtering and sorting documents Filtering documents Sorting documents Viewing metadata for a document Previewing a document Rejecting a document Editing a document Deleting a document Approving a document... 65

5 5 About Ad Hoc Correspondence and Correspondence Reviewer Ad Hoc Correspondence and Correspondence Reviewer are included in the StreamServe Correspondence Management solution. These two web applications are plug-ins, integrated into an existing business workflow to enhance its correspondence capabilities. For example, an SAP document collaboration workflow. The business workflow owns the correspondence process and invokes the web applications using web service calls. 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. 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.

6 6 Scenarios About Ad Hoc Correspondence and Correspondence Reviewer Scenarios Two main business scenarios are available 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 configurations 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. One end-user at a time The Ad Hoc and Reviewer applications support one end-user at a time accessing a specific document. 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.

7 Scenarios 7 About Ad Hoc Correspondence and Correspondence Reviewer On-demand scenario Creating a letter A call center company has integrated Ad Hoc Correspondence into the business workflow. The letter is created in Ad Hoc Correspondence Liza, who works at a call center company, receives a call from a customer with a complaint. As a standard procedure, a letter is sent to the customer. In her call center application, Liza selects the name of the customer and a letter template. A pre-filled, pre-formatted letter with mandatory texts, logotypes, etc, opens in Ad Hoc Correspondence. Liza modifies some texts and adds a personal note stating the arrangement she and the customer agreed upon. The letter is submitted in Ad Hoc Correspondence When Liza has completed the letter, she submits it for distribution. A final letter is formatted and distributed to the customer. Figure 1 On-demand scenario If Correspondence Reviewer is integrated into the business workflow, the document can be reviewed before it is formatted and distributed. See On-demand scenario Reviewing the letter.

8 8 Scenarios About Ad Hoc Correspondence and Correspondence Reviewer On-demand scenario Reviewing the letter This scenario is an extension of the On-demand scenario Creating a letter scenario. The company has integrated both the Ad Hoc and Reviewer applications into the business workflow. When Liza submits a letter from Ad Hoc Correspondence and the addressee is a not a premium customer, the letter is formatted and distributed to the customer. The letter is reviewed in Correspondence Reviewer However, if the letter submitted by Liza is intended for a premium customer, the letter is paused before being formatted and distributed. Carl is the business manager at the call center. When a letter is paused, Carl is notified. Carl opens Correspondence Reviewer in his call center application. In Correspondence Reviewer, a list with documents awaiting approval is updated with Liza s letter. Carl reviews the letter and has some comments regarding the personal note. He rejects the letter and adds a comment about the changes that should be made. The letter is edited in Ad Hoc Correspondence Liza re-opens the letter in Ad Hoc Correspondence and updates the personal note before she once again submits the letter. The letter is approved in Correspondence Reviewer Carl reviews the updated letter. He is pleased with the results and approves the letter. The processing is resumed and a final letter is formatted and distributed to the customer. Figure 2 On-demand scenario with reviewing 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, outside the StreamServe software.

9 Scenarios 9 About Ad Hoc Correspondence and Correspondence Reviewer Batch scenario Reviewing an invoice A manufacturing company has integrated Correspondence Reviewer into the business workflow. The company uses the StreamServe software to create invoices. If the invoice amount is lower than $ , invoices are automatically formatted and distributed to the customer. The invoice is reviewed in Correspondence Reviewer However, if the amount exceeds $ , the invoice is paused before being formatted and distributed. Steve, who is the CFO (Chief Financial Officer) of the manufacturing company, opens Correspondence Reviewer from his business application. In Correspondence Reviewer, the invoice is added to the list of documents awaiting approval. Steve reviews the invoice and double-checks that the invoice amount corresponds to the goods actually delivered to the customer. The invoice is approved in Correspondence Reviewer Since the invoice amount is correct, Steve approves the invoice. The processing is resumed and a final invoice is formatted and distributed to the customer. If the invoice amount would have been incorrect, Steve would have to delete the invoice in Correspondence Reviewer and adjust the input data in the business application. The corrected input data is once again sent to the StreamServer application, now creating the correct invoice. Figure 3 Batch scenario If Ad Hoc Correspondence is integrated into the business workflow, Steve can edit the invoice before he approves it. See Batch scenario Editing the invoice.

10 10 Scenarios About Ad Hoc Correspondence and Correspondence Reviewer Batch scenario Editing the invoice This scenario is an extension of the Batch scenario Reviewing an invoice scenario. The manufacturing company has integrated both the Ad Hoc and Reviewer applications into the business workflow. When Steve has reviewed the paused invoice, he can edit the invoice before he approves it. For example, he can add a personal greeting to the customer or adjust an incorrect value. The invoice is edited in Ad Hoc Correspondence In Correspondence Reviewer, Steve chooses to edit the invoice. The invoice opens in Ad Hoc Correspondence where Steve edits the invoice. When the invoice is completed, Steve closes the invoice. Correspondence Reviewer automatically re-opens. The invoice is approved in Correspondence Reviewer In Correspondence Reviewer, Steve finally approves the invoice. The processing is resumed and a final invoice is formatted and distributed to the customer. Figure 4 Batch scenario with editing

11 Technical overview 11 About Ad Hoc Correspondence and Correspondence Reviewer Technical overview Figure 5 Overview, components and connections Client Server solution Ad Hoc Correspondence and Correspondence Reviewer are web clients, making web service requests to an SSSP (StreamServe Service Provider) application. The SSSP application is the server part of the solution, containing all business logic. The communication between the web clients and the SSSP application is made via a web service API that conforms to the Representational State Transfer constraints (REST API). The SSSP application accesses the runtime repository using web services, hosted by the service gateway. The communication between the SSSP application and the service gateway goes through a web service API (WS API). Documents are StreamServe Messages A document displayed in the Ad Hoc or Reviewer application is actually a StreamServe Message, paused by an exception rule before being formatted and distributed. A paused Message is stored in a Message storage in the runtime repository. In the storage, each Message is identified by a unique Message ID. When displaying a document, the Message ID is used to identify and retrieve the corresponding Message from the storage. User interface in hosting system The Ad Hoc, Reviewer, and SSSP applications are accessed from a user interface in the hosting system. For example, a user interface in a business application or a CRM (Customer Relationship Management) system.

12 12 Technical overview About Ad Hoc Correspondence and Correspondence Reviewer Processing states in the Message storage The Messages in the Message storage in the runtime repository can have different processing states. Processing states control how and when the corresponding documents are processed. For example, if the processing state is Waiting, the document remains in the Message storage. If the processing state is Approved, the document is ready to be released. The processing state also controls which documents are available in a web application. For example, in Correspondence Reviewer, documents with the processing states Submitted, Rejected and Failed are available. The processing states below are available. See also Figure 6 on page 13. Processing state Waiting Submitted Rejected Approved Description A draft version of the document is under development in Ad Hoc Correspondence and has yet not been paused by an exception rule. A document, submitted in Ad Hoc Correspondence or created from a batch of input data, has been paused by an exception rule. The document is ready for approval and must be attended to in Correspondence Reviewer. If the document is submitted in Ad Hoc Correspondence but is not paused, the document is formatted and distributed according to the Design Center configuration. The processing state is then set to Released. If the document is re-opened for editing in Ad Hoc Correspondence after being paused by an exception rule, the state remains Submitted. The document has been rejected in Correspondence Reviewer. After being rejected, the document can be edited, deleted, or approved. If the document is opened for editing in Ad Hoc Correspondence after being rejected, the state remains Rejected. The document has been approved in Correspondence Reviewer. After being approved, the document is formatted and distributed according to the Design Center configuration. Any exception rules are not re-evaluated.

13 Technical overview 13 About Ad Hoc Correspondence and Correspondence Reviewer Processing state Released Failed Description The document has been delivered to the output connector. After the document is released, the corresponding Message is ready to be deleted, and an expiry time is set. At the expiry time, the Message and all its related resources and metadata are deleted from the Message storage. The release of an approved document failed due to an error. After the error has been attended to, the document must once again be approved in Correspondence Reviewer. Figure 6 Processing state (on-demand scenario with review)

14 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. Ad Hoc Correspondence and Correspondence Reviewer Administrator s Guide The administrator s guide describes how to install, deploy and access the Ad Hoc and Reviewer applications. You also find information on how to customize the applications. The administrator s guide is intended for developers, such as StreamServe consultants. The guide also contains information for system administrators and programmers at the customer. Programming Guides for the StreamServe Persuasion SDK StreamServe provides an SDK (Software Development Kit), which includes programming guides for the Web Service API and the REST Service API. Using the SDK, programmers can integrate Ad Hoc and Reviewer applications into the business workflow of the company. Programmers can also develop their own customized web applications. The required configurations in Design Center and Composition Center described in the Ad Hoc Correspondence and Correspondence Reviewer User Guide above also apply for customized web applications developed using the StreamServe Persuasion SDK.

15 Implementation and configuration tasks 15 About Ad Hoc Correspondence and Correspondence Reviewer Implementation and configuration tasks This section gives an overview of the tasks to implement, configure and use Ad Hoc Correspondence and Correspondence Reviewer. The steps 4 and 5 also apply to customized web applications developed using the SDK for Correspondence Management. Ad Hoc Correspondence and Correspondence Reviewer tasks 1 Install and deploy the Ad Hoc and Reviewer applications. See the Ad Hoc Correspondence and Correspondence Reviewer Administrator s Guide. 2 Customize the Ad Hoc and Reviewer applications (optional). See the Ad Hoc Correspondence and Correspondence Reviewer Administrator s Guide. 3 Access the Ad Hoc and Reviewer applications. See the Ad Hoc Correspondence and Correspondence Reviewer Administrator s Guide. 4 Configure the Project in Design Center. See Design Center configurations on page Configure document definitions in StreamStudio Composition Center. See Composition Center configurations for Ad Hoc Correspondence on page Use the Ad Hoc and Reviewer applications to create and quality assure customer correspondence. See: Using Ad Hoc Correspondence on page 41. Using Correspondence Reviewer on page 57.

16 16 Implementation and configuration tasks About Ad Hoc Correspondence and Correspondence Reviewer

17 17 Design Center configurations 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 StreamServe Persuasion SDK. warning Editing deployed Projects If you edit an already deployed Project, the updates are applied to any paused Messages in the Message storage. For example, if you edit the layout of the StoryTeller template after a few Messages have been paused, the new layout is applied to these paused Messages. Some updates may corrupt already paused Messages. For example, if an update results in an unpublished document definition in Composition Center, the following paused Messages will be corrupt: Messages where the corresponding documents are created in Ad Hoc Correspondence (the on-demand scenario). Messages where the corresponding documents are created from a batch of input data (the batch scenario) and the documents have been edited in Ad Hoc Correspondence. To achieve full control over the layout and behavior, you should ensure that the Message storage is empty before redeploying a Project either by letting the jobs complete or by manually emptying the storage. You can examine, empty and drop Message storages using Database Administration Tool. End of warning. Prerequisites An existing Design Center Project, including at least one document type. You can use a template, provided by StreamServe, to create a basic Project. For more information, see the Design Center documentation. For Ad Hoc Correspondence, the Project must include at least one Composition Center enabled StoryTeller Process. The StoryTeller Processes must include at least one section. Note: If a section is configured in StoryTeller but not filled with content in Composition Center, this section is empty in Ad Hoc Correspondence. For best performance, you should not use more empty sections than required.

18 18 Design Center configurations Post requisites Before a document definition can be used as a template in Ad Hoc Correspondence, some configurations must be carried out in StreamStudio Composition Center. In this section Resource set configuration on page 19. Runtime configuration on page 26. Platform configuration on page 28. Related topics Composition Center configurations for Ad Hoc Correspondence on page 35.

19 Resource set configuration 19 Design Center configurations Resource set configuration To use Ad Hoc Correspondence and Correspondence Reviewer, you must prepare certain resources in the resource sets connected to the Runtime and the Platform configurations. Runtime configuration resource set In a resource set connected to the Runtime configuration, you must enable the Message context for any metadata to be available to the web applications. For example, to enable Correspondence Reviewer to display a metadata as a document detail, the metadata must have the Message context. In a resource set connected to the Runtime configuration, you must also configure the exception rules that pause the Messages that are displayed as documents in the web applications. Platform resource set In a resource set connected to the Platform, you must import any fonts that are available in the text editor in Ad Hoc Correspondence, but are not included in the Project configuration. In this section Enabling the Message context for a metadata on page 20. Configuring exception rules on page 21. Importing fonts to be used in the Ad Hoc text editor on page 25.

20 20 Resource set configuration Design Center configurations Enabling the Message context for a metadata A metadata that you define in Design Center is not automatically available to the web applications. To make a metadata available, for example as a document detail in Correspondence Reviewer, you must enable the Message context for the metadata. You must also enable the Message context for any metadata to be used in exception rules. You configure metadata contexts in the Document Type Editor. warning If you disable the Message context in a Project that is deployed, the database column for the context remains in the Message storage in the runtime repository, but is no longer considered by the StreamServer application. Since the database column is still available to the web application, it is recommended to drop the Message storage to avoid any conflicts. For example, by using StreamServe Database Administration Tool. End of warning. 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. To make metadata available 1 In Design Center, open a resource set connected to the Runtime configuration. 2 Double-click the document type. The Document Type Editor opens. 3 From the drop-down list, select the Message context. 4 In the Metadata groups list, select the metadata group. 5 In the Value assignments list, select the metadata to be made available. 6 Select File > Save to save the document type. Related topics Document type contexts in the Document types and metadata documentation.

21 Resource set configuration 21 Design Center configurations Configuring exception rules To display a document in Correspondence Reviewer, the corresponding Message must be paused. A Message is paused when certain conditions are fulfilled. These conditions are specified in exception rules, which are executed directly after any retrieved scripts. 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. Rule resources, rule functions and exception rules In Design Center, you must add a rule resource to a resource set connected to the Runtime configuration. In the Rule editor, you create a rule function using the StreamServe script syntax. When you export the Project, the rule function turns into an exception rule. 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 22. Configuring a rule function on page 23. Related topics Service-enabling a Message on page 26.

22 22 Resource set configuration Design Center configurations Adding a rule resource In Design Center, you must add a rule resource to a resource set connected to the Runtime configuration. You must give the rule resource a unique and descriptive name. In Correspondence Reviewer, the name is exposed as the reason for review. Figure 7 The rule resource name and the reason for review warning If you update the name of a rule resource in a Project that is deployed, the reason for review is updated for all documents for which the corresponding Messages have been paused by the exception rule. You must refresh the web browser for the changes to take effect. Depending on web browser, you may have to clear the browser cache before refreshing. End of warning. To add a rule resource 1 In Design Center, open a resource set connected to the Runtime configuration. 2 Right-click in the resource set and select New > Rule. A new rule resource is added to the resource set. 3 Give the rule resource a unique and descriptive name.

23 Resource set configuration 23 Design Center configurations Configuring a rule function When you configure a rule function, you use the StreamServe script syntax to set up conditions. Depending on metadata values, the conditions are either true or false. Note: Since field variables may not be available when an exception rule is evaluated, you cannot use field variables in the rule function. warning If you update a rule function in an already deployed Project, the corresponding exception rule is updated. Next time the StreamServer application evaluates (or re-evaluates) the exception rule, the updated rule is used. End of warning. GetMetaDataMessage You must retrieve the metadata values using the GetMetaDataMessage scripting function. By using the scripting function instead of referring directly to the metadata, any external changes made to the metadata are also considered. For example, changes made by a customized web application, developed using the StreamServe Persuasion SDK. See Example 1 on page 24. 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. To configure a rule function 1 In the resource set, double-click the rule resource. The Rule Editor opens. 2 Replace MyEvalFunc with a unique name for the rule function. Note: Do not use white spaces in the function name. 3 Enter the rule function in the rule view. 4 Click Check Syntax to check the rule syntax. 5 Select File > Save to save the rule function. 6 Click OK to close the Rule Editor.

24 24 Resource set configuration Design Center configurations Example 1 Using GetMetaDataMessage in a rule function 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"; End of example. Related topics GetMetaDataMessage in the Scripting Reference. Enabling the Message context for a metadata on page 20.

25 Resource set configuration 25 Design Center configurations Importing fonts to be used in the Ad Hoc text editor All fonts used in the text editor in Ad Hoc Correspondence must be available to the StreamServer application that formats and distributes the document. When the Design Center Project is exported, all fonts used within the Project are automatically included in the export file and available to the StreamServer application. If a font is available in the Ad Hoc text editor, but not used in the Project, you must import this font to a resource set connected to the Platform. Default fonts in the text editor By default, the following fonts are available in the Ad Hoc text editor and must be available to the StreamServer application: Arial Regular, Bold, Italic, and Bold Italic. If no font is selected in the Ad Hoc text editor, Arial is used by default. 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. Courier New Regular, Bold, Italic, and Bold Italic. Figure 8 Default fonts in the Ad Hoc text editor 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.

26 26 Runtime configuration 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 26. Service-enabling a Message In the Runtime configuration, you must enable the Messages in the Message storage to be invoked through service requests. When a Message is invoked through a preview service request, a preview output connector is used to display the corresponding document. You can either use default preview connectors, or manually create the preview connectors. 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 Service. The Service <Message name> dialog box opens. 3 Select Service. 4 If you do not intend to use automatically created preview output connectors, clear Use default preview connector. 5 In the Service name text box, enter a descriptive name for the service. The name must be unique within the application domain. 6 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. 7 Click OK.

27 Runtime configuration 27 Design Center configurations Related topics Using default preview output connectors on page 29. Configuring preview output connectors manually on page 30.

28 28 Platform configuration 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. Message storage configuration Paused Messages are stored in the Message storage in the runtime repository. To enable use of this storage, you must make sure that input and output queues are used in the Design Center Project. When a final document is distributed, the corresponding Message remains in the Message storage until an expiry time has elapsed. You enable and configure the expiry time in the Platform configuration. In this section Using default preview output connectors on page 29. Configuring preview output connectors manually on page 30. Configuring input and output queues on page 34. Configuring an expiry time for documents on page 34.

29 Platform configuration 29 Design Center configurations Using default preview output connectors Preview output connectors are used to display documents in web applications. The connectors must apply drivers that match the content types required by the calling applications. For example: Ad Hoc Correspondence image/tiff Correspondence Reviewer application/pdf Composition Center application/pdf About default preview connectors If certain prerequisites are fulfilled, you can use default preview connectors. The default preview connectors are automatically created and selected at preview service requests. They are not visible in Design Center. The connectors are pre-configured with certain settings (for compression, resolution, etc.) and use output mode Job. You cannot modify these settings. To use other settings, you must configure the preview output connectors manually. Prerequisites All preview connectors in the Project are default preview connectors. It is not possible to combine default preview connectors with manually configured preview connectors. The content types required by the calling applications are exclusively application/pdf and image/tiff. Note: If you use an XMLOUT or a StreamOUT Process, you can use default preview connectors regardless of content type. The Message is service-enabled. In the configuration where the Message is service-enabled, the Use default preview connector option is selected. Related topics Service-enabling a Message on page 26. Configuring preview output connectors manually on page 30.

30 30 Platform configuration Design Center configurations Configuring preview output connectors manually Preview output connectors are used to display documents in web applications. The connectors must apply drivers that match the content types required by the calling applications. For example: Ad Hoc Correspondence image/tiff Correspondence Reviewer application/pdf Composition Center application/pdf You can manually create and select the required preview output connectors. For example, if the prerequisites for default preview connectors are not fulfilled or if you want to use settings other than the pre-configured ones. In this section Creating preview output connectors on page 31. Selecting preview output connectors on page 32. Related topics Using default preview output connectors on page 29.

31 Platform configuration 31 Design Center configurations Creating preview output connectors This section describes how to create preview output connectors manually. If the same driver and settings are used for the preview as and when generating the final output, you can use the same output connector for preview and output. To use another driver or other settings, you must create a separate preview output connector. For example, an output connector of type NULL. Prerequisites All preview connectors in the Project are manually configured. It is not possible to combine default preview connectors with manually configured preview connectors. The Message is service-enabled. In the configuration where the Message is service-enabled, the Use default preview connector option is cleared. In the Platform configuration, output mode Job is selected. Post requisites The preview connectors must be selected at preview service requests. To create a preview output connector You create preview output connectors and configure the driver settings using standard procedures. Recommended driver settings The driver settings affect the performance of the service request responses. For PDF and TIFF drivers, StreamServe recommends the following values: PDF driver settings Use Compression Recommended value Yes TIFF driver settings Recommended value Compression Color Resolution LZW Index color 150 DPI (maximum) The resolution directly affects the document size and formatting speed, and thereby the performance. Related topics Service-enabling a Message on page 26. Selecting preview output connectors on page 32.

32 32 Platform configuration Design Center configurations Selecting preview output connectors Prerequisites The preview output connectors and the output connector for the final release are created. To select preview output connectors You can use the scripting functions below to decide if an invocation is a preview service request. If it is a preview service request, you can select the appropriate output connector depending on content type. See Example 2 on page 32. Scripting function IsPreview() GetPreviewType() GetRequestedPrevi ewcontenttype() Description Checks if the current job is a preview job. Returns a number, indicating whether a job is a preview job. If the job is a preview job, the number indicates from where the preview job is invoked. Only available for preview calls from Ad Hoc Correspondence, Correspondence Reviewer and Composition Center. 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. 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 Design Center Platform includes the following output connectors in the production layer: PreviewTIFF For the preview in Ad Hoc Correspondence. The application requires content type image/tiff. PreviewPDF For the preview in Correspondence Reviewer and Composition Center. The applications require content type application/ pdf. 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.

33 Platform configuration 33 Design Center configurations The script below is run before the Process and selects the output connector that is used. if (IsPreview()) { $ContentType = GetRequestedPreviewContentType(); if (GetPreviewType() = 1) { if ($ContentType = "image/tiff") { $connector = "PreviewTIFF"; } else if ($ContentType = "application/pdf") { $connector = "PreviewPDF"; } } } else { $connector = "FileOUT"; } preproclog(0, " **** OUTCONNECTOR : " +$connector); End of example. Related topics Creating preview output connectors on page 31. Preview functions in the Scripting Reference.

34 34 Platform configuration Design Center configurations Configuring input and output queues To store paused Messages in the Message storage in the runtime repository, you must use input and output queues in the Project. The Message storage itself is automatically created and does not require any configuration. To configure queues You configure input and output queues in the Manage Queues dialog box in the Platform configuration. Configuring an expiry time for documents When a final document is distributed, the corresponding Message must be deleted from the Message storage. You must configure an expiry time after which the Message is ready to be deleted by the StreamServe job deletion process. To configure expiry time for documents You enable deletion and configure the expiry time in the Configure Platform dialog box in the Platform configuration.

35 35 Composition Center configurations for Ad Hoc Correspondence Before using a document definition as a template in Ad Hoc Correspondence, some configurations must be carried out in Composition Center. In a production environment, the configurations are carried out by the business user. As a developer, you can use the procedures described in this section during development and testing. Prerequisites A Design Center Project (configured according to Design Center configurations on page 17), exported and deployed to a StreamServer application. Composition Center configurations for Ad Hoc Correspondence Enable the document definition for Ad Hoc Correspondence. Make texts editable in Ad Hoc Correspondence. Make texts available from a list in Ad Hoc Correspondence. Set rules for the document definitions that are included in a final document (applies for the batch scenario). Post requisites When the configurations are completed, you must publish the document definition. If changes are made to a published document definition, you must republish the document definition. To publish or re-publish a document definition, you must have full access rights to Composition Center. In this section Enabling a document definition for Ad Hoc Correspondence on page 36. Making a text editable on page 38. Making a text available on page 39. Setting rules for document definitions on page 40. Related topics For detailed information on how to use Composition Center, see the StreamStudio Online Help for Composition Center.

36 36 Enabling a document definition for Ad Hoc Correspondence Composition Center configurations for Ad Hoc Correspondence Enabling a document definition for Ad Hoc Correspondence To make a document definition available as a template in Ad Hoc Correspondence, you must select one of the following process types: Batch and Ad-hoc The document definition is intended for both automated document production, where the paused documents can be edited in Ad Hoc Correspondence (the batch scenario), and for creating new documents in Ad Hoc Correspondence (the on-demand scenario). Ad-hoc The document definition is exclusively intended for creating new documents in Ad Hoc Correspondence. Prerequisites To make a document definition available as a template in Ad Hoc Correspondence, you must have full access rights to Composition Center. To enable a new document definition for Ad Hoc Correspondence 1 Log in to StreamStudio. 2 Open Composition Center. 3 On the start page, click New document definition. 4 Select a template and enter a name for the document definition. 5 In the Process type area, select Batch and Ad-hoc or Ad-hoc. 6 Click Create Document definition. To enable an existing document definition for Ad Hoc Correspondence 1 Open Composition Center. 2 On the start page, click Manage document definitions. The Manage document definitions view opens. 3 Click the document definition. The Properties tab opens.

37 Enabling a document definition for Ad Hoc Correspondence 37 Composition Center configurations for Ad Hoc Correspondence 4 In the Process type drop-down list, select Batch and Ad-hoc or Ad-hoc.

38 38 Making a text editable Composition Center configurations for Ad Hoc Correspondence Making a text editable By making a text editable in Composition Center, you enable an end-user to edit and reformat the text. The text can be either an embedded text or an approved text resource. An embedded text can be empty if you want the end-user to be able to enter a new text in Ad Hoc Correspondence. Figure 9 Editable text in Ad Hoc Correspondence To make a text editable in Ad Hoc Correspondence 1 In Composition Center, open the document definition. 2 In the Document definition view, either: Add a new text to the document definition. Click an already added text. 3 Select the Properties tab. 4 In the General properties area, select Ad-hoc. 5 Click Save.

39 Making a text available 39 Composition Center configurations for Ad Hoc Correspondence Making a text available In Ad Hoc Correspondence, texts can be presented in a list to the end-user. The end-user can add texts from the list to the document. After a text has been added to the document, the end-user can edit or reformat the text. You populate the list by making the texts available in Composition Center. The texts can be embedded texts or approved text resources. Figure 10 List of available texts in Ad Hoc Correspondence To make a text available in Ad Hoc Correspondence 1 In Composition Center, open the document definition. 2 In the Document definition view, in the Resources area, select either An embedded text. An approved text resource. 3 Drag the text and drop it in the Ad-hoc resources area. 4 If the text is an embedded text, edit the text and apply the changes. 5 Click Save.

40 40 Setting rules for document definitions Composition Center configurations for Ad Hoc Correspondence Setting rules for document definitions In Composition Center, StoryTeller Processes are used as templates. From one template, several document definitions can be created. In a batch scenario, rules determine which document definitions are included in an Ad Hoc document. Note: If a document definition is exclusively intended for creating new Ad Hoc documents (the on-demand scenario), no rule is required. One document can contain several document definitions When several document definitions are created from the same template, and the rules for more than one document definition are evaluated as true, the Ad Hoc document contains several document definitions. For example, from a template called Letter, the document definitions WelcomeLetter and NovemberOffer are created. The WelcomeLetter document definition is set to be used when Customer=New. The NovemberOffer document definition is set to be used when date=11/01/ /30/2010. If both these rules are true, the Ad Hoc document contains both document definitions. Figure 11 An Ad Hoc document with two document definitions Prerequisites for documents with several document definitions In Design Center, output mode Job is used for the output connector. In Composition Center, process type Batch and Ad-hoc is selected for the document definition. To set rules on document definitions, you must have full access rights to Composition Center. To set rules for document definitions For information on how to set rules on document definitions, see the StreamStudio Online Help for Composition Center.

41 41 Using Ad Hoc Correspondence This section describes the procedures that are carried out in Ad Hoc Correspondence. In a production environment, the Ad Hoc procedures are carried out by the enduser. As a developer, you can use the procedures described in this section during development and testing. Prerequisites A document is opened in Ad Hoc Correspondence. In this section Ad Hoc Correspondence user interface on page 42. Ad Hoc Correspondence procedures on page 44.

42 42 Ad Hoc Correspondence user interface Using Ad Hoc Correspondence Ad Hoc Correspondence user interface A document is opened and displayed in Ad Hoc Correspondence. In the application, you can edit and reformat texts, insert texts, delete texts, and finally submit or close the document. Any changes that you make to the document are automatically saved. Ad Hoc Correspondence supports one end-user at a time accessing a specific document. Figure 12 Example of the Ad Hoc Correspondence user interface Toolbar buttons Submit Description Submits the document for distribution according to the prepared configuration. If the Submit button is disabled, you must close the document and submit it outside Ad Hoc Correspondence. For example, in Correspondence Reviewer or in the hosting system.

43 Ad Hoc Correspondence user interface 43 Using Ad Hoc Correspondence Toolbar buttons Thumbnails Insert Editable texts Page Fit width Fit page About Close Description Displays thumbnails of the document pages. The page that is currently displayed is highlighted. The thumbnails are grouped by document definition, with the document definition name as title. When the mouse cursor is moved over a selected page or the corresponding thumbnail, any text flows for editable and inserted texts are highlighted. Lists available texts that can be inserted into the document. Highlights texts that can be edited and reformatted in the document. The current page number (of the total number of pages). Use the arrow buttons to change pages. Resizes the document to fit the width of the window. Resizes the document to fit the entire window. Displays information about Ad Hoc Correspondence and the SSSP application. Closes the document. The document can be re-opened at a later time. If close is handled outside Ad Hoc Correspondence, the Close button is not available. For example, if close is handled in the hosting system.