xpression 3 xdesign User Guide

Transcription

1 xpression 3 xdesign User Guide

2 by EMC. All rights reserved. The copyright protection claimed includes all formats of copyrightable material and information governed by current or future statutory or judicial law. This includes, without limitations, any material generated by the software programs that display icons or other screen interfaces. You may not copy or transmit any part of this document in electronic or printed format without the express written permission of. xpression, CompuSet, and all other Document Sciences Corporation products mentioned in this publication are trademarks of. For complete copyright information, please see the file xpression Licensing Document.pdf located on your ebook Library CD. EMC, 5958 Priestly Drive, Carlsbad, CA

3 Table of Contents Table of Contents Introduction Boxes and Revision Bars Solution Support Introduction to xdesign Getting Started with xdesign Starting xdesign Configuring xdesign Setting Up Your Authoring Tool Language Localization Support Configure LAN Settings Servers.xml The xdesign Interface Opening a Sample Document The xdesign Desktop The Design Tab Toolbar The Design Tab Tree Pane Design Tab Document Properties Pane Copying and Pasting Items in the Tree Pane...25 The Preview Tab Interface The Preview Tab Toolbar The xdesign Options Page xdesign Options Page: Authoring Tools Tab...29 xdesign Options Page: Output Profiles Tab... 30

4 4 Table of Contents xdesign Options Page: Diagnostics Tab xdesign Options Page: Settings Tab xdesign Options Page: Preferences Tab The xdesign Document About the xdesign Document Creating a Document Document Properties The Document Properties General Tab The Document Properties Templates Tab...37 The Document Properties Annotations Tab...38 The Document Properties Recipients Tab The Document Properties Output Profiles Tab The Document Properties Output Variable Mapping Tab Deleting a Document Renaming a Document Adding Items to Your Document How to Create Content in xdesign Using xdesign to Design Your Content Using xdesign as an Assembly Tool for xpresso Application Content About xdesign Rules About Content Rules Creating a Content Rule About Content Groups How Do Content Groups Work? Content Group Types Creating a Content Group About Content Items Creating a Content Item Content Item Properties Using Conditional Logic and Selection Criteria How Does it Work? How Do I Create Selection Criteria? Alphanumeric Operators Combining Multiple Criteria The View Tab Using Selection Criteria in Other Rules Creating Selection Criteria Multiple Data Source Groups... 65

5 5 Table of Contents Using Rules About Section Rules Recipients Revision Units Markers How Do I Create a Section Rule? Can I Change the Section Level of a Rule After I Define It? Can I Copy a Section? Using Revision Units with Section Rules Label Rules Creating a Label Rule GoTo Rules Creating a GoTo Rule Read Rules Creating a Read Rule Read Next Rules Creating a Read Next Rule Table Rules How Do I Create a Table Rule? How Does xdesign Process a Table Rule? Sharing Rule Queries Sharing a Query Using a Shared Query Variable Rules Creating a Variable Rule The Variable Rule Advanced Button Specifying Your Variable Value Through a User Exit Variable Rule Behavior in Batch Creating a Read Loop What is a Loop? How Does a Read Loop Work? Read Loop Structure Creating a Read Loop Using Subdocuments About Subdocument Rules A Simple Subdocument Use Case When Might I Use a Subdocument Rule?

6 6 Table of Contents Subdocuments in xpublish Master Documents Document Level Settings Subdocuments in CompuSet Master Documents Document Level Settings Retrieving Data for Subdocuments About Key Mapping About Value Mapping About Share Master Document Data Source About Data Source Binding Subdocument Scenarios CompuSet Subdocuments in xpublish Master Documents Passing Values from a Master Document to a Subdocument Publishing an xpresso Package Through xrevise Page N of M Managing Your Attributes in Subdocuments xpression Batch and Subdocuments Content In Your Master Document Managing Subdocument Data Sources Overriding Subdocument Data Sources Using Output Variables xrevise Issues Subdocuments and CompuSet Output Processing Creating a Subdocument with Master Document Data Creating a Subdocument Using Key Mapping Creating a Subdocument Using Value Mapping xpublish and CompuSet Subdocument: Document Name Options xpublish and CompuSet Subdocument: Key Mapping Options xpublish and CompuSet Subdocument: Value Mapping Options Adding an xpresso Subdocument xpresso Package Subdocument Options xpresso Package Subdocument Key Mapping Options xpresso Package Subdocument Variable Mapping Options Using an xpresso Array Variable with Subdocuments Adding a CompuSet Subdocument Subdocument Schema The xpression Chart Rule What is a Data Query and How Does it Work? Defining Your Chart Data Chart Types

7 7 Table of Contents How to Add a Chart to Your Document Create a Chart Rule Add Content to Your Chart Rule Customizing the Look of Your Charts Pie Chart Options Bar and Column Chart Options Line Chart Options Editing Your Chart Data Editing a Data Series Editing Your Category Data Sharing Rule Queries Sharing a Query Using a Shared Query Shared Content and Shared Rules Sharing a Content Item How Do I Add a Shared Item to My Document? Unsharing an Item Viewing Shared Content Item Usage Updating a Shared Content Item Sharing a Rule Adding a Shared Rule to a Document UnSharing a Rule Viewing Shared Rule Usage Updating a Shared Rule Limitations Related to Shared Rules Document Versions Before You Begin Creating a Document Version Creating a Document Version Managing Document Versions Delete a Document Version Update a Document Version Opening a Document Version

8 8 Table of Contents Previewing a Document How Does xdesign Preview Documents? About Generating XML Generating XML for a Document Previewing a Document Why You Should Test Publish a Document Assembling a Document Publishing Your Assembly Viewing Your Assembly Find a Record in the Customer Record List The xpression Approval System How Approval Works About Approval Definitions Submitting a Document or Content Item The Approval List Options Approving a Document or Content Item Rejecting a Document or Content Item Withdrawing a Document or Content Item Special Features About Optional Paragraphs How Do Optional Paragraphs Work? Optional Paragraph Groups Creating an Optional Paragraph in a New Rule Creating an Optional Paragraph in an Existing Rule Creating an Optional Paragraph Group Editing Optional Paragraph Group Properties Copying and Pasting Optional Paragraph Groups Overriding Attributes How Does an Overriding Attribute Work? Creating an Attribute Override Recipient Processing Differences Between CompuSet and xpublish Recipients Defining Recipients Create Recipient-Enabled Section Rule Create CompuSet Page Sequences Create xpublish Page Sequences

9 9 Table of Contents Create Output Streams Converting an xpression CompuSet Document to xpublish What Happens During a Conversion? Converting a CompuSet Document to xpublish Printing Document Details Printing the Document Summary Printing the Current Rule Printing the Document Structure Print Document Details Search Utility About Single Word Searches Rules for Single Word Searches About Phrase Searches Rules for Phrase Searches About Boolean Logic Searches The AND Operator The OR Operator The NOT Operator Parentheses Rules for Boolean Logic Searches Searching for Content Searching for Content Item Attributes Searching for Rules Searching for Selection Criteria Searching for Queries Building a Searchable Product List The View Query Tab The Search Results Window Printing Search Results Diagnostic Tools Application Traces COM Bridge Trace Business Document Template Assembly List Document Instance CompuSet Tagged Text Rule XML Data

10 Chapter 1 Introduction 1 Welcome to the xdesign User Guide. This book introduces you to the xdesign application. We will discuss and define all xdesign features and functions, as well as walk you through a number of common and important procedures that showcase xdesign s capabilities. Boxes and Revision Bars The following colored boxes alert you to special information in the documentation. Caution: The caution box warns you that a fatal error, unsatisfactory output, or loss of data may occur if you do not follow the directions carefully. Tip: A tip offers suggestions to simplify a task or describes a useful shortcut. They may also describe an alternate way to use the techniques described in the text. Note: A note offers information that emphasizes or supplements important points of the main text. Revision bars help you locate new or changed information. Look for these revision bars in the right margin of each affected page.

11 11 Chapter 1 - Introduction Solution Support For more information or to solve a problem, contact Document Sciences Solution Support: Telephone: (760) Fax: (760) World Wide Web: support@docscience.com

12 Chapter 2 Introduction to xdesign 2 xdesign enables you to assemble, design, test, and proof your documents. You define business logic, or business rules, that include or exclude portions of content based on the information contained in your customer data. xdesign stores the content, images, and other document information you create in a single database. The content you create through xdesign can consist of documents created through xdesign s Microsoft Word interface, xpresso packages, and external content. Through the Microsoft Word interface, you can create and maintain the document layout, content, and other items that affect the overall look and feel of your documents. You ll add text and images as you ordinarily would if you were creating a memo or letter. xdesign adds a layer of powerful data manipulation and page formatting utilities to this familiar word processing environment. When you are finished creating your content, you can test assemble and publish your content from xdesign. When content is assembled, xdesign executes the business rules and other components of the document for a specific row in your customer data. xdesign will generate an XML document that tells your production applications which information to pull from your customer data, and which objects to retrieve from the xpression database to produce the custom document. When you re satisfied with your document, and you re ready to send it out for distribution, you create a document version. All xpression applications support fax, , and print distribution.

13 Chapter 3 Getting Started with xdesign 3 In this chapter we will show you how to get started with xdesign. There are a few configuration steps you need to complete before you can start creating and editing documents. We ll walk you through those steps, then take a tour of the application in the next chapter. Starting xdesign xdesign must connect to your xpression server before you can create or edit a document with xdesign. When you start xdesign, a dialog box will pop up that enables you to select your xpression server name from a list and provide login credentials. To add or subtract servers from this list, see Servers.xml. To start xdesign: 1. Click Start, then select Programs > > xpression and then click xdesign. Figure 1. The Connect to xpression dialog box appears. 2. From the Connect to xpression dialog box, select the the name of your xpression server from the server connection list. The server houses the xpression database that stores your documents, as well as the rules, content, and images you use to create them. See Servers.xml for instructions on adding additional servers to the list.

14 14 Chapter 3 - Getting Started with xdesign 3. Type your xpression user name and password and click OK. User names and passwords come from your corporate network security system (such as LDAP or Active Directory). Your xpression administrator can authorize users for xdesign or any other xpression application. If your username and password fail, ensure that you are authorized to use xadmin. 4. If your username and password are valid, xpression will connect successfully and the xdesign main window appears. Figure 2. The xdesign main window. To see a demonstration of this feature, click here. Note: The user logged on to the xdesign client machine must have write permission to the \xpression\bin folder. By default, this directory is located here: C:\Program Files\xPression\bin. Configuring xdesign Now that you are logged in, there are a few configuration steps you should take care of right away. Setting Up Your Authoring Tool You can use Microsoft Word 2000, 2002, 2003, and 2007 with xpression Design. To use Word as a content item authoring tool, all you need to do is to register it with xpression Design.

15 15 Chapter 3 - Getting Started with xdesign To register an authoring tool: 1. On the Tools menu, click Options. Figure 3. This page enables you to define your xdesign authoring tools. 2. Choose Word 2000, Word 2002, Word 2003, or Word 2007 from the list, then browse to the location of the program executable file on your hard drive. 3. If you are registering the word processor for the first time, the button next to the available list of word processors will be the Add button. Click Add to register the word processor you have selected. If you are revising the path of a registered authoring tool, the Add button changes to Update. Note: If your word processor resides on a network, the execution path should include the command line needed to start the word processor and include any special network software or parameters required to access it. See your system administrator for information about execution paths. xpression supports the UNC naming system.

16 16 Chapter 3 - Getting Started with xdesign Selecting a Default Authoring Tool If you register only one authoring tool, xpression Design uses that authoring tool whenever you create, revise, or view content items. However, if you register two or more authoring tools, you must select a default tool. Each authoring tool you register appears in the default tool list at the bottom of the Authoring Tools tab. If you have more than one editor available, choose the default tool from the list and click Apply. To remove an editor from your set of authoring tools, select it from the list and click Remove. Language Localization Support xpression supports French Canadian and Chinese lanugages in the user interfaces. To use a French Canadian or Chinese user interface, set the locale on your local machine to either French Canadian or Chinese. Figure 4. You can set your locales from the Windows Control Panel in the Regional and Language Options application. To configure your locale for a specific language: 1. Click the Regional Options tab. 2. Select your desired language from the list in the Standards and formats section. For Chinese language, choose Chinese (PRC). For French, choose any variety of French. 3. On the Languages tab, click Details and ensure your language appears in the Installed Services box. Also on the Languages tab, if you are using the Chinese language, ensure that you select the Install files for East Asian languages option.

17 17 Chapter 3 - Getting Started with xdesign 4. On the Advanced tab, ensure your language is selected in the Language for non-unicode programs and that the code pages for your language are selected. 5. Click OK. Configure LAN Settings If your LAN settings are improperly configured, you may experience a 60-second delay after you shut down xdesign. The xpression process will remain in the Windows Task Manager for 60 seconds after you close the program and prevent you from logging on again. To prevent this problem: 1. Start Internet Explorer. and select Internet Options from the Tools menu. 2. On the Connections tab, click LAN Settings. 3. Clear the Automatically detect settings checkbox and click OK. Servers.xml The servers.xml file in the xpression folder on the client machine determines which servers are available to xdesign. This file is similar to the servers.xml file located on the xpression server. Add Server element for each server that you want to be able to access. For example, add Server elements for Development, Test, and Production servers to be able to access each of these three servers. Element ServerList Server Definition This element encapsulates the server list, and delimits the servers.xml file contents. This element defines the xpression server(s) available to the applications. This element has the following parameters: name: this is the descriptive server name that will display when logging on to xdesign. url: the url for the xpression server. This includes the descriptive server name and port number. Use iiop for RMI installations, and http for Servlet. uid: the default user id used to sign in to the xpression client. This is an optional attribute. password: the password that corresponds to the user id set with the uid attribute. This is an optional attribute.

18 18 Chapter 3 - Getting Started with xdesign Sample Servers.xml Servers.xml on the client will look similar to the following example: <?xml version="1.0" encoding="iso "?> - <ServerList> <Server name="xpression 2.5" url=" uid="" password="" /> </ServerList>

19 Chapter 4 The xdesign Interface 4 In this chapter we will open a sample document and take a tour of the xdesign interface. Some menus and options are not available unless a document is open. Opening a Sample Document An xdesign document is an ordered set of business rules, content items, and subdocuments that together form a printed document: a letter, an insurance policy, a statement, or other similar documentation. Document Sciences supplies several sample documents that you can use as a guide when you create your own documents, or to troubleshoot your xpression installation. See your system administrator if these samples aren t available. xdesign documents are stored in XML format. Each document contains a set of query and selection rules that retrieve text and binary objects from the xpression database based on your customer data and attributes. The document also contains assembly rules that govern the assembly of the returned objects. To open a sample document: 1. Click the Open Document button in the upper left corner of the xdesign main window. The Select Document box appears.

20 20 Chapter 4 - The xdesign Interface 2. From the Select Document box, select AUTOMATIC PAYMENT LETTER from the Categories list. Figure 5. The Categories list contains all available categories. The documents stored in the category appear in the Documents list. A category enables you to create a design environment in which the document designer can create documents that share attribute sets, data source groups, user authorizations, and approval structure. 3. Choose Automatic Payment Letter from the Documents list and click OK. Figure 6. xdesign displays the document. To see a demonstration of this feature, click here.

21 21 Chapter 4 - The xdesign Interface The xdesign Desktop The Design tab is active by default. From here you ll create and maintain the rule structure and content of your documents. Figure 7. xpression Design displays the components of a document in two panes: the tree pane on the left, and the Document Properties pane on the right. Toolbar Tree Pane Document Properties Pane Design Tab Preview Tab The xdesign desktop contains two tabs, two panes, a toolbar, and a menu bar. Element Design Tab Preview Tab Tree Pane Document Properties Pane Description The Design tab is active by default. The Design tab enables you to design your document. It displays the elements of a document in the tree pane and the properties of those elements in the document properties pane. The Preview tab enables you to test assemble and preview your document. For more information, see The Preview Tab Interface. If you re familiar with the folder structure used in Windows Explorer, you ll recognize a similar structure in the xdesign Tree view. Here you ll see displayed the structure of a document: rules, content groups, selection criteria, and content items. You ll learn more about these a little later, in The Design Tab Tree Pane. The Document Properties view shows the properties of items you select in the tree view: the name of the category the document is held in, the last time Generate XML was run, the name of the data source used with the document, and the path to the Microsoft Word template used by the authoring tool.

22 22 Chapter 4 - The xdesign Interface Element Toolbar Description The toolbar contains buttons for some of major xdesign features, such as Open Document, Submit Content, Approve Content, Create Document Version, and more. For a full description of features, see The Design Tab Toolbar. The Design Tab Toolbar The following buttons are available when you open a document. Element Open Document Definition The Open Document button opens the Select Document dialog box. This enables you to choose a category from the category list, and pick a document you want to open. Submit Content Approve The result of clicking this button differs depending on what you ve selected in the tree view. When you select a content item, this button sends the item to the workflow subsystem for approval. When you select the document name, this button sends all content items in the document to the workflow subsystem for approval. For more information, see The xpression Approval System. The Approve button starts the xdesign approval system. For more information, see The xpression Approval System. Create Document Version Find The Create Document Version button starts the document version utility that makes the document available to xpression s production services like xpression Batch, xrevise, or xresponse, or to an xpression Framework application. These applications use the document version to assemble, customize, and distribute your document. For more information, see Document Versions. The Find button can be used to look for rules, content groups, and content items in the document you re using. Create Searchable Document List The Create Searchable Document List button starts the Searchable Document List utility. A document list enables you to focus searches on specific groups of documents. For more information, see Building a Searchable Product List. Search Rules Search Content The Search Rules button enables you to locate rule, content group, and selection criteria descriptions, as well as selection criteria statements. For more information, see Searching for Rules. The Search Content button enables you to find text in content items, content item descriptions, or document annotations. For more information, see Searching for Content.

23 23 Chapter 4 - The xdesign Interface Element Refresh Server Data Definition To provide better performance, xdesign retrieves and stores server data in memory so that it does not have to retrieve the data each time the it is needed. The data stored in memory can become out of date if another user has updated the information on the server while you are working in xdesign. The Refresh Server Data button enables you to download the latest server data without having to log out of xdesign. The Refresh Server Data button retrieves the following server data: xpublish output profiles CompuSet output profiles CompuSet Format definitions Attribute sets info xpublish markers User exit info Customer file schema and data This button can only be used if none of the following xdesign functions are active: xpression documents Text search form Rule search form Search result form

24 24 Chapter 4 - The xdesign Interface The Design Tab Tree Pane The Design tab shows a tree-like structural view of your document. The document name appears at the top of the tree, followed by your business rules, content groups, subdocuments, and content items. Figure 8. Elements of the tree pane. Document Name Business Rules Content Group Content Item To open or expand an item, click the plus sign [+] next to that item. You can also expand the entire document structure by selecting Expand Document Tree from the View menu. For a description of all the items in the tree pane, see Design Tab Tree Pane Elements. Design Tab Tree Pane Elements The Design tab tree pane contains the following elements. Element Business Rules Content Groups Content Items Definition Also known simply as rules, business rules are the framework of every xpression Design document, shaping the order in which the document contents are assembled and published. Rules use logic to choose the content items included in a customized document when you assemble the document. You can create several different types of rules in xpression Design, each intended to perform a different task. You can also share a rule with many different documents. For more information, see About xdesign Rules. A content group is a collection of similar content items. Only one content item in the content group is valid for a particular document assembly request. Although the number of content items associated with a rule can vary, every content item belongs to, or is associated with, a content group. For more information, see About Content Groups. The content items that you create with Microsoft Word are the building blocks of an assembled document. They can range in size from a few words, to several pages, and they can contain text and images. Content items can be shared among any number of documents. For more information, see About Content Items.

25 25 Chapter 4 - The xdesign Interface Design Tab Document Properties Pane When you select an item in the tree pane, the properties of that item appear in the document properties pane. When you select a content item in the tree pane, the document properties pane shows a preview of the content item. This preview is view-only and cannot be edited. Below the content item preview, the document properties pane shows the attributes for the content item. Figure 9. Content item preview in the Document Properties pane. Content Item Preview Content Item Attributes Copying and Pasting Items in the Tree Pane Please be aware of the following items when copying and pasting in xdesign: Rules can be copied between documents in the same category, but you may encounter unexpected results if you attempt to copy rules and content items between documents in different categories that use different data sources and attribute sets. Copied Label and Section rules appear with the prefix Copy (x) of. If you copy a GoTo rule into another document, that document must also contain the Label rule used with the GoTo rule. If you copy an approved content item (one with a whole number version like 1.00, 2.00, and so on), xdesign sets the pasted item back to version 0.01 with a status of Pending. You can copy content from a document that uses the xpression Publish composition engine to a document that uses CompuSet as its composition engine only if the content is designated as universal. That is, if you create a text content item that doesn t contain features unique to a publishing type, the content becomes

26 26 Chapter 4 - The xdesign Interface universal and can be copied and pasted into any document, or shared with other documents along with its rule or by itself. Rules copied to a different document do not retain attributes such as Withdrawal and Effective Dates. Attributes must be applied manually after the content is copied. When you paste a rule into an expanded Section rule that contains one or more rules, xpression will place the rule inside the Section, at the top. If you choose a collapsed Section rule and then paste a copied rule, xpression will place the rule outside the Section and immediately following the Section rule in the Tree view. You can t copy a Chart rule from an xpublish document and paste it into a CompuSet document (xpublish charts are not supported in CompuSet documents). You can t copy content that contains an xpublish chart or an xpublish image from an xpublish document and paste it into a CompuSet document (xpublish charts and images are not supported in CompuSet documents). You can t copy a Read rule, Table rule, Chart rule, or Variable rule and paste it into a document with a different data source. To copy and paste an item in the tree pane: 1. Select the item you want to copy. 2. From the Edit menu, click Copy. Alternatively, you can right-click the item and then click Copy from the shortcut menu. 3. Select an item in the tree pane. When you paste your copied into to this location, the copied item will appear AFTER the item you select. Right-click and select Paste from the shortcut menu, or click Paste from the Edit menu. Document Sciences recommends using these methods rather than the drag and drop approach. 4. After pasting the copied content item, you will be presented with the option of retaining the attributes associated with the content. Click Yes to retain the attributes, or No to discard the attributes. To see a demonstration of this feature, click here.

27 27 Chapter 4 - The xdesign Interface The Preview Tab Interface With the tools available on the Preview tab enable you to assemble and publish documents for your customers using your actual customer data in a simulated production environment. Figure 10. The Preview tab contains a toolbar, a tree pane, and a customer data pane. Customer Data Tree Customer Row Detail The Preview tab contains the following elements. Element Tree Pane Customer Data Pane Toolbar Description The tree pane contains a list of rows from the primary data source for the current document s category. You can control the number of records that appear in the Customer Data Tree. To change this increment, select the Tools menu and click Options. Click the Settings tab and change the number of rows you want to view. The customer row detail shows the rows and values contained in an individual customer data row. This information is shown for display purposes only and can t be modified. The toolbar contains buttons for some of major xdesign features, such as Open Document, Submit Content, Approve Content, Create Document Version, and more. For a full description of features, see

28 28 Chapter 4 - The xdesign Interface The Preview Tab Toolbar These buttons are available when you switch to the Preview tab. Element Open Document What Does It Do? The Open Document button opens the Select Document dialog box. This enables you to choose a category from the category list, and pick a document you want to open. Assemble Approve The Assemble button starts the document version utility that makes the document available to xpression s production services like xpression Batch or xresponse and Revise, or to an xpression Framework application. These applications use the document version to assemble, customize, and distribute your document. For more information, see Assembling a Document. The Approve button starts the xdesign approval system. For more information, see The xpression Approval System. Find The Find button can be used to look for rules, content groups, and content items in the document you re using. Create Searchable Document List The Create Searchable Document List button starts the Searchable Document List utility. A document list enables you to focus searches on specific groups of documents. For more information, see Building a Searchable Product List. Search Rules Search Content The Search Rules button enables you to locate rule, content group, and selection criteria descriptions, as well as selection criteria statements. For more information, see Searching for Rules. The Search Content button enables you to find text in content items, content item descriptions, or document annotations. For more information, see Searching for Content. View Document The View Document button presents an assembled document for viewing in HTML, Microsoft Word, xpublish, or CompuSet format. Publish Document The Publish Document button publishes a document through one or more of the output profiles associated with the product. For more information, see Recipient Processing. Previous/Next The Previous and Next buttons in the customer data tree enable you to move through the customer data records in a default increment of 100 records. To change this increment, see The Preview Tab Interface.

29 29 Chapter 4 - The xdesign Interface The xdesign Options Page The xdesign Options page contains settings that apply to your entire xdesign environment. To access the Options page, click the Tools menu and select Options. xdesign Options Page: Authoring Tools Tab This page enables you to set up one or more authoring tools. You will not be able to view, create, or edit any of your content items until an authoring tool is defined. Figure 11. This page enables you to define your xdesign authoring tools. This page contains the following elements. Element Name List of Valid Authoring Tools Execution Path Description This list is the first list on the page. It contains a list of all authoring tools supported by xdesign. Choose the authoring tool you want to define. Supply the full path and filename of the executable for the authoring tool you selected.

30 30 Chapter 4 - The xdesign Interface Element Name Default Authoring Tool List Description If you have defiend more than one authoring tool, select one of the authoring tools to be the default authoring tool. This identifies the authoring tool that xdesign will use when a content items is viewed, created, or edited. xdesign Options Page: Output Profiles Tab The Output Profiles tab enables you to define a default output profile that will be used by xdesign when you test assemble and publish a document. Figure 12. The Output Profile tab contains a list of xpublish and CompuSet output profiles. xdesign Options Page: Diagnostics Tab For a description of this page, please see Diagnostic Tools.

31 31 Chapter 4 - The xdesign Interface xdesign Options Page: Settings Tab The Settings tab enables you to define some general settings for xdesign. Figure 13. The Settings tab enables you to define general usage settings. This page contains the following elements. Element Name Number of Rows Measurement Units Automatically Generate XML Description Defines the number of rows in your data source that you wish to view on the preview tab. The default is 100. This option is used with end-page-stubs. This option enables you to specify the unit of measurement used when defining the end-page-stub location. This option enables or disables the ability of xpression to automatically generate XML each time the Preview tab is selected.

32 32 Chapter 4 - The xdesign Interface xdesign Options Page: Preferences Tab Enables you to specify the default view type to be used when previewing documents in Word. You can choose Normal, Print, or Web. The View Mode buttons on the preview screen may become disabled if you have a document open in Word outside of xdesign, preventing you from changing the view mode. To avoid this condition, do not work in xdesign with Word documents open outside of xdesign. Figure 14. Enables you to set the default view mode for previewing documents.

33 Chapter 5 The xdesign Document 5 In this chapter we will discuss the xdesign document, as well as show you how to create, edit, rename, delete, and configure your xdesign document. About the xdesign Document A finished document may eventually contain a number of items, but every document you create contains these essential elements: Business rules - Rules are the framework of every xdesign document, shaping the order in which the document contents are assembled and published. For more information, see Adding Content to Your Document and Using the Other Rules. Content - The content items that you create with Microsoft Word are the building blocks of an assembled document. For more information, see Adding Content to Your Document. Data source - Although you won t see it when you create your documents, working in the background is the data source assigned to the category to which you add individual documents. xdesign uses the data in these databases to process rules and perform variable replacements during document assemblies. xdesign supports XML and relational database input. Word Template - The Microsoft Word template allows you to add styles and use them in any document that uses the same template. It also contains macros that allow xdesign to integrate with Microsoft Word.

34 34 Chapter 5 - The xdesign Document Creating a Document Before attempting to create a new document, ensure that your authoring tool is configured properly. For instructions, see Setting Up Your Authoring Tool. To create a document, complete the following steps: 1. Start the Create a New Document wizard by clicking New Document from the File menu. Figure 15. The Create a New Document wizard appears. 2. In the upper-most box, type a unique name for your document. Namesmust be between 1and 255 alphanumeric characters long. You can not use the ampersand (&) or the vertical bar ( ) symbols. 3. From the drop-down list, select a category. xpression Design uses categories to arrange, store, and control access to documents. You can think of a category as a folder in which you store documents that pertain to a similar subject. Your system administrator defines categories and their authorization levels using xpression Admin. A category contains the application security levels that control user access to the documents it holds, and it points to the data sources shared by all of its documents. You can add a new document to any category to which you have at least Write access. When you add your new document, it immediately becomes available to all other xpression Design users who have access to the category. You can put a document in one category only. 4. Select a composition engine for your document. For more information about xpression CompuSet and xpublish, see The xpression Publishers in the xpression Enterprise Edition System Overview book. It s

35 35 Chapter 5 - The xdesign Document very important that you decide which publisher to use. If you create a CompuSet document and then want to change it to xpublish, you can convert to xpublish. However, you can t convert an xpublish document to a CompuSet document. 5. If your attribute set contains an effective date, specify the Default Effective Date you want to use for your document by clicking the calendar button to the right of the field and selecting the desired date. The date from the attribute set appears by default. If you don t use an effective date attribute, Today s date is displayed. Alternatively, you can type in a date you want to use in mm/dd/yyyy format. The date you specify here overrides any dates assigned in xadmin to the attributes you are using in the document. You can change the effective date and apply it to the entire document or to individual content items whenever you create or modify content in that document. 6. Select the path to the Word template you use to create your document. The default location of the template supplied with xpression Design, xpressionwordtemplate.dot, is [drive:]\program Files\Xpression\Design\Templates. Note: You ll see an error message from Word if another template interferes with the template you define here. If Word finds a template in your Temp folder or if you defined other templates with Word s Templates and Add-ins utility, it will override the template you choose in xpression Design. You ll need to remove or rename those templates. 7. Click Finish to complete the creation of the new document. The properties of the new document appear in the document properties pane. To see a demonstration of this feature, click here. Document Properties After you create a document, you can view and modify the document properties. To modify the document properties, you must have at least Write access to the category that contains your document. With Read access you can view, but not modify, the properties.

36 36 Chapter 5 - The xdesign Document To view or modify document properties: 1. Ensure you are logged on to xpression Design and that the document is currently open. 2. From the Document menu, click Properties. You can also right-click the root name and click Properties from the shortcut menu. Figure 16. The Document Properties page appears. The Document Properties General Tab The General tab contains the general settings for your document that you defined while running the Document Creation wizard. Element Name Category Composition Engine Default Effective Date Description The name of the document. The category where the document resides. The composition engine that you have chosen for the document. The document s default effective date. See Default Effective Date for more information.

37 37 Chapter 5 - The xdesign Document The Document Properties Templates Tab Use the Templates tab to specify the name and location of the Word templates you use with xpression Design. Figure 17. The Document Properties Templates tab options.. The Document Properties Templates tab contains the following information. Element Name Microsoft Word Template Description The path and file name of the Microsoft Word template associated with the current document.

38 38 Chapter 5 - The xdesign Document The Document Properties Annotations Tab Annotations are notes that you can add to accompany the document. For example, you could choose to add information such as who created the document, and when it was created. Figure 18. The Annotations tab may not appear in every document. The annotation feature is implemented through the attribute set associated with the category where your documents reside. See your system administrator for more information. Annotations are notes that you can add to accompany the document. For example, you could choose to add information such as who created the document, and when it was created. Type your annontation in the provided box.

39 39 Chapter 5 - The xdesign Document The Document Properties Recipients Tab The options on this tab enable you define recipients for different sections of your document. Figure 19. The Recipients tab. The Document Properties Recipients tab contains the following information. Element Name Add to Server Available Recipients Recipients defined to document Description To create a recipient, type a name for the recipient in the Add to Server box and click Define. The name will then appear in the Available Recipients list. To remove a recipient name from the Available Recipients list, type the name and click Undefine. Lists all existing recipients. Lists all recipients that have been defined to this document. To add a recipient to this list, select a recipient name from the Available Recipients list and click Add. To remove a recipient from this list, select a recipient name from the Recipients defined to document list and click Remove. For full information about recipient processing, see Recipient Processing.

40 40 Chapter 5 - The xdesign Document The Document Properties Output Profiles Tab An output profile contains all of the information needed for directing documents to different output streams. The output profiles link each output stream with a distribution definition and an output definition. Figure 20. The Output Profiles tab. This tab lists all available output profiles. You can select one or more output profiles to associate with the current document.

41 41 Chapter 5 - The xdesign Document The Document Properties Output Variable Mapping Tab The Output Variable mapping tab enables you to override a globally mapped output variable. Figure 21. The Output Variable Mapping tab. Output variables are integral to xpression s ability to streamline your document automation processes by reducing duplication and simplifying administration duties. When you define an output variable in xadmin, you are telling xpression that a certain piece of data from your customer file is relevant to your documents. Your system administrator will give this piece of information a name and map this name to the relevant field in any or all of your data source groups. You can then use the output variable in any documents where the information from the customer file is needed. However, there may be situations when you need a document to output a value different than what has been mapped for global use. For example, you may want to place a literal value into the output variable and then later sort by the value in that variable when you run your job, or you might want to output the results of a calculation you defined within a variable. To override the global mapping, you can map a document variable that you define in a Variable Rule with an output variable from the Output Variable Mapping tab. When the document is published, the value of the output variable will appear instead of the value of the customer data field that was mapped to the document variable in xadmin.

42 42 Chapter 5 - The xdesign Document Overriding Global Output Variables To override global output variables, complete the following steps. 1. Access the properties for your document by clicking Properties from the Document menu or by right-clicking the document name from the tree pane and clicking Properties from the shortcut menu. 2. Click the Output Variable Mapping tab. 3. Select an Output Variable. Each of the Output Variables available are shown with their type as well. For example, the numeric Customer ID field is displayed as (Numeric) Customer ID. 4. Select a Document Variable. You cannot map an Output Variable to a Document Variable if they are different types of data. Output Variables can be defined in xadmin as Numeric, String, and Date. Document Variables can be defined in xdesign as Date, Float, Integer, and String. Obviously there is no problem matching Date and String types in both places, but it is important to know that a numeric Output Variable can be matched to either a Float or an Integer Document Variable. 5. Click Update to complete the match. The mapped fields are displayed in the list at the bottom of the tab. Note: You can change the mapping of any of the Output Variables by selecting one from the list, changing your mapping and clicking Update. Deleting a Document Document deletion is irreversible. Be very careful when you use this function! To delete a document: 1. Click the root level document name in the tree view. 2. On the Edit menu, click Delete Document. 3. Click OK and click Yes to confirm the document delete action. To see a demonstration of the document deletion process, see the video. Renaming a Document If you rename a document, xdesign automatically renames all versions of that document. To rename a document: 1. Click the document name in the tree pane. 2. Click the document name again. The document name should become editable. 3. Type a new name for the document and press Enter. To see a demonstration of this feature, click here.

43 Chapter 6 Adding Items to Your Document 6 In this chapter we will discuss the various items you can add to your document. You can add content rules or structural rules, content groups, subdocuments, content items, and selection criteria. How to Create Content in xdesign xdesign provides you with two methods for creating content. You can use either method individually, or use a mixture of the two methods. To see a demonstration of this feature, click here. Using xdesign to Design Your Content xdesign enables you to directly create and design new content through the creation of content items. When you create a new content item, xdesign launches its authoring tool, Microsoft Word. You can use Microsoft Word s advanced formatting features to edit and design CompuSet and xpublish-based content items. CompuSet and xpublish provide different levels of support for Microsoft Word features. For more information on creating content in Microsoft Word, see the xdesign Style and Formatting Guide. Using xdesign as an Assembly Tool for xpresso Application Content Another way content can be added to an xdesign document is through the use of subdocuments. Subdocuments enable you to import completed documents from xpresso for InDesign, xpresso for Word 2007, or from other xdesign documents. This functionality enables you to use design application better suited to the type of content you are creating. For example, you could create a graphic-intensive, professionally designed pamphlet in xpresso for InDesign and include it with an insurance policy packet created in xdesign. For more information, see Using Subdocuments.

44 44 Chapter 6 - Adding Items to Your Document About xdesign Rules Think of a rule as a folder that holds information devoted to one topic. Rules are the framework of every xdesign document, determining the content and order in which the document is assembled. The list of rules in xdesign s tree view is very similar to the table of contents in a printed document. There are several different types of rules that perform different functions in xdesign. Some rules will not be available depending on the composition engine and data source being used with the document. xpression processes a document s rules in the order in which they appear in the document. Figure 22. Rules appear in the xdesign tree view. Content Rule Read Rule Label Rule Goto Rule Some interesting facts about rules: Rules are stored in your xpression database. Rules can be designated as shared and used in many documents. Whenever a rule is used, xpression records where it is used so that you can access that information later. You can use the following rules with xdesign. Rule Content Rule Subdocument Rule Description This is the most common type of rule used in xdesign. A content rule contains content items, which are pieces of your document created through xdesign. Content Rules are discussed in this chapter. Subdocument rules enable you to insert content from other applications or insert complete documents into your current document. Subdocument rules can contain content from other xpression design applications. Subdocument rules are discussed in Using Subdocuments.

45 45 Chapter 6 - Adding Items to Your Document Rule Variable Rules Section Rules Label Rules Goto Rules Read Rules Read Next Rules Table Rules Chart Rules Description Variable rules (the variables in them are often referred to as user-defined replacements ) are used to build variables that can be inserted into documents when specified criteria is met. Variables can contain fields from your data source, literal values that you supply to the variable, references to another variable of comparable type, or calculated values. Variable rules are discussed in Variable Rules. Section rules enable you to place a group of related rules into a organizational container which can make your document structure easier to navigate and maintain. Applying criteria to section rules also makes the document more efficient to publish. Additionally, section rules enable you to define recipients for the content within the section. Section rules are discussed in About Section Rules. A Label rule acts as placeholder in your document structure that does not contain any content. Label rules are typically used in conjunction with GoTo rules for creating looping conditions, usually for the purpose of reading multiple records from a secondary table. Label rules are discussed in Label Rules. Goto rules are used in conjunction with Label rules to enable your processing logic to jump from one section in your document structure to another. Goto rules are discussed in GoTo Rules. Enables you to read data from any non-primary table in your data source. Read rules are discussed in Read Rules. After reading a record in the data source, a Read Next rule tells xpression to read the next record of data in a data source table. Read Next rules are discussed in Read Next Rules. Table rules enable you to dynamically build tables by looping through records in a non-primary data source. Table rules are discussed in Table Rules. Enables you to create dynamic charts for any type of xpression document (print, , or Webbased). xpression can graphically display your data in the form of a pie, bar, column, or line chart. Chart rules are discussed in The xpression Chart Rule. About Content Rules Content Rules are desired to contain Microsoft Word-based content along with other business logic to determine when that content should be assembled for each customer. Content Rules contain one or more Content Groups. Content Groups can include criteria to help in the content selection process and can be made up of Word-based content or external content such as a reference to a PDF or information in a Documentum docbase.

46 46 Chapter 6 - Adding Items to Your Document A typical Content rule that contains one content group, and one content item consisting of a Microsoft Wordgenerated document. Figure 23. A content rule and the contents of a content rule. Each content rule ultimately selects one content group and within that one content item to include in an assembled document. Whether or not a content group is selected depends on the conditions created in the criteria for the content group. If the criteria passes this first test, xdesign checks the attribute values on any content items in the chosen group and includes the one that matches in the assembled document. Note: Be careful not to test fields that are in the attribute set in criteria statements. This is duplicating your effort since attributes are required to be evaluated and so are always tested. Only fields that are not contained in the attribute set should be included in criteria statements on Content Groups. For example, you may have a content group that contains three content items, each containing a different cover page. Each content item has different Jurisdiction, Effective Date, and Language attributes as shown in the table below. Content Item Attribute: Jurisdiction Attribute: Effective Date Attribute: Language Standard Cover Page NJ NY CT 1/1/02 1/1/02 1/1/02 English English English CT Cover Page CT 2/15/02 English NY Cover Page NY 6/16/02 English When you assemble a document for the customer shown here, the third content item isn t selected because its Effective Date attribute is later than 3/1/2002. The second content item doesn t qualify because its Jurisdiction is Connecticut. Figure 24. A view of the Customer Data table. The first content item qualifies because its Effective Date is earlier than the value in the customer record and because the Language attributes match.

47 47 Chapter 6 - Adding Items to Your Document Creating a Content Rule To create a Content rule: 1. In your tree view, select the position for the new rule. When you add a rule it will be placed directly beneath the item you selected. 2. Click New Rule on the Rule menu, or right-click the document name and then click New Rule on the shortcut menu. The Rule Creation wizard appears. 3. Select Content from the Rule Type list and click Next. 4. Provide a name for your content rule. The name can be alphanumeric characters in length. 5. Specify a section level if necessary and click Next. If you are creating a rule adjacent to a section rule, you may be able to specify a section level in the Rule Creation wizard. A section level of 0 indicates that the rule is at the root level. A section level of 1 indicates that the rule belongs in a first level section rule. A section level of 2 indicates that the rule belongs in a section rule within another section rule. A new rule inherits the section level of the rule directly above it, if that rule is collapsed. If the rule is open, the new section rule will exist within the section. 6. The Is the new rule required for assembly? page appears. Select one of the three assembly options. Element Not required Rule required for assembly Optional content for on-demand use Description The default selection, and probably the one you ll use most often. Assembly of the document continues even if the rule fails to select a content item. Requires the Content rule to find a qualifying content item during document assembly. If the rule doesn t select a content item during assembly, the assembly for that record fails. Required text rules are often used for must-have items such as cover pages. Adds an optional paragraph that can be used by transactional applications like xresponse where users can choose the paragraph they want from the Optional Paragraph Group list. For function definitions, and more information about creating and using optional paragraphs, see About Optional Paragraphs. After making your selection, click Next. 7. The Add a content group to this rule? page appears. This page enables to immediately start the Content Group Creation wizard. Click Add to launch the Content Group Creation wizard now, or click Finish to add a content group at a later time. xdesign will automatically add a content group if you do not choose to create one. For instructions on creating a content group, see Creating a Content Group.

48 48 Chapter 6 - Adding Items to Your Document About Content Groups A content group is a grouping of similar content items where only one content item in the content group can be selected for a particular assembly request. A content group can be configured to hold text content, external content which acts as a reference to an external PDF document, and an end-page-stub. How Do Content Groups Work? xdesign uses content groups to identify and classify every content item within your document. For example, a content group might contain four different content items that contain different text as required by four different jurisdictions. Figure 25. Several content items in one content group. Each content item in this example contains a Jurisdiction attribute that xdesign compares to the mapped value, typically a field in the customer data source, from the Mapping option in the Category the document has been created in. xdesign starts with the first content item in the content group and examines each in succession until it finds a match. A rule can also contain more than one content group. For example, your document may be designed to create a letter, of which there are two versions. The version that is used depends on a value in the data, in this case, the name of the financial institution. The rule would contain two content groups, each containing a different version of the same letter. Figure 26. One rule with two content groups. When xdesign assembles a document, it will include only one content item from the one content group that meets your assembly criteria. The order of the content groups in the example is very important since only one of them has criteria assigned to it. If you were to switch the order, the Standard content group with no criteria would always be selected, and therefore the Wells Fargo content group would never assemble. If the criteria on the content group never evaluates to true, in other words there is no relevant text within the content group, no content would qualify from the rule, and xpression would move on to the next rule in the tree. To sum it up, you want the Standard content group to qualify only if the value of FIN_INST_NAME is anything other than Wells Fargo, but you have to check to see if it is Wells Fargo first.

49 49 Chapter 6 - Adding Items to Your Document Another scenario: It s not uncommon to have an xdesign content group that contains two versions of content for the same section of the document. This can occur when you need to make updates to an existing content item, but don t want to remove the old content item. You can create two versions of the same content item that have different effective dates. This might also happen when there are different requirements or regulations for different states. In this case you could use the Jurisdiction attribute to control which content item is selected. Content Group Types You can create three different types of content groups, Text, External Content, and an end-page-stub. Text Content Groups Text content items are the most common type of content group. Use this option if you plan to create your content through xdesign in Microsoft Word. Some interesting information about text content items: xpression text content is internally designated as Publish, CompuSet, or Universal depending on where it s created and what features it includes. If you create a text content item that doesn t contain features unique to a publishing type, the content becomes universal and can be copied and pasted into any document, or shared with other documents along with its rule or by itself. The type of publishing engine you select for your document determines what formatting features will be available for use in creating your content. For example, if you create a text content item in a CompuSet document you will be able to include CompuSet commands and named strings, where a text content item created in an xpression Publish document will not be able to use those features. If a text content item belongs to a shared rule, and it does not contain publishing-specific features, it is tagged as universal and is available for use wherever the shared rule is applied. If you include a shared rule from a different document, and it has content that doesn t qualify to be shared, that content is not brought into the new document with the rule. For more information, see Shared Content and Shared Rules. External Content Groups External content groups enable you to include externally created PDF documents in your xpression document. You can retrieve these PDFs from a location on your server or network, a Documentum docbase, or a Filent ECM system. See Creating an External Content Group.

50 50 Chapter 6 - Adding Items to Your Document Some interesting information about external content in xpression Publish documents: An external content group references an external PDF document as its content and, as such, doesn t contain content as you would find in text content groups. A content rule can contain text content groups and content along with external content groups. You can share external content groups only if you share the content rule in which they reside, they cannot be shared outside of the rule. If you change a text content group to an external content group, any content you had created in the text content group will be deleted. End-Page Stub Content Groups The End-Page Stub content group enables you to include a content item that will appear in its entirety at the end of the last page of the document. If there is insufficient room at the end of the last page, the entire stub will appear on a new page according to logic that you set up in the content group. See Creating an End-Page-Stub Content Group. Some restrictions apply to this content group type. Publisher must be xpublish. Must be the last item in the document. Only appears in PDF output. Page size must be set to the size of the stub. Creating a Content Group You can start the content group creation wizard from the content rule wizard, or by clicking Rule from the xdesign menu, selecting New Rule, and clicking Content Group. If continuing from the content rule creation wizard, xpression automatically applies the name of the rule to the content group, but you can change this name if needed.

51 51 Chapter 6 - Adding Items to Your Document To create a content group: 1. After starting the content group creation wizard, supply a name for the content group. The name can be alphanumeric characters in legth. The pipe symbol ( ) is not supported for content group names. 2. If you are working in an xpression Publish document, this page will contain the Content Group Type option in the dialog box. You must choose your content group type. You can choose Text, External Content, or End-Page Stub. Make your selection and click Next to continue. Figure 27. Choose your content group type. 3. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria. 4. The Add content to your content group page appears. This page enables you to immediately start the Content Item Creation wizard. If you are creating a Text content item, there are no other options on this page. You can click Add to launch the Content Item Creation wizard now, or click Finish to add a content item at a later time. For xpublish users, if you are creating an end-page-stub, this page contains options for the end-page-stub attributes. If you are creating an external content group, this page contains options that enable you to select your external content. When you have finished selecting options, click Finish.

52 52 Chapter 6 - Adding Items to Your Document Creating an End-Page-Stub Content Group An End-Page Stub content group places a formatted content item at the end of a document. An end-page-stub will take up an entire Microsoft Word page, even if the size of the stub is very small. To force your stub to fit on an output page with the previous content item, you must change the size of the Microsoft Word page to match the size of the stub. The End-Page Stub feature is subject to these cautions and limitations: The End-Page Stub must be the last item in the document. Supported output formats are PDF, Postscript, AFP, VPS, TIFF, and PCL. HTML, MSOHTML, and text are not supported. End-Page-Stub is an xpublish only feature. To create an End-Page Stub: 1. After starting the content group wizard as shown in Creating a Content Group, the Add content to your content group page appears. This page contains options for the end-page-stub attributes. Figure 28. From this page you can set end-page-stub settings, click Add to start the content item creation wizard, or click Finish.

53 53 Chapter 6 - Adding Items to Your Document 2. The Content Page Overflow option controls what happens when the content of the stub does not fit on the same page with the previous content. An end-page-stub will not break across a page, it must appear entirely on one page. There are three options: Ignore pushes the stub to the next page, which may be verso or recto. The Vertical Offset setting is ignored, but horizontal offset is honored. Offsets are established later in this procedure. Force Next Page Verso and Position adds a new page if required to place the stub on a verso page. Force Next Page Recto and Position adds a new page if required to place the stub on a recto page. If your stream definition specifies simplex the effect of this setting may not be obvious unless the document has page numbers. If the stub does not fit on the current recto page, page 5 for example, it will be forced to the next recto page, page 7. However, since page 6 is blank it will not be explicitly produced using simplex. It will not be clear that the stub appears on a recto page unless page numbers appear on the page. Select one of these options. 3. The Headers and Footers option enables you to select how you want to handle headers and footers on the page where the Stub appears. You have four options: Ignore includes header and footer as on other pages. Suppress Header Only suppresses the header. Suppress Footer Only suppress the footer. Suppress Header and Footer suppresses both header and footer. Select one of these options. 4. The Positioning section contains options for the horizontal and vertical offsets. These options determine the position of the Stub on the page. In most cases, the vertical offset should be sufficient to place the Stub at the bottom of the page, but not so far down the page as to risk overwriting the footer. The offset values are in points, and use the margins as the reference point. Note: Ensure that you fully consider the page size of the End-Page Stub content item when establishing this setting. If your end-page-stub does not fit on the page with the previous content item, change the page size of the end-page-stub content item. You can effectively reduce the page size by increasing the top margin for the End-Page Stub content item. 5. This page enables you to immediately start the Content Item Creation wizard. If you are creating a Text content item, there are no other options on this page. You can click Add to launch the Content Item Creation wizard now, or click Finish to add a content item at a later time.

54 54 Chapter 6 - Adding Items to Your Document Creating an External Content Group An external content group enables you to include PDF content from outside of the xpression system. To create an external content group: 1. After starting the content group wizard as shown in Creating a Content Group, the Add content to your content group page appears. Figure 29. From this page you can select your external content. 2. From the external content type list, select PDF. 3. From the external content source list, select File, Documentum, or Filenet. Select File when you are retrieving the PDF from a location on your network. Select Documentum or Filenet when you are retrieving the PDF from an existing Documentum Docbase or Filenet ECM system.

55 55 Chapter 6 - Adding Items to Your Document 4. If you selected File, you can retrieve the PDF from a Network Location by specifying the following settings. Element External Content Name Literal Field Variable Description This is the path to the location of the PDF document. You cannot edit this path directly. You must build the path from a combination of one or more Literals, Fields, or Variables, or click the Browse button to locate the path and have it inserted automatically. With this option you can type a string of alphanumeric characters in the edit box. You can also click the button to its right to navigate to location of the PDF file. When you click Open in the External Content File Selection dialog, the entire path to the PDF is entered in the edit box. Select this option to choose a data source group, one of its tables, and then the specific field you want to use. Select from the list of variables you have defined for this document. See Variable Rules. If you selected ECM, you can retrieve the PDF from an ECM system by specifying the following settings. Element ECM Configuration External Content Name Literal Field Variable Description Select your Documentum ECM Configuration from the list. This is the path to the location of the PDF document. You cannot edit this path directly. When you click the Browse button, xpression displays the contents of the Documentum Docbase. Select the item you want and click OK. Notice that the External Content Name box contains a path to the PDF you selected. With this option you can type the path to the PDF in the Documentum Docbase. For example: /xpressionfiles/pdfs/earningsstmt Select this option if you want to supply the Documentum path from your data source. Choose a data source group, one of its tables, and then the specific field you want to use. Select this option if you want to supply the Documentum path and file name with a variable. See Variable Rules.

56 56 Chapter 6 - Adding Items to Your Document If you selected Filenet, you can retrieve the PDF from your ECM system by specifying the following settings. Element ECM Configuration External Content Name Literal Field Variable Description Select your Filenet ECM Configuration from the list. This is the path to the location of the PDF document. You cannot edit this path directly. When you click the Browse button, xpression displays the contents of the Filenet ECM system. Select the item you want and click OK. Notice that the External Content Name box contains the path to the PDF you selected. With this option you can type the path to the PDF in the Filenet ECM system. For example: /xpressionfiles/pdfs/earningsstmt Select this option if you want to supply the path to the PDF from a field in your data source. Choose a data source group, one of its tables, and then the specific field you want to use. Select this option if you want to supply the PDF path and file name with a variable. See Variable Rules. 5. Each time you define either the path or a piece of the path and click Add, the item is placed in the list at the bottom of the page. It is also placed in the External Content Name box. 6. You can modify an item by selecting it to place it in the edit box, making your changes and then clicking Update. You can take an item out of the path, no matter where it appears, by selecting it in the list and clicking Remove. 7. Click Finish to complete the external content group reference. About Content Items Content items are Microsoft Word based pieces of content that you can add to your document through a content rule and a content group. Content items can be consist of as little as a few words of text or can be many pages in length. When you create or edit a content item, xdesign launches the Microsoft Word editor in which content can be created.

57 57 Chapter 6 - Adding Items to Your Document Creating a Content Item You can start the content item creation wizard from the content group wizard, or by clicking Content from the xdesign menu, selecting New Content, and clicking Content. Note: xpublish does not support continuation of numbered lists across content items. Numbering will restart with the following content item. 1. After starting the content item wizard, supply a content item name. The name can consist of alphanumeric characters. Click Next. Caution: Document Sciences recommends that you avoid using apostrophes (') when naming your content item. Document migration and import will fail if one of your content items contains an apostrophe. 2. The Attributes page appears. Select the values for the attributes shown on the Attributes page. xdesign uses attributes and selection criteria to choose the proper content item from each Content rule when you assemble a document. The example shown below is one implementation; your company will probably use different attribute sets. Figure 30. Select your attributes. If you don t use attributes, this page won t appear. 3. Click Finish to start Microsoft Word if you are adding text content. Note: When you have finished editing your content item, be sure to Generate XML and create or update the Document Version so that the changes are correctly saved to the xpression database.

58 58 Chapter 6 - Adding Items to Your Document Content Item Properties After you define a content item, you can use other xdesign functions to work with it further. If you have Write access to a document, you can view and modify content item properties; with Read access you can view, but not modify, the properties. Approved content items can t be modified. To view or modify content item properties, rightclick a content item and select Properties from the shortcut menu. Figure 31. Viewing content item properties. The Content Item properties dialog box contains the following tabs. Element General Attributes Annotation Description The General tab enables you to change authoring tool of active content items The Attributes page enables you to add, remove, or annotate the attributes associated with a content item. See Defining Content Item Attributes for more information. Annotations made on the Annotation page are associated with the content item. For example, you could choose to add information such as who created the document, and when it was created. Annotations added to content items are displayed in xrevise when you preview the content item. Content item components cannot be changed once the content item is approved. This is not true for annotations made on this page, which can be changed after the content item is approved. This enables you to add an annotation to a document without creating a new version.

59 59 Chapter 6 - Adding Items to Your Document Element Last Change Description This tab shows the content item description, the user who made the last change to the item, and the date and time of the change. Defining Content Item Attributes The Attributes page enables you to add, remove, or annotate the attributes associated with a content item. The note symbols next to the AK and CA jurisdictions shown below indicate that an annotation has been added. Select the jurisdiction and click Annotation to view the note. Figure 32. Attribut e tab with annotated Jurisdiction attribute. These indicate that a note is attached to the attribute When you add a new attribute to an existing content item that contains the effective date attribute, the effective date of your new attribute will be set according to the following rules: If the document itself contains an effective date, the document effective date will be used. If the document does not contain an effective date, the default effective date defined in xadmin will be used. If the document does not contain an effective date and no default effective date was specified, xpression will use the current date. Note: Annotations added to attributes are not available in xrevise.

60 60 Chapter 6 - Adding Items to Your Document Using Conditional Logic and Selection Criteria Conditional rules are content rules that use selection criteria to determine which content group is selected when the document is assembled. xdesign compares the criteria in the document to the customer data in the data source and selects content items only for the customers who meet the criteria. Use criteria to add flexibility and customization to your documents. How Does it Work? Every Content rule in a document uses one content item from one content group per customer record. To identify the one correct content item to use, xdesign applies certain optional filters called usage attributes to each content item. If the fields in this attribute set are not the fields you need to use to filter this content, you can define additional filters called selection criteria. xdesign uses selection criteria to choose between content groups by comparing the information (for example, number of dependents, age, and benefits selection) found in a customer record. If the information in the customer record matches all of the values specified by the criteria, xdesign will move on to select the most appropriate content item in the chosen group, determined by the attributes attached to the criteria s content item. Information from the data source must match all of the criteria attached to the content group before the correct content item associated with the content group will be selected. If the customer record doesn t match, xdesign searches for another content group and criteria in the rule and repeats the comparison. If xdesign finds nothing that matches, none of the content items attached to the rule will appear in the assembled document.

61 61 Chapter 6 - Adding Items to Your Document How Do I Create Selection Criteria? You can add selection criteria when adding new rules using the New Rule or New Content Group wizards, or you can add them later by selecting the rule or content group and clicking Properties on the shortcut menu. Figure 33. The selection criteria added from wizard. Because of the encoding support differences between an XML data source (UTF-8) and the underlying code used to build xdesign (ISO8859-1), special characters in XML data such as the copyright symbol ( ) or accented characters like å are seen differently by xpression and will return unpredictable results if you use them in a criteria statement. You can work around this by inserting this line at the beginning of your data file: <?xml version= 1.0 encoding= ISO ?>

62 62 Chapter 6 - Adding Items to Your Document If this isn t possible, rather than creating a criteria statement that compares a field in the XML data source to a value typed into xdesign, configure the criteria to compare the value of the field to another field in the XML. Tip: If a data source field contains several possibe matching values, you can create a selection criteria that checks for a variety of possible values in that field. For example, say you have a data source field called MARITAL_STATUS, and that field could contain the values SINGLE, MARRIED, DIVORCED, or WIDOWED. You could create the following selection criteria: Field EQ *SINGLE* or Field EQ *MARRIED* or Field EQ *DIVORCED* Alphanumeric Operators xdesign uses alphanumeric operators to compare the value specified against the value in the customer record. The default operator is EQ (=). xdesign supports six standard operators. Element EQ (=) NE (<>) GT (>) GE (>=) LT (<) LE (<=) Description Equal to. Includes all records exactly matching the entered value. Not equal to. Includes all records except the ones matching the value entered. Greater than. Includes all records chronologically after or numerically greater than the value entered. Greater than or equal to. Includes all records matching, chronologically after, or numerically greater than the value entered. Less than. Includes all records chronologically before or numerically less than the value entered. Less than or equal to. Includes all records matching, all records chronologically before, or numerically less than the value entered. xdesign doesn t support colons in criteria fields of Read or Table rules. For example, don t use time criteria (hh:mm:ss) values. Read and Table rule criteria are case-sensitive; GoTo, Text, and Section rule criteria are not. Combining Multiple Criteria You can add additional operators to selection criteria by selecting from the Add Symbols toolbar. When you use the & (AND) condition as shown below, every part of the condition must be met before xdesign selects the content item.

63 63 Chapter 6 - Adding Items to Your Document In this example, the value in the customer's MARITAL_STATUS field must be equal to MARRIED and their RATE_CLASS must be less than or equal to 3 to assign a content item. Figure 34. Using the AND condition. If you use the OR condition, xdesign selects the content item if either criteria is met, in this case if MARITAL_STATUS is MARRIED, or if the RATE_CLASS is less than or equal to 3. Figure 35. Using the OR condition. Parentheses allow you to control the order in which each row in the criteria is evaluated. xdesign processes criteria inside the parentheses first rather than sequentially as they appear in the Edit view. Parentheses can cross multiple fields, but you may not nest sets of parentheses. If you fail to add a closing parenthesis, a reminder appears. If you use both AND and OR conditions together, you must use parentheses.

64 64 Chapter 6 - Adding Items to Your Document Here is an example of qualifying a compound condition by following it with an OR condition. Figure 36. The compound condition followed by OR In this example, the parentheses create a compound condition that requires both of the criteria within the parentheses to be satisfied in order for a content item to be selected. If the conditions in the parentheses are not met, the OR condition that follows permits the content item to be selected if the AGENT value equals JACK JONES. Note: NULL can be used to test for the absence of any value. The View Tab Click the View tab to see a graphical representation of the criteria you created. Using Selection Criteria in Other Rules You can significantly improve the performance of your xdesign document by adding selection criteria. If the criteria is satisfied, the contents of the containing rule will be evaluated. If the criteria fails, xpression will skip this rule and move to the next rule in the Design Tree. Criteria for a section can be based on: Information within the data source. End-of-file conditions in the data source. A combination of these items. Creating Selection Criteria To create selection criteria: 1. Supply a name for your criteria statement. The name can be up to a 255-character description of your criteria. The default name is Criteria. Though the description plays no part in its functionality, giving the criteria a unique and very descriptive name is highly recommended. The more descriptive the name, the

65 65 Chapter 6 - Adding Items to Your Document easier it will be for you to find and identify what this criteria does at a later date. It also make it easier to share this criteria with other documents. Click OK to return to the Criteria page. 2. The variable section allows you to choose what kind of variable you want to use in your criteria statement. Your choices are field, variable or literal. If you choose Field, you will see three drop-down lists. Choose the data source name from the top list, the data source table from the middle list, and the field name from the bottom list. The column you select appears under Variable in the Edit window. If you choose Variable, you will see one drop-down list. Choose the output variable name from the list. The variable you select appears under Variable in the Edit window. 3. Between the Variable and Compared to sections is the is drop-down list. This list contain the operator you can use to compare the two values. See Alphanumeric Operators for further information. Select the appropriate operator. 4. In the Compared to section, you can compare the first value to a static alphanumeric value, to the contents of a field in a data source, or to a user-define variable. By default, xdesign selects Value. If you select Value, enter an alphanumeric value in the box. If you select Field, choose a data source, data source table, and data source field that contains the desired value. Don t select a field with parentheses embedded in the field name because xdesign will return unpredictable results. If you select Variable, choose the variable that contains the value. 5. You have now created a single criteria row. You can add additional rows using the Add Symbols buttons. See Combining Multiple Criteria for more information. To see a demonstration of this feature, click here. Multiple Data Source Groups You can read a record from a secondary data source that is not the same type as the primary data source. For example, you can set up a Read or Table rule, define criteria, or use a replacement from a secondary DB2 data source, when the primary table is XML or Oracle.

66 Chapter 7 Using Rules 7 In this chapter we will discuss all of the xdesign rule types with the exception of the content rule which is discussed in About Content Rules. Depending on the make-up of your data source, you may or may not be able to use certain rules. If your data source contains only one table or view, you can create GoTo, Label, Section, Variable, Subdocument, and Content rules. You cannot create Read, Read Next, or Table rules. If your data source contains two or more tables or views, you can create all the rule types: GoTo, Label, Read, Read Next, Section, Table, Variable, Subdocument, and Content. About Section Rules Documents with long sequences of rules can be difficult to read and manage. A Section rule improves document readability by acting as a folder holding a group of related rules and subsections. Large documents become more manageable, and their organization becomes more apparent to other users. Figure 37. Section rules can contain criteria. Section Rule Content Rules Additionally, section rules enable you to flag your section for specific recipients, xrevise revision units, and section-level markers. Note: Keep in mind that using a large number of sections causes xpression to process more items and this can degrade your assembly response time.

67 67 Chapter 7 - Using Rules Recipients Section Rules enable you to designate sections of your document for specific recipients. For example, if you are creating an insurance policy document, you may need to create different packages to go to the client, the agent, and to the home office. xpression enables you to easily create these three distinct packages from a single document. Revision Units Section rules are also used to establish the limits of a Revision Unit. Use Revision Units to divide the document into sections that can be handled individually by xrevise. Using Revision Units improve the way the Revise Carry Forward utility works, so using them should be considered for any document that may be subject to negotiated revisions. For more information, see Using Revision Units with Section Rules. Markers Markers enable you to implement print device (tray selection, simplex/duplex settings, watermarks) in your document. Section-level markers implement print device functions on a section of content in your documents. Section-level markers override output stream-level markers. Markers must be placed before the page (at the page boundary) where you want to marker to take effect. For more information, see the xadmin Enterprise Edition User Guide. How Do I Create a Section Rule? To create a Section rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. You can also select an existing rule that has been designated as shared by clicking Shared Rule List on the shortcut menu and then selecting the rule you want to use. 3. To create a new Section rule, select Section from the Rule Type list and click Next.

68 68 Chapter 7 - Using Rules 4. The Section Rule page appears. Figure 38. Creating a new section rule. Type a name for your section rule. The name can be alphanumeric characters in length. 5. Enter a section level. A section level of 0 indicates that the rule is at the root level of the document. A section level of 1 indicates that the section rule belongs inside a first level section rule. A section level of 2 indicates that the rule belongs in a section rule that is within another section rule. If this is a CompuSet document, and the content will be part of an output stream, select Is this a new Page Sequence? For more information, see Recipient Processing. 6. If you want to add recipients to the section rule, select the Recipients check box and select one or more of the available recipients from the list. Note: (CompuSet only) If you are using recipient processing in your Section rules, you may experience unpredictable results if recipients are not defined for all of the sections. For more information, see Recipient Processing and the Output Management Subsystem. 7. If you want to apply a marker to this section, select the Marker checkbox and select an existing marker definition from the list. Click Next. 8. You can use selection criteria with a Section rule to improve assembly performance. For example, if your customer data meets the selection criteria of a given section, xpression Design processes the section; if the criteria fails, xpression Design skips the section, thus saving processing time. For more information,

69 69 Chapter 7 - Using Rules see Using Conditional Logic and Selection Criteria. If you don t want to add selection criteria, click Finish and xpression Design adds the new rule to your document. 9. If you want to start a new Revision Unit, select the Section rule, right-click it, and then click Properties. Provide a name for it on the Revision Unit tab. You can construct the name from any combination of literal values, fields, and variables. You cannot set the Revision Unit name in the New Rule wizard. For more information on Revision Units, see Using Revision Units with Section Rules Note: If you make any changes to the rules structure, be sure to Generate XML and create or update the Document Version so that the changes are correctly saved to the xpression database. To see a demonstration of this feature, click here. Can I Change the Section Level of a Rule After I Define It? The simple answer to this question is yes. But, because changing section levels can alter document assembly, be very careful when you do! xpression Design assigns a section level to all rules. If you change the section level of any rule within a section, the section ends with the rule previous to the modified rule. xpression Design moves all rules that appear after the modified rule in the section to the same section level as the modified rule. For example, the document shown below contains two Section rules: one with a section level of 0, and another with a section level of 1. The highlighted Content rules have a section level of 2. Figure 39. Section level before change. Section Level 2

70 70 Chapter 7 - Using Rules If you click Properties in the Misc. Content rule shortcut menu and change the section level setting to 1, xpression Design also changes the level of the Drafts rule to 1. Figure 40. Section level after change. Level Changed to 1 Can I Copy a Section? Yes, you can copy a section within the same document or into another document. If you copy a section that is closed in the Tree (+), xpression Design copies the section and all of the rules within the section. If you copy a section that is open in the Tree (-), xpression Design copies only the section rule itself. Any modifications you make to the original version of the section version won t affect any of the copies. Using Revision Units with Section Rules Revision Units combine contiguous elements within a work item into a single object and provide a context within which xrevise can efficiently manage revisions to the document. By default the entire work item (and the entire document) is a single Revision Unit. Adding a Section rule does not automatically start a new Revision Unit. You need to provide a name on the Revision Unit tab of the Properties dialog box for the Section rule that begins the Revision Unit. The name can consist of any combination of variables, fields, and literal content. Revision Units cannot be nested; the previous Revision Unit ends whenever you start a new Revision Unit, regardless of where the Section rule resides in the hierarchy.

71 71 Chapter 7 - Using Rules Additional Revision Units are established with Section rules by providing a name for the Revision Unit. When performing the carry forward function, Revise uses the name that you provide to compare historical versions of the work item with the current one. Figure 41. The Revision Unit tab enables you to build a name for the Revision Unit from any combination of literal, field, and variable values. The Revision Unit tab is not available if the reviseru property in revise.properties is FALSE. The Revision Unit tab provides the following functions: Element Revision Unit Name Literal/Field/Variable Revision Unit Name Description Displays the full Revision Unit name. This field shows the Revision Unit name in a linear fashion. It is for reference only. Changes are generally not allowed, and any changes that are allowed in this field are not saved. Enables you to create name elements. Select the radio button for the type of element you want to add to the name. The space immediately below these radio buttons will change to reflect your choice. That is, when Literal is selected, the space is a text field where you can type the literal value that you want to apply. When Field or Variable is selected the field becomes a list or series of lists from which you can select the object that you want to use. This list shows individual name elements. The Revision Unit Name field near the bottom of the tab lists each element of the name individually. When you select an element in this field, the element is displayed in the Literal/Field/Variable area. When selected an element can be modified or removed. The Revision Unit Name cannot exceed 255 characters.

72 72 Chapter 7 - Using Rules Element Annotation Add Update Remove Description Adds an annotation to the Revision Unit. Click this button to open the Annotation dialog box and create an annotation for the Revision Unit. Adds a new name element. This button becomes active when you have created a valid name element in the Literal/Field/Variable section. Updates a new name element. This button becomes active when you have selected an existing name element. Click it to apply any changes that you have made to the name element. Removes existing elements. This button becomes active when you have selected an existing name element. Click it to remove the selected element. Creating a Revision Unit Name To create a Revision Unit name: 1. Select the Section rule that you want to use to begin the Revision Unit. See How Do I Create a Section Rule? for instructions on creating a section rule if one does not exist in the desired location. 2. Right-click the rule and then click Properties. 3. Click the Revision Unit tab. Caution: If you start a Revision Unit inside a loop, include a variable or counter in the Revision Unit name. A Revision Unit will be created with each iteration of the loop. If the Revision Unit name does not include an element that changes with each iteration, each Revision Unit created by the loop will have the same name. 4. Select Literal, Field, or Variable to determine the data type for the element. 5. Create the name element. If the element type is Literal, type the literal value. If the element type is Field or Variable, select from the available objects in the list(s). The Revision Unit name cannot be the same as any other Revision Unit. Note that, by default, the first Revision Unit is named the same as the document name so this name cannot be used for any other Revision Units. The complete name cannot exceed 256 characters. 6. Click Add. 7. Repeat steps 4 through 6 until you have created the desired name. 8. To change or remove an element, select it in the Revision Unit Name field near the bottom of the tab. Make the change in the Literal/Field/Variable area and click Update to apply a change, or click Remove to remove the element. 9. When satisfied with the name, click Ok.

73 73 Chapter 7 - Using Rules Revision Units General Information Some important points about Revision Units: Revision Unit boundaries override merge markers. If a Revision Unit begins with a paragraph that is marked for merge with the preceding paragraph, the merge marker will be ignored. If you use the.net editor in Revise, the way optional paragraphs are handled depends on whether the document includes a Revision Unit other than the default, whether the RU property is set to true, and how the optional paragraphs are deployed in the document. Refer to About Optional Paragraphs for information on creating optional paragraphs, and the Administering the xpression Enterprise Edition Server for more information on setting property values. Revision Units do not affect xresponse or xpression Batch functions. If external content occupies a Revision Unit with other content, the external content will be merged with the other content. If the external content occupies the Revision Unit exclusively, it will remain unchanged. For documents that may be used in xrevise, external PDF content must occupy a Revision Unit with no other external content or xpression database objects. There can be a sub-document in the Revision Unit as long as it follows the external PDF content. When you create a new work item, any merged content will be combined into a single Revision Unit. Revision Units and Subdocuments Revision Units in subdocuments are treated the same as Revision Units in the master document. Any content after a subdocument will be ignored unless you start a new Revision Unit after the subdocument. Revision Units and Optional Paragraphs Optional paragraphs must be contained in a separate Revision Unit, if any Revision Units are defined in the document. Optional paragraphs can be contained in the default Revision Unit as long as no other Revision Units are defined. Optional paragraph behavior is determined by the reviseru value in xrevise.properties. If this value is FALSE, then optional paragraphs are handled as described in About Optional Paragraphs. That is, if set to Multiple the paragraphs can be employed in combination with other paragraphs, but if Single they cannot be used with others. If reviseru is TRUE, then Revise does not distinguish between Single and Multiple optional paragraphs; you will be able to select any combination of optional paragraphs. Refer to Administering the xpression Enterprise Edition Server for more information on changing xpression properties. Optional paragraphs are distinguished by a checkbox in the Revise editor Table of Contents. Refer to the xrevise Reference Guide for more information on using optional paragraphs with your Revise work items.

74 74 Chapter 7 - Using Rules Label Rules Although Label rules contain no content groups, criteria, replacements, or content items, they can serve several functions in a document. You can use one as: A placeholder that defines the beginning of a Read loop. A destination for jumps defined by GoTo rules. A note inserted in the rule list. Creating a Label Rule To create a Label rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. You can also select an existing rule that has been designated as shared by clicking Shared Rule List on the shortcut menu and then selecting the rule you want to use. 3. To create a new Label rule, select Label from the Rule Type list. 4. Enter a character description. The label description must be unique within the document. 5. Specify the section level. You can insert a Label rule only within the current section level, or in a section with a level number less than the current section level. 6. Click Finish. xpression Design adds the new Label rule to the document. Figure 42. The document properties pane shows the rule section level and identifies any GoTo rules that use the Label rule as a destination. To see a demonstration of this feature, click here.

75 75 Chapter 7 - Using Rules GoTo Rules xpression Design uses GoTo rules to jump from one location to another in a document. If you use a GoTo rule to build a loop, it must have selection criteria attached to it. If it doesn t, the GoTo rule will create an endless loop condition when you attempt to assemble the document. For more information, see Creating a Read Loop. What does a GoTo rule do with selection criteria? If the data in your customer records satisfies the selection criteria you apply to the GoTo, xpression Design processes the jump. If the criteria aren t met, xpression Design moves on to the next rule after the GoTo in the rule list. Creating a GoTo Rule To create a GoTo rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. You can also select an existing rule that has been designated as shared by clicking Shared Rule List on the shortcut menu and then selecting the rule you want to use. 3. To create a new GoTo rule, select GoTo from the Rule Type list. 4. Pick the Label rule you want xdesign to jump to from the list. You won t be able to continue until you do. If you don t have at least one Label rule in the document already, click Cancel and start the New Rule wizard again to create one. Figure 43. Select a label from the list of existing label rules. 5. Specify the section level for the GoTo rule, if necessary. A new rule inherits the section level of the rule directly above it.

76 76 Chapter 7 - Using Rules 6. Define your selection criteria, if any. For more information, see Using Conditional Logic and Selection Criteria. 7. Click Finish and xpression Design adds the new GoTo rule to the document. Figure 44. The GoTo list appears in your tree pane. To see a demonstration of this feature, click here. Read Rules The primary table in the data source is defined by your system administrator using xadmin and chosen from an alphanumeric list of tables defined by the Schema. The main table contains unique records for each of your customers, including customer number, name, and address. xpression Design reads this table automatically. Read rules access customer file tables other than the primary table. These secondary tables contain records relating to the main table, such as purchase order records or sales records. Each secondary table contains at least one column, or foreign key, that matches a column in the primary table. This key links the two tables, and enables Read rules to identify and select the correct records from the table. Tables may contain more than one record related to each customer. Read rules retrieve information from these tables during assembly. They identify the table to be used and find the first record in that table that matches the foreign key in the primary table. Read rules enable you to define a query

77 77 Chapter 7 - Using Rules that qualifies a record to be read by xpression Design. xpression Design retrieves all qualifying records and points to the first record that qualified. Note: If you retrieve more than one matching record, Read rules enable you to sort the records retrieved. Creating a Read Rule To create a Read rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. 3. To create a new Read rule, select Read from the Rule Type list and click Next. The Read Rule page appears. Figure 45. This page enables your to define your query, select a data source and table to read, and define the rule as a Read or Read Next rule. 4. The query you create through this wizard can be saved and shared with your other rules. Chart rules and read rules also use queries. If you want to reuse queries among your rules, supply a unique name for your query in the Query Name box and then set your query as Shared according to the steps in Sharing Rule Queries. 5. Select a data source group and data source table from the lists. From the first list, choose a data source group. From the second list, choose a table. The list of tables is derived from the data source group you selected in the first list.

78 78 Chapter 7 - Using Rules 6. Select Read. 7. If you are inserting this rule under an expanded section, xpression Design automatically assigns the section level to this rule. Decrease the section level by one to move the rule to the previous section. Level 0 indicates that the rule will be added at the document s root level. Click Next. 8. The Read criteria page appears. On this page you want to tell xpression which records to read in your secondary table. You can accomplish this by linking a field in your secondary table to a fixed value, to a field in your primary data source, or to a variable. For instructions on linking your secondary table field to a fixed value, see Linking Your Secondary Table to a Fixed Value. For instructions on linking your secondary table field to a field in your primary data source, see Linking Your Secondary Table to a Primary Table Field. For instructions on linking your secondary table field to a variable, see Linking Your Secondary Table to a Variable. After completing your read criteria, click Next. 9. If you are using a JDBC data source, you can specify one or more sort fields. Field sorting is an optional feature that enables you to sort the records retrieved by the Read rule. Select the fields you want to use to sort the list, then click Add. Selecting more than one field helps present the information in the most logical and helpful manner possible. Figure 46. Select a sort order field, choose Ascending or Descending, and click Add to add the sort field to the sort order list box. 10. Click Finish and xpression Design adds the new Read rule to the document. To see a demonstration of this feature, click here.

79 79 Chapter 7 - Using Rules Linking Your Secondary Table to a Fixed Value To link your secondary table to a fixed value, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Value option. After selecting this option, the Read Criteria page displays the Link to Fixed Value option. Figure 47. This page enables you to define your read criteria. Secondary Table Field Link Table Options Value box 3. Type a value in the Link to Fixed Value box and click Add. You can use NULL if you want to test for the absence of any value. The field/value link appears at the bottom of the page.

80 80 Chapter 7 - Using Rules Linking Your Secondary Table to a Primary Table Field To link your secondary table to a field in your primary data source, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Field option. After selecting this option, the Read Criteria page displays the primary data field options. Figure 48. This page enables you to define your read criteria. Secondary Table Field Link Table Options Data Source Group Primary Table Field in Primary Table The Read Criteria page contains the following options: Element Secondary Table Field Link Table Options Data Source Group Primary Table Primary Table Field Description Links the field in the secondary table you are reading to the primary table in the data source. Select Value and type a value using proper syntax. You can use NULL if you want to test for the absence of any value. If you select Field, select the table containing that field, and the field itself, from the Link to Field list. Select Variable to link the field to an output variable. You can use more than one field to build a query. You can read a record from a data source that is not the same type as the primary. Choose a data source group from the list. The table you want to link to. The table could be the primary table, or any secondary table you have read in the data source. Defines the field in the Link Table that directly relates to the Read Table field.

81 81 Chapter 7 - Using Rules 3. The Link to Field section contains three lists. From the top list, select the data source group where your primary table resides. 4. In the middle list, select the primary table. 5. In the bottom list, select the field in the primary table that you want to link to the chosen field in your secondary table. 6. Click Add. The field names in the query appear on the bottom of the page. Linking Your Secondary Table to a Variable To link your secondary table to a variable, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Variable option. After selecting this option, the Read Criteria page displays the Variable list. Figure 49. This page enables you to define your read criteria. Secondary Table Field Link Table Options Variable list 3. Select the variable from the list and click Add. The field/variable link appears at the bottom of the page.

82 82 Chapter 7 - Using Rules Read Next Rules When a Read rule identifies and reads the segment that contains the information you want to use, it returns all of the qualifying records; however, it points only to the first qualifying record in the segment. It s up to you to move through the qualifying records and process any other retrieved records. A Read Next rule instructs xpression Design to move the pointer from the current record returned by the Read rule to the next qualifying record. If there are no more qualifying records, xpression Design sets the end-of-file (EOF) condition. You can test for this condition using rule criteria by selecting the EOF:tablename entry from the Field list box on the Criteria window. The EOF condition is valuable because you can use it to end list processing when you run out of records. The EOF:tablename field value is Y if xpression Design runs out of records to read, and N if any records remain. Read Next rules also play a vital role in Read loop processing. For more information, see Creating a Read Loop. Creating a Read Next Rule To create a Read Next rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. You can also select an existing rule that has been designated as shared by clicking Shared Rule List on the shortcut menu and then selecting the rule you want to use. 3. To create a new Read rule, select Read from the Rule Type list. The Read Rule page appears. Figure 50. This page enables you to select your data source group and table, define the rule as Read or Read Next, and set the section level for the rule.

83 83 Chapter 7 - Using Rules 4. Choose a data source group from the first list. 5. Choose a segment from the second list and select Read Next. 6. Click Finish and xpression Design adds the new Read rule to the document. Table Rules As you would suspect from its name, Table rules are used to build tables in your content items using your customer data sources. You create the base table in a content item with Word s Insert Table utility. The table can contain one or more table header rows, and one or more data rows. A Table rule combines the functionality of a Read rule with criteria, a Label rule, a Read Next rule, and a GoTo rule. Essentially, a Table rule contains all of the elements of a Read loop within a single rule. The only difference is that you can include table headers in the loop. Table rules can have business logic. If the business logic is satisfied, xpression Design processes the rest of the Table rule logic. If the business logic is not satisfied, then xpression Design skips the table rule. Table rules support standard borders, as well as running table headers. You can create only one table in each table rule. Therefore, a content item can contain only one table. A table content item can have text before and after the table. How Do I Create a Table Rule? To create a Table rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. You can also select an existing rule that has been designated as shared by clicking Shared Rule List on the shortcut menu and then selecting the rule you want to use.

84 84 Chapter 7 - Using Rules 3. To create a new Table rule, select Table from the Rule Type list. The table rule page appears. Figure 51. From the Table rule page you can define the table rule name, select a query, define the data source and data source table to read, and define a section level. 4. Give your Table rule a name. The name can be alphanumeric characters in length. 5. The query you create through this wizard can be saved and shared with your other rules. Chart rules and read rules also use queries. If you want to reuse queries among your rules, supply a unique name for your query in the Query Name box and then set your query as Shared according to the steps in Sharing Rule Queries. 6. Select a data source group and data source table from the lists. From the first list, choose a data source group. From the second list, choose a table. The list of tables is derived from the data source group you selected in the first list. 7. If you are inserting this rule under an expanded section, xpression Design automatically assigns the section level to this rule. Decrease the section level by one to move the rule to the previous section. Level 0 indicates that the rule will be added at the document s root level. Click Next. 8. The Read criteria page appears. On this page you want to tell xpression which records to read in your secondary table. You can accomplish this by linking a field in your secondary table to a fixed value, to a field in your primary data source, or to a variable. For instructions on linking your secondary table field to a fixed value, see Linking Your Secondary Table to a Fixed Value. For instructions on linking your secondary table field to a field in your primary data source, see Linking Your Secondary Table to a Primary Table Field.

85 85 Chapter 7 - Using Rules For instructions on linking your secondary table field to a variable, see Linking Your Secondary Table to a Variable. After completing your read criteria, click Next. 9. If you are using a JDBC data source, you can specify one or more sort fields. Field sorting is an optional feature that enables you to sort the records retrieved by the Read rule. Select the fields you want to use to sort the list, then click Add. Selecting more than one field helps present the information in the most logical and helpful manner possible. Figure 52. Select a sort order field, choose Ascending or Descending, and click Add to add the sort field to the sort order list box. 10. Click Finish and xpression Design adds the new Table rule to the document.

86 86 Chapter 7 - Using Rules Linking Your Secondary Table to a Fixed Value To link your secondary table to a fixed value, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Value option. After selecting this option, the Read Criteria page displays the Link to Fixed Value option. Figure 53. This page enables you to define your read criteria. Secondary Table Field Link Table Options Value box 3. Type a value in the Link to Fixed Value box and click Add. You can use NULL if you want to test for the absence of any value. The field/value link appears at the bottom of the page.

87 87 Chapter 7 - Using Rules Linking Your Secondary Table to a Primary Table Field To link your secondary table to a field in your primary data source, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Field option. After selecting this option, the Read Criteria page displays the primary data field options. Figure 54. This page enables you to define your read criteria. Secondary Table Field Link Table Options Data Source Group Primary Table Field in Primary Table The Read Criteria page contains the following options: Element Secondary Table Field Link Table Options Data Source Group Primary Table Primary Table Field Description Links the field in the secondary table you are reading to the primary table in the data source. Select Value and type a value using proper syntax. You can use NULL if you want to test for the absence of any value. If you select Field, select the table containing that field, and the field itself, from the Link to Field list. Select Variable to link the field to an output variable. You can use more than one field to build a query. You can read a record from a data source that is not the same type as the primary. Choose a data source group from the list. The table you want to link to. The table could be the primary table, or any secondary table you have read in the data source. Defines the field in the Link Table that directly relates to the Read Table field.

88 88 Chapter 7 - Using Rules 3. The Link to Field section contains three lists. From the top list, select the data source group where your primary table resides. 4. In the middle list, select the primary table. 5. In the bottom list, select the field in the primary table that you want to link to the chosen field in your secondary table. 6. Click Add. The field names in the query appear on the bottom of the page. Linking Your Secondary Table to a Variable To link your secondary table to a variable, complete the following steps: 1. Select your secondary data source field in the Secondary Table Field list. 2. Select the Variable option. After selecting this option, the Read Criteria page displays the Variable list. Figure 55. This page enables you to define your read criteria. Secondary Table Field Link Table Options Variable list 3. Select the variable from the list and click Add. The field/variable link appears at the bottom of the page.

89 89 Chapter 7 - Using Rules How Does xdesign Process a Table Rule? A Table rule automatically looks for a text table when processing the content item. You can place text before and after a text table. Table rules process only the table body in the loop. Figure 56. Table rules only process the table body. Date: {LETTER_DATE} Client number: {CLIENT_NUMBER} {FIRST_NAME} {LAST_NAME} {STREET_ADDRESS} {CITY}, {STATE} {ZIPCODE} Dear {TITLE}. {LAST_NAME}: The authorization for automatic payment for your insurance premiums is shown below. Document Prefix Financial Institution {FIN_INST_NAME} Account Number {FIN_INST_ACCT_NUM} Automatic Payment Details Product Name Account Payment Frequency Next Payment Due {ACCT_NAME} {ACCT_ NUMB} {ACCT_ AMT} {ACCT_FRE Q} {ACCT_NEXT_PA Y_DATE} Table Body Please Review Please review the bank information and payment details shown above to confirm their accuracy. If you have any questions, contact {REP_NAME} at {REP_PHONE}, or contact Customer Service at Document Suffix Here s how xpression Design creates a table with a table rule: 1. The xpression Design assembly engine evaluates the Table rule selection criteria. If the rule criteria fails, xpression Design doesn t process the table. You ll be unable to test a field from the segment. To test a field in the segment to be used for the Table rule, add an additional Read rule above the Table rule to ensure that the field is available. 2. If the rule criteria is valid, xpression Design reads the segment. The read process stores one or more records. If an end-of-file condition occurs on the initial read, xpression Design skips the Table rule. 3. xpression Design selects a content item based on its attributes and selection criteria. If a content item qualifies, xpression Design processes the Table rule.

90 90 Chapter 7 - Using Rules 4. xpression Design scans the content item looking for the first data row in the table. The text before the first data row, including the table header information, is called the document prefix. Figure 57. The assembly engine finds the text table and saves the preceding text and table header information. 5. The xpression Design assembly engine scans the content item looking for the end of the table. It uses the table row information to build the dynamic table on the fly. Figure 58. The assembly engine looks for the end of the table. 6. The text that appears after the table is called the document suffix. Figure 59. The assembly engine saves the remaining text

91 91 Chapter 7 - Using Rules 7. xpression Design uses the data between the prefix and suffix to build the table. Figure 60. The assembly engine processes the table. 8. The Read and Read Next functions of the Table rule fill the table with data until the end-of-file condition occurs. Figure 61. The assembly engine fills the table with data using internal read loop logic. 9. xpression Design appends the prefix and suffix to the document, and saves the prefix, table, and suffix as a table object to the history database. Caution: If the content item for the Table rule does not contain a table, the entire content item repeats for each row.

92 92 Chapter 7 - Using Rules Sharing Rule Queries You can share your queries between Read, Chart, and Table rules. Sharing a Query To share a query: 1. First, supply a unique name for your query in the Query name box. This box is located in your rule creation wizard. Figure 62. The Query Name box in the Table Rule Creation wizard. This box also appears in the wizard for Chart and Read rules. 2. After supply a unique name, complete the steps in the rule creation wizard.

93 93 Chapter 7 - Using Rules 3. When your completed rule appears in the xdesign tree pane, expand the rule item to display the query you created. Figure 63. When a query is selected, the document properties pane displays the query logic. 4. Right-click the query and choose Share Query. 5. Notice that the query icon now contains a small hand which indicates the item is shared. Figure 64. Shared items are always indicated by the small hand graphic added to the icon.

94 94 Chapter 7 - Using Rules Using a Shared Query When creating a Read, Table, or Chart rule, you can reuse existing shared queries by selecting them from the Shared List. To use a shared query: 1. Click the Shared List button from the rule creation wizard. 2. The Shared Query List dialog box appears. Figure 65. The Shared Query List enables you to select a query or view the properties of a query. The query properties enable you to edit the query settings. 3. Select a query from the list and click OK. All of the query options in the remainder of rule wizard will be filled in with the values from the shared query. Click through the wizard to verify the settings and click Finish. Variable Rules Variable rules define variables that are used in your document whenever the criteria in the rule is met. When a variable in the rule qualifies to be positioned in your content, xpression will replace the variable with information from your customer data or from a Variable Rule User Exit when the document is assembled. The great thing about Variable rules is that you can define them as fields from your data source, by using a literal value, as a reference to another variable of comparable type, as a calculated value, or as a value derived from a user exit. Note: When the value of a variable is sufficiently large, it is represented in scientific notation. When this occurs, the value must be converted to double type, which is limited to a length of 16. The 16 characters are the most significant positions, including both sides of the decimal point if present. Therefore, variable values should not exceed 16 places, including positions to the right of the decimal point.

95 95 Chapter 7 - Using Rules Creating a Variable Rule To add a variable rule you will use the same instructions as for any of the rules with some additional information: 1. Select the item (rule or document) under which you want the Variable rule to be placed. To make sure the variables in your Variable rule will be available to all of your document s content, place the Variable rule at the top of the document. 2. On the Rule menu, click New Rule or click New Rule in the shortcut menu. 3. Select Variable from the Type list. 4. Type a name for your new Variable rule. This can be any combination of alphanumeric characters up to 255 and is not case sensitive. 5. Click Next and continue defining your rule criteria. For more information, see Using Conditional Logic and Selection Criteria. 6. Click Next to define your variables. You can define as many variables as needed. Figure 66. Adding variables to a Variable rule. 7. Select an existing variable to add to this Variable Rule from the Variable list, or type the name of a new variable in the box. If you have already added variables to this rule, and want to make modifications, select one from the list at the bottom and click Update. A Variable name can be any combination of alphanumeric characters up to 255, none of which are case-sensitive.

96 96 Chapter 7 - Using Rules 8. Select a variable type. You can define your variable type as date, float, integer, and string. Variable Type Date Description For date variables, you can supply the value by typing a literal value, selecting the value from a data source, specifying an existing output variable, or supplying the value through a User Exit. If you choose the Date variable type and type a date in the Literal field, xpression will display the date in Short Date format, mm/dd/yy. However, different regions of the world use different date formats (yy/mm/dd, DD MMM YY, YY MMM DD, and so on). When you add a date, xdesign uses Microsoft Visual Basic date validation routines that attempt to both verify it and convert it to a valid system date. Float For float variables, you can supply the value by typing a literal value, selecting the value from a data source, specifying an existing output variable, or supplying the value through a User Exit. You can also use The Variable Rule Advanced Button to use a mathematical expression. Integer For integer variables, you can supply the value by typing a literal value, selecting the value from a data source, specifying an existing output variable, or supplying the value through a User Exit. You can also use The Variable Rule Advanced Button to use a mathematical expression. String For String variables, you can supply the value by typing a literal value, selecting the value from a data source, specifying an existing output variable, or supplying the value through a User Exit. 9. Click Add to add the new variable. 10. Click Finish to save your changes and exit the Add Variable dialog. When you add the variable to the content item it appears in uppercase letters enclosed with braces: {VARIABLE}. Caution: If you intend to share the Variable rule and its variables across documents that use different data sources, ensure that the variables and data are compatible to prevent assembly errors.

97 97 Chapter 7 - Using Rules The Variable Rule Advanced Button The Float and Integer Types activate the Advanced button where you can further define their values. The Value Item area functions the same way it does in the Add Variable dialog for your choice of Value, Field, or Variable. Figure 67. Integer and float value definition. In the Value Expression area you can define a mathematical expression using the left and right parenthesis, add, subtract, multiply, and divide operator buttons as well as clear a row or clear all entries. Click OK to exit the dialog and return to the Add Variable dialog. xpression validates that the Variable Type matches the data field s type and will display an error message if they are not the same. You can create a counter with the Advanced feature by adding an Integer or Float variable, then clicking Advanced and setting the variable to equal itself plus the amount that it should increment for each iteration. When

98 98 Chapter 7 - Using Rules you create a counter in this way, the value will be indicated on the rule s Properties screen. Master document values are applied first, then subdocuments can change the value according to their own policies. Figure 68. Counter definition. Specifying Your Variable Value Through a User Exit User exits allow you to establish the value of a variable with an external program. User exits are integrated with your document in xdesign in a variable rule. A standard user exit must be created within paramaters specified in the xadmin User Guide. Values provided by a standard user exit must be in the form of a string. A standard user exit allows maximum flexibility in determining the value of a variable. Standard user exits are registered in xadmin. XML user exits allow you to transfer data from virtually any data source to xpression in XML format. XML user exits are created and implemented within the limitations discussed in the xadmin Integration Guide. Determining whether to use a standard user exit or an XML user exit depends on your specific requirements. To specify your variable value with a user exit, you must have first completed two steps: 1. Created a User Exit according to the instructions supplied in the xadmin Enterprise Edition User Guide. 2. Registered your User Exit with xpression through the xadmin User Exit Management page. 3. Once these steps are completed, you can click the User Exit button on the Variable Rule page.

99 99 Chapter 7 - Using Rules 4. When you click the User Exit button, the Variable User Exit page appears. Figure 69. Variable User Exit. 5. To set up your User Exit, supply the following information. Element User Exit Name Description Select the User Exit name from the drop-down box. The list of names available from this drop-down box originates from the User Exit Management list in the xadmin System Management section. This drop-down box will only display the names registered through xadmin. These names are listed in alphabetical order. Method After selecting a User Exit, the Method box becomes populated with all User Exit methods that are prefixed with UE_. Select the method to use from the available list of methods. If the method requires input parameters, you should define a value for each parameter. If the result and input parameters of the selected method are not of the String type, an error message is displayed and you will be unable to select the method.

100 100 Chapter 7 - Using Rules Element Parameters Description If the method requires input parameters, define those parameters here. Variable Rule Behavior in Batch Variable rules persist through batch runs. For example, if you have a variable that increments, the value will continue to increment through the entire batch run. This can be useful under certain circumstances, but you must initialize the variable at the beginning of the document if you do not want the variable to persist. To illustrate, you can initialize the variable x in this manner: x=x+1 If a parameter value is null or empty, use an empty string literal value. All the parameters listed in the Parameter Value box represent the parameters required for the method. All parameters should be of the String type. Parameter values are converted to string before they are passed to the method. Float values are represented as n.n and date values are converted to the YYYYMMDD format. To modify an existing parameter, select the parameter from the Parameter Value box. When you have completed updates to a parameter, click Update. Click OK to save your changes and return to the Variable Rule page. In this case, the value of x will continue to grow through the entire batch run. To prevent the variable from persisting, use a construction similar to this: x=0 x=x+1 Note: Variable persistance may not be accurate if batch is multi-threaded. This topic applies to single-threaded operations only. Creating a Read Loop This section introduces the concept of using loops as a more efficient way to organize your documents. It uses the Automatic Payment Letter sample to demonstrate the following topics:

101 101 Chapter 7 - Using Rules What is a Loop? How Does a Read Loop Work? Read Loop Structure Creating a Read Loop What is a Loop? Loops are used to repeat sets of data, or to create lists of customer data by taking advantage of the table relationships in your customer data source. Very simply, a loop processes a content item or a table over-and-over until all relevant data from the customer data source has been processed. When you create a loop, you use the following rule types: Section, Label, Read, Read Next, and GoTo. Example Caution: When using a Read Loop, the repeating header row and the detail rows must have the same number and size of columns if producing output to Word or HTML. Your company needs to create a confirmation letter informing customers that their insurance premiums have been set up for automatic payment. This letter must contain a list of all insurance products that have been designated for automatic payment. The content and length of this list will be very different for each customer. Read loops automatically create lists of variable length based on the data in your customer data source. How Does a Read Loop Work? With xpression Read loops, you only need to create the first row of a list in a content item. The loop processes the single-row content item over and over, creating new rows in the list for each associated row in the data source. Read loops are primarily built from Read and Read Next rules. Read rules tell the xpression assembly engine to read the first record in a secondary table of your customer data source. Read Next rules enable Read rules to read the next record in the table. xpression uses the Read rules to take advantage of the table relationships in your customer data. In this example, the customer data source, cust.xml, contains two tables: AUTOPAY and AUTOPAY_ACCTS. The primary table contains customer data, such as name, effective date, account number, address, and language. The secondary table contains information about the customer s policies and accounts. By linking the two tables with key fields, xpression can match the customer information with information for their accounts.

102 102 Chapter 7 - Using Rules Read Loop Structure A successful Read loop contains the following components and conditions. Component Read Rule Section Rule Label Rule Content Rule Read Next GoTo Description A Read loop begins with an initial Read rule to read the secondary table for all items that pertain to the customer. This rule sets up your Read loop by creating a memory buffer that holds a list of all secondary table records that pertain to the customer. The Read rule also places a pointer to the first record in the list. If no records exist, the Read rule encounters an End of File condition. It is recommended that after the initial Read, you add a Section rule to test for the End of File condition to skip the Read loop if no records exist. If records do exist, the loop process continues. The Label rule is placed ahead of the Content rule as a destination for the impending GoTo rule. A Content rule processes the record pointed to in the buffer. This Content rule is the focus of the Read loop. The goal of a Read loop is to process this rule once for each qualifying record in the buffer. Any number of rules can exist between the Label and Read Next rules. A Read Next rule moves the pointer to the next record in the memory buffer. A conditional GoTo rule tests for the End of File condition. To stop the loop from executing when no more records exist in the buffer, test the data for an End of File (eof) condition. When a Read or Read Next rule does not return any records, the End of File condition occurs. You can test for the End of File condition in the GoTo rule with standard rule criteria using the eof:tablename variable. Define the criteria to skip the GoTo rule if the End of File condition occurs. If the End of File condition is not met, the GoTo rule sends the loop routine back to the Label rule. Here s the Automatic Payment Letter Read loop. A read loop structure will have the following components. Figure 70. Read Loop Structure. Creating a Read Loop This section shows you how to create a Read loop using the existing Automatic Payment Letter Read loop. To create a loop:

103 103 Chapter 7 - Using Rules 1. Create a Read rule that will read your secondary table. See Read Rules for complete instructions. 2. Create a Section rule to test for the End of File condition to skip the Read loop if no records exist. If records do exist, the loop process continues. To test for the End of File condition, set up your criteria as follows: <Data Source Group> : <Table> : eof:<table> = N See About Section Rules for more information. 3. Create a Label rule. To identify the beginning of the loop, place a Label rule immediately after the Section rule. Type a name for the Label, and be sure to choose the name carefully. If multiple loops are used in a document, and labels are not named specifically, you can accidentally choose a label from a different loop and cause endless loops or other errors to occur. See Label Rules for more information. 4. Create a content rule. See About Content Rules for more information. The content rule should consist of the table body. Because a Read loop processes the entire content item with each pass, do not place table headers within the Read loop. If you place the table header within the read loop, the table header will be repeated for each row of the table. The table header should appear in the previous content item. The header row and table body rows must have the same number and size of columns if producing output to Word or HTML. To place data from the secondary columns into your content item, use variable replacements. In this example, we used variable replacements for the account name, account number, amount, frequency, and next pay date. Figure 71. This image is an example of the single-row content item that is processed by the Read loop. 5. Create a Read Next rule to read the next record in the table. See Read Next Rules for more information. 6. Create a GoTo rule to jump back to the Label rule. Define criteria on the GoTo rule to check for the End of File condition. When there are no more records in the memory buffer, an End of File condition occurs. Checking for this criteria from a GoTo rule prevents infinite loops. If you do not check for the End of File condition, the Read loop processes indefinitely. See GoTo Rules for more information. 7. Run a Read loop test. Assemble your document to see the Read loop create lists of variable length.

104 Chapter 8 Using Subdocuments 8 In this chapter we will discuss all of the xdesign rule types with the exception of the content rule which is discussed in About Content Rules. Depending on the make-up of your data source, you may or may not be able to use certain rules. About Subdocument Rules The xdesign subdocument feature enables you to place a document within a document. You can use a subdocument rule to reference a complete, existing xdesign, xpresso for InDesign, or xpresso for Word 2007 document from within any xdesign document (xpublish only). CompuSet documents can only reference CompuSet subdocuments. Subdocuments are added through subdocument rules. The document which contains the subdocument rule is the master document, and the document that the subdocument rule references is the subdocument. xdesign enables you to add subdocument rules to CompuSet-based master documents and xpublish-based master documents. CompuSet master documents can only use CompuSet subdocuments. xpublish master documents can contain CompuSet, xpublish, and xpresso-based subdocuments. Note: Subdocuments begin and end at the page boundary, and are treated as full-page documents. Additionally, you can apply criteria to your subdocument rules to conditionally process (or not process) your subdocuments. A Simple Subdocument Use Case Consider the following scenario. ABC insurance company wants to sends out a welcome letter in advance of sending out the customer s policy forms. A week later the policy holder will receive their policy package with a slightly different version of the welcome letter and the policy forms.

105 105 Chapter 8 - Using Subdocuments The welcome letter and the policy forms are two separate documents. The welcome letter was created in xpresso for Word 2007 and the policy was created in xdesign. Using subdocument rules, you can insert the welcome letter and policy forms as subdocuments into a master document. The subdocuments will be published in their entirety each time the master document is published. Figure 72. This figure shows a sample master document with xpresso for Word and xdesign subdocuments. From within the master document, the welcome letter and policy forms documents are viewed as subdocuments. Outside of the master document, the welcome letter and policy forms documents retain their status as stand-alone documents and can still be published individually. When Might I Use a Subdocument Rule? In addition to a scenario described above, subdocuments could be used to separate a very large document into several smaller documents, enabling individual users to work simultaneously on individual portions of the larger document. You could also use subdocuments to manage a single document that contains multiple pieces of content contributed by disparate groups. For example, one group may need to provide confidential customer information, while another group supplies legal language, and yet another group contributes sales and marketing content. Each of these groups would likely work on documents from different categories because each group would require different access rights and different data sources. You could use subdocuments to incorporate the content from each of these groups into a master document, without enabling each group to see the other group s work.

106 106 Chapter 8 - Using Subdocuments Subdocuments in xpublish Master Documents xpublish master documents can contain CompuSet, xpublish, or xpresso subdocuments. xpublish and xpresso subdocuments will be merged directly into the master document. xpresso packages are treated as external PDFs (converted to image) when previewed in xdesign through HTML or Microsoft Word, or when viewed through xresponse or xrevise. Caution: The last content item in your document cannot be an xpresso package subdocument. If you place an xpresso package subdocument as the last content item in your document, xrevise and xresponse will contain extra blank pages. CompuSet subdocuments are not merged directly into the master document. They are first converted to a PDF file using the built-in PDF format definition and then merged into your master document. After conversion to PDF, the PDF file will be treated as an external PDF. This means that for HTML output, the subdocument PDF will be converted to an image file. For PDF and PostScript output, the PDF will be merged into output stream as a PDF. When a CompuSet subdocument is viewed in xrevise or xresponse, the PDF will be converted to an image. Document Level Settings When designing your xpublish master document/subdocument scenario, be aware of any document-level settings (such as page numbering, page setup options, or headers and footers) in your subdocument that are different from the respective settings in your master document. By default, the master document settings will override the settings in your subdocument. As is the case in normal xpression documents, a Microsoft Word section break enables xpression to change these document-level settings. This system works the same in regular xpression documents and master document/subdocument scenarios. For example, if your subdocument contains a different set of headers and footers than your master document, and you would like to retain these differences when the documents are published together, you must facilitate this change with a section break at the end of the master document content item that precedes your subdocument or at the beginning of the first content item in your subdocument. Document Sciences recommends that you place the section break at the end of the master document. Be aware that a Next Page section break in either location will result in the subdocument starting at the beginning of a new page. If you want the subdocument to appear within the flow of the master document, use a Continuous section break. Note: If you place a Next Page section break at the beginning of the subdocument, then your subdocument will start with a blank page when published as a stand-alone document.

107 107 Chapter 8 - Using Subdocuments If your subdocument contains a different set document-level settings than your master document, and you would like to enforce the master document settings in your subdocument, be aware that any section breaks that occur in the subdocument will cause the subdocument settings to supersede the master document settings. Subdocuments in CompuSet Master Documents CompuSet master documents can only use CompuSet-based subdocuments. xpresso and xpublish subdocuments are not supported. Document Level Settings When designing your CompuSet master document/subdocument scenario, be aware of any document-level settings (such as page numbering, page setup options, or headers and footers) in your subdocument that are different from the respective settings in your master document. By default, the master document settings will override the settings in your subdocument. As is the case in normal xpression documents, a Microsoft Word section break enables xpression to change these document-level settings. This system works the same in regular xpression documents and master document/subdocument scenarios. For example, if your subdocument contains a different set of headers and footers than your master document, and you would like to retain these differences when the documents are published together, you must facilitate this change with a section break at the beginning of the first content item in your subdocument. A section break placed at the end of the content item that precedes the subdocument will not produce the correct result. Be aware that a Next Page section break will result in the subdocument starting at the beginning of a new page. If you want the subdocument to appear within the flow of the master document, use a Continuous section break. Note: If you place a Next Page section break at the beginning of the subdocument, then your subdocument will start with a blank page when published as a stand-alone document. If your subdocument contains a different set of document-level settings than your master document, and you would like to enforce the master document settings in your subdocument, be aware that any section breaks that occur in the subdocument will cause the subdocument settings to supersede the master document settings.

108 108 Chapter 8 - Using Subdocuments Retrieving Data for Subdocuments There are four methods for retrieving data for your subdocuments: key mapping, value mapping, share master document s data source, and data source binding. About Key Mapping Key mapping enables you specify fields in your master document that can be used to identify customer records in the sub document data source. This is the same type of data retrieval that was used for pervious xpression versions. About Value Mapping Value mapping enables you to directly reuse the data available in master document data source without defining a subdocument data source. With this method, the subdocument will retrieve data from the master document data source according to the mapping of the subdocument and master document schemas. When the document is being assembled, the assembly engine will not have to read the subdocument data source. Only the master data source will be read. About Share Master Document Data Source With this method, the subdocument uses the same data source as the master document. This method eliminates mapping because you are using the same data. About Data Source Binding This method provides a non-default data source to the subdocument at design time. This option only appears if your subdocument uses the same data source group as your master document. You can directly select another data source from the data source group. This data source will be used by your subdocument. Subdocument Scenarios When designing your documents, please review the following topics to ensure that you plan a successful strategy for using subdocuments. CompuSet Subdocuments in xpublish Master Documents When a CompuSet subdocument is used with an xpublish master document it is handled as an external PDF. Because of this certain OP features are not supported: Recipients - All recipient information in the subdocument is ignored Bookmarks - Bookmarks in the subdocument are not merged into the master document

109 109 Chapter 8 - Using Subdocuments Table of Contents - The subdocument s table of contents will not be merged into the master document Hand-coded CompuSet are not supported Conversion Options are not supported Passing Values from a Master Document to a Subdocument You cannot directly pass a value from a master document variable rule to a subdocument, but you can indirectly pass the value using the method described in Passing a Master Document Variable Rule Value to a Subdocument. Additionally, you cannot pass a value from a secondary table in your master document data source to a subdocument without first reading the secondary table in your subdocument. Alternatively, you could read the secondary table in your master document, assign the value to a variable rule, then use the method described in Passing a Master Document Variable Rule Value to a Subdocument to pass the value to your subdocument. Passing a Master Document Variable Rule Value to a Subdocument To pass a value from a master document variable rule to your subdocument: 1. In the master document, create and define your Variable rule. 2. Next, you must retrieve the value in your subdocument. You retrieve the value by setting the value of the variable rule to itself. For example, if your variable name is MYVAR, you would define the value of the variable rule in the subdocument as follows: MYVAR=MYVAR. 3. The variable value is now available for use in criteria and content. Publishing an xpresso Package Through xrevise xrevise does not allow you to place two external content items in the same Revision Unit. When CompuSet content items and xpresso packages are included as subdocuments, they are converted to PDF and treated as external content items. If your document includes two external content items, you must ensure that each content item is placed in a separate Revision Unit. You can accomplish this by placing each external content item in a separate section rule with a different Revision Unit name. Page N of M Note: If you are unable to initially set the value of the subdocument variable rule to itself (MYVAR=MYVAR), first set it to a different value, then change it to reflect its own value. When using Page N of M (called Page X of Y in the Microsoft Word interface) page numbering from the master document carries into the subdocument by default. Refer to Restarting page numbering for a Subdocument if you want the subdocument to retain its own numbering independent of the master document.

110 110 Chapter 8 - Using Subdocuments Managing Your Attributes in Subdocuments The master and subdocument categories don t necessarily have to have the same attribute sets, but where they do share any attributes, the data mapped to them must be the same, or content will be pulled based on different attribute values. xpression Batch and Subdocuments If you are using xpression Batch to process documents that contain subdocuments, and if the master document uses an XML data source, the subdocument data source (whether XML or RDB) must use the same data source schema as the master document. This limitation is confined to xpression Batch, and is not a limitation at all if the data source of the master document is a relational database. If the main document data source is XML, the server will need to override the subdocument data source schema with the main document data source schema in xpression Batch. Content In Your Master Document Your master document does not need to contain only subdocument references. You can also place regular content rules in your master document. There are no restrictions on placing your content rules before, in-between, or after your subdocuments. Managing Subdocument Data Sources If you are using xpression batch to process documents that contain subdocuments, and if the master document uses an XML data source, the subdocument data source must use the same data source schema as the master document. This limitation is confined to xpression Batch only, and is not a limitation at all if the data source of the master document is a relational database. If the main document data source is XML, the server will need to override the subdocument data source schema with main document data source schema in xpression Batch. Overriding Subdocument Data Sources When overriding the data source of a master document in a subdocument/master document scenario, the subdocument data sources will also be overwritten. You must ensure that the subdocument and master document use the same schema. xpression will override the subdocument data source even when the sub-document uses a different data source group. Also, when publishing from xresponse, Revise, or Web Services, you can use output variables in your subdocuments and master documents. However, you cannot override the data source to change the value of the output variable. If you override the data source to change the value of one of the output variables, the change will only be reflected in the master document, not in the subdocument.

111 111 Chapter 8 - Using Subdocuments Using Output Variables When using output variable with subdocuments, consider these important points: If an output variable is mapped to both the master document and the subdocument data sources, only the value contained in the subdocument's data source will be returned. If you need to retrieve the value of both the master and the subdocument's data source, create two different output variables each mapped to its respective data source. Example 1: You have a document with a subdocument. You create an output variable and map it to a field in the data source for the document and a field in the data source for the subdocument. In this case, the variable will always return the value for the field in the subdocument data source, so the value of the field in the data source for the master document is not available through this output variable. Example 2: You have a document with a subdocument. You create two output variables, one mapped to a field in the master document and the other mapped to a field in the subdocument. The variable mapped to the field in the master document will always return the value of the field in the master document s data source, and the variable mapped to the field in the subdocument s data source will always return the value of the field in the subdocument s data source. xrevise Issues Objects that follow a subdocument rule will be ignored in xrevise unless a new Revision Unit is started to contain them. Subdocuments and CompuSet Output Processing The CompuSet output processing features are defined as: recipient processing, splitting and sorting, bar codes, and output stream functionality. Output processing functionality works well with CompuSet sub and master documents, but there are certain guidelines you should follow. Recipient Processing You can assign recipients inside your subdocument documents or in your master document, but you cannot assign recipients in both the master and subdocument at the same time.

112 112 Chapter 8 - Using Subdocuments Also, you can place your subdocument in a section rule in your master document and assign recipients to that section rule. Figure 73. Master document. Recipients Partitioning Subdocuments will not affect your print file partitioning. If you partition your output by print file, you will receive only one print file for your master document, with your subdocuments included in the print file. You will not receive a print file for each subdocument.

113 113 Chapter 8 - Using Subdocuments Bar Codes If you set up bar codes on your output stream for your master document, the bar codes will carry through to your subdocuments. If you installed the xpression sample applications, you can see bar codes defined on the Policy Package master document by publishing it through the Multiple output profile. Figure 74. Bar Codes in a Subdocument. Bar code

114 114 Chapter 8 - Using Subdocuments Creating a Subdocument with Master Document Data To create a Subdocument rule that uses the same data source group as your master document, complete the following steps: 1. Select the position for the new rule. 2. From the Rule menu, click New Rule and then Rule, or right-click and select New Rule from the shortcut menu. You can also add an existing shared rule. 3. Select Subdocument from the rule Type list. 4. Give the new rule a name. The name must be between 1 and 255 alphanumeric characters. Click Next. 5. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria. 6. The Document Name page appears. Figure 75. Select your document type, category, and document name. From this page you can select the document you want include as a subdocument.

115 115 Chapter 8 - Using Subdocuments 7. Select the category that contains the subdocument. The categories list contains the name of each category on your server. If you select the same category that contains your master document, two new options will appear at the bottom of the page: Share Master Document s Data Sources and Data Source Binding. 8. In the Documents list, select the document you want to add as a subdocument. 9. If your subdocument uses a data source from the same data source group as your master document, two options will appear at the bottom of the page: Share Master Document s Data Sources and Data Source Binding. With either option, you will not have to map your data because the data sources will share the same schema. With the Share Master Document s Data Sources method, the subdocument uses the same data source as the master document. This method eliminates mapping because you are using the same data. With the Data Source Binding method, you can provide a non-default data source to the subdocument at design time. You can directly select another data source from the data source group. This data source will be used by your subdocument. 10. To use the master document data source, select Share Master Document s Data Source. 11. To use a data source binding, clear the Share Master Document s Data Source checkbox and select a new data source from the Data Source Binding list. 12. Click Finish to exit the subdocument wizard. Creating a Subdocument Using Key Mapping To use Key Mapping to map your master document data source to fields in your subdocument, access the Subdocument rule Data Mapping page: 1. Select the position for the new rule. 2. From the Rule menu, click New Rule and then Rule, or right-click and select New Rule from the shortcut menu. You can also add an existing shared rule. 3. Select Subdocument from the rule Type list. 4. Give the new rule a name. The name must be between 1 and 255 alphanumeric characters. Click Next. 5. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria.

116 116 Chapter 8 - Using Subdocuments 6. The Document Name page appears. Figure 76. Select your document type, category, and document name. From this page you can select the document you want include as a subdocument. 7. First, select the category that contains the subdocument. The categories list contains the name of each category on your server. Note: If you select the same category that contains your master document, two new options will appear at the bottom of the page: Share Master Document s Data Sources and Data Source Binding. You will not be able to use Key or Value mapping. 8. In the Documents list, select the document you want to add as a subdocument. Click Next.

117 117 Chapter 8 - Using Subdocuments 9. The Data Mapping page appears. From this page you must map your master document data keys to the subdocument data keys. Select Key from the Mapping Type section. The Key Mapping options appear. Figure 77. Key Mapping Options. All of the Key fields from your subdocument are displays in the list at the bottom of the page. You must assign values from your master document data source to each of the keys in the subdocument. 10. In the Data Source Binding list, select the data source you want to use with your subdocument. Only XML data sources will appear in this list. 11. In the Key Field list, select the key field that you want to map. 12. In the Value section, provide a value for the selected key. The value can be specified as a Literal value that you type into the field, a Field from another data source, or an existing Variable that you defined inside the current document. The values of the subdocument keys must match the values in the master document keys for the document to assemble correctly. 13. Each time you set the value for a key, click Update and you will see the assignment in the list at the bottom of the page. 14. When you have provided values for all the keys, click Finish to complete the rule. If there are any keys that don t have assignments you will not be allowed to complete the rule. 15. See xpublish and CompuSet Subdocument: Key Mapping Options for more information.

118 118 Chapter 8 - Using Subdocuments Creating a Subdocument Using Value Mapping Use Value Mapping to directly reuse the data available in master document data source without defining a subdocument data source. This enables you to process the subdocuments without the assembly engine having to read the subdocument data source. If you choose this option, you will have to map all of your data source tables. To set up Value mapping, access the Subdocument rule Data Mapping page: 1. Select the position for the new rule. 2. From the Rule menu, click New Rule and then Rule, or right-click and select New Rule from the shortcut menu. You can also add an existing shared rule. 3. Select Subdocument from the rule Type list. 4. Give the new rule a name. The name must be between 1 and 255 alphanumeric characters. Click Next. 5. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria. 6. The Document Name page appears. Figure 78. Select your document type, category, and document name. From this page you can select the document you want include as a subdocument.

119 119 Chapter 8 - Using Subdocuments 7. First, select the category that contains the subdocument. The categories list contains the name of each category on your server. Note: If you select the same category that contains your master document, two new options will appear at the bottom of the page: Share Master Document s Data Sources and Data Source Binding. You will not be able to use Key or Value mapping. 8. In the Documents list, select the document you want to add as a subdocument. Click Next. 9. The Data Mapping page appears. From this page you must map your master document data keys to the subdocument data keys. Select Value from the Mapping Type section. The Value Mapping options appear. Figure 79. Value Mapping Options. This page lists all fields in your subdocument data source. Each field needs to be mapped to your master document data source.

120 120 Chapter 8 - Using Subdocuments 10. Click Map. The mapping page appears. Figure 80. The mapping page enables you to define two levels of mapping, table-level mapping and fieldlevel mapping. 11. There are two different levels of mapping that you can perform: Table-level mapping and field-level mapping. If you are mapping the primary table of your data source, you must use the field-level mapping options. if you are mapping a secondary table, you can choose not to map the table if it is not used in your subdocument, use the table-level mapping options if your subdocument secondary table is identical to a secondary table in your master document data source, or use field-level mapping. See xpublish and CompuSet Subdocument: Value Mapping Options for more information. 12. Make your mapping choices and click OK. 13. Click Finish.

121 121 Chapter 8 - Using Subdocuments xpublish and CompuSet Subdocument: Document Name Options The xpublish subdocument options enable you to use an existing xpublish document as a subdocument. These options are available from the Subdocument rule wizard, or right-clicking a subdocument rule, selecting properties, and clicking the Document tab. Figure 81. Select your document type, category, and document name. If you select a document from the same category as your master document, this page enables you to use the data source from the master document or select a different data source from within the category. These options are only available if the subdocument is coming from the same category as the master document. This page contains the following elements. Element Name Document Type Categories Documents Description This list enables you to select the document type. The categories list contains the name of each category on your server. Select the category that contains the document you want to use. If you select the same category that contains your master document, two new options will appear at the bottom of the page: Share Master Document s Data Sources and Data Source Binding. After you select the category name, this box populate with the name of all xpublish documents contained within the category. Select the package that you want to use as a subdocument, and click Next to supply the mapping for the subdocument.

122 122 Chapter 8 - Using Subdocuments Element Name Share Master Document s Data Sources Data Source Binding Description This option only appears if you select the same category that your master document uses. Select this option if you want the subdocument to use the same data source that the master document uses. If you do not select this option, you must specify a data source for your subdocument in the Data Source Binding list. This option only appears if you select the same category that your master document uses. If you unselected the Share Master Document s Data Sources option, you can select a data source from this list. This is the data source that your subdocument will use. xpublish and CompuSet Subdocument: Key Mapping Options The xpublish subdocument Key mapping options are available from the data mapping page of the subdocument rule wizard if your subdocument and master document do not share the same primary data source. Figure 82. Select Key in the Mapping Type section to see the Key mapping options.

123 123 Chapter 8 - Using Subdocuments This page contains the following elements. Element Name Data Source Binding Key Field Value: Literal Value: Field Value: Variable Update Button Field Name List Description This list enables you to select a data source for your subdocument. When you select Key mapping, the Key Field list populates with all of the key fields from the selected data source. On this page you need to map all of the key fields from your subdocument to your master document data source. Use this list to select the data source where your key field resides. This list contains all of the key fields in the data source defined in the Data Source Binding list. When you select Literal, you can supply a literal value in the box. This is the value you are mapping to the subdocument key field. When you select Field, you can select a data source, table, and field from the provided three lists. This is the field you are mapping to the subdocument key field. When you select Variable, you can select an existing output variable. The value of this variable is the value you are mapping to the subdocument key field. When you have selected a key field and defined a value, click Update. The mapping will appear next to the key field name in the Field Name list at the bottom of the page. Displays all key fields in the subdocument data source. When you supply a mapping for a key field, the mapping appears in the Field Value column. xpublish and CompuSet Subdocument: Value Mapping Options Use Value Mapping to directly reuse the data available in master document data source without using the subdocument data source. This enables you to process the subdocuments without the assembly engine having to read the subdocument data source. When you use value mapping, you have to map every field that your subdocument uses. The xpublish subdocument Value mapping options are available from the data mapping page of the subdocument rule wizard if your subdocument and master document do not share the same primary data

124 124 Chapter 8 - Using Subdocuments source. To see these options, access the data mapping page of the subdocument rule creation wizard and click Value. Figure 83. This page lists all mappable fields in your subdocument data source. This page contains the following elements. Element Name Map Button Field List Description Launches the mapping page. The mapping page enables you to map the table fields from your subdocument data source to literal values, variable values, or to field values from your master document data source. For more information, see Value Mapping: Table Level Mapping Options and Value Mapping: Field-Level Mapping Options. When you click Value, this list will populate with fields from the primary table.

125 125 Chapter 8 - Using Subdocuments Value Mapping: Table Level Mapping Options If a secondary table in your subdocument data source is identical to a secondary table in your master document data source, you can choose to map one table to the other instead of individually mapping each field. A Primary table cannot be mapped with table-level mapping, you must use field-level mapping. Figure 84. Tablelevel mapping options. This page contains the following elements. Element Name Subdocument Table No Mapping Needed Map to Master Document Table Mapping Level Description From this list, select the subdocument secondary table that you want to map to a secondary table in your master document data source. If your subdocument does not use any of the data in the subdocument table selected in the Subdocument Table list, you can select this option. This option is selected by default for secondary tables. If you are mapping a secondary subdocument table to a master document data source and clear the No Mapping Needed option, the Read Criteria and Read Order tabs appear. From this list, select the master document table that is identical to the subdocument secondary table selected in the Subdocument Table list. Select Table to work with the table-level mapping options. Click OK when all tables are mapped.

126 126 Chapter 8 - Using Subdocuments Value Mapping: Table Level Mapping Options: Read Criteria If you are mapping a secondary subdocument table to a master document data source and clear the No Mapping Needed option, the Read Criteria and Read Order tabs appear. This tab enables you to filter the data you send to the subdocument. Figure 85. This page appears when you are mapping a secondary table from your subdocument data source to a table from your master document data source. This page contains the following elements. Element Name Select a Field from the Mapped MasterDocument s Table list Link to Description In the top drop-down list, select a field from the mapped master document table. The fields in this list are derived from the table you selected in the Map to Master Document Table list on the Mapping tab. To establish the read criteria, link the field from the mapped master document table to a literal value, a field in another data source, or an existing output variable. Click Add to add your mapping to the table at the bottom of the page. Click OK when finished.

127 127 Chapter 8 - Using Subdocuments Value Mapping: Table Level Mapping Options: Read Criteria If you are mapping a secondary subdocument table to a master document data source and clear the No Mapping Needed option, the Read Criteria and Read Order tabs appear. Figure 86. This page appears when you are mapping a secondary table from your subdocument data source to a table from your master document data source. This page contains the following elements. Element Name List of fields from the mapped MasterDocument s table Direction Description This list is populated with fields rom the mapped master document table. The fields in this list are derived from the table you selected in the Map to Master Document Table list on the Mapping tab. After you select a field from the list, you can choose to order the data for the selected field in Ascending or Descending order. Select a field from the list, select a direction and click Add to add a field to the ordering list at the bottom of the page. Add as many fields as needed. Click OK when finished.

128 128 Chapter 8 - Using Subdocuments Value Mapping: Field-Level Mapping Options You can use the field-level mapping options for subdocument secondary or primary tables. The primary table is automatically set to field-level mapping. Primary tables must be mapped using the field-level options. Ensure that all mapped values are valid. When you map the subdocument primary table, it will be passed to the assembly engine automatically and will not have to be read prior to assembly. Figure 87. The field-level options enable you to map the fields using literal, data source, or variable data. This page contains the following elements. Element Name Subdocument Table Map to Master Document Table Description From this list, select the secondary or primary table that you want to map to a table in your master document data source. After selecting this table, select a master document table to map it to. From this list, select the master document table that you want to map to the subdocument table selected in the Subdocument Table list. After selecting this table, select the subdocument field you want to map. This is required for secondary table mapping, not required for primary table mapping.

129 129 Chapter 8 - Using Subdocuments Element Name Mapping Level Subdocument Table Field Literal Field Variable Automap Button Add Button Update Button Remove Button Field List Description Choose Field. Choose the field from your subdocument table that you want to map. All of the mappable fields appear at the bottom of the page in the Field list. After selecting this field, specify a literal, field, or variable value. Use this option to map the subdocument field to a literal value. Type the literal value in the provided box. Use this option to map the subdocument field to a field in your master document data source group. Using the provided lists, select a data source, data source table, and data source field. Use this option to map the subdocument field to an existing output variable. Select an output variable from the list. When you click this button, xpression will attempt to automatically map the fields from the defined subdocument table to the defined master document table. Any fields that share the same name will be automatically mapped and their mapping will be reflected in the Map To column in the Field list at the bottom of the page. Click this button if you have selected a Subdocument Table Field and supplied a literal, field, or variable value to map to it. When you click add, the mapping you created will be reflected in the Map To column in the Field list at the bottom of the page. Click this button if you are changing an existing mapping. Click this button to remove a mapping from the Field list. This list shows all mappable fields in the subdocument data source. When you provide a mapping for one of the subdocument fields, this mapping appears in the Map To column in the Field list at the bottom of the page. Adding an xpresso Subdocument Before you can use an xpresso package as a subdocument, you must import it from xadmin. To create a subdocument rule that adds an xpresso document to your master document: 1. Select the position for the new rule. 2. From the Rule menu, click New Rule and then Rule, or right-click and select New Rule from the shortcut menu. You can also add an existing shared rule. 3. Select Subdocument from the rule Type list.

130 130 Chapter 8 - Using Subdocuments 4. Give the new rule a name. The name must be between 1 and 255 alphanumeric characters. Click Next. 5. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria. 6. The Document Name page appears. Figure 88. Select your document type, category, and document name. From this page you can select the document you want include as a subdocument. In the Document Type list, you can select an xpublish document, an xpresso document, or a CompuSet document. Select xpresso document. 7. From the Categories list, select the category where your xpresso package resides. 8. After you select a category from the Categories list, the xpresso Packages list populates with all the xpresso packages in the selected Category. Select a package from this list and click Next.

131 131 Chapter 8 - Using Subdocuments 9. The Data Mapping page appears. Figure 89. The Data Mapping page enables you to map your data by Key or Variable. The variable options appear by default. You can use your subdocument data source with your subdocument or map your xpresso variables to your master document data source. If you want to use your subdocument data source, choose key mapping and map your xpresso subdocument data through data keys in your subdocument data source. See xpresso Package Subdocument Key Mapping Options for more information. If you want to use your master document data source to process your subdocument, choose Variable and map all of your xpresso variables to your master document data source. See xpresso Package Subdocument Variable Mapping Options for more information. 10. When you have completed your mapping, click Finished.

132 132 Chapter 8 - Using Subdocuments xpresso Package Subdocument Options The xpresso package subdocument options enable you to use an existing xpresso package as a subdocument. These options are available from the Subdocument rule wizard, or right-clicking a subdocument rule, selecting properties, and clicking the Document tab. Figure 90. Enables you to use an imported xpresso package as a subdocument. This page contains the following elements. Element Name Document Type Categories xpresso Packages Description This list enables you to select the document type. The categories list contains the name of each category on your server. Select the category that contains the document you want to use. This is the category that you identified as the target category when importing the xpresso package. After you select the category name, this box populate with the name of all xpresso packages contained within the category. Select the package that you want to use as a subdocument, and click Next to supply the mapping for the subdocument.

133 133 Chapter 8 - Using Subdocuments xpresso Package Subdocument Key Mapping Options The xpresso package subdocument key mapping options enable you to map the data key in your xpresso subdocument data source to a literal, data source, or variable data. These options are available from the Data Mapping page in the Subdocument rule wizard. Figure 91. You can map xpresso package data to your master document data source through your xpresso data source or your xpresso variables. This page contains the following elements. Element Name Data Source XML File Customer Data Elements xpath Data Key xpath Data Key Value: Literal Description This is the data source used by the xpresso document. Select the data source name from the list. This is the xpath to the customer data. For example: /CustomerData/Transaction This is the xpath to a customer data key. For example: /CustomerData/Transaction/Autopay/Autopay_Key Enables you map your xpresso data key(s) to a literal value. If you select this option, type a literal value in the provided box.

134 134 Chapter 8 - Using Subdocuments Element Name Data Key Value: Field Data Key Value: Variable Add Button Update Button Data Key xpath List Description Enables you map your xpresso data key(s) to a field in your master document data source group. If you select this option, select the data source name, table name, and field name from the provided lists. Enables you map your xpresso data key(s) to an existing output variable. If you select this option, select an output variable from the list. After you have initially defined a mapping for a data key, click Add to add the mapping to the Data Key xpath list. If you are changing the xpath or value of a data key mapping, click Update to save your changes. This list displays all data key mappings that you define. xpresso Package Subdocument Variable Mapping Options The xpresso subdocument variable mapping options enable you to map the variables in your xpresso subdocument to a field in a literal, data source, or variable value. When variable mapping is selected, xpression will attempt to automap the variables. Regular variables will be mapped with primary table fields and array variable elements will be mapped to secondary table fields if any variable name matches the secondary table name.

135 135 Chapter 8 - Using Subdocuments These options are available from the Data Mapping page in the Subdocument rule wizard. Figure 92. You can map xpresso package data to your master document data source through your xpresso data source or your xpresso variables. This page contains the following elements. Element Name xpresso Variable Value: Literal Value: Field Value: Variable Variable: Advanced Description Enables you to select an xpresso variable. All the xpresso variables from your xpresso package appear in the xpresso Variable list at the bottom of the page. When you select this option you can supply a literal value in the provided box. When you select this option, you can select a data source name, data source table name, and data source field name from the provided lists. When you select this option, you can select an existing output variable from the list. This option becomes available when you are mapping an xpresso Array type variable. xdesign does not use the Array variable type, so an xpresso Array variable must be mapped to a secondary table in your master document data source. To learn about mapping array variables, see Using an xpresso Array Variable with Subdocuments.

136 136 Chapter 8 - Using Subdocuments Element Name Add Button Update Button xpresso Variable List Description After you have initially defined a mapping for a data key, click Add to add the mapping to the xpresso Variable list. If you are changing the xpath or value of a data key mapping, click Update to save your changes. This list displays all the xpresso variables from your xpresso package. When you add a mapping for a variable, the mapping appears in the Value column. Using an xpresso Array Variable with Subdocuments When you are mapping the variables in an xpresso document, the Advanced button becomes available when you select an xpresso array variable from the variable list at the bottom of the page. Figure 93. The Advanced button appears when you select an array variable.

137 137 Chapter 8 - Using Subdocuments To map an array variable: 1. Select an array variable from the xpresso Array Variable list. 2. Click Advanced. The xpresso Array Variable Mapping & Query page appears. Figure 94. Click Advanced to display the xpresso Array Variable Mapping & Query page. 3. xdesign does not use the Array variable type, so an xpresso Array variable must be mapped to a secondary table in your master document data source. Select a secondary table from the Map to MaterDocument s Table. 4. The elements in the xpresso array appear in the list at the bottom of the page. Map each element to a field in your secondary table, to a literal value, or to a variable. You can also use the Automap feature. The Automap feature maps all elements from the array to identically named fields in your selected secondary data source table. If an array element does not have the same name as any fields in your secondary table, the element will remain unmapped. To directly map an array element to a literal, field, or variable value, use the options in the Map to section. After mapping an array element, click Add to add the mapping to the xpresso Array Element list at the

138 138 Chapter 8 - Using Subdocuments bottom of the page. To update an array element that is already mapped, select a new mapping and click Update. 5. You need to set up read criteria in order to display your data correctly for each customer record. A primary key xpresso element must be in your xpresso array in order to correctly link the read criteria to the master document data source group. 6. Click the Read Criteria tab. Figure 95. The Read Criteria page appears. 7. On this page, you must supply read criteria for the array variable. Select a field from the mapped table in the list at the top of the page, link it to a fixed value, field, or variable, and click Add. Repeat this process for all array variables that require read criteria.

139 139 Chapter 8 - Using Subdocuments 8. Click the Read order tab to configure ordering for any of the array elements. Figure 96. The Read Order page appears. This page enables you to order the return records by selecting the fields that you want to use to sort the return records. The fields in the list come from the mapped table you selected on the Read Criteria page. 9. When finished, click OK. If specified, subdocument secondary tables will be read first based on read criteria and read order before processing subdocument.

140 140 Chapter 8 - Using Subdocuments Adding a CompuSet Subdocument To create a CompuSet Subdocument rule: 1. Select the position for the new rule. 2. From the Rule menu, click New Rule and then Rule, or right-click and select New Rule from the shortcut menu. You can also add an existing shared rule. 3. Select Subdocument from the rule Type list. 4. Give the new rule a name. The name must be between 1 and 255 alphanumeric characters. Click Next. 5. The selection criteria page appears. xdesign uses selection criteria to select items based on the criteria you establish. The information in your data source must match all of the criteria attached to the content group before xdesign can use the content items it contains. Selection criteria are optional, so you can click Next to skip this step. For more information about selection criteria, see Using Conditional Logic and Selection Criteria. 6. The Document Name page appears. Figure 97. Select your category and document name. From this page you can select the document you want include as a subdocument. In the Document Type list, you can only select CompuSet document. 7. From the Categories list, select the category where your CompuSet document resides.

141 141 Chapter 8 - Using Subdocuments 8. After you select a category from the Categories list, the Documents list populates with all the CompuSet documents in the selected Category. Select a package from this list and click Next. 9. Assign values to the keys in the subdocument. To assign a value to each of these keys, click the down arrow next to the Key Field box and choose one of the keys. Figure 98. Notice that the Key Fields from the subdocument are listed in the bottom portion of the page. From the master document. Key fields from the subdocument. 10. Give the key a value that can be specified as a Literal value that you type into the field, a Field from another data source, or an existing Variable that you defined inside the current document. The values of the subdocument keys must match the values in the master document keys for the document to assemble correctly. 11. Each time you set the value for a key, click Update and you will see the assignment in the list at the bottom of the page. 12. When all keys have associated values, click Finish to complete the rule. If there are any keys that don t have assignments you will not be allowed to complete the rule. Subdocument Schema You have the option of selecting Same Schema, Key Mapping, or Value Mapping when creating a subdocument rule. xdesign determines if the master and subdocument use the same primary data source. If so, then Mapping Type defaults to Same Schema and Data Source Binding defaults to master document's data source. If the master and

142 142 Chapter 8 - Using Subdocuments subdocument do not use the same primary data source group, then Mapping Type default to Key Mapping and Data Source Binding defaults to (default). Figure 99. Document properties default when the master and subdocument share the same primary data source group You can change these options as required. The (default) option for Data Source Binding was previously shown as blank. Caution: If you choose Same Schema, ensure that the master and subdocuments actually use the same schema. xdesign will not validate your selection.

143 143 Chapter 8 - Using Subdocuments When Mapping Type is Key is selected, you have the ability to apply a literal, field, or variable value to the selected customer key. Figure 100. Click Update to assign the value.

144 144 Chapter 8 - Using Subdocuments When Mapping Type is Value, you need to map each field in the subdocument data source to one in the master document data source. Figure 101. You ll need to map each field in the subdocument s primary data source to one in the master document s data source Click Apply when finished.

145 Chapter 9 The xpression Chart Rule 9 Charts are visually appealing and make it easy for users to see comparisons, patterns, and trends in data. Using xpublish charts, you can create dynamic graphics for any type of xpression document (print, , or Webbased). xpression can graphically display your data in the form of a pie, bar, column, or line chart. Figure 102. Two examples of xpression charts. xpression creates custom charts by querying tables and fields in your customer data. xpression charts are highly customizable, allowing you control over nearly every aspect of the chart. xpression stores chart images in the xpression database as shared objects, which enables you to define a chart template as shared, and to use the shared template to define similar charts across different applications and categories. Caution: Documents with Corda DDG (Data Driven Graphics) charts cannot be published in the WebSphere 6.0 environment. This limitation does not apply to Weblogic, JBoss, or WebSphere 6.1.

146 146 Chapter 9 - The xpression Chart Rule What is a Data Query and How Does it Work? Your customer information may not reside in a single table; it could reside in different tables and possibly different data sources. For xpression to get at the chart data in your data source, xpression must first read the table that contains the data. Simply put, queries tell xpression which data source table to read. To keep your data synchronized across tables and data sources, queries require you to link one table to another using the values in the key fields from each table. This link enables a query to identify and select corresponding records from the table. Figure 103. For example, one table may contain customer information (account numbers, addresses, billing information), and a separate table might contain specific information about savings and checking accounts. Account information table Customer information table To ensure you extract the correct account information for a specific customer, a column in your customer table must match a column in your accounts table. In this example, the two tables share a CUST_ID column. This link effectively identifies your customers in the accounts table. When xpression assembles your document, the query locates the matching records in the tables. xpression stores these matching records in memory and points to the first record that qualified. These records will be used to create your chart. The table containing customer information does not need to reside in the same data source as the table containing data for your chart. Although your query can link two different tables and data sources, xpression charts can only draw data from one data source segment or table. All the data that you want represented in the chart must reside in the same table. Note: While you can create a Chart rule without adding a query, xpression won t generate a chart without a query.

147 147 Chapter 9 - The xpression Chart Rule Defining Your Chart Data This diagram identifies the elements that comprise the data of a chart, and shows how the data series and category name relate to the data in your data source. Figure 104. A diagram of a column chart. Value Data Series Chart Category To define the data for your chart, you must identify the fields in the chart segment that contain the data you want represented in the chart. Specifically, you must define which data you want to use for your data series and for your chart category information. A data series is a group of related data points on your chart. Each data series has a unique color or pattern and is represented in the legend by the legend key and series name. In our example, the July, August, and September rows represent the data series. You can plot one or more data series in bar and column charts. Pie charts only represent one data series and one category. For the chart in Figure 104 you would create three separate queries for three separate data series, one each for July, August, and September. Select the By Month field for the category data. Chart Types The xpression Chart rule can create the following chart types and styles. Chart Type Bar Charts Chart Formats A bar cluster chart illustrates comparisons between individual items. Categories are organized vertically and values horizontally to focus on comparing values, and to place less emphasis on time. This chart type is also available in a three-dimensional version. Bar stacked charts show the relationship of individual items to the whole. This chart type is also available in a three-dimensional version.

148 148 Chapter 9 - The xpression Chart Rule Chart Type Column Charts Chart Formats Column cluster charts show data changes over a period of time or illustrate comparisons between items. To emphasize variation over time, categories are organized horizontally and values are organized vertically. This chart type is also available in a three-dimensional version. Column stacked charts show the relationship of individual items to the whole. This chart type is also available in a three-dimensional version. Pie Charts Line Charts Pie charts are used for proportional assessment by comparing data elements as percentages against other data elements and against the sum of the data elements. A pie chart is a circular graph with wedges dividing the circle into sectors that are proportional in area to the quantities of the data sets represented. This chart type is also available in a three-dimensional version. Line charts show how data changes over time and can be used to compare changes in different data series over the same period. This chart type is also available in a threedimensional version. How to Add a Chart to Your Document How do you create a chart in an xpublish document? Charts are added to your documents through Chart rules. The xpression rule wizard for charts contains standard rule creation pages for providing a rule name, a section level, rule criteria, and content. The Chart rule wizard also contains pages for setting up your chart data queries. The Chart rule wizard does not contain content group pages. Create a Chart Rule To create a Chart rule: 1. Select the insert position for the new rule. 2. On the Rule menu, click New Rule, or click New Rule on the document name shortcut menu. 3. To create a new Chart rule, select Chart from the Rule Type list. 4. Give your Chart rule a name, and enter a section level, if necessary. 5. Add selection criteria, if necessary. For more information about selection criteria, see Using Conditional Logic and Selection Criteria.

149 149 Chapter 9 - The xpression Chart Rule 6. To add a query to your chart rule, click Add. Figure 105. If you ve already created or selected queries for this rule, those queries will appear in the text box on this page. 7. The query Name and Group page appears. Figure 106. You can begin creating a new query from this page or select an existing shared query from the Shared Query list. Click to see a list of existing queries Data source group Chart segment The query you create through this wizard can be saved and shared with your other rules. Table rules and read rules also use queries. If you want to reuse queries among your rules, supply a unique name for your query in the Query Name box and then set your query as Shared according to the steps in Sharing Rule Queries. Otherwise, leave the default name.

150 150 Chapter 9 - The xpression Chart Rule 8. Select a data source group and data source table from the lists. From the first list, choose a data source group. From the second list, choose the table that will serve as the chart segment. The list of tables is derived from the data source group you selected in the first list. After selecting the chart segment, click Next. 9. The Read Criteria page appears. This page enables you to link the chart segment to another segment or table that contains information about your customer. We ll call this segment or table the customer segment. You create this link by selecting the key field from the chart segment and linking it to a literal value or to a field in the customer segment. Figure 107. To make your query more selective, you can add more than one pair of linked fields. Field From Chart Segment Field From Customer Segment Linked Tables 10. In the top list box, select a field from the chart segment. The chart segment was the table you defined on the previous wizard page. 11. The Read criteria page appears. On this page you want to tell xpression which records to read in your chart segment. You can accomplish this by linking a field in your chart segment to a fixed value, to a field in your primary data source, or to a variable. For instructions on linking your chart segment to a fixed value, see Linking Your Chart Segment to a Fixed Value. For instructions on linking your chart segment to a field in your primary data source, see Linking Your Chart Segment to a Primary Table Field. For instructions on linking your chart segment to a variable, see Linking Your Chart Segment to a Variable. After completing your read criteria, click Next.

151 151 Chapter 9 - The xpression Chart Rule 12. The Read Order page appears. This page enables you to sort the order of the data returned from the query. xpression charts process data on a first-come-first-served basis. This means that the first piece of data returned from the query will be the first piece of data presented in the chart. Figure 108. You are not required to establish a sort order, but is recommended for effective charts. If you want the data to appear in a specific order, select the data field you want to sort from the list of fields. The Field list contains fields from the chart segment. Data from the field you select will be sorted in the order and direction you specify. 13. To sort the field, select Ascending or Descending, and click Add to add it to the sort order. 14. When you complete configuring your sorting options, click Finish. The query page reappears, enabling you to add another query to the Chart rule. Individual charts can use more than one query, and you can place more than one chart in a single Chart rule. If your charts require different data queries, you can add them at this time or add them later by right-clicking the chart rule from the xdesign tree view and selecting New Query. 15. Click Next and you re ready to Add Content to Your Chart Rule.

152 152 Chapter 9 - The xpression Chart Rule Linking Your Chart Segment to a Fixed Value To link your chart segment to a fixed value, complete the following steps: 1. Select your chart segment in the chart segment list. 2. Select the Value option. After selecting this option, the Read Criteria page displays the Link to Fixed Value option. Figure 109. This page enables you to define your read criteria. Chart Segment Link Table Options Value box 3. Type a value in the Link to Fixed Value box and click Add. You can use NULL if you want to test for the absence of any value. The field/value link appears at the bottom of the page.

153 153 Chapter 9 - The xpression Chart Rule Linking Your Chart Segment to a Primary Table Field To link your chart segment to a field in your primary data source, complete the following steps: 1. Select your chart segment in the chart segment list. 2. Select the Field option. After selecting this option, the Read Criteria page displays the primary data field options. Figure 110. This page enables you to define your read criteria. Chart Segment Link Table Options Data Source Group Primary Table Field in Primary Table The Read Criteria page contains the following options: Element Chart Segment Field Link Table Options Data Source Group Primary Table Primary Table Field Description Links the field in the chart segment you are reading to the primary table in the data source. Select Value and type a value using proper syntax. You can use NULL if you want to test for the absence of any value. If you select Field, select the table containing that field, and the field itself, from the Link to Field list. Select Variable to link the field to an output variable. You can use more than one field to build a query. You can read a record from a data source that is not the same type as the primary. Choose a data source group from the list. The table you want to link to. The table could be the primary table, or any chart segment you have read in the data source. Defines the field in the Link Table that directly relates to the Read Table field.

154 154 Chapter 9 - The xpression Chart Rule 3. The Link to Field section contains three lists. From the top list, select the data source group where your primary table resides. 4. In the middle list, select the primary table. 5. In the bottom list, select the field in the primary table that you want to link to the chosen field in your secondary table. 6. Click Add. The field names in the query appear on the bottom of the page. Linking Your Chart Segment to a Variable To link your chart segment to a variable, complete the following steps: 1. Select your chart segment in the chart segment list. 2. Select the Variable option. After selecting this option, the Read Criteria page displays the Variable list. Figure 111. This page enables you to define your read criteria. Chart Segment Link Table Options Variable list 3. Select the variable from the list and click Add. The field/variable link appears at the bottom of the page.

155 155 Chapter 9 - The xpression Chart Rule Add Content to Your Chart Rule In this step you will add a content item to your Chart rule and start the chart template wizard from the Microsoft Word interface. To add a content item: 1. Click Add to add a new content item. Figure 112. If you want to finish the rule wizard without adding a content item, click Finish. 2. Define the name and attributes for the content item as you would for any content item and click Finish. 3. Microsoft Word opens and adds the xpression chart control buttons to the xpression toolbar. Figure 113. The Microsoft Word toolbar contains three chart-related buttons: Insert Chart, Edit Chart, and Edit Chart Data. Starts the xpression Chart Wizard Click to edit the data of a existing chart Click to edit an existing chart template 4. Click Insert Chart and the xpression chart wizard appears. Click Next to begin.

156 156 Chapter 9 - The xpression Chart Rule 5. Select Create a new chart template and type a name for the chart. Figure 114. From this page you can supply a name for a new chart or choose to use a shared chart template. 6. Click Next. The Chart Type page appears. Figure 115. On the Chart Type selection page, you can select from a variety of bar, column, and pie charts. You can select from bar, column, line and pie charts. For a description of all chart types, see Select your general chart type from the Chart list and then click the thumbnail example of the style you prefer. 7. When you ve selected your chart type and format, click Next.

157 157 Chapter 9 - The xpression Chart Rule 8. The Chart Wizard Data Definition Page shows a list of all the queries available to this rule. These are the queries you defined in the Chart rule wizard. You also have the option of selecting the primary table of your data source instead of a query. Figure 116. Some of the queries in this list may be intended for other charts in your content item and may not apply to your current chart. Select the queries you want to use for your chart data series, or select Use primary table, and click Next. The queries you select here should read from the table that contains your chart data. Caution: If you later delete a query, ensure that it s not being used by other charts. xpression will generate an assembly error when you try to assemble a chart that references the deleted query. If you do delete a query, you ll need to re-edit the chart data before you can assemble it.

158 158 Chapter 9 - The xpression Chart Rule 9. The Series Data Definition page appears. Figure 117. This page enables you to define the fields that contain the data for your data series. This page enables you to define your series data as iterative or static. Iterative data resides in the same field for all customer records. Static data resides in multiple fields in the same customer record. If you choose Iterative, you re defining a single field. After selecting Iterative in the Type column, choose the field that contains the series data from the drop-down list at the bottom of the page and click Next. If you choose Static, you can define as many fields as you need. After selecting Static in the Type column, a Field grid appears at the bottom of the page. Click Add to add a field containing series data to the grid. To add another field, click add again. Click Next when finished.

159 159 Chapter 9 - The xpression Chart Rule 10. On the Category Data page you must define the field or fields that contain your category data. Figure 118. Select the rule query you want to use to generate the values for your category, or use the primary table. Define your data as Iterative or Static. Select the field or fields that contain your category data as you did on the previous wizard page. Click Next when finished. 11. The Color Scheme page appears. Figure 119. On the Color Scheme page you can select an existing color scheme for your chart or define your own custom color scheme. If this is your first time through the Chart wizard, no color schemes will exist and you will need to create one. Click New.

160 160 Chapter 9 - The xpression Chart Rule 12. The color scheme dialog box appears. Figure 120. You can set the color scheme name, define up to 16 colors, and select a fill pattern. 13. Type a name for your color scheme. 14. In the Colors section, you will see a series of grey boxes. Click a box to add a color to the palate. You can add up to 16 colors. Figure 121. The color selection page. 15. In the Patterns section, you can define the order of your patterns. If your chart uses patterns, define how the patterns are applied in the chart by placing them in order from left to right. xpression uses the patterns in this order. When you have completed defining color options for your chart, click Next. 16. The completion page appears. Review your choices and click Finish if they are correct. If not, click Back to return to the page where you need to make modifications. A sample chart appears in your xdesign document. This chart does not reflect your customer data, it is merely a placeholder for the real chart that is added when you assemble the document. You can resize your chart by resizing this placeholder chart. Select the placeholder and drag the edges until it is the size that you want.

161 161 Chapter 9 - The xpression Chart Rule Customizing the Look of Your Charts The chart template wizard creates a generic chart as a placeholder. In most cases you will need to edit the appearance of your chart to meet the requirements of your document. The Edit chart function provides control over almost every aspect of the chart s appearance from the Chart Options dialog box. See the following table for more information about chart elements. Chart Element Value Data Series Category Title Legend What is it? The chart value relates to the field in your customer data that contains the values for generating the chart. A group of related data points plotted in a chart to correspond to your category and category data. Each data series has a unique color or pattern. You can define more than one data series in bar and column charts. A group of related data points made up of one data point from each data series in the chart. For bar charts, categories are plotted along the vertical (y) axis. In column charts the category (x) axis is horizontal. A title to further define your chart and its data. A key to the patterns or colors assigned to the data series or categories in a chart. You can edit the appearance of your chart by configuring the chart labels, legend, colors, depth, and format. Each chart type contains different settings: Pie Chart Options Bar and Column Chart Options Line Chart Options

162 162 Chapter 9 - The xpression Chart Rule Pie Chart Options To edit a pie chart, select your chart in Microsoft Word and click the Edit chart button. For pie charts you can set options on that following tabs: Pie Chart General Tab Pie Chart 3D Tab Settings Pie Chart Data Labels Tab Pie Chart Legend Tab Pie Chart Text Boxes Tab Pie Chart Tab Pie Chart Colors Tab Pie Chart General Tab The General tab contains general formatting and layout options, such as fill patterns, the size of the gaps between the pie slices, offsetting a pie slice, outlined edges, and placement settings. Figure 122. Pie chart General tab.

163 163 Chapter 9 - The xpression Chart Rule These configuration options are available. Element Use Fill Patterns Show Pie With Gaps Description Select this option to turn on the display of patterns for each slice in the order defined to the color scheme associated with the chart. Select this option to place gaps between your pie chart slices. To set the size of the gap between the slices, choose a number between 1 and 50, with 50 being the largest possible gap. The gap amount is measured in points. No gap here Gap setting of 20 If your chart has only one segment and you choose to show gaps, the image may not display. If there is a possibility that the chart will include only a single element, it is recommended that you not select Show Pie with Gaps. Show Pie With Exploded Wedge Select this option to show the pie chart with a wedge separated slightly from the rest of the chart. The Explode Amount setting determines how far from the center of the pie the slice is separated from the chart. The Explode Element setting is the number of the slice you want to offset. The elements are numbered starting at the 12 o clock position and they proceed clockwise. Element 1 Exploded Wedge (and Element 5) Element 2 Element 4 Element 3

164 164 Chapter 9 - The xpression Chart Rule Element Outline Pie Edges Description Select this box to add a colored outline to the pie chart wedges. Lighter Darker Custom Color Placement Editor Use the Placement editor to directly control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Chart body Legend Text boxes Placement Editor Settings The height, width, horizontal and vertical offset options position the chart in the image area. These settings are measured in pixels.

165 165 Chapter 9 - The xpression Chart Rule Pie Chart 3D Tab Settings The 3D Settings tab enables you to make the pie chart three-dimensional and control the tilt and depth of the 3D image. Click an area in the illustration below to learn more about it. Figure 123. Pie chart 3D tab settings. These configuration options are available. Element Description 3 Dimensional Select this box to make the pie chart three dimensional. Tilt % The tilt setting determines the angle of the pie chart. The tilt value is determined as a percentage of the size of the whole graph. Move this setting to suit your document. A sample pie chart appears to illustrate your changes in real time. The sample here shows the difference between the minimum Tilt value of 30, on the left, and the maximum value of 70.

166 166 Chapter 9 - The xpression Chart Rule Element Depth % Description The depth setting determines the thickness of the chart. The depth value is determined as a percentage of the size of the whole graph. Move this setting to suit your document. A sample pie chart appears to illustrate your changes in real time. The sample here shows the difference between the minimum Depth value of 4, on the left, and the maximum value of 20. Pie Chart Data Labels Tab The Data Labels tab enables you to add data labels to identify the values of your data series. You can specify the format, placement, and decimal setting for the label. Click an area in the illustration below to learn more about it. Figure 124. Pie chart Data Labels tab options.

167 167 Chapter 9 - The xpression Chart Rule These configuration options are available. ErrorsElement Show Data Labels Data Label Format ErrorsDescription Select this option to add data labels to your chart. When selected, the data label options become accessible. The data label identifies the data represented by each pie slice. You can define the label to be the actual value defined in the field or the name of the field. You can select: Value only. Uses the actual value from the field. Name only. Uses the name of the field that contains the value represented. Name and value. Places the name and value outside the pie chart. Name outside, value inside. Places the name outside the pie chart and the actual value contained in the field inside the pie chart. Value Format Data Label Font Determine how you want to present the values in your pie chart. You can select: Percentage of total. Represents the value as a percentage of the total. Actual value. Represents the value as it appears in the customer data. Click Choose Font to select your font family, font type, and point size.

168 168 Chapter 9 - The xpression Chart Rule ErrorsElement Data Label Position ErrorsDescription Define the placement of the data labels. You can select: Outside with leader on side. Places the data label to the side of the chart with a leader pointing to the pie slice. Outside with leader. Places the data label immediately outside the chart with a leader pointing to the pie slice. Outside. Places the data label immediately outside the chart. Inside. Places the data label inside the pie slice. Maximum width Background Color Border Data Label Margins Set the maximum width in points for your data labels. Provides a background for the data label. Select this box to add a background color, then click the color box to select the background color. xpression applies a transparent background if you don t select a color. Provides a border to the data label. Select this box to add a border to the data label, then click the color box to select a border color. Provides a margin for the data label. You can set a margin for Left, Right, Top, and Bottom of up to 10 points.

169 169 Chapter 9 - The xpression Chart Rule ErrorsElement Number Format ErrorsDescription This option places the number that appears in the value field in the proper format. You can select: General. Places the number on the chart as it appears in the field. Percentage. Places the number in the chart as a percentage. Currency. Places the number in the chart as currency. Always Show Decimal Places Show Thousands Separator Select this option to use decimal points on your chart. and then indicate the number of decimal places in the box. Select this option to use the thousands separator for your chart value. The thousands separator is the comma (,) that appears to the left of every third number. Pie Chart Legend Tab The Legend tab enables you to add and configure a legend for your chart. You can set the layout, placement, font style, background, and border settings. Click an area in the illustration below to learn more about it. Figure 125. Pie chart Legend tab options.

170 170 Chapter 9 - The xpression Chart Rule These configuration options are available. Element Show Legend Item order Placement Editor Font Background Color Border Shadow Description Select Show Legend to display a legend with your chart. Determines the orientation of the legend items. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Select the font for your legend. You can use any TrueType font resident on your computer. Defines a background color for the legend. Select to place a border around the legend. Select to place a drop-shadow around the legend.

171 171 Chapter 9 - The xpression Chart Rule Pie Chart Text Boxes Tab The Text Boxes tab enables you to add text boxes that provide explanatory information about your chart. From this tab you can control the layout, placement, and format of the text box. Figure 126. Pie chart text Boxes tab options. These configuration options are available. Element Text Box Name Text Layout Grow Text Box Description On the left side of the page is the Text Box Name list. You can add text boxes to your chart by clicking Add. xpression won t accept spaces in the text box name, but you can add underscore characters to improve readability. You can remove selected text boxes by clicking Delete. To define layout and formatting for a text box, select it from this list before altering the other settings on this tab. Type the text you want xpression to place in the text box here. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Gives you the option to either set the width of the text box to a static value, or give the text box a maximum width it can grow (before wrapping the text) if the text is longer than the width specified for the box.

172 172 Chapter 9 - The xpression Chart Rule Element Margins Font Justification Rotation Background Color Border Description Provides a margin for the text box. You can set a margin for Left, Right, Top, and Bottom of up to 10 pts. Click Choose font to select the font for your text box. You can use any TrueType font resident on your computer, but you should limit the number of fonts you use across all charts. Too many will adversely affect performance. Enables you to determine the justification for the text within the text box. Enables you to determine the rotation of the text box; determined from the top left offset of the text box. Defines a background color for the text box. Places a border around the text box. Border line widths are: thin; double thin; thin outside, medium inside; medium; medium outside, thin inside; thick. Shadow Places a drop-shadow around the legend.

173 173 Chapter 9 - The xpression Chart Rule Pie Chart Tab The Chart tab enables you to control the sharing of the current chart. You can also change the background color, select a gradient background, and add borders to the chart. Figure 127. Chart tab options for pie charts. These configuration options are available. Element Shared Name Background Color Gradient Description Select Shared to share your chart. To prevent sharing, clear the Shared check box. If you are sharing your chart, type a name for the chart to identify the chart in the shared list. Select a background color for the chart. To apply a gradient color pattern to your background, select Gradient. Select a gradient pattern from the Type list. The gradient pattern gradually transforms from one color to another. The color you selected for the background is the first color. The pattern will gradually transform into the color you select for End color. Border Select the Border option to add a border to your chart. Click Choose border to select a border style.

174 174 Chapter 9 - The xpression Chart Rule Pie Chart Colors Tab The Colors tab accesses the same functionality as the Color Definition page in the chart template wizard. It enables you to change the color scheme of your chart after the chart has already been created. Figure 128. Pie chart color settings. The color scheme tab shows a preview of the active color scheme and a list of existing color schemes. You can select an existing color scheme to edit or delete, but you won t be able to delete a scheme if it s being used by another chart. To create a new Color Scheme, click New to open the color scheme page. On this page you can define these options. Element Name Colors Pattern Order Description The name for your new color scheme. You can define 16 colors in your color scheme. Click each box to add a new color to your color scheme. If your chart uses patterns, define the order that you want the patterns to appear in your chart. xpression will use the patterns in order from left to right when creating your chart.

175 175 Chapter 9 - The xpression Chart Rule Bar and Column Chart Options To edit either a bar or column chart, select your chart in Microsoft Word and click Edit chart. For bar charts you can set options on that following tabs: Bar and Column General Tab Bar and Column Chart Format Bar and Column 3D Settings Bar and Column Data Labels Bar and Column Value Axis Bar and Column Category Axis Bar and Column Gridlines Bar and Column Legend Bar and Column Text Boxes Tab Bar and Column Chart Tab Bar and Column Chart Colors Tab

176 176 Chapter 9 - The xpression Chart Rule Bar and Column General Tab The bar and column General tab contains general formatting and layout options such as, bar width, space between bars, outlining, chart size, and placement. Figure 129. Bar and column chart General tab options. These configuration options are available. Element Bar Width % Space Between Bars % Outline Bar Elements Description The bar width is a percentage of the width of the category. The category width is the width that each category takes along the left margin of the chart. If you set the width at 100%, the bar will fill in the entire category width. The space between the bars based on a percentage of the bar width. Select this option to set an outline for the bars. From the Color Options list, select: Lighter. This setting draws the bar chart border in a color lighter than the main bar chart colors. Darker. This setting draws the bar chart border in a color darker than the main bar chart colors. Custom Color. This setting enables you to set your own border color.

177 177 Chapter 9 - The xpression Chart Rule Element Single Series Multi-Color Mode Layout Description If a bar/column chart only has one series of data this option enables you to specify that each bar gets a different color. If this is not set, and if there is one data series, each bar is the same color. Use the Placement editor to directly control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Bar and Column Chart Format The Format tab contains the following settings. This tab enables you to change your chart to a bar or column chart, select a basic chart or stacked chart, and select the shape of your bars or columns. Click an area in the illustration below to learn more about it. Figure 130. Bar and column chart Format tab.

178 178 Chapter 9 - The xpression Chart Rule These configuration options are available. Element Format Description Select the format of your chart from the following options: Bar or Column. You can change your chart type to a bar or column chart from this page. Basic or Stacked. You can choose a basic or stacked format. A basic format places the data series within a category side by side. A stacked chart places data series within a category on top of one another. Style Choose the shape of your bars: rectangle, cylinder, triangle, diamond, or pattern. Bar and Column 3D Settings The 3D Settings tab enables you to make the chart three-dimensional and control the horizontal and vertical tilt, and the depth of the image. Click an area in the illustration below to learn more about it. Figure 131. Bar and column 3D Settings tab.

179 179 Chapter 9 - The xpression Chart Rule This page contains the following options. Option Definition 3 Dimensional Select this option to change your chart to 3 dimensional or 2 dimensional. Horizontal Tilt % Vertical Tilt % Depth % Rotates the bar horizontally to the left or right. The tilt value is determined as a percentage of the size of the whole graph. Rotates the bar vertically up and down. The tilt value is determined as a percentage of the size of the whole graph. Controls the depth of your image. The depth value is determined as a percentage of the size of the whole graph. Bar and Column Data Labels The bar and column Data Labels tab contains the following settings. You can add data labels to your chart from this tab. Data labels identify the values in your data series. You can specify the format, placement, and decimal setting for the label. Click an area in the illustration below to learn more about it. Figure 132. Bar and column Data Labels tab.

180 180 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Show Data Labels Data Label Format Description Select this option to add data labels to your chart. Click Format to open the Format Data Label dialog box. This is where you will define the formats for the labels placed on your data. The label can consist of one or more Fields, Text, or new lines. You can order selections by moving them up and down. Data Label Font Data Label Position Click Choose Font to select your font family, font type, and point size. Define the placement of the data labels. You can select from the following: Outside Top. Places the data labels outside of the bar near the top of the bar. The top of the bar is the end of the bar. If you are creating a bar chart, the top of the bar will actually appear on the right side of the chart. Inside Top. Places the data labels inside the bar at the top of the bar. The top of the bar is the end of the bar. If you are creating a bar chart, the top of the bar will actually appear on the right side of the chart. Inside Bottom. Places the data labels inside the bar at the bottom of the bar. Maximum Width Background Color Set the maximum width in points for your chart. Provides a background for the data label. Select this option to add a background color, then select the background color.

181 181 Chapter 9 - The xpression Chart Rule Element Border Data Label Show Data Labels for Zero Values Margins Negative Format Description Provides a border to the data label. Select this option to add a border to the data label, then select a border color. Select this option to display a data label for data series with a zero value. Provides a margin for the data label. You can set a margin for Left, Right, Top, and Bottom of up to 10 points. Select the data label format for negative values: Minus Sign. Displays a minus sign to show negative values. Parenthesis. Displays a parenthesis to show negative values. Absolute Value. Displays the value as it appears in the data source. Always Show Decimal Points Show Thousands Separator Select this option to use decimal points on your chart and specify the number of Decimal places. Enables a thousands separator for your chart value. The thousands separator is the comma (,) that appears to the left of every third number.

182 182 Chapter 9 - The xpression Chart Rule Bar and Column Value Axis Sets up the layout of your value axis. You can set the maximum and minimum allowed values, the size and format of the tick marks, the value labels, and the number format. The Value Axis tab contains the following settings. Click an area in the illustration below to learn more about it. Figure 133. Bar and column Value Axis tab. The value axis contains data that measures the value of the data series. The category axis displays information identifying the categories. Figure 134. The value and category axis. Value Axis Category Axis

183 183 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Scale Definition Description This setting defines how your values will display along the value axis. You can select: Automatic enables xpression to determine how your values will display along the value access. Manual sets custom values for the value axis. Maximum/Minimum Value Show Major/Minor Tick Mark Options (Manual only) Set the maximum and minimum value for the value axis. These settings define the number and format of tick marks along the value axis: Max. Tick Marks. (Automatic only) If you select automatic scaling, set the maximum number of tick marks that can appear on the value axis. Number of Tick Marks. (Manual only) Set the exact number of tick marks that can appear on the value axis. Size. Set the size of the tick marks. Choose Small, Medium, or Large. Position. Select the position of the tick marks. Choose Outside to place the tick marks outside the chart. Choose Inside to place the tick marks inside the chart. Choose Cross to place the tick marks across the value axis, creating a cross at each tick mark. Color. Click the color box and select a color for the tick marks. Black is the default color. Show Labels Label Format Select this option to display labels along the value axis. The value axis labels are the number that appear along the side of the chart. These labels identify the tick mark label interval values. Select the label format: General displays the value as it appears in your data source. Percentage displays the value as a percentage. Currency displays the value as currency. Font Click Choose font to select your font family, font type, and point size.

184 184 Chapter 9 - The xpression Chart Rule Element Rotate Labels Label Abbreviation Description Select this option to rotate the labels by the amount defined in the Angle box. Negative values rotate the label counterclockwise, positive values rotate the label clockwise. This option places an abbreviation after the value axis label: None places no abbreviation. Percentage places a percentage symbol (%) after the data label. For example: 10% Thousands places a thousands symbol (k) after the data label. For example: 10k. Millions places a millions symbol (m) after the data label. For example: 10m. Billions places a billions symbol (b) after the data label. For example: 10b. Trillions places a trillions symbol (t) after the data label. For example: 10t. Select Show abbreviation symbol to display the label abbreviation. Negative Format Select the data label format for negative values. Minus Sign displays a minus sign to show negative values. Parenthesis displays a parenthesis to show negative values. Absolute Value displays the value as it appears in the data source. Decimal Places Always Show Decimal Points Show Thousands Separator Define the number of decimal places to use for each data label. Select this option to use decimal points on your chart. Select this box to use the thousands separator for your chart value. The thousands separator is the comma (,) that appears to the left of every third number.

185 185 Chapter 9 - The xpression Chart Rule Bar and Column Category Axis Enables you to adjust the layout of your category axis. You can set the tick mark and value label settings. Click an area in the illustration below to learn more about it. Figure 135. The Category Axis tab. These options appear only when you select a column chart. The value axis marks the value of the data series. The category axis displays information identifying the categories. Figure 136. The category and value axis. Value Axis Category Axis

186 186 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Show Tick Marks Description Select this option to display tick marks along the category axis: Length. Select a length for the tick marks. Choose between Small, Medium, and Large. Position. Select the position of the tick marks. Choose Outside to place the tick marks outside the chart. Choose Inside to place the tick marks inside the chart. Choose Cross to place the tick marks across the value axis, creating a cross at each tick mark. Color. Click the color box and select a color for the tick marks. Black is the default color. Show Labels Font Limit Label Length Adjust Label Layout Select this option to display labels for the category axis. Click Choose Font to select your font family, font type, and point size. Select this option to limit the label length to the number of characters defined in the Max. characters box. You can define any value between 0 and Adjusts the axis labels and is only enabled if the Show Labels option box is checked. Choose from these options: Always. xpression will automatically apply the selected options if the labels overlap. Only When Labels Overlap. xpression will apply the selected options if necessary. Wrap Label Reduce Font Size Stagger Labels Rotate Labels Enables the text in your label to wrap. In the Max. lines box, select the maximum number of lines that the label can contain. Select this option to enable xpression to reduce the font size in certain situations where the label is too big to fit within your size parameters. In the Min. font size box, set the minimum allowable font size. Select this option to prevent the labels from overlapping. Select this option to rotate the labels by the amount defined in the Angle degree box. Negative values rotate the label counterclockwise, positive values rotate the label clockwise.

187 187 Chapter 9 - The xpression Chart Rule Element Skip Labels Description If the Only When Labels Overlap is selected under Adjust Label Layout, xpression will skip one label at a time only if all the other settings do not prevent the labels from overlapping. The options are applied in order and it is possible that not all the options will be applied, if the first option solves the problem. Bar and Column Gridlines The Gridlines tab enables you to place, define, and configure horizontal and vertical gridlines. Click an area in the illustration below to learn more about it. Figure 137. Bar and column Gridlines tab.

188 188 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Vertical Description Sets the options for the vertical gridlines. You can select the color for each of the following vertical gridlines: Right, Left, and Zero. Select the color and style of gridlines for Major or Minor gridlines. You can also select Grid Stripes for the vertical gridlines. Grid stripes make complex and lengthy charts easier to read. Horizontal Sets the options for the horizontal gridlines. You can select the color for each of these horizontal gridlines: Bottom, Top, and Inner. You can also select the style of gridline, Solid, Dash, Dot, or Dash Dot, for all of the horizontal gridlines. Bar and Column Legend The Legend tab enables you to add and configure a legend for your chart. You can set the layout, placement, font style, background, and border settings. Click an area in the illustration below to learn more about it. Figure 138. Bar and column Legend tab.

189 189 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Show Legend Layout Font Background Color Border Shadow Description Select Show Legend to display a legend with your chart. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Click Choose font to select the font for your legend. Select Background Color to define a background color for the legend. Select Border to place a border around the legend. Select Shadow to place a drop-shadow around the legend.

190 190 Chapter 9 - The xpression Chart Rule Bar and Column Text Boxes Tab The Text Boxes tab enables you to add text boxes that provide explanatory information about your chart. This tab enables you to control the layout, placement, and format of the text box. Click an area in the illustration below to learn more about it. Figure 139. Bar and column Text Boxes tab. This page contains the following options. Element Text Box Name Text Layout Description On the left side of the page is the Text Box Name list. You can add text boxes to your chart by clicking Add. xpression won t accept spaces in the text box name, but you can add underscore characters to improve readability. You can remove selected text boxes by clicking Delete. To define layout and formatting for a text box, select it from this list before altering the other settings on this tab. Type the text for your text box here. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart.

191 191 Chapter 9 - The xpression Chart Rule Element Grow Text Box Margins Font Justification Rotation Background Color Border Description Enables you to set the width of the text box to a static value, or to give the text box a maximum width to which it can grow (before wrapping the text) if the text is longer than the width specified for the box. Provides a margin for the data label. You can set a margin for Left, Right, Top, and Bottom of up to 10 pts. Click Choose font to select the font for your text box. Enables you to determine the justification for the text within the text box. Enables you to set the rotation for the text box (portrait, landscape or inverse landscape) - determined from the top left offset of the text box. Select Background Color to define a background color for the legend. Select Border to place a border around the legend.

192 192 Chapter 9 - The xpression Chart Rule Bar and Column Chart Tab The Chart tab enables you to control the sharing of the current chart. You can also change the background color, select a gradient background, and add borders to the chart. Click an area in the illustration below to learn more about it. Figure 140. Bar and column Chart tab. This page contains the following options Element Shared Name Background Color Description Select Shared to share your chart. To prevent sharing, clear the Shared check box. If you are sharing your chart, type a name for the chart to identify the chart in the shared list. Select a background color for the chart.

193 193 Chapter 9 - The xpression Chart Rule Element Gradient Description To apply a gradient color pattern to your background, select the Gradient box. Select a gradient pattern from the Type list. The gradient pattern gradually transforms from one color to another. The color you selected for the background is the first color. The pattern will gradually transform into the color you select for End color. Border Select the border check box to add a border to your chart. Click Choose border to select a border style. Bar and Column Chart Colors Tab This tab provides the same functionality as the Color Definition page in the chart template wizard. It enables you to change the color scheme of your chart after the chart has already been created. The Colors tab contains the following settings. Figure 141. Bar and column chart Colors tab. The color scheme tab shows a preview of the active color scheme and a list of existing color schemes. You can select an existing color scheme and edit or delete it. To create a new Color Scheme, click New to open the color scheme page.

194 194 Chapter 9 - The xpression Chart Rule On this page you can define these options. Element Name Colors Pattern Order Description Supply a name for your new color scheme. You can define sixteen colors in your color scheme. Click each box to add a new color to your color scheme. If your chart uses patterns, define the order that you want the patterns to appear in the chart. xpression will use the patterns in order from left to right when creating your chart. Line Chart Options To edit a line chart, select your chart in Microsoft Word and click Edit chart. You can define the following options for line charts. Line Chart General Tab Line 3D Settings Line Chart Data Labels Line Chart Value Axis Line Chart Category Axis Line Gridlines Line Series Line Legend Line Text Boxes Tab Line Chart Tab Line Colors Tab

195 195 Chapter 9 - The xpression Chart Rule Line Chart General Tab The General tab contains general formatting and layout options. For line charts, the only general formatting options available are the Default line width and the position of the chart in the image area. Figure 142. Line chart General tab.

196 196 Chapter 9 - The xpression Chart Rule These configuration options are available. Element Default Line Width Placement Editor Description This setting sets the default pixel width of the line. This value can be overridden in the Line Series tab for a specific data series. Use the Placement editor to directly control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Chart body Legend Text boxes Placement Editor Settings The height, width, horizontal and vertical offset options position the chart in the image area. These settings are measured in pixels.

197 197 Chapter 9 - The xpression Chart Rule Line 3D Settings The 3D Settings tab enables you to make the chart three-dimensional and control the horizontal and vertical tilt, and the depth of the image. Click an area in the illustration below to learn more about it. Figure 143. Line 3D Settings tab. This page contains the following options. Element Description 3 Dimensional Select this option to change your chart to 3 dimensional or 2 dimensional. Horizontal Tilt % Vertical Tilt % Depth % Rotates the bar horizontally to the left or right. The tilt value is determined as a percentage of the size of the whole graph. Rotates the bar vertically up and down. The tilt value is determined as a percentage of the size of the whole graph. Controls the depth of your image. The depth value is determined as a percentage of the size of the whole graph.

198 198 Chapter 9 - The xpression Chart Rule Line Chart Data Labels The line Data Labels tab contains the following settings. You can add data labels to your chart from this tab. Data labels identify the values in your data series. You can specify the format, placement, and decimal setting for the label. Click an area in the illustration below to learn more about it. Figure 144. Line chart Data Labels tab.

199 199 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Show Data Labels Data Label Format Description Select this option to add data labels to your chart. Click Format to open the Format Data Label dialog box. This is where you will define the formats for the labels placed on your data. The label can consist of one or more Fields, Text, or new lines. You can order selections by moving them up and down. Data Label Font Data Label Position Maximum Width Background Color Border Data Label Show Data Labels for Zero Values Click Choose Font to select your font family, font type, and point size. Define the placement of the data labels. You can select from the following: Above. Places the data labels above the line. Below. Places the data labels below the line. Centered on the Line. Centers the data labels on the line. Set the maximum width in points for your chart. Provides a background for the data label. Select this option to add a background color, then select the background color. Provides a border to the data label. Select this option to add a border to the data label, then select a border color. Select this option to display a data label for data series with a zero value.

200 200 Chapter 9 - The xpression Chart Rule Element Margins Negative Format Always Show Decimal Points Show Thousands Separator Description Provides a margin for the data label. You can set a margin for Left, Right, Top, and Bottom of up to 10 points. Select the data label format for negative values: Minus Sign. Displays a minus sign to show negative values. Parenthesis. Displays a parenthesis to show negative values. Absolute Value. Displays the value as it appears in the data source. Select this option to use decimal points on your chart and specify the number of Decimal places. Enables a thousands separator for your chart value. The thousands separator is the comma (,) that appears to the left of every third number. Line Chart Value Axis Sets up the layout of your value axis. You can set the maximum and minimum allowed values, the size and format of the tick marks, the value labels, and the number format. The Value Axis tab contains the following settings. Click an area in the illustration below to learn more about it. Figure 145. Line chart Value Axis tab.

201 201 Chapter 9 - The xpression Chart Rule The value axis contains data that measures the value of the data series. The category axis displays information identifying the categories. Figure 146. Value and category axis. Value Axis Category Axis This page contains the following options. Element Scale Definition Description This setting defines how your values will display along the value axis. You can select: Automatic to enable xpression to determine how your values will display along the value access. Manual to set custom values for the value axis. Maximum/Minimum Value Show Major/Minor Tick Mark Options (Manual only) Set the maximum and minimum value for the value axis. These settings define the number and format of tick marks along the value axis: Max. Tick Marks. (Automatic only) If you select automatic scaling, set the maximum number of tick marks that can appear on the value axis. Number of Tick Marks. (Manual only) Set the exact number of tick marks that can appear on the value axis. Size. Set the size of the tick marks. Choose Small, Medium, or Large. Position. Select the position of the tick marks. Choose Outside to place the tick marks outside the chart. Choose Inside to place the tick marks inside the chart. Choose Cross to place the tick marks across the value axis, creating a cross at each tick mark. Color. Click the color box and select a color for the tick marks. Black is the default color. Show Labels Select this option to display labels along the value axis. The value axis labels are the number that appear along the side of the chart. These labels identify the tick mark label interval values.

202 202 Chapter 9 - The xpression Chart Rule Element Label Format Description Select the label format: General displays the value as it appears in your data source. Percentage displays the value as a percentage. Currency displays the value as currency. Font Rotate Labels Label Abbreviation Click Choose font to select your font family, font type, and point size. Select this option to rotate the labels by the amount defined in the Angle box. Negative values rotate the label counterclockwise, positive values rotate the label clockwise. This option places an abbreviation after the value axis label: None places no abbreviation. Percentage places a percentage symbol (%) after the data label. For example: 10% Thousands places a thousands symbol (k) after the data label. For example: 10k. Millions places a millions symbol (m) after the data label. For example: 10m. Billions places a billions symbol (b) after the data label. For example: 10b. Trillions places a trillions symbol (t) after the data label. For example: 10t. Select Show abbreviation symbol to display the label abbreviation. Negative Format Select the data label format for negative values. Minus Sign displays a minus sign to show negative values. Parenthesis displays a parenthesis to show negative values. Absolute Value displays the value as it appears in the data source. Decimal Places Always Show Decimal Points Show Thousands Separator Define the number of decimal places to use for each data label. Select this option to use decimal points on your chart. Select this box to use the thousands separator for your chart value. The thousands separator is the comma (,) that appears to the left of every third number.

203 203 Chapter 9 - The xpression Chart Rule Line Chart Category Axis Enables you to adjust the layout on your category axis. You can set the tick mark and value label settings. Click an area in the illustration below to learn more about it. Figure 147. Line chart Category Axis tab. The value axis marks the value of the data series. The category axis displays information identifying the categories. Figure 148. Value and Category Axis. Value Axis Category Axis

204 204 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Show Tick Marks Show Labels Font Limit Label Length Adjust Label Layout Wrap Label Reduce Font Size Stagger Labels Rotate Labels Skip Labels Description Select this option to display tick marks along the category axis: Length. Select a length for the tick marks. Choose between Small, Medium, and Large. Position. Select the position of the tick marks. Choose Outside to place the tick marks outside the chart. Choose Inside to place the tick marks inside the chart. Choose Cross to place the tick marks across the value axis, creating a cross at each tick mark. Color. Click the color box and select a color for the tick marks. Black is the default color. Select this option to display labels for the category axis. Click Choose Font to select your font family, font type, and point size. Select this option to limit the label length to the number of characters defined in the Max. characters box. You can define any value between 0 and Adjusts the axis labels and is only enabled if the Show Labels option box is checked. Choose from these options: Always. xpression will automatically apply the selected options if the labels overlap. Only When Labels Overlap. xpression will apply the selected options if necessary. Enables the text in your label to wrap. In the Max. lines box, select the maximum number of lines that the label can contain. Select this option to enable xpression to reduce the font size in certain situations where the label is too big to fit within your size parameters. In the Min. font size box, set the minimum allowable font size. Select this option to prevent the labels from overlapping. Select this option to rotate the labels by the amount defined in the Angle degree box. Negative values rotate the label counterclockwise, positive values rotate the label clockwise. If the Only When Labels Overlap is selected under Adjust Label Layout, xpression will skip one label at a time only if all the other settings do not prevent the labels from overlapping. The options are applied in order and it is possible that not all the options will be applied, if the first option solves the problem.

205 205 Chapter 9 - The xpression Chart Rule Line Gridlines The Gridlines tab enables you to place, define, and configure horizontal and vertical gridlines. Click an area in the illustration below to learn more about it. Figure 149. Line chart Gridlines tab. This page contains the following options. Element Vertical Horizontal Description Sets the options for the vertical gridlines. You can select the color for each of the following vertical gridlines: Right, Left, and Zero. Select the color and style of gridlines for Major or Minor gridlines. You can also select Grid Stripes for the vertical gridlines. Grid stripes make complex and lengthy charts easier to read. Sets the options for the horizontal gridlines. You can select the color for each of these horizontal gridlines: Bottom, Top, and Inner. You can also select the style of gridline, Solid, Dash, Dot, or Dash Dot, for all of the horizontal gridlines.

206 206 Chapter 9 - The xpression Chart Rule Line Series The Series tab enables you to define settings for a particular data series. Figure 150. Line chart Series tab. This page contains the following options. Element Data Series Line Width Line Style Symbol Symbol Style Description Select the data series that you want to customize from this list. Sets the width of the line in pixels. This overrides the default line width setting. Enables you to select the line style: Solid, Dot, Dash, or Dot-Dash. Places symbols at points along the line to represent data points. If selected, the symbol is also used in the legend. Sets the shape to be used for the symbols.

207 207 Chapter 9 - The xpression Chart Rule Element Color Height and Width Description Sets the color of the symbol. Determine the size of the symbol. Line Legend The Legend tab enables you to add and configure a legend for your chart. You can set the layout, placement, font style, background, and border settings. Click an area in the illustration below to learn more about it. Figure 151. Line chart Legend tab options. This page contains the following options. Element Show Legend Layout Description Select Show Legend to display a legend with your chart. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart.

208 208 Chapter 9 - The xpression Chart Rule Element Font Background Color Border Shadow Description Click Choose font to select the font for your legend. Select Background Color to define a background color for the legend. Select Border to place a border around the legend. Select Shadow to place a drop-shadow around the legend. Line Text Boxes Tab The Text Boxes tab enables you to add text boxes that provide explanatory information about your chart. This tab enables you to control the layout, placement, and format of the text box. Click an area in the illustration below to learn more about it. Figure 152. Line chart Text Box Settings tab.

209 209 Chapter 9 - The xpression Chart Rule This page contains the following options. Element Text Box Name Text Layout Grow Text Box Margins Font Justification Rotation Background Color Border Description On the left side of the page is the Text Box Name list. You can add text boxes to your chart by clicking Add. xpression won t accept spaces in the text box name, but you can add underscore characters to improve readability. You can remove selected text boxes by clicking Delete. To define layout and formatting for a text box, select it from this list before altering the other settings on this tab. Type the text for your text box here. Use the Placement editor to manually control the height, width, and vertical and horizontal offsets. Drag the sizing handles and select and move the elements to different relative locations inside the chart. Enables you to set the width of the text box to a static value, or to give the text box a maximum width to which it can grow (before wrapping the text) if the text is longer than the width specified for the box. Provides a margin for the data label. You can set a margin for Left, Right, Top, and Bottom of up to 10 pts. Click Choose font to select the font for your text box. Enables you to determine the justification for the text within the text box. Enables you to set the rotation for the text box (portrait, landscape or inverse landscape) - determined from the top left offset of the text box. Select Background Color to define a background color for the legend. Select Border to place a border around the legend.

210 210 Chapter 9 - The xpression Chart Rule Line Chart Tab The Chart tab enables you to control the sharing of the current chart. You can also change the background color, select a gradient background, and add borders to the chart. Click an area in the illustration below to learn more about it. Figure 153. Chart tab options for Line Charts. This page contains the following options. Element Shared Name Background Color Description Select Shared to share your chart. To prevent sharing, clear the Shared check box. If you are sharing your chart, type a name for the chart to identify the chart in the shared list. Select a background color for the chart.

211 211 Chapter 9 - The xpression Chart Rule Element Gradient Description To apply a gradient color pattern to your background, select the Gradient box. Select a gradient pattern from the Type list. The gradient pattern gradually transforms from one color to another. The color you selected for the background is the first color. The pattern will gradually transform into the color you select for End color. Border Select the border check box to add a border to your chart. Click Choose border to select a border style. Line Colors Tab This tab provides the same functionality as the Color Definition page in the chart template wizard. It enables you to change the color scheme of your chart after the chart has already been created. The Colors tab contains the following settings. Figure 154. Line Chart Colors tab options. The Colors tab shows a preview of the active color scheme and a list of existing color schemes. You can select an existing color scheme and edit or delete it. To create a new Color Scheme, click New to open the Color Scheme dialog box.

212 212 Chapter 9 - The xpression Chart Rule On this dialog box you can define these options. Element Name Colors Pattern Order Description Supply a name for your new color scheme. You can define sixteen colors in your color scheme. Click each box to add a new color to your color scheme. If your chart uses patterns, define the order that you want the patterns to appear in the chart. xpression will use the patterns in order from left to right when creating your chart. Editing Your Chart Data The Edit Chart Data button enables you to change the data series and category values for your chart. This feature is useful for correcting mistakes or for updating an existing chart with new data. To edit your chart data, click the Edit Chart Data button. The Chart Data Options page contains two tabs, Data Series and Category. Figure 155. Chart Data Options.

213 213 Chapter 9 - The xpression Chart Rule Editing a Data Series The data series tab contains options for your data series values. The Chart data series list shows all of the queries you defined for the chart. You can add to or remove from this list using the Add and Delete buttons. To edit a data series: 1. Select the data series from the Chart data series list. 2. Define the query as Iterative or Static in the Type column. Iterative data resides in the same field in multiple customer records, static data resides in multiple fields in the same customer record. Figure 156. Chart data series list. 3. To use different fields in the same query, double-click the data series name to name each data series in the chart so you don t have to use the same query name in the chart. Figure 157. To change a data series name. It provides another level of separation from the xdesign chart rule and the chart itself. Most importantly, when using the primary table, PRIMARYTABLE was the name of the data series, this feature enables the user to provide a meaningful data series name.

214 214 Chapter 9 - The xpression Chart Rule 4. After defining your data series type, define the data series values. There are different options for an iterative and a static data series. Figure 158. Define your data series and category information. For an iterative data series, define a single field. For a static data series, define as many fields as you need. Click Add to add a static value definition. When you have completed adding your data series and category information, click OK. Editing Your Category Data The category tab enables you to edit the category values for your chart. This page lists the query and values you defined for your category values in the chart template wizard. Figure 159. The category Data tab options.

215 215 Chapter 9 - The xpression Chart Rule To edit your Category data: 1. The Query list contains a list of all of your queries. You can change your current query by selecting a new query from the list. 2. You can change the category values, by selecting iterative or static. Iterative data resides in the same field for all customer records, static data resides in multiple fields in the same customer record. There are different options for an iterative and a static data series. Figure 160. Define your data series and category values. 3. For an iterative data series, define a single field. For a static data series, define as many fields as you need. Click Add to add a static value definition. 4. When you have completed adding your category and data series information, click OK.

216 216 Chapter 9 - The xpression Chart Rule Sharing Rule Queries You can share your queries between Read, Chart, and Table rules. Sharing a Query To share a query: 1. First, supply a unique name for your query in the Query name box. This box is located in your rule creation wizard. Figure 161. The Query Name box in the Table Rule Creation wizard. This box also appears in the wizard for Chart and Read rules. 2. After supply a unique name, complete the steps in the rule creation wizard.

217 217 Chapter 9 - The xpression Chart Rule 3. When your completed rule appears in the xdesign tree pane, expand the rule item to display the query you created. Figure 162. When a query is selected, the document properties pane displays the query logic. 4. Right-click the query and choose Share Query. 5. Notice that the query icon now contains a small hand which indicates the item is shared. Figure 163. Shared items are always indicated by the small hand graphic added to the icon.

218 218 Chapter 9 - The xpression Chart Rule Using a Shared Query When creating a Read, Table, or Chart rule, you can reuse existing shared queries by selecting them from the Shared List. To use a shared query: 1. Click the Shared List button from the rule creation wizard. 2. The Shared Query List dialog box appears. Figure 164. The Shared Query List enables you to select a query or view the properties of a query. The query properties enable you to edit the query settings. 3. Select a query from the list and click OK. All of the query options in the remainder of rule wizard will be filled in with the values from the shared query. Click through the wizard to verify the settings and click Finish.

219 Chapter 10 Shared Content and Shared Rules 10 xpression enables you to share both your content items and your document rules among many documents. You can also share a content item with both CompuSet and Publish documents. The Shared Content feature enables you to use a single copy of a content item in more than one document, or use it several times within a single document. For example, if all your documents contain a logo and address information, you could create one shared content item and use it as needed in your documents. Other uses of shared content include signature pieces and actuarial tables that contain variable replacement fields. Shared content items are autonomous. They exist independently of all categories, and they don t have attributes attached to them until you add them to your document. Shared rules, just like shared content, can be used among many documents. With this feature you can define your rules once and use them many times, or use a shared rule as the basis for another rule. Note: In order to update any rules or content that have been shared, you must have Shared Admin rights in the category you are working with. See your System Administrator to make sure you have the access you need. Sharing a Content Item You can share any of your existing content items. To share a content item: 1. From the xdesign tree pane, select a content item for sharing. 2. Right-click the content item and select Share from the content item shortcut menu.

220 220 Chapter 10 - Shared Content and Shared Rules 3. xpression Design adds a hand graphic to the icon, indicating that the item is now shared. This makes the content available across categories to anyone who wants to use it in a document using the same publishing engine. Figure 165. Shared items are indicated by the hand graphic on the item icon. 4. When you have finished your changes, be sure to Generate XML and create or update the Document Version so that the changes are correctly saved to the xpression database. How Do I Add a Shared Item to My Document? Adding a shared item to a document is even easier than adding a new content item. Insert it at the desired location in your document. To add shared content to a document: 1. Expand the Content rule where you want to place a shared content item. 2. Select the content group that will contain the content item. 3. Open the shortcut menu and click Shared Content List to display a list of the shared items you can use in the active document. Figure 166. Items in a shared content list. 4. From the list, select a shared content item, click OK, and the shared item appears in the Tree view. xpression Design gives inserted shared content items an approval status of Pending.

221 221 Chapter 10 - Shared Content and Shared Rules Unsharing an Item After you use a shared content item in your documents, you can make changes to one particular item in a particular document. However, if you add or delete something from a shared item, xpression Design propagates the change throughout all the documents that use the item. To make a change to one shared item only, you ll need to remove the shared content designation from the content item. To remove sharing: 1. Select the shared content item. 2. Click Remove Sharing from the shortcut menu. You ll be prompted to confirm that you want to remove sharing. 3. Click Yes to remove sharing. When you remove sharing, the version number returns to 0.01 and the sharing hand disappears from the icon. The content item contains all the text from the source and can be modified as needed. The new content item is no longer related to the shared item from which it was created. Viewing Shared Content Item Usage The Shared tab enables you to view a list of all of the documents using a specific shared content item. If you plan to change the content of a shared item, you should know which documents will be affected. Figure 167. This tab is available from the properties of a content item.

222 222 Chapter 10 - Shared Content and Shared Rules To view the list of documents using a specific shared content item: 1. From the xdesign tree pane, right-click the content item and select Properties. 2. Click the Shared tab. 3. The Shared tab lists all documents currently using the shared content item. Updating a Shared Content Item If you have Shared Admin authority in the category, yes you can. And when you update approved shared content, xdesign enables you to select which documents should contain the updates. To update a shared content item: 1. Expand the rule. 2. Right-click the content item and select New Version from the shortcut menu. 3. Create the new version as directed by the wizard, and update the content as required. 4. Save the content item and return to xdesign. You ll see the following dialog box. Figure 168. The New Shared Version page. Use the options on this page to update a shared content item. 5. If you want to update the shared content in other documents select them from the list and click OK. If you don t want to update any other occurrences of the content, effectively creating a second version of the original shared content, select nothing from the list and click OK.

223 223 Chapter 10 - Shared Content and Shared Rules Sharing a Rule If you have Write-level access or higher in a category, you can share any of your existing rules. To share a rule: 1. From the xdesign tree pane, select a rule for sharing. 2. Right-click the rule and select Share Rule from the rule shortcut menu. 3. xpression Design adds a hand graphic to the icon, indicating that the rule is now shared. This makes the rule available across categories to anyone who wants to use it in a document using the same publishing engine. Figure 169. Shared rules are indicated by the hand graphic on the item icon. A shared rule 4. When you have finished your changes, be sure to Generate XML and create or update the Document Version so that the changes are correctly saved to the xpression database. Adding a Shared Rule to a Document Adding a shared rule to a document is even easier than adding a new rule. Insert it at the desired location in your document. If you share a rule, all of the content items in the rule are shared as well unless they contain publisher-specific data. If a content item is publisher-specific and you are using the rule in a different document type, the nonqualified content will not be copied into the new document with the shared rule.

224 224 Chapter 10 - Shared Content and Shared Rules To add a shared rule to a document: 1. Select the rule just above where you want to place the shared rule. 2. Right-click and select Shared Rule List from the shortcut menu to display a list of the shared rules you can use in the active document. Figure 170. The Shared Rule list enables you to select a shared rule or view the properties of a shared rule. 3. From the list, select a shared rule, click OK, and the shared rule appears in the Tree view. xpression Design gives inserted shared rules an approval status of Pending. UnSharing a Rule After you use a shared rule in your documents, you may want to make changes to one particular item in a particular document. However, if you add or delete something from a shared rule, xpression Design propagates the change throughout all the documents that use the item. To make a change to one shared rule only, you ll need to remove the shared designation from the rule. To remove sharing: 1. Right-click the shared rule. 2. Select Remove Sharing from the shortcut menu. You ll be prompted to confirm that you want to remove sharing. 3. Click Yes to remove sharing. When you remove sharing, the version number returns to 0.01 and the sharing hand disappears from the icon. The rule contains all the properties from the source and can be modified as needed. The new rule is no longer related to the shared rule from which it was created.

225 225 Chapter 10 - Shared Content and Shared Rules Viewing Shared Rule Usage The Shared tab enables you to view a list of all of the documents using a specific shared rule. If you plan to change the properties of a shared rule (you ll need at least Write-level authority to do so), you should know which documents will be affected. To see which documents use a shared rule: 1. Right-click the shared rule. 2. Select Properties from the shortcut menu. 3. Click the Shared tab. The document using the rule you selected appear in the Document Name list. Figure 171. The Shared Tab enables you to view which documents are using the shared rule. Updating a Shared Rule If you have Shared Admin authority in the category, yes you can. Additionally, when you update a shared rule, xdesign enables you to select which documents should contain the updated rule. To update a shared rule: 1. Select the rule. 2. Right-click and select Properties from the shortcut menu. 3. Update the rule properties as required and click OK.

226 226 Chapter 10 - Shared Content and Shared Rules 4. If you want to update the shared rule in other documents select them from the list and click OK. If you don t want to update any other occurrences of the rule, effectively creating a second version of the original shared rule, select nothing from the list and click OK. Limitations Related to Shared Rules The following issues apply to shared rules in xdesign: You can t share a Chart rule or a Subdocument rule between an xpublish document and a CompuSet document (Chart rules and Subdocument rules are not supported in CompuSet documents). You can t share any content that includes an xpublish chart or an xpublish image between an xpublish document and a CompuSet document (xpublish charts and images are not supported in CompuSet documents). You can t share Read rules, Table rules, Chart rules, or Variable rules between documents with different data sources.

227 Chapter 11 Document Versions 11 Think of a document version as a snapshot of a document taken at a certain point in time. This process captures a snapshot of the following document properties and files to create an image of the document: Content groups Business rules Criteria Replacements Microsoft Word template HTML to CompuSet Conversion options file Font mapping file Versions are distinguished from each other by their Effective Dates. You must create a document version to make the document available to xpression production services like xpression Batch, xresponse, or an xpression Framework application. These applications use the document version to assemble, customize, and distribute your document. Note: If you rename a document, xdesign automatically renames all existing document versions. Before You Begin Creating a Document Version Before you create a document version, ensure that you first complete the following preliminary tasks: Compile the document by running Generate XML. Conduct test assemblies to determine if the document assembles correctly. Print draft copies of the assembled document to determine if the text is correctly formatted. Submit and approve all content items needed for the assembly.

228 228 Chapter 11 - Document Versions Creating a Document Version The Create Document Version button is available whenever a document is open. If more than one document is open, ensure the document you want to create a version of is active. To create a document version: 1. Click the Create Document Version button, or click Create Document Version on the Document menu. Figure 172. The Document Version dialog box appears. This box enables you to create a new document version or manage existing document versions. 2. Type the Effective Date for this document version. If another version of this document exists, make sure you choose a unique effective date. If you choose an effective date that is already in use for this document, you will receive the error shown here. Figure 173. The effective dates must be unique for your document. 3. Click Create. 4. xdesign creates a document version based on the Effective Date and displays a pop up box. Click OK. Document versions remain intact unless updated with the Update Document Version function. This means that changes made to the original document are not automatically reflected in any existing document versions. You must create a new document version to make your changes available to the production services of xpression.

229 229 Chapter 11 - Document Versions Managing Document Versions You can update or delete existing document versions. To update or delete a document version: 1. Click the Create Document Version button, or click Create Document Version on the Document menu. 2. Click Manage. The Manage Document Versions page appears. This page displays all existing document versions for the open document in xdesign. Figure 174. From this page your can update or delete document versions. 3. Select Retrieve XML to open the Document pane and display the document s XML. 4. From this page you can Delete a Document Version or Update a Document Version. Note: Updating the document version is also disallowed when the document version is already associated with an xresponse or xrevise Work in Progress item. Delete a Document Version To delete a document version, select a version from the Document Version list and click Delete. Deleted items can t be restored.

230 230 Chapter 11 - Document Versions Update a Document Version Changes made to your original document in xpression do not automatically carry over to existing document versions. To individually update document versions, select a version from the Document Version list and click Update. Opening a Document Version xdesign enables you to load the rules from past versioned documents in read-only mode. From the Manage Document Version page, select a date from the Document Versions list and click Open. Figure 175. The Open button enables you to open older versions of your document for viewing.

231 231 Chapter 11 - Document Versions The document will appear in xdesign in read-only mode. Figure 176. The versioned document appears in Read Only mode.

232 Chapter 12 Previewing a Document 12 While designing your document in xdesign on the Design tab, the document is essentially generic because it does not yet contain any customer-specific information. An essential part of preparing a document for production and eventual release to your customers is testing it with the customer data in your data sources. The Preview tab enables you to test your document through batch from your development environment. How Does xdesign Preview Documents? During assembly, xpression uses your selection criteria and the attributes attached to both the document and the content items to select the appropriate content items and fill the variable fields as it creates a personalized document. After assembly, you can test the document assembly against different data sources to make sure, for example, that your XML data formats the same as your RDB data. xdesign also enables you to compare the formatting of your document in Word, HTML, and xpublish or CompuSet viewers. When everything looks good, you can submit the document to your workflow process with the xpression approval system. The approval system supplies the tools necessary to control the review and approval of documents and content items. When all interested parties have signed off on your document, you ve proofed it with different data and looked at it in different viewers and possibly in print, you re ready to migrate it to your production platform for distribution.

233 233 Chapter 12 - Previewing a Document About Generating XML Before you can assemble a document, you need to use the Generate XML utility. Generating XML gathers all the rules, content groups, selection criteria, replacements, and content items and from them creates an XML file that tells xpression Design how to assemble your customer documents. You ll need to generate XML (or regenerate it) if you add, modify, or delete any of the following: Rules Content groups Criteria Replacements Note: If you are use the WebSphere IIS plug-in, and you also process large XML files, your computer may run short of available memory. Make sure the UploadReadAheadSize metabase property in WebSphere IIS is set to accommodate large files. If you make any of these changes and move to the Preview tab without generating XML, xpression Design prompts you to generate XML. Click Yes to generate XML. You don t need to generate XML if you: Change the contents of the data source Edit, add, or remove content items Add or remove attributes from a content item or a document Approve, reject, or withdraw a content item or document Generating XML for a Document To generate XML for a document: 1. On the Document menu, click Generate XML. 2. A status bar marks the progress of document compilation. Click Cancel to stop the process.

234 234 Chapter 12 - Previewing a Document Previewing a Document To preview a document, you must assemble the document for a customer record, then test publish or view the document. Before you begin, ensure you have Generated XML for your document. When you Generate XML, xpression Design creates an XML version of the document and saves it in the xpression database with a unique identification number. To Generate XML, see About Generating XML. Why You Should Test Publish a Document Before you go live with your xpression Batch job, you want to make sure everything is working as you expect it to. Are the correct documents being produced? Is variable data being reconciled correctly? There are many different items that compose your batch job, and it is important that all of them are working correctly to ensure that your final batch output is what you require it to be. It s important that you test your job using BatchRunner before going into production in a Batch environment. Testing in xdesign only tests transactional production, on a document-by-document basis, it doesn t test whether or not the job is going to run correctly on a larger scale. When Should I Test in Batch? After you ve designed your xpression document, all your content is ready to go, and you have a good, representative group of data, it s time to run a batch test. You should test before the approval process is completed by running your batch job with a status of ANY, so that you can test your output. After you are done testing, you can either go through the approval process and then migrate your data to your production environment, or you can migrate first, and then complete the approval process. How Do I Prepare to Test in Batch? The data you use in your test should include all the test variations that you designed into your document. It should exercise all the different rules, content selection criteria, and content item selections that can be a part of your document. Your test should also check any output profile functionality you have in your job. For example, does your output profile specify any particular inclusion conditions, partitioning, sort orders, recipient processing, or bar codes? You ll want to make sure your test data will produce documents that include these features. If your output has several assembly scenarios, you ll want to ensure that your test data contains records that will test each scenario. You ll want to ensure that your test data validates any of the following that are applicable to your jobs: Variable replacements Rule replacements Keep together requirements for text Merged paragraphs

235 235 Chapter 12 - Previewing a Document Optional paragraph selections Document assembly requirements PDF output and corresponding index files (for archiving systems) Tray pulls (metacode output only) Multiple imposition options (metacode output only) Number of copies specifications (metacode output only) Data extraction Trigger and customer file population and cleanup Error log interrogation and audit report ( ) notification Bar code generation and placement Include file information Assembling a Document To assemble a document: 1. Ensure the document you want to preview is open. 2. Click the Preview tab at the bottom left of the xpression Design window. If you have not Generated XML for the document, xpression will automatically Generate XML when you click the Preview tab. The preview and assembly page appears. Figure 177. The tree pane contains rows defined in the primary data source for the category this document resides in.

236 236 Chapter 12 - Previewing a Document 3. You can switch between data sources by selecting Data Sources from the Document menu. The rows from the new data source will appear in the customer data tree. Figure 178. The primary data source is indicated by a check mark in the menu. 4. Select a record and its properties appear in the Customer Detail pane on the right. 5. Right-click the customer record you want to assemble and select Assemble. Alternatively, you can select the record you want to assemble and choose Assemble from the Document menu or double-click the record. Also, if you multi-select more than one record, you can assemble multiple records at one time. 6. xpression processes the customer record and displays the results. Figure 179. When assembly is complete, the content items that qualified appear in the customer record list. Customer Record Qualified Content Items If your document uses Label and GoTo rules, xpression may display the section hierarchy differently than what appears on the Design tab. This happens when the GoTo rule causes a jump out of the current section, or into another section. xpression assembles the document correctly in this case, but the section hierarchy on the Preview tab may be confusing. The best practice is to avoid this situation altogether. That is, either place both the GoTo and Label rules in the same section, or place them both outside the section. 7. The next steps is to publish or view your assembly and preview your document. To see a demonstration of this feature, click here.

237 237 Chapter 12 - Previewing a Document Publishing Your Assembly xdesign enables you to test how your documents will be processed by the xpression output management system with the xdesign Publish utility. To test publish a document: 1. Assemble one or more documents as described in Assembling a Document. 2. From the Tools menu, click Options. 3. Click the Output Profile tab. Document Sciences supplies a set of generic output profiles for each publisher with xdesign. Figure 180. The Output Profile tab contains a list of xpublish and CompuSet output profiles. 4. Select an output profile. An output profile is needed to test publish an assembly. The output profile tells xpression how to create your output. For example, to test your output in PDF format, select PDF To File and click OK. This output profile instructs xpression to create Portable Document Format (PDF) files and send them to the location specified in the distribution definition portion of the output profile. 5. In the Preview tab tree pane, select the assembly you want to publish. To publish the assembly, right-click the assembly and select Publish. Alternatively, you can select Publish Document from the Tools menu. 6. xpression will publish the document to the output folder designated in your distribution definition. Locate your output folder and view the newly created output file. Note: If someone creates or modifies an output profile while you re logged on to xdesign, log out then log back in to display an updated list of output profiles. Make sure to update your document by generating XML so that the output profile changes are applied.

238 238 Chapter 12 - Previewing a Document Viewing Your Assembly To get an idea of how your documents will look in different formats, xpression Design enables you to proof the content of an assembled document in four different embedded viewers: HTML, Word, xpublish, and CompuSet. If you are viewing an xpublish document, you can choose HTML, Word, and xpublish. The xpublish viewer uses Adobe Acrobat Reader to display the selected document in PDF form. If you are viewing a CompuSet document, you can choose from the HTML, Word, or CompuSet viewers. To view an assembled document: 1. Select one or more customer records, assembled documents, or content items in the customer data tree. Hold the CTRL key to choose nonadjacent items. 2. From the View menu, choose the viewer you want to use and the documents appear in the viewer embedded in the customer row detail pane. When you select a View format, xpression displays the document in the customer data pane in the selected format. Word s Web Layout view is the default view. Figure 181. You can use the Word viewer to check the placement of headers and footers that wouldn t appear in the HTML view. This image shows an assembled document in the Word viewer. Web Layout View 3. If you switch viewers, click View Document on the toolbar to reset the viewer.

239 239 Chapter 12 - Previewing a Document Find a Record in the Customer Record List Because you may have hundreds, or even thousands, of customer records appearing in the customer list, you can use the key fields in your customer data to locate a specific record, or set of records. To find a record: 1. Click Find on the toolbar, or on the Edit menu, click Find, then Customer Record. Figure 182. The Find Customer dialog box. 2. The names of the key fields in your customer data (the example in Figure 182 shows only one) appear next to a text box for a field value. Type the search key value and click Find. 3. The first record with a key matching the search key in the current customer list appears at the top of the customer record list. Select Refresh from the View menu, or press F5, to restore the complete customer record list.

240 Chapter 13 The xpression Approval System 13 The xpression approval system supplies the tools necessary to control the review and approval of documents and content items. Users (depending on their authority) can approve, reject, or withdraw documents and content items from use. Users can access the approval system through xdesign, or through xresponse, a thin client application that enables you to access the approval system remotely. xpression documents do not have to make use of the Approval system or xresponse. Both features are optional. You may skip this section if your documents don t use the xpression Approval system. How Approval Works The approval system enables authorized users to move a document or content item through different document approval states from submitted to approved. The purpose of the approval system is to provide an easy way to review documents for accuracy and style before they are made available to xpression s publishing services. Here s how the approval system works: 1. When you have completed designing your xpression document or content item, you can Submit it to the Approval system. 2. Your designated Reviewer, defined by your system administrator in xadmin, receives an to let them know that an item in the Approval system requires their attention. 3. They access their approval workspace from xdesign by clicking Approve on the Tools menu. This workspace contains all of their pending reviews. 4. They can approve the document which makes it ready for assembly or reject it and send it back to the document designer for rework.

241 241 Chapter 13 - The xpression Approval System About Approval Definitions Your system administrator defines approval definitions and attaches them to a category from xadmin. Every workflow contains two default approval levels: Submitted and Approved. These levels are protected and cannot be modified, deleted, or moved. xdesign adds one more level, Pending, which is where all unapproved and unsubmitted content begins its approval process. Approved is always the highest level, while Pending is always the lowest level. Your system administrator can add custom document approval states between these mandatory states (for example, Legal) that correspond to the appropriate approval states for your document flow. For more information about adding custom approval states, see the xadmin Enterprise Edition User Guide. Before a document is submitted to the approval process, it is marked as Pending. State Pending Submitted Approved Description Items not yet in the approval system. An item in the approval system waiting for approval. The item is approved, and is ready for assembly. Approved content cannot be modified, except for Annotations. Submitting a Document or Content Item A document or content item enters the approval workflow when a user submits the item for approval. To submit a document or content item: 1. Open a document. 2. From the xdesign Design tab, select the document or content item in the tree pane.

242 242 Chapter 13 - The xpression Approval System 3. Click Submit All button (if you ve selected the document) or Submit Content button (if you ve selected a content item) on the toolbar. Alternatively, you can right-click an item and select Submit or Submit All from the shortcut menu. Select Submit from the Tools menu. Figure 183. Notice that new content items have a version number of 0.01, and new versions of approved content items are given a version number of x.01. If you select the new content item, the Design Information pane shows the content item status as PENDING. A pending status refers to a document or content item that has not been submitted.

243 243 Chapter 13 - The xpression Approval System 4. The submitted items status changes to SUBMITTED. Figure 184. The status in the Information pane changes to SUBMITTED.

244 244 Chapter 13 - The xpression Approval System The Approval List Options For users who are authorized to be approvers, the approval system can be accessed through xdesign any time you want to see if there are any items waiting for your approval. All documents and content items awaiting your review appear in the Approval list box. Figure 185. Each category contains documents, which contain content items and attribute elements. Categories Documents Content item Attribute elements The Approval list box contains the following functions. Element Approve Reject Withdraw Description Only available if one or more items are selected from the list. This action moves selected categories, documents, or content items to the next status in the workflow. If the next status is Approved, the Effective Date and Comment screen appears. See Approving a Document or Content Item for more information. Only available if one or more items are selected from the list. This action moves selected categories, documents, or content items all the way back to the starting status of Pending and removes them from the approval system. Only available if one or more items are selected from the list, this action displays the Withdrawn Date and Comment screen.

245 245 Chapter 13 - The xpression Approval System Element By Attributes Description Available when Approve, Reject, and Withdraw are available. When selected and Approve, Reject, or Withdraw is clicked the Select Attributes dialog box opens. This permits you to perform the action on documents based on a chosen set of attributes in addition to Effective or Withdrawn Date. You will not be able to select this option if any of the following conditions exist: An attribute element, rather than a content item, is selected on the Approval dialog box. You have selected items from different categories The attribute set for the category does not contain at least one selection attribute. An error message will display if you select By Attributes and any of these conditions exist. View Note Print Close Update Note Remove Note Select the name of a content item and click View to see a read-only version of a portion of the document that s been submitted for approval. Only available if one item is selected from the list, this action enables the user to type a notation for the selected item. Prints the contents of the user s workspace. A workspace includes all items from all categories that the user is authorized to view. This action closes the approval workspace screen. Only available in a selected item s shortcut menu, this action enables a user to update a notation. Only available in a selected item s shortcut menu, this action enables a user to delete a notation. Approving a Document or Content Item To approve a document or content item: 1. To view your xpression approval work space, click Approve on the Tools menu. 2. The main approval screen displays a list of categories. The approval system only displays content items and attribute elements that the user is authorized to approve or reject. Note: Shared content that is used more than once in the same document, or content that is used in different document versions, is only listed once. All attributes for the content are sorted and displayed, and any attribute duplicates are only listed once. Approving, rejecting, or withdrawing will apply to all usages of the item within the document. 3. Select the item or items you want to approve and click Approve. This action moves selected categories, documents, or content items to the next status in the workflow.

246 246 Chapter 13 - The xpression Approval System 4. If you selected the By Attribute option, the Select Attributes pop-up box appears. Figure 186. This dialog box appears if By Attribute is selected when you click Approve, Reject, or Withdraw. The Select Attributes pop-up box enables you to select a combination of attributes to determine which documents should be subject to the selected action. In this example Gender and Jurisdictions are available, but the actual choices available to you is based on the attribute set for the category. Select the attributes that you want to use to determine which items are subject to the action. The available attributes are determined by the attribute set for the category and click OK.

247 247 Chapter 13 - The xpression Approval System 5. If the next status in the workflow is Approved, the Effective Date and Comment dialog box appears. This box enables you to define an effective date for the listed attribute. You can manually type an effective date in the Effective Date box, or select one from the calender function. Figure 187. This dialog box opens when you click Approve on the on the Approval dialog box, or when you click OK on the Select Attributes dialog box. After selecting an effective date, choose one of the following actions. Action Back Next OK for All Definition Returns you to the previous attribute value (only available if more than one is selected). Displays the next attribute value (only available if more than one is selected). The effective date you selected and notation you entered will apply to all selected attribute values (only available if more than one is selected). When you click this button, the Effective Date currently indicated will be applied to all of the items being submitted for approval, overwriting any Effective Dates provided for any individual items. This is unlike DLS, which would retain the Effective Date that you provided for each item. OK Cancel Sets the defined effective date and comment for the current attribute value. To set the effective date and comment for the remaining attribute values, use Back and Next. Cancels the approval process.

248 248 Chapter 13 - The xpression Approval System Rejecting a Document or Content Item To reject a document or content item: 1. To view your xpression approval work space, click Approve on the Tools menu. 2. The main approval screen displays a list of categories. The approval system only displays content items and attribute elements that the user is authorized to approve or reject. Note: Shared content that is used more than once in the same document, or content that is used in different document versions, is only listed once. All attributes for the content are sorted and displayed, and any attribute duplicates are only listed once. Approving, rejecting, or withdrawing will apply to all usages of the item within the document. 3. Select the item or items you want to reject and click Reject. This action moves selected categories, documents, or content items all the way back to the starting status of Pending and removes them from the approval system. 4. A pop-up box will appear to confirm that you want to reject the item. 5. If you selected the By Attribute option, the Select Attributes pop-up box appears. Figure 188. This dialog box appears if By Attribute is selected when you click Approve, Reject, or Withdraw.

249 249 Chapter 13 - The xpression Approval System The Select Attributes pop-up box enables you to select a combination of attributes to determine which documents should be subject to the selected action. In this example Gender and Jurisdictions are available, but the actual choices available to you is based on the attribute set for the category. Select the attributes that you want to use to determine which items are subject to the action. The available attributes are determined by the attribute set for the category and click OK. Withdrawing a Document or Content Item To withdraw a document or content item: 1. To view your xpression approval work space, click Approve on the Tools menu. 2. The main approval screen displays a list of categories. The approval system only displays content items and attribute elements that the user is authorized to approve or reject. Note: Shared content that is used more than once in the same document, or content that is used in different document versions, is only listed once. All attributes for the content are sorted and displayed, and any attribute duplicates are only listed once. Approving, rejecting, or withdrawing will apply to all usages of the item within the document.

250 250 Chapter 13 - The xpression Approval System 3. Select the item or items you want to withdraw and click Withdraw. If you selected the By Attribute option, the Select Attributes pop-up box appears. Figure 189. This dialog box appears if By Attribute is selected when you click Approve, Reject, or Withdraw. The Select Attributes pop-up box enables you to select a combination of attributes to determine which documents should be subject to the selected action. In this example Gender and Jurisdictions are available, but the actual choices available to you is based on the attribute set for the category. Select the attributes that you want to use to determine which items are subject to the action. The available attributes are determined by the attribute set for the category and click OK.

251 251 Chapter 13 - The xpression Approval System 4. The Withdraw dialog box appears. This box enables you to define a withdrawn date for the listed attribute. Figure 190. This dialog box opens when you click Approve on the on the Approval dialog box, or when you click OK on the Select Attributes dialog box. Your document or content item will become unavailable to xpression for assembly AFTER the withdrawn date. An item is available to the document assembly system only during the interval of time starting the day after the item is approved, up to (and including) the date the item is withdrawn. You can manually type the withdrawn date in the Withdrawn Date text box, or select one from the calender function. 5. After selecting a withdrawn date, choose one of the following actions. Element Back Next OK for All OK Cancel Description Returns you to the previous attribute value (only available if more than one is selected). Displays the next attribute value (only available if more than one is selected). The withdrawn date you selected and notation you entered will apply to all attribute values (only available if more than one is selected). Sets the defined withdrawn date and comment for the current attribute value. To set the withdrawn date and comment for the remaining attribute values, use Back and Next. Cancels the withdrawal process.

252 Chapter 14 Special Features 14 This chapter contains information about optional paragraphs, attribute overrides, recipient processing, converting CompuSet documents to xpublish, and printing the details of your document. About Optional Paragraphs When designing your document, you may want to add an addition level of flexibility to your output. Optional paragraphs enable users of xdesign to create paragraphs of text that can be selected for inclusion at assembly time by an xresponse, xpression Framework correspondence application user, or by xpression Batch. xresponse and Framework users are presented with a list of optional paragraphs they can add to a document for an individual customer. You can also configure optional paragraphs for unattended batch processing. How Do Optional Paragraphs Work? xdesign, xresponse, xrevise, xpression Framework, and xpression Batch use optional paragraphs differently, as described in the following table. xdesign enables you to create optional paragraphs and optional paragraph groups. When you assemble a document in xdesign, each optional paragraph is displayed so the document designer can review and modify as necessary. xresponse and xrevise with the OCX editor Presents user with a document assembled for an individual customer and a list of optional paragraphs available for that document. Users can select paragraphs to add to the assembled document. See the xresponse User Guide and the xrevise Reference Guide. xrevise with the.net editor If the RU property in revise.properties is false, optional paragraphs are handled in much the same way as with the OCX editor, except that they are selected by a checkbox in the Table of Contents. If RU is true, optional

253 253 Chapter 14 - Special Features paragraphs must occupy different Revision Units. Optional paragraphs in the same Revision Unit will be merged. Multiple Select optional paragraphs are treated in the same manner as Single Select optional paragraphs. xpression Framework Provides users with the methods to retrieve a list of optional paragraphs, retrieve optional paragraph text, set a user's optional paragraph selection, and preview the updated document. For more information, see the xpression Framework Reference. xpression Batch Skips any optional paragraphs that the template designer has not marked as included in xpression Batch. Optional paragraphs that are marked for inclusion with batch are automatically added to the assembled document. Optional Paragraph Groups All optional paragraphs reside in optional paragraph groups. When xresponse or xpression Framework displays the list of available optional paragraphs, they are displaying all the items in an optional paragraph group. A group can contain one or many content items, and must be one of the following group selection types: Single Select: Users can select only one content item from the group. Multiple Select: Users can select multiple content items from the group. Populate individual optional paragraph groups with optional paragraphs that apply to specific situations. For example, a single select optional paragraph group might contain different versions of a closing paragraph for a past due reminder. A multiple select optional paragraph might contain marketing messages promoting different products. Note: When you migrate a document that contains optional paragraph groups, keep in mind that optional paragraph group names must be unique. If the target server already has an optional group with the same name as the imported the imported document, the name of the imported optional paragraph group will be given a counter. For example, OptionalGroup will be renamed OptionalGroup_1.

254 254 Chapter 14 - Special Features Creating an Optional Paragraph in a New Rule To create an optional paragraph in a new rule: 1. Create a new Content rule with the Rule creation wizard. 2. Name the rule and specify a section level if necessary, and click Next. Figure 191. This page contains options for your rule. You can select Not required, Rule required for assembly, or Optional content for on-demand use. 3. For xpression to treat the content of a rule as optional, you must mark it as such. If the content qualifies for assembly, xresponse, xrevise, and xpression Framework users can then choose to add the optional paragraph before distributing the document.

255 255 Chapter 14 - Special Features 4. To specify the rule as optional, select Optional Content for On-Demand Use. Additional optional paragraph configuration choices appear. Figure 192. The optional paragraph group options appear after you mark the content as optional. The optional paragraph group options window displays the following options. Element Default for supporting applications Please Select an Optional Paragraph Group Edit Group New Group Description When selected the optional paragraph will be offered as the default for supporting applications such as xrevise where a default option can be changed, and will be included in xbatch and WebServices where there is no option to change the default. The list of available, existing Optional Paragraph Groups. Enables editing of the properties of the selected Optional Paragraph Group. See Editing Optional Paragraph Group Properties. Creates a new Optional Paragraph Group. 5. If you want to make the optional content available to the batch process, ensure you select Default for supporting applications. 6. Select a optional paragraph group or create a new optional paragraph group. See Creating an Optional Paragraph Group for more information. 7. Click Next when finished.

256 256 Chapter 14 - Special Features 8. After you define an optional paragraph group, the rule icon changes to signify that it is enabled for optional paragraphs. Figure 193. The optional paragraphs information in the right pane shows the name of the selected optional paragraph group, its group selection status (Single or Multiple select), and whether you chose to include the group in xpression Batch processing. Creating an Optional Paragraph in an Existing Rule To create optional paragraphs within an existing rule: 1. Select the rule you want to redefine as optional. 2. Access the rule properties by right-clicking the rule and selecting Properties or by clicking Properties on the Rule menu. 3. Click the Options tab to display the same optional paragraph options shown in Figure Configure your options and click Apply.

257 257 Chapter 14 - Special Features Creating an Optional Paragraph Group To create a new optional paragraph group: 1. The optional paragraph group options are accessible from your rule properties or from the rule creation wizard. Figure 194. The Edit Group and New Group buttons enable you to edit or create an optional paragraph group. 2. From the optional paragraph options, click New Group. 3. Type a name for your group in the Group Name field. Your group name can contain up to 100 alphanumeric characters. Symbols and special characters are also supported. Figure 195. Option al paragraph group names that appear in the Group Name list exist by database connection, not by document. This enables you to copy entire optional paragraph groups between documents.

258 258 Chapter 14 - Special Features 4. Choose a group selection option, either Single select or Multiple select. 5. Click Save. Your new Optional Paragraph Group now appears in the Group Name field. Editing Optional Paragraph Group Properties You can change optional paragraph group names or selection types while you create groups or afterwards. To access a group and change its name and selection type: 1. Select the Optional Paragraph rule you want to change. 2. Click Properties on the rule s shortcut menu, or click Properties on the Rule menu. 3. When the Rule Information window appears, click the Options tab. This tab contains the same options available when Creating an Optional Paragraph Group. 4. From the paragraph group list, select the group you want to change from the list and click Edit Group. 5. The group you selected now appears in the Group Name field. Type the new group name in the Rename Group field. 6. Verify your group selection type and change it if necessary. Click Save. 7. A message box pops up. Click OK. Figure 196. A message displays that explains when your name change goes into effect. 8. Click OK. 9. Click Close. This returns you to the Options tab in Rule Properties. 10. Click Apply and Close to save your changes and exit. Copying and Pasting Optional Paragraph Groups You can copy and paste optional paragraph groups within the same document, or from one document to another. In either situation, you can use standard Windows keyboard conventions (CTRL+C and CTRL+V), the Copy and Paste commands on the Edit menu, or you can drag and drop.

259 259 Chapter 14 - Special Features Keep Groups in Order Ensure that you paste groups in contiguous order with other existing groups that have the same optional group name. If you paste groups out of sequence, xdesign returns an error. For example, suppose your document has two rules called Body and Body2. Each rule contains a different content item, and each content item references an optional paragraph group, called Body Options, as shown below. Figure 197. A sample document with optional rules. xdesign generates an error if: You attempt to insert a rule that is not optional between the Body and Body2 rules. The rule you want to insert is optional, but the rule has an optional paragraph group name other than Body Options. Copying Optional Paragraph Groups with the Same Name If the groups that precede and follow a pasted group are optional, and if one or the other of those groups shares the same name as the pasted group, xdesign sets the optional paragraph group name of the pasted rule to match that of the group that precedes it in the new location. xdesign adds Copy (x) to the group name and displays the following message: Optional group name has changed during paste process. For example, suppose you want to copy an optional paragraph section called Body Text and paste it between two optional paragraph sections, called Heading and Closing within your document. If you leave the pasted group name as Body Text and paste it underneath Heading, xdesign renames it Copy (1) Body Text.

260 260 Chapter 14 - Special Features Overriding Attributes You may occasionally encounter situations when you would like to temporarily override your flexible attribute mappings for a single rule. The assembly data override feature enables you to individually replace your flexible attribute mappings with data from other tables in your customer data source or hard-coded values. This section contains the following topics: How Does an Overriding Attribute Work? The attributes you select for a document determine how the document is assembled. Each attribute is mapped to an actual column in your customer data source. The Assembly Data Override feature enables you to select a different column from any previously read customer data source table, and use it as the content group search value. Once the content group has been processed, the original values for the flexible attribute columns are restored. Note: This feature can be applied only to Table and Content rules, which are the only rules that contain content items. Example Your company insures a couple who owns a home in Wisconsin, and vacation property in California. They now want to add an earthquake rider to the California property (the jurisdiction on the rider is CA, but the jurisdiction for the customer in your data source is WI). To assemble the correct document for the vacation home, you need to replace the Wisconsin jurisdiction with California. To do this, override the Jurisdiction attribute in your Primary customer data source table with a column from your secondary customer table. Figure 198. A Primary and Secondary Table. The secondary customer table describing the vacation home has a column (Property State) containing the jurisdictional value of the property. The Attribute Override function enables you to override the Jurisdiction column from your main customer data source with any column from the secondary customer table. Note: To add an Attribute Override, your customer data source must contain more than one table.

261 261 Chapter 14 - Special Features Creating an Attribute Override To add an Attribute Override: 1. Select the appropriate Content or Table rule. 2. Click Properties on the Rule menu, or click Properties on the rule s shortcut menu. 3. When the Rule Properties window appears, click the Assembly Data tab. Figure 199. The Assembly Data tab lists every mapped attribute defined in xadmin for this category. Previously defined attribute overrides appear with a check in the first column. 4. Give your override a descriptive name. If you don t type a name, xdesign assigns a default name of Assembly Override. 5. If you ve created and shared an override in the past, click Shared List to apply it to the current rule.

262 262 Chapter 14 - Special Features 6. For any listed attribute you want to override, select a table from the Table list. Figure 200. This figure shows how to select a table from the list. 7. When you select a table, all the columns that exist in that table become available in the column list. Select the column you want to use as the override from the column. Figure 201. The selections in the column list are limited to columns of the same data type as the column you are overriding.

263 263 Chapter 14 - Special Features Alternatively, you can override the attribute with a hard-coded value. You can t define both a column and a Value. To use a hard-coded value, type the value in the Value field. Figure 202. You can type a hardcoded value in the Value field. 8. To continue, click one of the following buttons: OK to apply the changes and exit the Rule Properties dialog box. Apply to apply the changes and leave the Rule Properties dialog box open. Reset to remove all previously defined overrides and return to the original mappings defined in xadmin. Cancel to cancel any changes and exit the Rule Properties dialog box. Note: You can identify rules containing overrides by looking under Assembly Data Overrides in the information view pane on the xdesign tab.

264 264 Chapter 14 - Special Features Recipient Processing Section rules enable you to designate sections of your document for inclusion in document instances for specific recipients. For example, if you are creating an insurance policy document, you may need to create different packages to go to the client, the agent, and to the home office. xpression enables you to easily create these three distinct packages from a single document. Caution: The maximum number of recipients allowed for a CompuSet job is 32. To configure recipient processing with xpression: 1. Define your recipients. For this example, you would create a Client recipient, an Agent recipient, and a HomeOffice recipient. 2. Define page sequences with a Section rule. In xpression, you can enable any section in your document as a page sequence and attach recipients to the page sequence. 3. Create output streams for each recipient. You define output streams in xadmin. Output streams are referenced in an output profile which you define while setting up your output configuration. Differences Between CompuSet and xpublish Recipients To set up recipient processing for CompuSet, you must set up page sequences in your recipient enabled section rules. Recipients will not be honored unless they are identified by page sequences. Please see Create Recipient- Enabled Section Rule for more information. xpublish automatically defines the content in your recipient enabled section rule as a page sequence, so you do not have to set up individual page sequences for each section. However, you can override this automatic designation by simply setting up page sequences in your content item.

265 265 Chapter 14 - Special Features Defining Recipients To enable recipient processing on both CompuSet and xpublish documents: 1. Open the document and click Properties on the Document menu. 2. Click the Recipients tab. Figure 203. The Recipients tab enables you to configure recipient processing for your document. 3. Type the name of the recipient in the Add to Server text box (you ll need to know these names ahead of time) and click Define. Repeat as necessary. 4. To associate one of the recipients with the current document, select the recipient in the Available Recipients list and click Add.

266 266 Chapter 14 - Special Features 5. Click the Output Profile tab. Figure 204. The Output Profile tab contains a list of all available output profiles. 6. Select the check box next to each of the output profiles you want to use and click OK. Create Recipient-Enabled Section Rule To define portions of your document for recipients, complete the following steps: 1. Add a Section rule as described in How Do I Create a Section Rule?. 2. After you type the name of the Section rule, select Specify Recipient(s). 3. The recipients available to this document appear in the list box. Select the appropriate recipients and click Next to proceed with rule creation. Create CompuSet Page Sequences CompuSet requires that you define page sequences to identify which sections of your document you want to designate for inclusion by recipient. xpublish does this step automatically. If you are creating an xpublish document, proceed to Create xpublish Page Sequences. You must create at least one content item under each recipient processing-enabled Section rule. When xpression assembles a document that contains a recipient processing-enabled Section rule, the content item that immediately follows the Section rule must begin with a Microsoft Word Odd page section break. The combination of a recipient processing-enabled Section rule and a Word Odd page section break marks the beginning of a new page sequence.

267 267 Chapter 14 - Special Features The page-level formatting you apply to the section following a Word page-breaking section break (Next page, Even page, or Odd page) determines the page-level formatting produced by xpression when you publish through CompuSet. Page-level formatting includes settings such as paper size and orientation, page margins and gutter width, as well as header and footer content and position. Your page-level formatting continues for the rest of the document, or to the next page-breaking section break, whichever comes first. You may want to define one or more special content items that contain only an Odd page section break, and the page-level formatting for that section (including headers and footers). Typically, you won t modify these page-level formatting content items when you modify document content. Separating the page-level formatting content items from the rest of the content items may make your document more manageable in the long run. To prevent unwanted blank pages from appearing at the beginning of your xpression-generated CompuSet documents, you must use a CompuSet conversion option, Omit document-initial NS/NP commands, to disable the automatic insertion of NP commands. See your system administrator to have this option enabled for the category in which the document resides. Note: If you are a previous DLS Output Processing user, you ll remember that to enable Output Processing for your product, you had to add a Section rule as the first rule in your product, and enable it as a page sequence. In xpression, you can enable any section in your document as a page sequence. Create xpublish Page Sequences xpression Publish automatically sets up one page sequence for the entire content item in any recipient-enabled section rule. If you want to define a smaller page sequence that would encompass only a subsection of the content item, simply define a page sequence by adding a Next Page Section Break at the location where you want to begin the page sequence. Create Output Streams Output streams enable you to sort recipients within a stream, include or exclude recipients based on conditions, and configure finishing information like bar codes. Output streams are then referenced in an output profile (the same profiles you made available to the document) where they are joined with a format definition or output definition (which specifies a particular output format type, such as PostScript) and a distribution definition (to distribute the document to the correct output device). For more information, see the xadmin Enterprise Edition User Guide. Note: If you make any changes in xadmin to your output profiles, or any of the components contained within them, or you decide to add recipient processing functionality to your documents at a later time, you must regenerate the XML for your xpression document in xdesign before any of the changes will be applied to the output documents.

268 268 Chapter 14 - Special Features Converting an xpression CompuSet Document to xpublish It s very important that you decide which publisher to use during the design phase, and then select the correct publisher when you first create the document. If you create a CompuSet document and then want to change it to xpublish, or you have a document created in a pre-2.0 version of xpression, you can convert to it xpublish. However, you can t convert an xpublish document to a CompuSet document. Because the feature sets of the two publishers are different, and not necessarily compatible, make sure xpublish offers all the features and formatting options your document requires before you convert. For example, xpublish doesn t support IBM OnDemand AFP Indexing. If your CompuSet document needs to use this archive format, it would be unwise to convert it to xpublish. For a list of other currently unsupported features, please see your xpression Release Notes. Caution: Once you convert a document to xpublish, you can t convert it back to CompuSet. What Happens During a Conversion? When you convert a CompuSet document to xpublish, xpression: Converts all the images in the document text to xpublish format. Uploads any fonts used in the document. Ignores any CompuSet commands (they will appear in the converted document as printable characters). Marks all the content as xpublish content. Converting a CompuSet Document to xpublish To convert a CompuSet document: 1. Open the CompuSet document in xdesign. 2. On the Document menu, click Convert to xpublish Document. If the document contains subdocuments, xpression displays a message asking if you would like to convert all the subdocuments as well. If your document contains no subdocument, skip to Step Click Yes to include all the subdocuments in the conversion, or click No to omit all the subdocuments from the conversion and from the new (converted) document. 4. The conversion process may take a while to complete, click OK to start the process. After you have converted the document, review the output to ensure that it appears as you expected. Be on the lookout for any CompuSet commands that may have been used in the original document, as they will appear within the text of the converted document as printable characters.

269 269 Chapter 14 - Special Features Printing Document Details xdesign enables you to create a printable outline of your document, illustrating your structure, rules, criteria, and content items. There are several potential uses for this sort of document. For example, the document can be used as a simple snapshot of the document at a given moment, or you can use a print of an approved and completed document as a blueprint for future document development. Because the content of each content item is included in the document, you could also use it as a tool that enables those without xpression to view a document, or even send it to an external xdesign user. xdesign provides several options to print information about an active document. Printing the Document Summary Printing the Current Rule Printing the Document Structure Printing the Document Summary The document summary option gives you a high-level overview of the components of a selected document. Figure 205. This option provides a document summary and a list of rules in your document.

270 270 Chapter 14 - Special Features Printing the Current Rule The Current Rule option is available only if you have a specific rule selected. Figure 206. This option provides details about the contents, attributes, and properties of a specific rule. Printing the Document Structure Occasionally you may need to document the layout and design of your xdesign documents. The Document Structure print function records the information gathered by the Document Summary and Current Rule options, supplements it with the text and graphics from each content item, converts the attribute lists into tables, and

271 271 Chapter 14 - Special Features generates a Microsoft Word document (complete with a table of contents) to be saved in the location of your choosing. Figure 207. The table of contents structure is based on the Section levels defined in the document. You can jump from any item in the table of contents to the location of that item by holding CTRL and clicking the page number. Page-breaking section breaks separate each item in the document. xpression inserts Word TC fields with P type identifiers before the document name and all the rule names. A TOC field at the top of the first page gathers the TC field and creates the table of contents. The TC field that marks the document name is assigned table of contents level 1. TC fields marking rules with section levels of zero use

272 272 Chapter 14 - Special Features level 2, rules with level 1 section levels use level 3, and so on. However, Word supports tables of content with up to nine levels. If you have any rules with section levels greater than seven, they will stay at table of contents level 9. Figure 208. An image of a document with field codes exposed. The TOC field marks where the table of contents is inserted. Both TOC and TC fields are formatted as hidden text. To view hidden text, click the Show/Hide button on the Standard Word toolbar. Document name marked with TC field. Note the P identifier and section level of 1. This rule has a section level of zero, so it s assigned a table of contents section level of 2. Please note that if your document contains subdocuments, the subdocument location will be noted in the output, but the content won t be included. Also, footers containing page numbering and document and rule name information are added to the output document. However, the footer won t be added if the content item has its own headers and footers defined.

273 273 Chapter 14 - Special Features Print Document Details To print the details of a document: 1. Select Print from the File menu and the Select Print Information dialog box appears. Figure 209. This box enables you to select your print options. 2. If you want to send this information directly your default Windows printer, select Print to Printer. If you d like a more permanent record, select Print to File to create a Microsoft Word compatible file. Use the browse button to specify a storage location, and xpression will create a Word document with your document information. 3. Select the type of document you want to create. Select Document Summary, Current Rule, or Document Structure. 4. After choosing your document type, select the elements you would like to include in the document: Elements Rule Elements Content Groups Content Items With Attributes With Contents Description Includes Rule Elements. Not available with Current Rule option. Includes Content Groups. Not available with Current Rule option. Includes Content Items. Not available with Current Rule option. Includes Attributes. Available only when Content Items is selected. Includes Contents. Available only when Content Items is selected.

274 274 Chapter 14 - Special Features Elements With Content Item Annotations With Attribute Annotations Use Icons Description Includes Content Annotations. Available only when Content Items is selected. Includes Attribute Annotations. Available only when Content Items is selected. In very large documents, the number of icons can be so large that Microsoft Word is unable to handle them. This option was added to enable you to remove the icons from the structure document, enabling Microsoft Word to save and print your document structure. When printing the document structure, xdesign first creates a number of.htm files, then uses the Word automation object to open the.htm file, add table of contents, add footers, and make referenced icons become resident. If xdesign fails to create a Word document when using Word automation, xdesign will leave the.htm files so that users can review the.htm version using a Web browser. However, the.htm version will not have TOC or footers, and all the image icons will be set by references instead of resident. The.htm files will be named after the specified Word document. If printing to printer, the.htm file is placed in xpression Design temp folder with name, "xdesignprint.htm".

275 Chapter 15 Search Utility 15 The xpression Design search utility enables you to search products for both content item and rule information. The utility supports free-form text searches using standard single word search, phrase search, and Boolean logic techniques. Some important things to know about using xpression s full text search feature: In order for the search function to work in xdesign, your xpression database database must be set up to be searchable. For more information, see your installation documentation. You can use the search utility only to search the xpression database, and you can t use it to perform findand-replace functions. The categories you can search may be limited by your user access privileges. There are some database-imposed limitations to xpression s full text search capability. For example, in a DB2 database, you can t include the underscore (_) character in your search phrase. SQL Server databases use an editable file called noise.xxx (where xxx is a three letter language extension) to specify words that are to be ignored by the full text search functionality. For more information, see your database documentation. About Single Word Searches Single-word search statements are the simplest of all search statement constructions. A search statement consists of two elements: a search word (a search word can actually consist of one or more words), and a search operator. The search operator is optional and establishes a condition that the search word must satisfy. A search statement containing a single search word directs xpression Design to locate every document containing that exact word. For example, type house and xpression Design will find every occurrence of the word house.

276 276 Chapter 15 - Search Utility Rules for Single Word Searches The following rules apply to search words: Do not search on common words such as a, an, and, the, this, or that. Don t use commas, single quotation marks, or double quotation marks when you search for single words, for the following reasons: xpression Design uses commas as implied OR connectors. Single quotation marks direct xpression Design to take the values between them literally. For example, xpression Design interprets this search statement as one word: clinical trials. Double quotation marks direct xpression Design to omit search connectors. For example, type: fire and theft and xpression Design will find all occurrences of fire, and, and theft. Don t use the pound sign (#) character, or the special character combinations #+ or #@. Don t use the ampersand (&). Don t force a line break in a search statement with a carriage return. xpression Design will wrap the statement automatically. xpression Design doesn t recognize hyphens as parts of words. Search statements aren t case-sensitive. About Phrase Searches A phrase search is a series of two or more words describing the search topic. Use a search phrase to narrow the scope of your search. Rules for Phrase Searches The following rules apply to the search phrase: If you use a common word such as a, and, or the, xpression Design replaces it with an asterisk. For example, to search for the phrase policies and procedures, type policies * procedures. If the search phrase contains a word that is a search operator (AND, OR, NOT), enclose it within single quotation marks.

277 277 Chapter 15 - Search Utility About Boolean Logic Searches Named after English mathematician George Boole, a Boolean search uses combinations of the Boolean operators AND, OR, NOT, and parentheses to link words, phrases, and other operators into one powerful search statement. Depending on the operator you choose, a Boolean search will broaden, or narrow, your search. Boolean operators are a common feature of World Wide Web search engines. The AND Operator Use the AND operator to search for text pieces that satisfy two conditions. The AND operator directs xpression Design to retrieve a text piece if it contains both the first and second search word. Use AND to narrow your search. The shaded area shown below represents the search results of a search for Deductible AND Co-pay. Figure 210. Search with an AND operator. The OR Operator Use the OR operator to search for text pieces that meet either of two specified conditions. The OR operator directs xpression Design to retrieve a text piece when it satisfies either the first or second search word, or both. Use OR to broaden your search. The shaded area shown below shows the search results for the words Deductible OR Co-pay. Figure 211. Search with an OR operator. The NOT Operator Use the NOT operator to retrieve a text piece that doesn t contain the specified search word or phrase. The NOT operator is particularly useful for relationships between two or more search words. Use NOT to narrow your search. The shaded area shown below shows the search results for the words Deductible NOT Co-pay. Figure 212. The NOT operator. Parentheses You might want to use parentheses to resequence a search phrase. For example, this search statement, regular AND temporary employee, looks for occurrences of regular and temporary employee. If you add parentheses like this, (regular and temporary) employee, xpression Design will find occurrences of the phrase regular employee and temporary employee.

278 278 Chapter 15 - Search Utility Rules for Boolean Logic Searches Follow these rules when you construct a Boolean search: Blank spaces must appear on both sides of AND, OR, NOT, and AND NOT operators. Don t begin or end a search statement with the AND, OR, NOT, or AND NOT operator. A search word or phrase must appear on either side of an AND, OR, NOT, or AND NOT operator. When you combine text search criteria, xpression Design automatically places an implied AND between the criteria. For example, if you look for the words co-pay and deductible, xpression Design adds an AND as shown here: co-pay AND deductible When you combine one or more selections in one type of search, xpression Design places an OR (indicated with a comma) between the selections. For example, if you search for text pieces with jurisdictions of Wisconsin OR Minnesota OR North Dakota: Jurisdictions=WI, MN, ND Searching for Content To search for text in content items, content item descriptions, or in document annotations: 1. Click the Search Content toolbar button. The Search Content window appears. Figure 213. You can also click Search Content from the Content menu.

279 279 Chapter 15 - Search Utility 2. Select a Searchable Product List from the Search These Products list, if you have one defined. The default product list setting is All Products. Click New List to create a new searchable list. For more information, see Building a Searchable Product List. 3. To search for content item text, click in the Text in content text box. Type a single word, a phrase, or several words and phrases connected by Boolean operators. For more information, see About Boolean Logic Searches. 4. To search for the name of a content item (the item description), click in the Text in description text box. Type a complete or partial description, up to 255 alphanumeric characters long. The query is not casesensitive. 5. Click Search to start your search immediately. Click Stop to cancel the search. Click Clear to reset the search settings. Searching for Content Item Attributes If the content items in your documents have one or more attributes associated with them, the attributes appear in the Match These Attributes section of the Search Content window. In this example, AUTHOR, MODIFIED_DATE, SHARED, and LANGUAGE are the first four attributes that appear in the list. Use the scroll bar to view any additional attributes. The characteristics of the attribute determine what sort of data you supply in this section. For example, AUTHOR can have only a single value associated with it, the name of the person who created the content item. LANGUAGE can possibly have several values, so they are displayed in a checklist. Figure 214. If you search for a date attribute, you can look for a specific date, or a range of dates. Searching for Rules Use the search utility to locate rule, content group, and selection criteria descriptions, as well as selection criteria statements. When you combine rule search criteria, xpression Design places an implied AND between the criteria. For example: TextClass=Condition AND CriteriaStatement=Name

280 280 Chapter 15 - Search Utility To search for rule and content group descriptions: 1. Click the Rule Search toolbar button. Figure 215. The page is also available if you click Search Rules from the Rules menu. 2. Select a Searchable Product List if you have one defined. The default product list setting is All Documents. Click Define to create a new searchable list. For more information, see Building a Searchable Product List. 3. To find a rule, click in the Rule text box. Type a complete or partial description up to 255 alphanumeric characters long. The query is not case-sensitive. 4. To find a content group, click in the Content Group text box. Type a complete or partial description, up to 255 alphanumeric characters long. The query is not case-sensitive. 5. Indicate if the rule you are searching for is a Shared Rule by selecting Yes or No in the list. 6. Click Search to begin your search immediately, or select another tab to add more search parameters. Click Stop to cancel it. Click Clear to reset the search settings.

281 281 Chapter 15 - Search Utility Searching for Selection Criteria Your company has changed the minimum liability value for all of its automobile policies. The documents that generate these policies contain selection criteria with the old minimum value. You have to find, and update, all selection criteria in all documents. The xpression Design search utility makes this easy. To search for selection criteria: 1. Click the Rule Search toolbar button, or click Search Rules on the Rules menu. The Rule Search window appears. 2. Click the Criteria tab. Figure 216. The rule search criteria tab. 3. To find the name of a selection criteria, type a complete or partial name in the Description text box. You can use field names, values, or a combination of both. The query isn t case-sensitive. 4. Is the rule you are searching for shared? Select Yes or No from the Shared Criteria list. 5. You can further define what you are searching for using defined variables and their Data Source Group, Table, or Field and include comparisons to other Values or Fields. 6. Click Search to begin your search immediately, or select another tab to add more search parameters. Click Stop to cancel it. Click Clear to reset the search settings.

282 282 Chapter 15 - Search Utility Searching for Queries You ve designed a complex query that you discover you can use in many of the charts you include in your documents. It s a query that you ve set up to be shared among many of your documents, but you don t know exactly where it is. All you know is the name of the field you used as your data output. How do you find it? To search for a query: 1. Click the Rule Search toolbar button, or select Search Rules from the Rules menu. 2. Click the Query tab. Figure 217. Rule search query tab. 3. To find the name of a query, click in the Description text box and type a complete or partial name. You can use field names, values, or a combination of both. The search isn t case-sensitive. 4. Is the query you re searching for shared? Select Yes or No from the Shared Query list. 5. You can further define what you are searching for using defined variables and their Data Source Group, Table, or Field and include comparisons to other Values or Fields. 6. You can also search on the field you ve used as the Read Order if the query has one, and then choose the Direction that was specified in the order. 7. Click Search to begin your search immediately, or select another tab to add more search parameters. Click Stop to cancel it. Click Clear to reset the search settings.

283 283 Chapter 15 - Search Utility Building a Searchable Product List You probably don t need to search every product every time. A searchable product list enables you to focus searches on specific groups of products. Targeted searches are also much faster than global searches. You can also save a searchable list for future use. To create a searchable product list: 1. Click Create a Searchable Document List on the toolbar, or click Create a Searchable Document List on the Tools menu. Figure 218. Build a searchable document list. 2. Click New. Type a case-sensitive search list name, up to 255 alphanumeric characters long, in the Searchable Document Lists text box. 3. The Available Documents list shows all the categories and all the documents stored in your xpression database, even if you don t have access to them. Click the plus (+) symbol next to a content group name to view the documents it contains. 4. Select the documents you want to add to your searchable list, then click Add to copy them to the Selected Documents list. Click Remove to remove a document from the list. 5. Click Save to store your new list. The list now appears in the Searchable Documents List box on the search windows. 6. Click Close to exit the window. Note: xpression Design warns you if an existing search list becomes outdated or obsolete, or if your category privileges change. Edit and save your list to reset the document list.

284 284 Chapter 15 - Search Utility The View Query Tab The View Query tab displays your complete search statement. The search statement shown below instructs xpression Design to look for all content items that: Contain the word deductible Were modified by Jim Harrison on or before December 14, 1997 Are shared content items Have a language field equal to English Have Pending status Figure 219. The View Query tab. The Search Results Window When xpression Design completes a search, it displays the items it finds in a Search Results window. The information in the window depends on the type of search you had xpression Design perform. Rule Search Results After a rule search, the Rule Search Results window appears. Figure 220. The Rule Search Results window.

285 285 Chapter 15 - Search Utility The Rule Search Results window displays information about the rules that satisfied the search criteria. Element Document Rule Description Description The name of the document that contains the rule. The description of the rule that contains the qualifying text. Blue indicates that this selection is a hyperlink you can click to display the rule. Content Search Results After a content search, the Content Search Results window appears. Figure 221. The Content Search Results window. The Content Search Results window contains four columns. By default, xpression Design sorts the results by the Text Description column value in ascending order. Click any of the column labels to sort the search results by the values found in that column. Element Content Description Document Document Link Description The description of the content item that contains the qualifying text. The name of the document that contains the content item. The rule and content group that contains the content item. Blue indicates that this selection is a hyperlink. Click to open the document and display the content item. xdesign can display up to three open documents at one time. Printing Search Results To print the search results: 1. Select Print from the File menu. If you want to send this information directly your default Windows printer, select Print to Printer. If you d like a more permanent record, click Print to File. Use the browse button to specify a storage location, and xpression will create a Word document with your document information. 2. Select Search Results List and your search query and a list of hits are included in the output.

286 286 Chapter 15 - Search Utility 3. To print the results of a rule search, select Rule and Content Group Information. The rule is printed with rule elements, content groups, contents with attributes, plus the actual contents. To print the results of a content search, select Content Information. All attributes, including the content itself, are included.

287 Chapter 16 Diagnostic Tools 16 Document Sciences provides several tools that you can use with Solutions Support to help identify xdesign problems. You can active application or COM traces or set up files that capture specific information as your application is running. You can access these tools from the following location: 1. Click Options from the Tools menu. 2. Click the Diagnostics tab. Figure 222. The Diagnostics tab enables you to activate logs and traces that can help identify the source of an error. 3. Document Sciences recommends that you use.xml as the extension for your BDT, Assembly List, and Rule XML data files. Then you can easily use a Web browser to view these files.