EMC® Document Sciences®
xPression ®
Version 4.5 SP1
CompuSet User Guide
EMC CorporationCorporate Headquarters
Hopkinton, MA 01748-91031-508-435-1000www.EMC.com
Legal Notice
Copyright © 2003-2014 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.
Documentation Feedback
Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we canmake our documentation better or easier to use, please send us your feedback directly at [email protected]
Table of Contents
Chapter 1 Introduction .................................................................................................. 9Information Boxes ............................................................................................. 9EMC Document Sciences Technical Support ........................................................ 9
Chapter 2 Working With CompuSet ............................................................................. 11About CompuSet.............................................................................................. 11The CompuSet Publishing Engine...................................................................... 11xPressionHome ................................................................................................ 12
Chapter 3 The xPression Publishers ........................................................................... 13About CompuSet.............................................................................................. 13About xPublish ................................................................................................ 13Differences in Architecture................................................................................ 14CompuSet .................................................................................................... 14xPublish....................................................................................................... 15
Differences in Font Support............................................................................... 16Embedded Fonts in xPublish ......................................................................... 16
Differences in Image Type Support .................................................................... 17Supported Formats ....................................................................................... 17Animated GIFs ......................................................................................... 18EPS Image with TIFF Proof/Preview .......................................................... 18Smart Format Selection ............................................................................. 18
Differences in Output Processing Support .......................................................... 18xPublish Usage of Markers and PPD Files ...................................................... 19CompuSet Usage of PDEF Files ..................................................................... 19Supported Output Processing Features .......................................................... 19Partitioning .................................................................................................. 22Built-In System Functions ............................................................................. 22Software Simplex.......................................................................................... 22Printer Support ............................................................................................ 22Supported Printer Features ........................................................................... 22
Differences in PDL Features .............................................................................. 23AFP ............................................................................................................. 23
Support for Previous Versions ........................................................................... 23Differences in Formatting Features .................................................................... 24Data Driven Charts ....................................................................................... 24CompuSet ................................................................................................ 24xPublish................................................................................................... 24
Headers and Footers ..................................................................................... 25Remittance Stub Formatting ...................................................................... 25
Two-Column to One-Column Changes Across Page Boundaries ...................... 25Differences in Reporting/Logging ...................................................................... 25Reporting..................................................................................................... 25
3
Table of Contents
Logging ....................................................................................................... 26
Chapter 4 The xPression Server .................................................................................. 27Server Deployment ........................................................................................... 27Enable Asynchronous I/O on AIX .................................................................. 27Linux ........................................................................................................... 27
How Does xPression Use Documentum?............................................................ 28Web Services .................................................................................................... 28The Document Requester Web Service ........................................................... 28The xPression Request Web Service ............................................................... 28
The xPression Adapter...................................................................................... 29Bar Codes ........................................................................................................ 29xPression 1-D Bar Code Support.................................................................... 29Glyphmaps in Code 128 and 2 of 5 Interleaved Bar Codes ............................... 29Global Options File................................................................................... 30GLYPHMAP ............................................................................................ 30Syntax ................................................................................................. 30Parameters ........................................................................................... 30
Sample Global Options Files...................................................................... 31Properties Files on the Server ............................................................................ 32AssemblyEngine.properties........................................................................... 32OTC_ENABLED....................................................................................... 32
CustomerData.properties .............................................................................. 32HTMLFormatting ..................................................................................... 32
DistributionController.properties .................................................................. 33CompuSetQuotePrintScriptParameters ...................................................... 33The VariableColor and PreviewVariable Color Properties ............................ 34
ecor.properties ............................................................................................. 34ofp.properties............................................................................................... 34revise.properties........................................................................................... 39
Built-In Function List ........................................................................................ 39CharData(data,width)..................................................................................... 40CurrentDate()............................................................................................... 40Current Page Count of the Package(counting).................................................. 40Current Recto Page Count of the Package ....................................................... 41Current Verso Page Count of the Package....................................................... 41Current Package Count of the Partition .......................................................... 41Current Package of Current Partition ............................................................. 41Current Recto Page Count of the Partition ...................................................... 41Current Verso Page Count of the Partition ...................................................... 41Current Page Count in the Partition ............................................................... 42Current Page Count of the Stream.................................................................. 42Current Recto Page Count of the Stream......................................................... 42Current Verso Page Count of the Stream ........................................................ 42CurrentPageOrientation().............................................................................. 42CurrentPageSequenceName() ........................................................................ 42Current Partition File Name .......................................................................... 43Current Sheet Count of the Package ............................................................... 43Current TimeMillis ....................................................................................... 43DataWidth(data) ........................................................................................... 43Day(date)...................................................................................................... 43Month(date).................................................................................................. 44NumData(data,width,decimals) ........................................................................ 44TotalPagesInPackage(0|1|2) .......................................................................... 44Total Recto Pages in Package ......................................................................... 45Total Verso Pages in Package ......................................................................... 45
4
Table of Contents
Total Paper Thickness of Package(mm), Total PackageThickness(mm)............................................................................................. 45Total Paper Weight of Package(g)................................................................... 46Total Sheets in Package ................................................................................. 46Year(date) ..................................................................................................... 46
Chapter 5 CompuSet and xAdmin ............................................................................... 49Category Management...................................................................................... 49CompuSet Conversion Options Tab ............................................................... 49
Resource Management...................................................................................... 53Using JPEG Images in AFP Output ................................................................ 54
CompuSet Output Management ........................................................................ 54An In-Depth Look at CompuSet Output Management .................................... 55About Font and Format Definitions ............................................................... 56About Distribution Definitions ...................................................................... 56About Output Streams .................................................................................. 57About Output Profiles................................................................................... 57Working with the Expression Editor .............................................................. 57The Expression Editor Interface ................................................................. 57Page and Document Condition Options ..................................................... 58Supported Operators ................................................................................ 62
Font Definitions................................................................................................ 62Font Definitions: List Options ....................................................................... 63Font Definition Options ................................................................................ 63
Format Definitions............................................................................................ 64Multiple Formats .......................................................................................... 65Format Definitions: List Options.................................................................... 65Format Definition Options ............................................................................ 66Override Global Merge Libraries ................................................................... 66About Web Archive Output........................................................................... 67
Distribution Definitions .................................................................................... 68Distribution Definitions: List Options ............................................................ 68Distribution Definition General Tab Options .................................................. 69Distribution Options Tab............................................................................... 69E-mail Distribution Options Tab Options ....................................................... 71Send As Attachments................................................................................ 72
Print Device Settings..................................................................................... 72Print File Naming Conventions ................................................................. 74Print Scripts on AIX Platforms................................................................... 75
FileNet Capture Distribution Options Tab Options ......................................... 75FileNet HPII/MRII Distribution Options Tab Options...................................... 75DocFinity Imaging Distribution Options Tab Options ..................................... 77IBM OnDemand AFP Indexing Distribution Options Tab Options ................... 78IBM OnDemand Generic Indexing Distribution Options Tab Options .............. 79Index Keys and Values Example ................................................................ 81
Documentum Indexing Distribution Options Tab Options............................... 82Bar Codes ........................................................................................................ 82Bar Codes: List Options ................................................................................ 83Bar Code General Tab Options....................................................................... 83About Orientation .................................................................................... 84
Page and Document Conditions..................................................................... 853 of 9 Bar Code Type Tab Options .................................................................. 862 of 5 Interleaved Bar Code Type Properties Tab Options................................. 87Code 128 Bar Code Type Properties Tab Options ............................................ 87PostNet Bar Code Type Properties Tab Options .............................................. 89OMR Bar Code Type Properties Tab Options .................................................. 89
5
Table of Contents
PDF417 Bar Code Type Properties Tab Options............................................... 90Bar Code Data Tab Options ........................................................................... 91Creating Bar Code Data Equations............................................................. 92Supported Operators ................................................................................ 92
Output Streams ................................................................................................ 93How Do Output Streams Work? .................................................................... 93Output Streams: List Options ........................................................................ 94Output Stream General Tab Options .............................................................. 94Defining Inclusion Conditions ....................................................................... 95Ignoring Missing Output .......................................................................... 96
Sorting Tab Options ...................................................................................... 96Finishing Tab Options ................................................................................... 97Reporting..................................................................................................... 98Package and Partition Reports ................................................................... 99
Output Profiles............................................................................................... 100Output Profiles: List Options....................................................................... 101Output Profile Options ............................................................................... 101
Migration Utilities .......................................................................................... 102Output Profile PDPX Contents .................................................................... 102Job Definitions PDPX Contents .................................................................... 102Exporting or Migrating xPression Documents .............................................. 103Preventing Errors WhenMigrating Documents to Different Platforms ............ 103Exporting and Migrating Jobs...................................................................... 103
Chapter 6 xDesign ..................................................................................................... 105About xDesign ............................................................................................... 105The xDesign Interface ..................................................................................... 106The xPression Toolbar ................................................................................. 106The Refresh Server Data Button ................................................................... 106Copying and Pasting Items in the Tree Pane ................................................. 107The Preview Tab Toolbar............................................................................. 107Diagnostic Tools ......................................................................................... 108Document Instance ................................................................................. 108CompuSet Tagged Text ........................................................................... 108
Creating a Document ...................................................................................... 109About Text Content Groups ........................................................................ 109About Section Rules.................................................................................... 109About Share Rules ...................................................................................... 110
Subdocuments................................................................................................ 110Including CompuSet Subdocuments in xPublish Master Documents.............. 111Subdocuments in CompuSet Master Documents........................................... 111Document Level Settings......................................................................... 111
Publishing an xPresso Package Through xRevise .......................................... 112Subdocuments and CompuSet Output Processing ........................................ 112Recipient Processing ............................................................................... 112Partitioning ............................................................................................ 112Bar Codes .............................................................................................. 112
Adding a CompuSet Subdocument .............................................................. 113Document Versions......................................................................................... 113Recipient Processing ....................................................................................... 114Differences Between CompuSet and xPublish Recipients............................... 114Defining Recipients .................................................................................... 115Create Recipient-Enabled Section Rule ......................................................... 115Create CompuSet Page Sequences................................................................ 115Create xPublish Page Sequences .................................................................. 116
6
Table of Contents
Create Output Streams................................................................................ 116Formatting Variable Replacements................................................................... 117
Chapter 7 Batch and xDashboard .............................................................................. 119CompuSet and xPublish Job Definitions ........................................................... 119Job Definition Page ..................................................................................... 119Job Log File Naming Conventions ............................................................... 121About Job Steps .......................................................................................... 122
Job Steps for Previously Run Jobs .................................................................... 123Running a Batch Job ....................................................................................... 124Server Management ........................................................................................ 124The Job History Tab ........................................................................................ 125File Naming Recommendations for Batch Jobs.................................................. 125Command Line Batch Processing..................................................................... 125Command Line Parameters ......................................................................... 126
Previously Run Jobs........................................................................................ 127Overview of a Previously Run Jobs Scenario................................................. 127Important Requirement........................................................................... 127
Creating the Intermediate Output ................................................................ 129Creating the Previously Run Jobs Job Step.................................................... 130
Multi-Threading in xPression .......................................................................... 131An In-Depth Look at Multi-Threading in xPression Batch ............................. 131Configuring Multi-Threading .................................................................. 135
Chapter 8 xResponse and CompuSet ........................................................................ 139About xResponse ........................................................................................... 139xResponse.................................................................................................. 139
Previewing a PDF in xResponse ...................................................................... 139Activate Preview PDF ................................................................................. 140Use Preview PDF........................................................................................ 140
Chapter 9 xRevise and CompuSet ............................................................................. 141About xRevise ................................................................................................ 141xRevise ...................................................................................................... 141
Previewing a Work Item in xRevise.................................................................. 141Working with Tables in xRevise ....................................................................... 142xRevise Documents Using CompuSet Commands ............................................ 142Variables in xRevise ........................................................................................ 142
Chapter 10 CompuSet Bridge ...................................................................................... 143Configuration................................................................................................. 143Enabling the Bridge .................................................................................... 143CompuSet and Emitter Options Files ........................................................... 143CompuSet with Linked Emitters.............................................................. 144Example............................................................................................. 144
Running CompuSet and Then Running An Emitter .................................. 144Example............................................................................................. 144
CompuSet and the Emitters in xPression ..................................................... 145Logging ..................................................................................................... 146
Batch Applications.......................................................................................... 146Pre and Post Processing Scripts................................................................... 146
7
Table of Contents
CompuSet.exe and CompEmit.exe .............................................................. 146Script Examples ......................................................................................... 146
Job Steps ........................................................................................................ 147Compose Tagged Text ................................................................................ 147Submit z/OS Job......................................................................................... 147Download From z/OS ................................................................................. 147Examples ................................................................................................... 148
Automating Batch Applications....................................................................... 148xDesign - External Content Tagged Text Rule ................................................... 149External Tagged Text File ........................................................................... 150Using Customer Data................................................................................. 150Customized User Exit ................................................................................. 150The Options File ......................................................................................... 150Default Paths.............................................................................................. 151Specifying Multiple Option Files................................................................. 151Example................................................................................................. 151
Subdocuments................................................................................................ 152CompuSet Master Document....................................................................... 152xPublish Master Document ........................................................................ 152
Web Services .................................................................................................. 152Enabling/Installing the Bridge Web Service.................................................. 152Available Methods...................................................................................... 153Publish Tagged Text................................................................................ 153Syntax ............................................................................................... 154Parameters ......................................................................................... 154
Preview Text to PDF ............................................................................... 154Syntax ............................................................................................... 154Parameters ......................................................................................... 155
Publish Tagged Text with OP Fields ......................................................... 155Syntax ............................................................................................... 155Parameters ......................................................................................... 155
Examples ................................................................................................... 156Setting up output variables ............................................................................. 157Adding the data to the DSG ........................................................................ 158Modifying the XML Reading Def ................................................................. 158Define and Map the OP Variable.................................................................. 158Pass the Values to the Web Service ............................................................... 158
Updating Legacy CompuSet Batch Applications Configuration ......................... 159Updating Legacy Batch Applications on Mainframes .................................... 162
8
Chapter 1Introduction
This guide provides in-depth information about using CompuSet with xPression Enterprise Edition.
Information BoxesThe 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 mayoccur 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 describean 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.
EMC Document Sciences Technical SupportFor more information or to solve a problem, contact EMC Document Sciences Technical Support:
Online Support: https://support.emc.com
Telephone Support: http://www.emc.com/collateral/contact-us/h4165-csc-phonelist-ho.pdf
United States: 800–782–4362Canada: 800–543–4782Worldwide: +1–508–497–7901
9
Introduction
10
Chapter 2Working With CompuSet
This chapter covers some of the CompuSet specific processes you will need to use when creatingCompuSet documents.
About CompuSetCompuSet is one of the xPression composition engines. CompuSet is a tagging language that enablesyou to produce composed pages and documents that are processed by printer emitter software toproduce high quality printed or online documents. While most formatting can be accomplishedentirely with Microsoft Word, there are instances where you may want to place CompuSet commandsinto your xDesign content items. For example, you may want to:• Access functionality beyond the capabilities of Microsoft Word.
• Address gaps in the xDesign HTML to CompuSet conversion.
To convert your Microsoft Word MSOHTML content items to CompuSet command language,xPression executes a conversion program each time you publish an MSOHTML document throughCompuSet. xPression maps most Microsoft Word MSOHTML functionality to CompuSet commandsto provide the best possible integration. The mapped functionality should satisfy the formattingrequirements of most documents.
For situations where a mapping is not available, xPression provides the CompuSet CommandWizard, a utility you can use to insert CompuSet commands directly into xPression content items.
CompuSet experts who want to override certain automatic HTML conversion results can usethe CompuSet Conversion Options. Before you develop a document that you intend to publishwith CompuSet, be sure you understand how each Word formatting feature maps to CompuSet.Functionality that’s not supported by CompuSet is listed throughout this chapter.
The CompuSet Publishing EngineCompuSet is a complex, highly configurable tagging language that extends the formatting capabilitiesof Microsoft Word. It enables advanced output processing functionality such as sorting, grouping,and recipient processing, provides for the addition of barcodes, and supports PCL and Metacodeoutput. However, CompuSet does require extensive configuration.
11
Working With CompuSet
Components:• CompuSet Composer - Composes CompuSet Tagged Text commands and content into pages
• Output Processing Pre-Processor - Prepares composed pages for output processing actions.
For example, adds index records so Output Processing Engine can efficiently sort output
Packages into CCF (Container for CompuSet Intermediate Format) file
• Output Processing Engine - Applies various output processing directives (sorting, merging, barcodes, …) to CCF and streams content to the Emitter
• Emitter - Transforms CompuSet Intermediate Format record stream to a particular PDL
xPressionHomeThe term "xPressionHome" refers to the location where xPression was installed on your server. Bydefault on Windows servers, the location is C:\xPression, but your installer may have selecteda different location during installation. Please consult with your administrators or IT personnel todetermine the location where they installed xPression. Throughout the xPression documentation, wewill refer to this location as "xPressionHome".
12
Chapter 3The xPression Publishers
The xPression publishers are responsible for formatting and distributing assembled documentsaccording to the specifications of the document designer. They also perform any requiredpost-composition processing that groups documents into streams, adds finishing information, anddistributes the final documents to the designated output format.
xPression provides two different publishing engines, CompuSet and xPublish. The two publishingengines have different feature sets and support a variety of options. When choosing a publishingengine, consider which features and options are most important in each case.
About CompuSetCompuSet is a native code composition engine that is configurable through a complex, highlyconfigurable tagging language. The CompuSet command language is used to implement manyMicrosoft Word formatting features, as well as output processing functionality such as sorting,grouping, recipient processing, and barcodes. Although CompuSet supports many of the sameoutput processing features that xPublish supports, implementing these features in CompuSetrequires extensive configuration and coding.
About xPublishxPublish is a pure Java composition engine that is easy to use and provides WYSIWYG functionalitywith Microsoft Word for document formatting. It enables advanced output processing functionality,true multi-threading in batch mode, integration with ECM Documentum, and greater out-of-the-boxsupport for fonts and image types. xPublish can supports nearly all of the features that CompuSetsupports, plus many key features that CompuSet cannot support. The configuration process forxPublish is drastically easier than the CompuSet configuration. Additionally, xPublish processingperforms about 4 times faster than CompuSet processing.
13
The xPression Publishers
Differences in ArchitectureCompuSet and xPublish have significantly different architectures, and while some of their featuresupport may be the same, the method used to support the underlying features may be completelydifferent.
CompuSet
CompuSet is the most sophisticated composition engine in the industry that is flexible and fullyprogrammable through CompuSet command language. Some key aspects of CompuSet are:• Native code implementation and embedded native code emitters drives performance.
• Extensive support for output processing capabilities.
• Because CompuSet has multi-thread restrictions, only one CompuSet call can be made at a timeper JVM.
The CompuSet publishing engine consists of CompuSet, the CompuSet composer, the outputprocessing pre-processor, the output processing engine, and the emitters.
The following image shows the simplified CompuSet data flow
.
When you publish to CompuSet, CompuSet processes the output produced by xPression Assemble tocreate your desired output formats. The output processing engine performs partitioning, sorting,merging and other output management tasks. The output formatters create print data streams for usewith a large variety of laser printers. Additionally, CompuSet can produce PDF for use with AdobeAcrobat Reader, for inclusion in e-mail, and archive solutions. You can then distribute the outputthrough the various xPression distribution components,
After you design your document in xPression Design, and create the layout and develop your content,you pull all the pieces together and produce the final output through an xPression publishing engine.
14
The xPression Publishers
When you publish to CompuSet, the CompuSet composer composes the CompuSet tagged textcommands and content into the pages of your document. Next, the output processing pre-processorprepares the composed pages for output processing actions. For example, it adds index recordsto enable the output processing engine to efficiently sort output. The pre-processor packages thedocument into a Container for CompuSet Intermediate Format (CCIF) file. The output processingengine applies output processing directives to the CCIF and streams the content to the emitter.Finally, the emitter transforms the CCIF record stream into the desired output format.
xPublish
xPublish is a powerful, easy to configure J2EE-based composition engine that uses thread-safe pureJava code libraries. It enables greater performance and scalability than CompuSet through anadvanced multi-threading batch mode and caching.
The following image shows the simplified xPublish data flow
.
When you publish through xPublish, the Instantiater assembles your content into a styled documentand feeds the document to the xPublish Composer. The Composer transforms the Styled Documentsinto composed pages of content in Device Independent Format (DIF) streams. The Streamer appliesnecessary output processing logic to a DIF stream and sends the DIF to the Emitter. The Emittertransforms the DIF stream into the required output format and invokes the Controller to send todesired document distribution channel.
15
The xPression Publishers
Differences in Font SupportThere are major differences in the level of support for font types and level of configuration needed touse the font of your choice.
CompuSet requires extensive configuration for fonts. The fonts you use when editing a document(Windows fonts) will not work when publishing to an output type (production fonts). You cannotsimply select a font in Microsoft Word while you are editing and expect it to work when you createPDF, AFP, or Metacode output. You must set up a series of external font configuration files for each ofyour fonts. Additionally, you must map your Windows fonts to your production fonts.
The xPublish composition engine was designed to support the same TrueType fonts (TTF) used inMicrosoft Word. This enables you to publish documents in any supported format using any fontavailable to Microsoft Word. TrueType fonts are the xPublish master format.
xPublish also supports OpenType and Type 1 fonts for PDF and PostScript, and True Type fonts in anOpen Type wrapper. xPublish also supports the AFP fonts that meet the following characteristics.• Must be an AFP Outline font
• Must have been created from TrueType font masters stored in the xPression database
• Supports double-byte (Unicode) through TTF fonts and single-byte through AFP Outline fonts
• Fonts must use the Latin alphabet
Additionally, xPublish provides out-of-the-box support for Unicode fonts and double-byte fonts, suchas those used in Chinese, Turkish, and Japanese characters.
Embedded Fonts in xPublish
We have expanded the range of characters that can be used without being embedded in an outputPDF. Originally, xPression enabled you to publish a PDF without embedding fonts if all the characterswere within the ASCII range (0-256). Any character that fell outside of that range was embedded.
Now the supported range is expanded to code page 1252. If the character is outside of this range, itwill have to be embedded.
If you want to publish a PDF with no embedded fonts, you must do the followingtwo steps:1. Ensure that all characters fall within the supported range as outlined above.
2. Set the following two parameters in the DCPI.properties file.LargeCharacterSet=falseEmbedFont=false
16
The xPression Publishers
Differences in Image Type SupportBoth CompuSet and xPublish images are stored in the xPression database, but they are stored inseparate locations. You cannot access xPublish images from a CompuSet document and you cannotaccess CompuSet images from an xPublish application.
With CompuSet you can insert an image from the xPression database, from an external location(Metacode only), or from your printer memory. You cannot resize an image or change the rotation ofan image from within Word. You can rotate black and white TIFF and Xerox images using CompuSetcommands. Additionally, CompuSet can instruct supported printers to rotate an image. Scaling ofimages is allowed in CompuSet for some output types, such as PCL, PostScript, and Metacode.Scaling is supported through the CompuSet IMG command.
If your output is produced in more than one output format and requires more than one version ofthe same image (such as an EPG and a JPEG), you must import both formats into the xPressiondatabase separately.
You can use xPublish images that are stored in the xPression database, at an external location, inthe printer memory, or in a Documentum docbase. With xPublish, you can resize and rotate yourimage directly in Microsoft Word without having to alter your source image. xPublish was designedto automatically handles the image format selection by converting your image to the most suitableformat for your output type. For this reason, you do not need to place multiple formats of the sameimage in the xPression database. If the xPression database does not contain an image compatible withyour output format, xPression will automatically perform the conversion.
Supported Formats
The following table shows the types of images currently supported by CompuSet and xPublish.
Feature CompuSet xPublish
BMP Not supported √
EPS √ √
Flate Not supported √
GIF Not supported √
Group4 √ √
IMG (Xerox) √ √
JPEG √ √
PDF as an image Not supported √
PNG Not supported √
TIFF Only black and white imageswith one bit per pixel. Must beuncompressed, CCITT 1D, Group3, Group 4, LZW, or PackBits.
Only Uncompressed,Huffman RLE (CCITT1D), Group 4, LZW andPackBits
17
The xPression Publishers
Feature CompuSet xPublish
External Images Metacode only √
Images Resizable in Word Not supported √
Highlight Color √ Not supported
Animated GIFs Not supported Not supported
CMYK TIFFs √ Only B/W, Gray, RGBPalette and RGB
Smart Format Selection Not supported √
The following additional image formats and types are not supported.
Animated GIFs
Animated GIFs are not supported. Animated GIFs are comprised of a number of images in the samefile. The animation effect occurs when an application, like Internet Explorer, switches between theimages. If you import an animated GIF, xPression extracts only the first image in the sequence.
EPS Image with TIFF Proof/Preview
If you import an EPS image that contains a TIFF proof or preview:• CompuSet processes the EPS image and ignores the TIFF preview.
• xPression only import the TIFF image because the TIFF proof precedes the EPS image in the file.xPression will treat the image as a TIFF and not as an EPS.
Smart Format Selection
In CompuSet, if your output requires two versions of the same image (such as an EPG and a JPEG),you must import both formats into the xPression database.
In xPublish, xPression automatically converts images to the correct format to fulfill the output needs;images do not need to be stored in multiple formats.
Differences in Output Processing SupportOutput processing enables you to channel your output to one or more output streams, and performoutput processing tasks on the documents in that stream such as, sorting, grouping, and reporting.
In CompuSet, output processing is a two phase process. First, the composition engine composes theCCIF, then sends the CCIF to an emitter. The emitter publishes the document into your desiredoutput format. In order to create a package, CompuSet must perform sorting on the documents in thepackage. This additional processing must be done even if you are not using sorting. Additionally,
18
The xPression Publishers
whenever output processing is used, CompuSet temporarily saves all documents to the file systembefore passing them to the emitter.
xPublish uses a pipeline approach for output processing. A different software processor is usedfor each output processing feature. Documents and packages are passed through a pipeline. Ifno sorting is needed, no documents are temporarily saved to the file system, and xPublish doesall processing in memory.
xPublish supports many of these output processing features through the use of markers and PostScriptPrinter Definition (PPD) files. CompuSet supports these features through the use of PDE files.
xPublish Usage of Markers and PPD Files
PPD files are text files that provide applications (like xPression) with the necessary information abouta device’s features. Markers identify places in the document where you would like a feature or setof features to be implemented. A Marker does not inherently contain the feature(s) you want toimplement, it is a merely a name that marks a location.
Through xAdmin, you can import PPD files for all of your print devices and map your markers tofeatures described in the PPD file. This enables great flexibility in how and where you implementthese features. This enables the printer features to be invoked differently (or not at all) for each device.
Every PostScript device ever produced has an associated PPD file. This enables xPublish to addressevery device feature on every PostScript printer. Document Sciences provides you with an AFP PPDfile to enable you to use the same mechanisms for features of AFP.
CompuSet Usage of PDEF Files
When you publish to CompuSet, xPression uses PDEF files to determine the format and other specificcharacteristics of your output. PDEF files define such characteristics as page size, what type of color isto be used (no color, highlight color, or full color), and whether the document is to be produced in abooklet format.
Before you publish your document to CompuSet, you must configure a PDEF file with your outputoptions. The Output Format Tool enables you edit or create a PDEF file to specify those characteristicsas output options for your job.
Output format options are stored in the PDEF file, and are printer-specific. This means you can createa PDEF file for each printer you use, and then select the appropriate PDEF file by selecting the FormatDefinition that contains it. There are many options that you can define to control the way your outputlooks. The available options vary between the different output types.
Supported Output Processing Features
CompuSet and xPublish support the following output processing options and functions.
19
The xPression Publishers
Feature CompuSet xPublish
Media: Tracking Paper Weight √ √
Media: Tracking Paper Thickness √ √
Media: Tracking Quantities of each paperstock used
Not supported √
Media: Change of orientation indocument
√ √
Media: Change of page size in document √ √
Media: Tray Pulls √ √
Partitioning: Individual files √ √
Partitioning: Maximum Sheet Count √ √
Partitioning: Single File √ √
Partitioning: At Change in Variable Not supported √
Barcodes: 2 of 5, Code 39, Code 128,PostNet, OMR, PDF417
√ √
Barcodes: DataMatrix Not supported √
Barcodes: Does Not Require Fonts Not supported √
Barcodes: Arbitrary Rotation of Barcodes Not supported √
Barcodes: Support for Front to Back Order Not supported √
Barcodes: Font Based √ √
Content Stamps: Text Content Stamps Not supported √
Content Stamps: Image Content Stamps Not supported √
Sorting of Output √ √
Packaging √ √
Reporting √ √
Separator Sheets Not supported √
Imposition: Booklet Imposition √ √
Imposition: N Up Impositions √ √
Imposition: N Up Stacked Impositions Not supported √
Bleeds Not supported √
Crop Marks Not supported √
Fonts: Type 1 √ √
Fonts: TrueType Not supported √
Fonts: OpenType Not supported √
Fonts: Kerning Not supported √
20
The xPression Publishers
Feature CompuSet xPublish
Fonts: Use fonts without conversion Not supported √
Printer Support: Support all devices forPPD
Not supported √
Printer Support: Printer Resident Images √ √
Spot (PMS) Colors Not supported √
Recipient Processing √ √
Output Metadata (Reporting) Not supported √
Images: Configurable ImageOptimization
Not supported √
Images: Resampling to Device Resolution Not supported √
Images: Arbitrary Rotation Not supported √
Images: Cropping Not supported √
PDF Features: Image Resampling Not supported √
PDF Features: Compression Control Not supported √
PDF Features: Fillable PDF Not supported √
PDF Features: Font embedding withSubsets
Not supported √
PDF Features: Do Not Embed FontOption
√ √
PDF Features: Bookmarks √ √
PDF Features: PDF Properties √ √
PDF Features: Security √ √
AFP Features: Do Not Embed FontOption
√ √
AFP Features: TLE √ √
AFP Features: NOOP √ Not supported
PostScript Features: Image Resampling Not supported √
PostScript Features: Do Not Embed FontOption
√ √
PostScript Features: PDF Properties √ √
Plain Text Emitter Not supported √
TIFF Emitter Not supported √
VIPP Emitter √ Not supported
Software Simplex √ √
Built-in System Functions √ √
21
The xPression Publishers
Partitioning
xPublish supports the ability to start a new partition each time there is a change in a selected outputvariable. For example, if you set up an output variable based on the customer’s zip code, xPublish willcreate a new partition each time it encounters a new zip code. CompuSet does not support this feature.
Built-In System Functions
While both CompuSet and xPublish support system variables, xPublish has a far more robust setof built-in functions than CompuSet.
Software Simplex
Software simplex mode enables the output device to remain in hardware duplex mode whilexPression simulates simplex mode by inserting blank pages. This is useful when you are runninga mixed plex job where you don’t want to change the hardware plex mode for a small amount ofsimplex pages.
Printer Support
CompuSet uses a proprietary method for supporting printers. As a result, a limited numberof printers are supported. xPublish uses a standards based approach that enables it to supportthousands of printers.
Supported Printer Features
CompuSet and xPublish support the following printer features.
Feature CompuSet xPublish
Shingling Not supported √
Stapling √ √
Jogging of Output √ √
Offsets √ √
Producing printer console messages √ Not supported
Printer commands √ √
Markers Not supported √
22
The xPression Publishers
Differences in PDL FeaturesFor xPublish TLEs are defined at the output stream level in an output definition. xPublishconfiguration of TLEs is done entirely through the output definition page in xAdmin. For CompuSet,TLEs are defined manually through commands placed in your properties file that must correspond tovalid CompuSet index files in your document.
The following table shows the output formats currently supported by CompuSet and xPublish.
Feature CompuSet xPublish
AFP √ √
HTML Not supported √
Metacode √ Not supported
PCL √ √
PDF √ √
PostScript Xerox DocuPrint, DocuTech, andNuevera printers.
√
VPS √ √
VIPP √ Not supported
PDF Image Resolution Not supported √
TLEs AFP only AFP only
AFP
xPublish and CompuSet both support “Comment” or NOPS AFP. This is more easily done withxPublish. CompuSet requires special custom coding to support NOPS.
Support for Previous VersionsThe CompuSet publishing engine was used exclusively by xPression releases prior to version 2.0.With version 2.0, xPression introduced a new composition engine: xPublish.
Feature CompuSet xPublish
xPression 1.0, 1.2, 1.2.1 √ Not supported
xPression 2.0 and above √ √
23
The xPression Publishers
Differences in Formatting FeaturesCompuSet supports many formatting features through the use of CompuSet command language.CompuSet tags can be placed into your document using the hidden text feature of Microsoft Word.During processing, xPression reads the CompuSet tags as commands and not as text.
xPublish supports most formatting features directly through Microsoft Word, eliminating the needfor complex coding and non-intuitive document design. Other features can be easily implementedthrough macros on the xPression toolbar or through xDesign.
A complete list of supported/unsupported formatting functionality appears in the xDesign Styleand Formatting Guide.
Some key differences are listed below.
Feature CompuSet xPublish
Data Driven Charts √ √
Image Rotation √ √
Image Resizing √ √
Headers and Footers √ √
Special Characters Additional configuration needed √
Bulleted Lists Additional configuration needed √
Table of Contents Additional configuration needed √
Data Driven Charts
Both CompuSet and xPublish support creating data driven charts. The following paragraphs outlinethe differences in how each publisher supports them.
CompuSet
To create data driven charts using the CompuSet composition engine, you’ll need to use CompuSetcommands, as there is no graphical user interface for the functionality. You should be familiar withCompuSet commands, especially those required to produce charts. You must assemble and view thedocument to troubleshoot or refine the chart.
xPublish
xPublish has a graphical user interface that makes creating and adding charts to your document fairlyeasy. You can also create a template that you can use again and again. xPression places a placeholderchart, complete with your formatting, in your document. You can move and adjust the placeholdercharts as necessary, without having to assemble the document first.
24
The xPression Publishers
Headers and Footers
CompuSet and xPublish have the following differences in header and footer support.
Remittance Stub Formatting
Remittance stub formatting can be accomplished through CompuSet by creating three differentfooters. The footer on the first page is the front of the remittance stub, the footer on the second page isthe back of the stub, and the footer on the third page is for all subsequent pages. In this situation, thecontent must flow naturally from the top of page one, and onto page three. This can’t be resolved bysection break logic, since in order to set a third page footer, a section break requires knowing wherethe page will break. If the content being set is, for example, transactional information of unknownlength, there is no way to know at assembly time where the pages will break.
xPublish doesn’t support footer changes beyond a different first page, or different odd or even pages,when content flows naturally beyond two pages. This is because footer changes are determined bypage breaking section breaks. This limits the ability to produce remittance stubs. If the content onlyflows to two pages maximum, you can accomplish this through Word. If you are using xPublish,consider creating an End-Page Stub.
Two-Column to One-Column Changes Across PageBoundaries
You may have a situation where variable content starts in one column of a two-column page (withother unrelated content in the other column), and then flows on to the next page, where it must be in aone-column format. You can accomplish this dynamically with CompuSet. This type of functionalityis not supported in Word, and therefore, not in xPublish.
Differences in Reporting/LoggingxPression provides a number of log files for both CompuSet and xPublish. For documents that arepublished through CompuSet, additional log files are generated.
Reporting
CompuSet supports traditional reporting at the package, partition, and page sequence levels.xPublish supports a more flexible type of reporting in the form of metadata. The metadata featureis called Generic Index, and it provides four levels of reporting: stream, partition, package, anddocument. The generic index feature creates an XML formatted index that lists values for all instancesof all output variables in the output stream. When activated, xPression creates the index each time thebatch job is run. Generic index does not support document error counts.
25
The xPression Publishers
Logging
xPublish uses a unified log file, the xPression.log Java log file. All messages are written to this log file.CompuSet also uses the xPression.log file, but also uses separate logs for CompuSet and the emitter.The use of multiple logs can make it difficult to locate the information you need.
However, CompuSet provides a detailed log of each composition, where any page errors areindicated, as well as program versions and start/stop times. The emitters also provide detailed logsabout each job. These details include program version, widths file version, options in the widths file,other program options in affect, and images and/or fonts being merged into the document. Anyerrors are also listed. The end of the emitter log shows the details of font usage.
26
Chapter 4The xPression Server
This chapter contains topics related to using CompuSet on the xPression Enterprise Edition Server.
Server DeploymentThe xPression server runs within a Java EE application server (IBM WebSphere, BEA Weblogic, orRedhat JBoss). The server components run within the application server process on the applicationserver machine. The CompuSet and CompuSet emitter are called through JNI, the Java standard forintegrating native code with Java code.
The batchrunner application also runs as a separate Java process on the application server machine.xPression uses one Java server for each batchrunner instantiation. The Java process communicateswith the application server Java process to execute batch jobs. Depending on the nature of the batchjob, the batch runner may also execute the composition engine directly.
Enable Asynchronous I/O on AIX
The CompuSet publishing engine contains Fortran code. In order for the Fortran code to run, youmust enable asynchronous I/O in the kernel of your AIX system. This may be disabled by default onyour system. If you do not enable asynchronous I/O, CompuSet will fail to load.
For more information about these settings, see: http://www16.boulder.ibm.com/pseries/en_US/infocenter/base/aix.htm
LinuxTo enable xPression to distribute CompuSet documents as an “Individual file for eachcustomer”, please add the following path to the com2ejbbridge.properties file.1. Open com2ejbbridge.properties located in your xPressionHome directory.
2. Locate the BootClassPath parameter.
3. Add the following path to the end of the BootClassPath. Ensure you place a colon at thebeginning of the new path.
27
The xPression Server
:$JDK_HOME/jre/lib/jsse.jar
4. Save the file.
How Does xPression Use Documentum?xPression supports Documentum Content Server version 5.3. With Documentum integration, you can:• Archive your xPression-generated documents in a Documentum docbase. This feature works forboth xPublish and CompuSet documents. For more information about Documentum archiving,see the xAdmin Enterprise Edition User Guide.
• Pull images and PDFs from your Documentum docbase for use in your xPression documents.This feature applies only to xPublish documents. You can import Documentum images into yourxPression document through two different methods. One method inserts an image reference inthe document, which enables xPression to retrieve the most recent version of the image from thedocbase each time the image is used. The other method enables you to import the Documentumimage into the xPression database, where it will be treated as an xPression image. For moreinformation about Documentum images, see the xDesign Style and Formatting Guide.
Web Services
The Document Requester Web Service
The document requester Web service enables you to retrieve an assembled xPression documentin the format you specify by passing an output profile name. If successful, the xPression serverpasses back an array containing the document (or stream) name, the output format name, and theassembled document stored in a byte array. The format of the returned byte array depends on theoutput profile you provide.
Note: For the CompuSet engine, be aware that if you select HTML as the format you want returned,the document requester will pass back packed MSOHTML. The calling program must convert thereturned byte array to a logical file.
The xPression Request Web Service
When the Preview PDF method is called for a CompuSet document, the web service determines ifthere is a format definition named PDF. If your system does contain a format definition named PDF,the web service creates a PDF based off the pdef file and the font files associated with that formatdefinition. If a PDF format definition is not available, xPression creates a basic PDF format definition.
If your system does not contain a format definition named PDF, you can create one that uses pdefand font files of your choice.
If your system does not contain a format definition named PDF, you can modify the format definitionto use the def and font files of your choice.
28
The xPression Server
The xPression AdapterFor CompuSet, the xPressionAdapter needs the following information as part of its configuration towork properly.
Parameter Definition
PreviewPDFOutputProfile This is the xPression Server Output Profile default for CompuSetcomposition engine documents, should this optional parameternot be given on Preview PDF requests into the adapter. xPressionPublish composition documents do not require a PDF outputprofile to be executed to return PDF documents.
Here’s an example:xPressionServerURL=iiop://localhost:2809xPressionApplicationName=xPression AdapterPreviewPDFOutputProfile=PDF Return to ApplicationxPressionBatchRunnerScriptDir=C:\\WebSphere\\AppServer\\installedApps\\xPression.ear\\
Bar CodesThe following section covers CompuSet-specific information about bar codes. For more informationabout bar codes, see the xAdmin Integration Guide.
xPression 1-D Bar Code Support
xPression supports several versions of one-dimensional (1-D) bar codes. xPression assumes allsupported 1-D bar codes are font-based. It is your responsibility to provide the appropriate font forthe bar code and ensure that the font is included in the font database and the widths file used for yourjob. When you define your 1-D bar code, you define the CompuSet font number for the bar code font.This font number should match the font number used in the widths file.
Caution: xPression does not support the AFP BCOCA font format.
Glyphmaps in Code 128 and 2 of 5 Interleaved BarCodes
Code 2 0f 5 Interleaved and Code 128 bar codes are non-standard, meaning that the characterpositions vary from font vendor to font vendor. CompuSet uses the GlyphMap to map characterpositions to the correct corresponding glyph (character) in the font.
Fonts for these bar code types are non-standard, meaning that the character positions vary from fontvendor to font vendor. The GlyphMap maps glyphs (the logical piece of the bar code) to the actual
29
The xPression Server
character location in the font where this glyph occurs. This mapping is done in a Global Options file(.opg) whose prefix matches your Wids file prefix. For example, if your Wids file is named AFP.wid,the global options file should be named AFP.opg.
xPression automatically searches for this global options file in the following directory: \\xPressionServer\xPression\CompuSet\Font Definition
Global Options File
The Global Options file contains bar code GlyphMaps. xPression does not supply a tool to create thisfile. You must create the Global Options file using a text editor.
The Global Options file consists of commands in the following syntax:
COMMAND PARAMETER1=VALUE PARAMETER2=VALUE
Each command exists on its own line. The line directly beneath the command line contains one ofthe command parameters, followed by an equal sign (=), followed by the parameter value. Eachcommand may contain multiple parameters, but each parameter must be on a separate line. Somecommands may appear in the Global Options file multiple times. The Global Options file can containa total of 256 commands and 256 parameters.
Each line can contain up to 256 characters. If you need more than 256 characters on a single line, youcan use a back slash (\) to continue the command definition onto the next line. You can continue asingle definition up to five lines.
Comments may be inserted into an Global Options file by starting a line with an asterisk (*).Comments do not count toward the five-line limit for a single parameter definition.
The following sections describe the commands used in the Global Options file.
GLYPHMAP
There is no standard implementation for 2 of 5 Interleaved or Code 128 fonts; therefore, youmust define the location of the bar code glyph for xPression to create the bar code correctly. TheGLYPHMAP command enables you to define the location of the bar code glyph in the 2 of 5Interleaved or Code 128 font.
Syntax
GLYPHMAPTYPE=BarcodeTypeTABLE=GlyphLocationValues
Parameters
TYPE=BarcodeType
30
The xPression Server
Define the name of the bar code type that you are associating with this GLYPHMAP command:2OF5INTERLEAVED or CODE128.
Default: Required.
TABLE=GlyphLocationValues
Define CODE128 for any of the different font sets (A, B, or C).
Define a value for each position in the table that represents the decimal value of the character thatwould be placed in the output file. For more information, see the xPression CompuSet Reference.
Each position in the TABLE parameter represents a glyph that the bar code font supports. For 2 of 5interleaved, the values represent the digit pairs 00 to 99, the start character, and the stop character.Output Processing requires all 102 values.
For Code 128, the values represent the code value of the glyph, 0 to 106, where:• Value 103 equals the start value for set A
• Value 104 equals the start value for set B
• Value 105 equals the start value for set C
• Value 106 equals the stop value.
xPression requires all values.
Default: Required.
Sample Global Options Files
The following example of a Global Options file defines the font glyph information for a 2 of 5Interleaved bar code font. Position 1 in the TABLE parameter represents the digit pair 00, whose fontglyph is accessed with ASCII character 33 (or the ! character).
GLYPHMAPTYPE=2OF5INTERLEAVEDTABLE=33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,\54,55,56,57,58,59,188,61,189,63,64,65,66,67,68,69,70,71,72,73,74,75,76,\77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,190,95,96,97,98,99,\100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,\117,118,119,120,121,122,123,124,125,126,161,162,163,164,165,166,167,168
GLYPHMAPTYPE=CODE128TABLE=32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,\54,55,56,57,58,59,180,61,189,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,\78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,190,95,96,97,98,99,100,101,\102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,\120,121,122,123,124,125,126,127,161,162,163,164,165,166,167,168,169,170,171
31
The xPression Server
Properties Files on the ServerA CompuSet-enabled installation will include the following properties files and properties in thexPressionHome directory (by default, C:\xPression).
AssemblyEngine.properties
The AssemblyEngine.properties file contains many properties. You can see definitions of theseproperties in the Administering the xPression Server guide. The only properties listed here are thosethat are exclusive to CompuSet.
OTC_ENABLED
Enables One Time Conversion when set to TRUE. One Time Conversion is used in batch mode. It is aprocess which causes content items to be converted to CompuSet only once and cached for subsequentuse, rather than being converted each time the content item is used. This property is not includedin the property file by default. To use this property you must add it to assemblyengine.propertiesmanually.
CustomerData.properties
The AssemblyEngine.properties file contains many properties. You can see definitions of theseproperties in the Administering the xPression Server guide.
HTMLFormatting
This property is listed in the Administering the xPression Server guide because it applies to xPublishas well as CompuSet.
The HTMLFormatting property works in conjunction with the “Data Contains HTML Formatting”option for the formatting of variables in xDesign.
This global property enables or prevents xPression from intercepting and converting specialcharacters used by HTML and CompuSet (for example, <, >, &) to their equivalent entity code(<, &rt;). The special characters can be passed through to the composition unaltered where theycan be read and executed.
When this property is set to TRUE, HTML formatting will be applied to all string type variables. If setto FALSE, formatting will not be applied and the HTML tags will be included in the output.
When the “Data Contains HTML Formatting” is selected in xDesign, any HTML formatting will beapplied to the variable regardless of the value of HTMLFormatting.
32
The xPression Server
DistributionController.properties
The DistributionController.properties file contains many properties. You can see definitions ofthese properties in the Administering the xPression Server guide. The only properties listed here arethose that are exclusive to CompuSet.
CompuSetQuotePrintScriptParameters
UNIX passes single-quote marks as special characters. So, when a parameter is passed to a printscript that includes a single-quote mark in a UNIX environment, it must be enclosed in double-quotesto execute properly. The new distribution controller property places double-quote marks aroundeach parameter when true. This property is false by default.
33
The xPression Server
The VariableColor and PreviewVariable Color Properties
These properties are listed in the Administering the xPression Server guide because they apply toxPublish as well as CompuSet.
You can separately control the color of replacement variables as they appear in a document previewpage or in an output file.
The VariableColor property in DistributionController.properties controls the color of yourreplacement variables any time you publish a document xDesign, xFramework, xResponse, xRevise,Web Services, or BatchRunner. For example:
VariableColor=black
Ensure that the color value you supply is in lowercase letters. If you do not use lowercase letters, youwill receive an error in your CompuSet log. The default color is black.
The PreviewVariableColor property in DistributionController.properties controls the color of yourreplacement variables any time you view a document from the maintenance tab in xDesign, orcall the previewPDF Web Service. For example:
PreviewVariableColor=red
Ensure that the color value you supply is in lowercase letters. If you do not use lowercase letters, youwill receive an error in your CompuSet log. The default color is black.
ecor.properties
The ecor.properties file contains many properties. You can see definitions of these properties in theAdministering the xPression Server guide. The only properties listed here are those that are exclusive toCompuSet.
ofp.properties
The ofp.properties file is not documented in the Administering the xPression Server guide becauseit is exclusive to CompuSet.
The output format processing (ofp) file contains information about CompuSet related files, such as thelog file and default output directory. It also references the files used to execute the various emitters.The installer creates this file upon installation.
Note: If you want to embed Tag Logical Elements (TLEs) in your AFP output file, you must add PDEFcommands to the ofp.properties file. Instructions for this procedure is located in Embedding TagLogical Elements (TLEs) in Your AFP Output File in your xPression CompuSet Reference.
34
The xPression Server
A sample ofp.properties file is shown below:
xPressionTempDir=[drive:][path]\\xPression\\CompuSet\\temp\\xPressionOutputDir=[drive:][path]\\xPression\\CompuSet\\output\\xPressionLogDir=[drive:][path]\\xPression\\CompuSet\\log\\xPressionFontDefinitionDir=[drive:][path]\\xPression\\CompuSet\\FontDefinition\\xPressionFormatDefinitionDir=[drive:][path]\\xPression\\CompuSet\\FormatDefinition\\UnPackFolder=[drive:][path]\\xPression\\Unpacked\\msgDatabaseFileLocation=[drive:][path]\\xPression\\CompuSet\\xicsmsg.mdbhyphDictFileLocation=[drive:][path]\\xPression\\CompuSet\\newhdc.cnfcom2ejbbridgeproperties=[drive:][path]\\xPression\\com2ejbbridge.propertiesCompuSetLogEnabled=true
# Content Repository CompuSet Support# Paths must be platform dependentDCLib1="C:\\xPression\\CompuSet\\NULL.dcl"DCLib2="C:\\xPression\\CompuSet\\NULL.dcl"DCLib3=CR# Windows Emitter Definitions (uncomment to activate)PDFEmitter=[drive:][path]\\xPression\\CompuSet\\pdfemitter.batPCLEmitter=[drive:][path]\\xPression\\CompuSet\\pclemitter.batPostScriptEmitter=[drive:][path]\\xPression\\CompuSet\\postscriptemitter.batAFPEmitter=[drive:][path]\\xPression\\CompuSet\\afpemitter.batMetacodeEmitter=[drive:][path]\\xPression\\CompuSet\\metacodeemitter.batTwoPassBufferSize=2048# Unix/Solaris Emitter Definitions (uncomment to activate)#PDFEmitter=/xpression/CompuSet/pdfemitter.sh#PCLEmitter=/xpression/CompuSet/pclemitter.sh#PostScriptEmitter=/xpression/CompuSet/postscriptemitter.sh#AFPEmitter=/xpression/CompuSet/afpemitter.sh#MetacodeEmitter=/xpression/CompuSet/metacodeemitter.sh
# AFP Indexing for TLE Requirements##AFPIFLD1=IFLD 1,1,1,1,1,1,1,1,1,1,1,,,,,,,,,,,,,,, AFP INDEX 1#AFPINDX1=INDX 1,0,'Identifier',,,,,,,,,,,,,,,,,,,,,,,#AFPIFLD2=IFLD 2,1,1,1,1,1,1,1,1,1,1,,,,,,,,,,,,,,, AFP INDEX 2#AFPINDX2=INDX 2,0,'DDName',,,,,,,,,,,,,,,,,,,,,,,#AFPIFLD3=IFLD 3,1,1,1,1,1,1,1,1,1,1,,,,,,,,,,,,,,, AFP INDEX 3#AFPINDX3=INDX 3,0,'DocumentType',,,,,,,,,,,,,,,,,,,,,,,#AFPIFLD4=IFLD 4,1,1,1,1,1,1,1,1,1,1,,,,,,,,,,,,,,, AFP INDEX 4#AFPINDX4=INDX 4,0,'Other',,,,,,,,,,,,,,,,,,,,,,,
## compact CCFCompactCCF=falseCompressCCF=false#log#CSetReturnAsInfo=1#When this setting exists and is true, a missing report file (for PDL email) willbe ignored.IgnoreMissingEmail=true#TwoPassBufferSize=2048EnableMergeLibOverride=true#deleteScratch=true
The following table lists the available parameters for this properties file.
35
The xPression Server
Property Definition
xPressionTempDir Temporary files generated during the composition and emitter stepswill be saved to this directory. These files need to be manually deletedfrom the system as part of a daily maintenance program.
xPressionOutputDir This is the default output directory for files using the CompuSetcomposition engine. This directory will be used if no other path isspecified on the CompuSet Distribution Definition page in xAdmin.
xPressionLogDir All CompuSet and emitter log files are written to this location.
xPressionFontDefinitionDir The location of the CompuSet widths, configuration and font databasefiles.
xPressionFormatDefinition-Dir The location of the printer definition files (PDEFs) for the emitters.
UnPackFolder When output has been distributed in HTML format, this is the locationwhere the HTML will be unpacked.
msgDatabaseFileLocation The location of the CompuSet and emitter message database file.
hyphDictFileLocation The path and filename of the hyphenation dictionary used to hyphenatewords when this feature is enabled for CompuSet.
com2ejbbridgeproperties xPression enables for multiple xPression installations on a singleserver. This parameter indicates where to find the appropriatecom2ejbbridge.properties file for this particular installation.
CompuSetLogEnabled This parameter enables you to disable the logging feature for CompuSet.Document Sciences recommends that this parameter be set to true toenable easier debugging using the CompuSet log.
DCLib1 Merge library 1 used by CompuSet and the emitters. This typicallypoints to a file titled NULL.dcl, which is an empty file.
DCLib2 Merge library 2 used by CompuSet and the emitters. This typicallypoints to a file titled NULL.dcl, which is an empty file.
DCLib3 Merge library 3 used by CompuSet and the emitters references thexPression database, where all images are stored
PDFEmitter The emitters are delivered as executables and must be passedparameters from the java code. This is the path and filename of the batchfile or shell script used to pass the parameters and run the PDF emitter.
PCLEmitter The emitters are delivered as executables and must be passedparameters from the java code. This is the path and filename of the batchfile or shell script used to pass the parameters and run the PCL emitter.
PostScriptEmitter The emitters are delivered as executables and must be passedparameters from the java code. This is the path and filename of thebatch file or shell script used to pass the parameters and run thePostScript emitter.
AFPEmitter The emitters are delivered as executables and must be passedparameters from the java code. This is the path and filename of the batchfile or shell script used to pass the parameters and run the AFP emitter.
36
The xPression Server
Property Definition
MetacodeEmitter The emitters are delivered as executables and must be passedparameters from the java code. This is the path and filename of thebatch file or shell script used to pass the parameters and run theMetacode emitter.
TwoPassBufferSize Sets the size of the two-pass buffers. Any value greater than 0 isallowed, but values less than 1024 are not recommended. Althoughthis property does not appear in this properties file by default, thetwo-pass buffer size is automatically set to 1024. This property shouldonly be added to this file if you intend to set the two-pass buffer size tosomething other than 1024.
CompactCCF This function effectively increases the CCF size limit to 16GB. Theuncompressed CIF size must still remain below 4 gigabytes. Acompacted CCF uses a smaller data structure for a CIF record, so iteffectively gives you a 16GB CIF.
If the CCF file may exceed the 4GB limit you can set this propertyto TRUE to reduce the CIF file size. This property can be used incombination with CompressCCF if required. This property is FALSEby default.
CompressCCF This function reduces the file size of the CCF. The benefit of thisfeature is that the CIF uses less disk space, and will result in betterperformance for larger files. To activate this function, set the value totrue: CompressCCF=true
CSetReturnAsInfo This property determines whether the error messageCompuSetComposer : return value for csetCompose()is ‘n’ is reported as INFO or DEBUG. If null, the message is returnedas DEBUG, if set to any value the message is returned as INFO.
IgnoreMissingOutput You may want to create a scenario where your output profile containsmore than one print output stream, but may not publish all outputstreams each time. By default, xPression will create an error to warnyou that one or more of your output streams failed to produce output.To disable this warning for print output, add the following setting andvalue to the ofp.properties file located in your xPressionHome directory.
IgnoreMissingEmail You may want to create a scenario where your output profile containsmore than one Email output stream, but may not publish all outputstreams each time. By default, xPression will create an error to warnyou that one or more of your output streams failed to produce output.To disable this warning for Email output, add the following setting andvalue to the ofp.properties file located in your xPressionHome directory.
37
The xPression Server
Property Definition
EnabledMergeLibOverride When a CompuSet job is running, the global merge libraries are locked.This prevents users from updating the merge library while the emitteris running.
xPression now enables you to define a different set of merge libraries touse while running your job, ensuring that your global merge librariesremain accessible.
The new merge libraries are defined in the xAdmin FormatDefinition page, but you must first enable this functionality by settingEnableMergeLibOverride=true.
deleteScratch When set to true (default), this parameter enables xPression to delete allxPression temporary files provided that no errors exist in the temporaryfiles. If errors are recorded in the temporary files, the files are preserved.When set to false, all temporary files are preserved.
When attempting to run a job with e-mail distribution for a CompuSetdocument with this property set to TRUE (default) an error occursand the attempt to send the e-mail fails. When distributing CompuSetdocuments by e-mail deletescratch should be set to FALSE.
MaxOVWidth When activated, this property sets the maximum width of an outputvariable. Please set this value to match the largest field size in yourdata sources. If you set this value too low, xPression will cut off anyvariables that exceed that length. Please use caution when activatingthis property. The property is “commented out” by default.
38
The xPression Server
Property Definition
MaxOVWidth (Con’t.) The ofp.properties file now includes an optional MaxOVWidthproperty. The property should be enabled if any of the followingconditions apply:
• If you are publishing CompuSet documents in transactional mode
• If you are using many output variables in your documents
• If the application that calls xPression WebService/Framework inTransactional Mode is run in Batch
• If any of the output variables are mapped to many data sources orany data source schema is large
If so, then set MaxOVWidth=128. You can delete the pound signpreceding this line to invoke the property.
For more information about when to use this feature, please see thexPression CompuSet Reference.
KeepZeroByteReports A zero-byte report file is generated when reporting is turned on and norecords are output in a CompuSet job. By default these files are deleted.To retain these zero-byte report files, this property to ofp.properties.
If the value of KeepZeroByteReports is not TRUE, or the property is notpresent, zero-byte report files will be deleted. As with any property filechange, restart the server after adding the new property.
revise.properties
The replaceVariables property is ignored for all CompuSet documents. The feature is exclusive toxPublish.
Built-In Function ListMost of the material in this section also appears in the xAdmin User Guide. ImportantCompuSet-related information has been added to this section. xPression allows you to defineconditions in the output streams to determine whether or not individual documents should beincluded. An inclusion condition is a Boolean expression comprised of user fields, system functions,string and numeric literals, and operators. This appendix describes the built-in system functions youcan use to create inclusion conditions.
39
The xPression Server
CharData(data,width)
This function converts a piece of string data to a string of a defined width. The data parameter is anOutput Processing expression that evaluates to a string (including a simple character-based OP field).The width parameter is the number of characters of the resulting string. If the data is longer thanthe defined width, Output Processing truncates the resulting string. If the data is shorter than thedefined width, Output Processing adds space characters to the end of the string. The function returnsa string exactly as long as the defined width.
This function enables you to modify string data to control trailing spaces. For example, if an addressis to be represented in a bar code and must occupy 25 spaces, but the value of the address uses fewerspaces (for example: "123 Main Street"), you can use this function to place trailing spaces:
CharData(address,25)
CurrentDate()
Valid for CompuSet Barcode page conditions, CompuSet Barcode package conditions, CompuSetoutput stream inclusion conditions, CompuSet output stream package reporting, CompuSet Barcodedata, and xPublish content stamp data.
The date functions allow you to conditionally include a document within your output based on adate parameter. For example, if you wanted to create documents whose legal effective date was thecurrent date, then you could use a rule such as:
EffectiveDate = CurrentDate()
This function returns a number representing the current date in the format YYYYMMDD. You cancombine this function with the Year(), Month (), and Day() functions to get the current year, month, orday only.
Current Page Count of the Package(counting)
Valid for xPublish content stamp page conditions, xPublish content stamp data, CompuSet Barcodepage conditions, and CompuSet Barcode data.
This function allows you to determine the current page number within a document (package). Thismight be used to determine whether special action should be taken. For example, in an insurancepackage, if a special bar code needs to be placed on the first page of the document, then you could usea condition such as:
Current Page Count of the Package(2) = 1
Page counting always starts with 1 on the recto side. Therefore, counting in recto mode returns thecurrent number of odd pages and counting in verso mode returns the current number of even pages.
The counting parameter takes the following values:
Define 0 to count the recto sides of the paper only.
Define 1 to count the verso sides of the paper only.
40
The xPression Server
Define 2 to count both the recto and verso sides of the paper.
If the current page is the first page, and you define the counting method as verso (1), the functionreturns 0, as no verso pages have been counted.
xPublish also provides separate functions to return recto and verso pages.
Current Recto Page Count of the Package
Valid for xPublish content stamp page conditions and xPublish content stamp data.
This xPublish function returns the number of the current recto page in the package. It is equivalent tothe CompuSet CurrentPageInPackage(0) function.
Current Verso Page Count of the Package
Valid for xPublish content stamp page conditions and xPublish content stamp data.
This xPublish function returns the number of the current verso page in the package. It is equivalent tothe CompuSet CurrentPageInPackage(1) function.
Current Package Count of the Partition
Valid for xPublish content stamp data.
Current Package of Current Partition
Valid for CompuSet bar code data. This function returns the position or current document number ofa document within a stream. This could be included as one of the fields to be output in a report file.This enables you to see the position or document number of every document. Another use of thisfunction might be to get the total document count.
Current Recto Page Count of the Partition
Valid for xPublish content stamp data.
Current Verso Page Count of the Partition
Valid for xPublish content stamp data.
41
The xPression Server
Current Page Count in the Partition
Valid for CompuSet bar code data, xPublish content stamp data.
Current Page Count of the Stream
Valid for xPublish content stamp data.
Current Recto Page Count of the Stream
Valid for xPublish content stamp data.
Current Verso Page Count of the Stream
Valid for xPublish content stamp data.
CurrentPageOrientation()
Valid for CompuSet bar code page conditions, CompuSet bar code data, and xPublish content stampdata.
This function determines the current page orientation. This allows you to perform such tasks asdetermine the proper orientation for a bar code to be placed on the page. For example, if the page inlandscape format, and you need a landscape bar code, you could use the condition:
CurrentPageOrientation() = 2
For pages within a merge document, this function returns the orientation of the first page onto whichthe document was merged.
The return values are:• 1 - portrait
• 2 - landscape
• 3 - inverse portrait
• 4 - inverse landscape
CurrentPageSequenceName()
Valid for CompuSet bar code page conditions.
42
The xPression Server
This function returns the name of the page sequence that the current page belongs to. xPressionreturns the name as a string in all uppercase letters.
For example:
CurrentPageSequenceName()=?IDCARD?
Instructs Output Processing to place bar codes only on a page sequence called ?IDCARD".
When used as a Page Condition function it enables you to conditionally place your barcode oncertain pages.
Current Partition File Name
Valid for CompuSet output stream partition reporting.
Current Sheet Count of the Package
Valid for xPublish content stamp page conditions, and xPublish content stamp data.
This xPublish function returns the number of the current sheet in the package. It differs from theCurrent Page in Package function in that it returns the physical number of sheets without regard fordistribution of recto, verso, or phantom pages.
Current TimeMillis
Valid for xPublish content stamp data.
DataWidth(data)
This function returns the number of characters used to represent a piece of data. The dataparameter can be any Output Processing expression that evaluates to a string (including a simplecharacter-based OP field).
The DataWidth(data) allows you to evaluate the width of a string, for example, the length of anaddress or name. One use for this is to separate out documents whose address or name is too long tofit in an envelopes window. For example, an inclusion condition might be: DataWidth(MyAddress)
Day(date)
Valid for CompuSet bar code page conditions, CompuSet bar code package conditions, CompuSetoutput stream inclusion conditions, and CompuSet bar code data.
This function returns a number representing the day within a month (1–31).
43
The xPression Server
Month(date)
Valid for CompuSet bar code page conditions, CompuSet bar code package conditions, CompuSetoutput stream inclusion conditions, and CompuSet bar code data.
This function returns a number representing the month (1–12). The date parameter is a numericvalue that contains a date in the format YYYYMMDD. You can use this function to separate outputfor organizational or archiving purposes. For example, if you wanted all documents for the monthof May, then you could use:
Month(YourDateField) = 5
NumData(data,width,decimals)
This function allows you to place numeric data as a string and allows you to control leading andtrailing zeroes and the decimal point. For example, if an account number is to be represented in abar code and must be represented with 9 zeroes, but if the account number is passed as "12345", youcan use this function to place leading zeroes:
NumData(AccountNumber,9,0)
The data parameter is an Output Processing expression that evaluates to a number (including a simplenumeric OP field). The width parameter is the number of characters of the resulting string. Thisparameter can include the negative sign and decimal point, if applicable. The decimals parameter is thenumber of digits to the right of the decimal place in the resulting string. If decimals is 0, then OutputProcessing does not include the decimal point itself in the resulting string. This function returnsa string exactly width characters long, with decimals number of decimal places. In addition, theresulting string contains leading and trailing zeros as needed to force the correct width and decimals.
If the width you define is not large enough to store the data, Output Processing removes the leastsignificant decimal places, truncating the resultant data. NumData(12.346 + .005, 4, 2) = 12.35
Tip: If you want the result to be a rounded value, add the appropriate value to the data for roundingto occur in the OP expression. For example, if the data evaluates to three decimal places and youwant the result to have two decimal places, adding .005 to the expression rounds up the seconddecimal place.
TotalPagesInPackage(0|1|2)
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish output stream inclusion conditions, xPublish content stamp data, xPublish separator sheetinclusion conditions, CompuSet bar code page conditions, CompuSet bar code package conditions,CompuSet output stream inclusion conditions, CompuSet output stream package reporting, andCompuSet bar code data.
This function returns the total number of pages in the current package. The parameter indicateswhether the page count contains recto pages only (0), verso pages only (1), or both (2). You cancompare the result of this function to a literal value, a variable, or the value of another function.
44
The xPression Server
The TotalPagesInPackage function allows you to conditionally include a document within youroutput based on the number of pages in the document. This is often used to separate a streaminto different files in order to accommodate finishing equipment. For example, in a run of 10,000customers, some customers might have documents that exceed 10 pages. Those documents mightrequire a manual process if a folding machine cannot accommodate that many pages for an envelope.In this case, we would use a condition such as:
TotalPagesInPackage(0) <= 10
xPublish provides separate functions for total Recto and Verso page counts, but is otherwise the sameas the CompuSet function.
Total Recto Pages in Package
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish output stream inclusion conditions, xPublish content stamp data, and xPublish separatorsheet inclusion conditions.
This function returns the total number of recto pages in the package. It is available for xPublishonly, and works the same way as the CompuSet TotalPagesInPackage(0) function. The result of thisfunction can be compared to a literal value, variable, or the result of another function.
Total Verso Pages in Package
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish output stream inclusion conditions, xPublish content stamp data, and xPublish separatorsheet inclusion conditions.
This function returns the total number of verso pages in the package. It is available for xPublishonly, and works the same way as the CompuSet TotalPagesInPackage(1) function. The result of thisfunction can be compared to a literal value, variable, or the reslult of another function.
Total Paper Thickness of Package(mm), Total PackageThickness(mm)
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish output stream inclusion conditions, xPublish content stamp data, xPublish separator sheetinclusion conditions, CompuSet bar code page conditions, CompuSet bar code package conditions,CompuSet output stream inclusion conditions, CompuSet output stream package reporting, andCompuSet bar code data.
This function returns the total thickness in millimeters of the paper in the package. TheTotalPagesInPackage function allows you to conditionally include a document within your outputbased on the thickness of the document. This is often used to separate a stream into different filesin order to accommodate finishing equipment. For example, in a run of 10,000 customers, somedocuments might have too many pages (i.e. too great of thickness) for the finishing equipment to
45
The xPression Server
handle. Those documents might require a manual process. In that case, we would use a conditionsuch as:
TotalPaperThicknessInPackage() <= 2
where "2" is the thickness in millimeters.
In xPublish, this function is called “Total Package Thickness (mm).”
Total Paper Weight of Package(g)
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish output stream inclusion conditions, xPublish content stamp data, xPublish separator sheetinclusion conditions, CompuSet bar code page conditions, CompuSet bar code package conditions,CompuSet output stream inclusion conditions, CompuSet output stream package reporting, andCompuSet bar code data.
This function returns theweight in grams of the paper in the package. The TotalPaperWeightInPackagefunction allows you to conditionally include a document within your output stream based on theweight of the document. This is often used to separate a stream into different files in order toaccommodate mailing costs. For example, in a run of 10,000 customers, some customers might havedocuments that exceed N grams in weight, where N is a specified number in the inclusion condition.Those documents might require a manual process or a different mailing process due to the weight. Inthat case, we would use a condition such as:
TotalPagesInPackage(0) <= 20
where "20" is the weight in grams.
Total Sheets in Package
Valid for xPublish content stamp page conditions, xPublish content stamp package conditions,xPublish content stamp data, xPublish output stream inclusion conditions, and xPublish separatorsheet inclusion conditions.
This function returns the total number of sheets in the package. It differs from the Total Pagefunctions in that it provides the physical number of sheets in the package without regard to thedistribution of recto, verso, and phantom pages. Use this function when you need to identifypackages that require special handling due to the number of sheets that they use.
Year(date)
Valid for CompuSet bar code page conditions, CompuSet bar code package conditions, CompuSetoutput stream inclusion conditions, and CompuSet bar code data.
This function returns a number representing the 4-digit year. The date parameter is a numeric valuethat contains a date in the format YYYYMMDD. You can use this function to separate output for
46
The xPression Server
organizational or archiving purposes. For example, if you wanted all documents for the monthof May, then you could use:
Month(YourDateField) = 5
47
The xPression Server
48
Chapter 5CompuSet and xAdmin
xAdmin is the browser-based administration console that enables you to easily configure andmaintainall aspects of the xPression system from any Web-enabled client connected to your network. As thesystem administrator, xAdmin will be the tool you use to administer your xPression environment.
xAdmin organizes administrative tasks into six menus located on the xAdmin menu. From thesemenus you can organize similar documents into categories, administer your data sources, createsets of attributes on which to qualify your documents for assembly, manage resources like imagesand fonts, define your output format, configure printer settings, create output scenarios, migratedocuments, and administer your server. xAdmin does not support concurrent users. While morethan one user may log in to xAdmin, it is not recommended because changes made by one user couldoverwrite the changes made by another concurrent user.
Category ManagementThe CompuSet-only features of Category Management are described below.
CompuSet Conversion Options Tab
If you are publishing your document with CompuSet, you can set up a variety of CompuSet optionsthat effect the way xPression and CompuSet compose your documents. See Categories: CompuSetConversion Options Tab for more information.
The CompuSet Conversion Options are meant for expert CompuSet users who want to override theautomatic HTML to CompuSet conversion results with their own embedded CompuSet commands.CompuSet conversions options are not required. To view the CompuSet Conversion Optionstab, click Category Management, then click Categories, click your category name, and click theCompuSet Conversion Options tab.
The CompuSet Conversion tab lists a number of options that you can select. Options selected hereapply to all CompuSet-based documents in the category.
49
CompuSet and xAdmin
The CompuSet Conversion Options page contains the following options.
Conversion Option Description
Generate Only Single-PassCompuSet Commands
CompuSet operates in “two-pass” mode by default. Two-pass mode requiresCompuSet to execute twice for each document it processes. Many CompuSetfunctions, like Page n of m (also called Page x of y), require two passes. Thisconversion option tells xPression Design not to generate two-pass commandsand command syntax. If you use two-pass CompuSet commands apart fromtwo-pass mode, you’ll get errors in the CompuSet log, and be unable to get aCompuSet return code of 0.
Generate No Style File TagDefinitions for Word Styles
This option defines all paragraph and character formatting through in-lineCompuSet commands. By default, xPression Design defines some of theformatting associated with these styles through these tags. Use this option toreduce the amount of CompuSet counters used by the conversion. xPressionDesign defines CompuSet tags for each Word paragraph style and each Wordcharacter style.
Omit Direct Coded NPCommands Derived fromWord Formatting
This option omits user-specified new page commands, except for those specifiedby a Word paragraph style. Select this option if you need a “galley-mode” print(all the available vertical space on every page is filled), or if you need to controlpage breaks and NP command parameters.
This option omits user-specified or Word default NP (or NPR or NPV)commands specified at:
• Page-breaking section breaks
• Page breaks
• Paragraphs marked with the Page break before feature
When using this option with a document that will be published through xRevise,xRevise will display an extra blank page at the beginning of your document. Thisblank page will be removed when publishing or viewing the output. You cansuppress this blank page in xRevise by designating the document-initial pagebreaking section as “hidden”. However, this action will suppress headers andfooters on the first page of the document in xRevise. The headers and footerswill appear in the output as expected.
Allow CompuSet to BreakRows Across Pages
By default, Word table rows don’t split across pages by default. You can forceindividual rows to split across a page by selecting Allow row to break acrosspages in the Table Row Properties. Unfortunately, Word doesn’t save thisinformation when it creates an HTML version of your content item. As a result,xPression Design can’t tell when a row has been set up in Word to break acrosspages. By default, xPression Design maps Word tables to CompuSet constructsthat don’t allow any table rows to break across pages. With this option selected,xPression Design maps tables to CompuSet constructs that allow all table rowsto break across pages.
50
CompuSet and xAdmin
Conversion Option Description
Use Word’s PaginationSettings for Widow/OrphanControl
By default, xPression Design ignores the Microsoft WordWidow/Orphancontrol and Keep lines together settings, and doesn’t automatically generateCompuSet widow specifications. If you select this option, xPression Designgenerates CompuSet widow specifications for each paragraph outside ofheaders, footers, and tables. Specifically, paragraphs for which you specifiedWidow/Orphan control will include <WS,2,2> and <WS,63,63> in the setup ofparagraphs for which you specified Keep lines together.
Generate Paragraph StyleTags Only
If you select this feature, xPression ignores character styles and direct formatting.Only the formatting defined in paragraph style tags gets converted to CompuSet.
Treat Consecutive SpaceCharacters As if They WereJust a Single Space
By default, xPression ignores strings of consecutive space characters in adocument when it encounters them. For example, if you type two spaces after asentence-ending period, xPression “sees” both spaces. This option enables youto override this behavior and make xPression treat occurrences of consecutivespaces as a single space. If you enable this option, the two spaces after the perioddescribed in the previous example would be converted to one.
Do Not Initialize the Page Nof M Two-Pass Buffer OffsetCounter in the Style File
By default, the CompuSet counter used to monitor position in the “Page N of M”two-pass buffer is initialized at the beginning of each document. However, if youselect this option and you’re using xPression batch to produce your documents,the page N of M two-pass buffer offset counter will not be reset at the beginningof each document. This option is needed if you are two-pass processing withxPression batch. You can also set the size of the two-pass buffer by adjusting theTwoPassBufferSize parameter in the ofp.properties file. For more information,see ofp.properties in the Property Files chapter of the Administering the xPressionServer guide. Note that the Page N of M feature is sometimes referred to as“Page X of Y.”
Do not remove emptyparagraphs in otherwiseempty sections
Retains empty paragraphs in otherwise empty sections. This selection canprevent spacing differences between different CompuSet versions for the sametext.
Begin Each Document on anOdd/Recto Page
This option ensures that your instantiated document begins on an odd/rectopage, a very useful feature in batch duplex printing processes that printdocuments one after another. xPression Design generates an NP command atthe beginning of each document by default. If you select this option, xPressionDesign will instead generate an NPR command.
The Omit document-initial NS/NP commands option overrides this option.
Omit Document-InitialNS/NP Commands
This option omits the New Section and New Page commands that xPressionDesign automatically inserts at the beginning of each content itemwhen it definesthe DLSDOC tag. Select this option if you want to insert custom documentinitialization commands at the beginning of the first content item in a xPressionDesign document, or if you need to insert commands that must occur before theNP command, such as the paper tray or duplex commands. You must insert therequired NS and NP commands for your next document to begin properly.
When using the ‘Omit document initial NP’ CompuSet Conversion Option,xRevise will display an extra blank page at the beginning of your document. Thisblank page will be removed when publishing or viewing the output. You can
51
CompuSet and xAdmin
Conversion Option Descriptionsuppress this blank page in xRevise by designating the document-initial pagebreaking section as “hidden”. However, this action will suppress headers andfooters on the first page of the document in xRevise. The headers and footerswill appear in the output as expected.
Use Word-ComputedValues for Numbered Lists
CompuSet and Microsoft Word handle numbered lists differently. For example,Word alphabetical numbered lists use aa, bb, cc, after the letters a through z areused. CompuSet uses aa, ab, ac. Use this option to retain Microsoft Word valuesfor numbered lists instead of using CompuSet counters. The recommendedapproach to all numbering is to use Microsoft Word’s SEQ field.
Determine Line FeedsThrough Paragraph Settings
When xPression Design generates CompuSet coding for a paragraph, it specifiesthe line feed for that paragraph only once, at the beginning of the paragraph. Bydefault, xPression Design determines the line feed for a paragraph by examiningboth paragraph level settings (including explicit settings for Line spacing aswell as point size), and paragraph-initial character level point size settings.If you select this option, xPression Design disregards all paragraph-initialcharacter level point size settings, and bases the line feed for the paragraph onparagraph-level settings alone.
Restart Numbered ListsOnly Where SpecifiedThrough Word
By default, xPression Design attempts to reset the counter it uses for numberedlists to mirror the way Microsoft Word automatically resets its numbered lists. Ifyou select this option, xPression Design will not attempt to automatically resetnumbered list numbering. If you manually reset your numbered lists in Word,xPression Design will still perform a corresponding reset of the appropriateCompuSet counter; only the implied resets will be inhibited. The recommendedapproach to all numbering is to use Microsoft Word’s SEQ field.
By Default, Align LeftmostCell Border at Left Margin
This setting ensures that your cell borders will not extend beyond the left pagemargin.
Disregard shadingpercentages (map all celland paragraph shading tomedium)
xPression supports four grades of shading when publishing through CompuSet:sparse, medium, dense, and solid:
• Shading of less than 20% maps to CompuSet sparse shading.
• Shading of at least 20% and at most 80% maps to CompuSet medium shading.
• Shading of more than 80% maps to CompuSet dense shading.
• Shading with no specified percentage maps to CompuSet solid shading.
Select this option to force all shading selections to map as CompuSet mediumshading.
Define Tray Pulls in aContent Item SeparateFrom the Content Item ThatDefines Other Section-LevelFormatting – xPressionBatch Only
By default, all section-level formatting is defined in a Microsoft Word sectionlocated in a single content item. This CompuSet Conversion option enables youto define tray pull information in a content item separate from the content itemthat contains the section-level formatting. This enables you to use separate setsof users to manage your tray pulls and your section-level formatting.
52
CompuSet and xAdmin
Conversion Option Description
For emitters that support it,set cell/ paragraph shadingbelow cell/paragraphborders.
xPression generates cell and table shading in such a way that the shadingcan overlap and obliterate the cell or table borders for PDF and PostScriptoutput. This occurs because the shading is output after the borders are alreadydrawn. This option sets parameter 9 to a value of 5 for each SVR command thatimplements table cell shading. This parameter controls the output order priority.When p9=5 cell shading is implemented first, which will prevent the shadingfrom overlapping the cell and table borders.
Omit Vertical SpacingCommand Between MergedRows
This option eliminates the half-point space that is placed between merged rows.
Let header and footerchanges occur aftercontinuous section breaks(effective next page)
Allows changes in the header and footer to be made following continuoussection breaks. When this option is not selected, the header and footer will repeatpast continuous section breaks even if a header or footer change is indicated.
Honor not-first-pageheaders/footers whenomitting NS/NP commands
When selected, headers and footers are honored when Different First Page isselected and New Section / New Page commands are omitted.
Do not adjust table cellwidths in a row to fit anexplicit table width
Use this option to prevent changing tab column width during the upgrade.Changing the column widths may result in misaligned or misformatted text.
Do not add extraspacing within a tableto accommodate a tablebottom border
This conversion option is used to address an issue that occurs under certaincircumstances when upgrading from a version of DLS to 9.4. It is possible that a<sp,3> command is omitted from the table header definition. This causes the firstrow of the table to be too close to the horizontal rule of the table border whenthe header is repeated on pages after the first page. The problem is not notedon the first page. To avoid this, a space is automatically. Invoke this option tosuppress automatically adding the space.
When a table comes at theend of a header/footer,generate no vertical spacefor the unavoidable emptyparagraph after that table
An empty paragraph always follows a table, so extra vertical space is generatedby default to accommodate the empty paragraph. Choose this option to preventgenerating the additional space.
Resource ManagementYou cannot manage CompuSet images and fonts through xAdmin. Only output variables, ECMconfiguration, user exits, and track changes are supported for CompuSet.
53
CompuSet and xAdmin
Using JPEG Images in AFP Output
In order to merge a JPEG image into an AFP output file, you must tell the AFP emitter that the AFPprinter is a color printer. The AFP emitter will never merge a JPEG for a black and white printer. Toresolve this problem, you must add the following command to the Pdef file for the job:
FTYP 13,0,2,,
This will enable color and the emitter’s ability to merge a JPEG.
It is also advisable to set OPTN p6 = 4. This will request that the AFP emitter define images asresources, so that the images are embedded in the AFP output file only once. This will improvethe printer’s performance.
Refer to the CompuSet AFP Emitter Guide, in the CompuSet eBooks folder of your eBook CD, fordetailed information on the OPTN and FTYP commands and on working with the Pdef file.
CompuSet Output ManagementThe CompuSet Output Management sections contain settings for your output devices, output formatchoices, printer functions, barcode and content stamps, output streams, distribution definitions,and output profiles. These controls differ for each of the two composition engines, CompuSet andxPublish.
Before you begin configuring your output management settings, ensure that you are using the correctoutput management menu. The CompuSet Output Management and xPublish Output Managementmenus contain very different settings. xPression’s highly customizable output process centers aroundthree sets of information.
54
CompuSet and xAdmin
How will you format your documents?
This information determines how your documents look and how they are presented. xPressionrequires CompuSet users to specify which fonts and which output formats (PDF, PostScript, AFP,PCL, Metacode, HTML, Web Archive) to use. Document Sciences recommends that you configurethese settings before designing your products.
How will you publish your documents?
xPression documents are published through output streams. Each stream is a collection of documentsthat share similar output properties. Each stream is associated with a defined recipient group(streams can also be applied to ALL recipients). You can qualify or disqualify documents for thestream by setting up inclusion conditions.
You can also perform output processing on the documents in the stream. For example, you cansort and group the documents, create copies, set up simplex of duplex printing, add barcodes, andconfigure xPression to create reports on the documents in your stream as they are processed.
How will you distribute your documents?
You must configure a distribution definition that provides xPression with information about yourdistribution mode and distribution device (for example, a print device, e-mail server, or archivesystem).
xPression combines this information to create a customized output solution for each set of documentsyou want to process. Now, let’s take a more in-depth look at the output management settings forCompuSet.
An In-Depth Look at CompuSet Output Management
The CompuSet Output Management options were designed with a “define it once, apply it manytimes” philosophy. The output scenario for any given xPression document must take into accountthe document format, the document recipients, and the document distribution mode. xPressionstores these settings separately, enabling you to mix-and-match and reuse these settings to createcustomized output scenarios based on your specific output needs.
55
CompuSet and xAdmin
The following graphic shows how output managementsettings merge to create an output profile for your documents
.
About Font and Format Definitions
Font information resides in a font definition. The graphic in the previous section shows that a fontdefinition, by itself, is not a part of an output profile. While created independently, the font definitionis referenced in the output profile from the format definition. The format definition stores settings forspecific output formats (for example PostScript, AFP, or PDF). It also references a single font definitionfor the purpose of bringing in a set of fonts. The separation of the font and format definitions enablesyou to use the same set of fonts with different types of printers and different PDEF files.
Think of your format definitions as font/format pairs. Each format definition is tied to a fontdefinition, but font definitions can be reused by any format definition. This enables you to havemultiple format definitions for the same format, each using different font information. Aside from thefont definition, the settings include the definition name, the PDEF file location, and the output format.For more information, see Font Definitions, page 62 and Format Definitions, page 64.
About Distribution Definitions
Distribution definitions provide xPression with specific information for your distribution devices.Supported output devices are e-mail servers, print devices, and archive systems. The distributiondevices supply xPression with enough information to connect to and provide output to yourdistribution devices. For more information, see Distribution Definitions, page 68.
56
CompuSet and xAdmin
About Output Streams
Output Streams supply documents to your output profile. You use inclusion conditions to qualify ordisqualify documents for the stream. You can use more than one stream in an output profile, enablingyou to send multiple sets of documents to multiple distribution devices.
You can also use multiple streams to send the same set of documents to different recipients orproduce the same set of documents in a different format.
You can perform output processing on the documents in a stream such as sorting, grouping, recipientprocessing, simplex/duplex designation, barcodes, and reporting. For more information, see OutputStreams, page 93.
About Output Profiles
An output profile joins this information together to create a customized output solution. xPressionBatch, xDesign, and xResponse call upon an output profile when processing documents. For moreinformation, see About Output Profiles, page 57.
Working with the Expression Editor
On many of the CompuSet Output Management pages that you will work with in xAdmin EnterpriseEdition, you will see a browse button next to an entry box that, when clicked, opens the ExpressionEditor. The link appears for many expression entry boxes. The Expression Editor feature enables youto create complex and customized expressions.
You can create an expression in the edit box on the page, and then modify it in the Expression Editor,or you can create the expression entirely in the Expression Editor.
Note: Expressions created in the Expression Editor, or entered on any page are not validated byxAdmin. You must ensure that your expression is valid to avoid errors during publishing.
The Expression Editor Interface
The main part of the Expression Editor dialog box is the Content Expression edit box, which enablesyou to define an expression that will generate a value for the specific option. You can use outputvariables, system variables, system functions, and literal text (enclosed in single quotes (’)) to createyour expression. For a list of supported operators, see Supported Operators, page 62. Specific keycombinations help you to build your expression:
• Ctrl+Alt+O. Displays a drop-down list of output variables defined on the server. Select thevariable you want to include and it will appear at the location of the cursor. For more information,see the xAdmin User Guide.
• Ctrl+Alt+V. Displays a drop-down list of system variables. Select the system variable that youwant to include, and it will appear at the location of the cursor. For more information, see thexAdmin User Guide.
57
CompuSet and xAdmin
Not all system variables are useful in every situation. xPression doesn’t limit the use of systemvariables; all variables are available for selection all the time. Ensure that the system variable youinsert is useful for the specific situation. System variables are meaningless in HTML output.
• Ctrl+Alt+F. Displays a drop-down list of system functions. Select the function that you want toinclude, and it will appear at the location of the cursor. For more information, see the xAdminUser Guide.
The Save button on the dialog box saves your expression, and returns you to the previous page inxAdmin. The Cancel button returns to the previous page without saving any of the changes made inthe Expression Editor.
Page and Document Condition Options
xPression keeps track of information at four levels of use: document, package, partition, and stream.xPression knows all information about the package at the package level, such as totals. It doesnot know any totals for the partition or stream level unless processing has completed. Therefore,you must be aware when using system functions that relate to totals for the partition and streamlevel, that they should occur at the end of that level, such as in an “End of” separator sheet. Thosevariables will typically have a current count value when not used at the end of the particular levelto which they pertain.
There are other system functions that can be used at any time, and will have a valid value, such asPartitionNo (partition number) and date and time system functions.
Package level totals are known at the time the package is resolved, which occurs before the inclusioncondition of the package for the stream. Therefore, totals relating the package can be reliably usedfor both conditions and data for the package.
58
CompuSet and xAdmin
Keeping all this in mind, be sure to select functions that are appropriate for your situation whencreating your expression. For example, the TotalPagesInPartition function will not return meaningfuldata when used in a package. It will return meaningful data when used at the end of a partition-levelseparator sheet.
The functions names available for selection through the interface are named for clarity, and may notmatch the actual function name exactly. If you are using the Advanced Expression Entry dialog box,you must use the true name of the function (listed in ). You can add the following built-in functions toyour Page Condition:
Default
• Now
• Current Date
• Current Date Time
• Current Time Millis
• Unique Number
• Current Plex
• Is Recto Page
• Is Verso Page
• Is Inserted Blank Page
• Current Page Orientation
• Total Pages in Package
Document Level Functions
• Total Pages in Document
• Total Recto Pages in Document
• Total Verso Pages in Document
• Total Sheets in Document
• Total Blank Pages Inserted in Document
• Total Simulate Blank Pages Inserted in Document
• Current Page Includes Simulate Document
• Current Page in Document
• Current Sheet in Document
• Current Recto Page in Document
• Current Verso Page in Document
• Current Inserted Blank Pages in Document
59
CompuSet and xAdmin
Package Level Functions
• Current Document in Package
• Current Page in Package
• Current Recto Page in Package
• Current Verso Page in Package
• Current Sheet in Package
• Is Last Document of Package
• Is First Page of Package
• Is First Recto Page of Package
• Is First Verso Page of Package
• Is Last Page of Package
• Is Last Recto Page of Package
• Is Last Verso Page of Package
• Total Pages in Package
• Total Recto Pages in Package
• Total Verso Pages in Package
• Total Sheets in Package
• Total Blank Pages Inserted in Package
• Total Simulate Blank Pages Inserted in Package
• Total Package Weight (g)
• Total Package Thickness (mm)
• Current Inserted Blank Pages in Package
Partition Level Functions
• Total Pages in Partition
• Total Recto Pages in Partition
• Total Verso Pages in Partition
• Total Sheets in Partition
• Total Blank Pages Inserted in Partition
• Total Simulate Blank Pages Inserted in Partition
• Current Package in Partition
• Current Document in Partition
• Current Page in Partition
• Current Recto Page in Partition
• Current Verso Page in Partition
60
CompuSet and xAdmin
• Current Sheet in Partition
• Partition Output File Name
• Total Separator Sheets in Partition
• Current Separator Sheet in Partition
• Current Inserted Blank Pages in Partition
• Total Imposed Sheets in Partition
• Current Imposed Sheets in Partition
• Total Stack in Partition
• Current Stack in Partition
• Total Imposed Pages in Partition
• Current Imposed Pages in Partition
• Total Recto Imposed Pages in Partition
• Total Verso Imposed Pages in Partition
Stream Level Functions
• Current Stream Plex
• Partition No
• Current Package in Stream
• Current Document in Stream
• Current Page in Stream
• Current Recto Page in Stream
• Current Verso Page in Stream
• Current Sheet in Stream
• Total Partitions in Stream
• Total Pages in Stream
• Total Blank Pages Inserted in Stream
• Total Sheets in Stream
• Total Separator Sheets in Stream
• Current Separator Sheet in Stream
• Total Simulate Blank Pages Inserted in Stream
• Total Recto Pages in Stream
• Total Verso Pages in Stream
• Current Inserted Blank Pages in Stream
• Total Imposed Sheets in Stream
• Current Imposed Sheets in Stream
61
CompuSet and xAdmin
• Total Stack in Stream
• Current Stack in Stream
• Total Imposed Pages in Stream
• Current Imposed Pages in Stream
• Total Recto Imposed Pages in Stream
• Total Verso Imposed Pages in Stream
Refer to the xAdmin User Guide for specific information about all of the functions.
Supported Operators
You can use the following operators in your expressions.
Symbol Definition Symbol Definition
* Times ! NOT
/ Divide = Equal (string and numeric)
% Modulous != Not equal (string andnumeric)
+ Plus > Greater than
- Minus < Less than
( Open parentheses >= Greater than or equal to
) Close parentheses <= Less than or equal to
Ensure you use “AND” and “OR”, there is no supported symbol for these operators.
Font DefinitionsxPression requires you to create and configure three CompuSet configuration files to enable fonts foreach output format. Once created, you will assign these files to a format specific font definition. If youwant to use a specific font in more than one format, you must create a font definition for each format.
Font definitions are referenced by format definitions and should be created first. Font definitionscontain the following CompuSet configuration files:• Font Database
• Widths File
• Font Mapping File
62
CompuSet and xAdmin
Font Definitions: List Options
Access font definitions by clicking Font Definitions from the Output Management menu. Thefont definition page displays a list of existing font definitions. From this page you can performthe following actions.
Element Name Description
Add Button Enables you to define a new font definition. See Font Definition Options,page 63 for more information.
Copy Enables you to create a duplicate font definition. Select the check box next tothe font definition you want to copy and click Copy.
The Duplicate appears in the font definition list with the words “Copy of”placed before the name of the original font definition.
Delete Deletes an existing font definition. Select the check box next to the fontdefinition you want to copy and click Delete.
Font Definition Name List To edit the settings of an existing item, click the item name.
Font Definition Options
The font definition options are the same for both creating new and updating existing font definitions.The Font Definition options enable you to set up your font definition. Your font definition containsthe following options.
Element Name Description
Font Definition Name The font definition name can be 255 alphanumeric characters in length.
Primary Widths File Name A widths file is a binary file that provides font and character widthmeasurements. All widths files should be stored in the following directory:
\\xPression Server\xPression\CompuSet\Font Definition
When you click Find File, xPression displays all widths files stored in thisdirectory in a pop-up window. To choose a widths file, select the desired fileand then, click Open.
63
CompuSet and xAdmin
Element Name Description
Secondary Widths FileName (AFP only)
This option only applies to full color AFP implementations. Define thisoption if you are creating AFP output that uses PostScript pieces in the AFPfile. You can invoke full color data support for an AFP print data stream thatruns on any IBM full color printer.
The changes to CompuSet processing are the same changes you would maketo invoke full color for any application. The significant change for full colorAFP support is to use a customized batch file. This batch file requires thatyou specify two Configuration/ Widths files: one for managing the PostScriptimages, and one for managing normal AFP processing.
Select from a list of the secondary widths file located on your xPressionserver in the \\xPression Server\CompuSet\font definition directory. Formore information, see the xPression CompuSet Reference.
Font Database File Name A font database is a random access file that resides on your xPression serverand contains the fonts used to create your xPression documents. All fontdatabases should be stored in the following directory:
\\xPression Server\xPression\CompuSet\Font Definition
When you click Find File, xPression displays all the font databases storedin this directory in a pop-up window. To choose a font database, select thedesired file and then, click Open.
Font Map File The font mapping file maps your CompuSet fonts to your Windows fonts.You should have already created a font mapping file that mapped the fontsin your widths file to Windows fonts. Define the name and location of thatfile in the Font Map File box.
This file can exist in any directory on any machine in your network.xPression ships a sample set of font mapping files located in:
\\xPression Server\xPression\CompuSet\Font Mapping
After selecting your font mapping file, click Get Data to register the fontmap information. The font map file path will disappear and the larger textbox will display a list of your mapped fonts. Ensure you click Save whenfinished.
Format DefinitionsThe format definition contains all the information needed to produce the document in a specificformat for a specific output device. It pairs a font definition with a PDEF file and a format type. APDEF file determines format specific characteristics of your output.
You need to create a format definition for each distinct usage of a format. For example, if you wantto use PostScript in more than one font definition or PDEF file, you must create a separate format
64
CompuSet and xAdmin
definition for each combination you want to use. You can access format definitions by clicking FormatDefinitions from the CompuSet Output Management page.
Multiple Formats
If you need to publish the same document in more than one format (for example, one copy is sent inPDF form to an archive system and another is sent to a PostScript printer), create a format definitionfor each format, and use output profiles to create two streams of the same document. One streamshould go to the archive system, the other should go to the printer.
If you are printing the same document in two different formats, ensure your widths file has the fontsloaded in the same order. CompuSet uses a font number, which is assigned within the widths file, toassociate the windows font to the printer font. If the font numbers are not the same for both outputformats, the output will not look the same. For example, if your widths file for Postscript has fontnumber 7 assigned to Times New Roman, but your PDF widths has font 7 as Arial, the output willlook significantly different (because font 7 will be assigned to a single Windows font, which is howyour document was created).
To ensure that your output looks the same in all formats, you must acquire an equivalent fontcontaining identical font metrics for each format.
Format Definitions: List Options
Access format definitions by clicking Format Definitions from the Output Management menu. Theformat definition page displays a list of existing format definitions. From this page you can performthe following actions.
Element Name Description
Add Button Enables you to define a new format definition. See Format Definition Options,page 66 for more information.
Copy Enables you to create a duplicate format definition. Select the check box nextto the format definition you want to copy and click Copy. The duplicateappears in the format definition list with the words “Copy of” placed beforethe name of the original format definition.
Delete Deletes an existing format definition. Select the check box next to the formatdefinition you want to copy and click Delete.
Format Definition NameList
To edit the settings of an existing item, click the item name.
65
CompuSet and xAdmin
Format Definition Options
To create a new format definition or edit an existing one, you must define all the settings on theFormat Definition page. The Format Definition page contains the following elements.
Element Name Description
Name Define a name for your format definition. The name can be 255 alphanumericcharacters in length.
Format Select a format for your font definition. Supported output formats are: AFP,HTML, Metacode, PDF, PCL, and PostScript.
This selection determines the format of the output.
Note the following conditions when choosing the HTML format option:
Distribution definitions that return HTML to caller will return packedMSOHTML.
Distribution definitions that e-mail HTML will not send packed HTML. It willsend the unpacked main body HTML with images.
Please note that xPression does not support any output processing functionalityfor PCL output. This includes file partitioning, file splitting, archiving, multi-fileoutput, and recipient processing.
PDEF File Location PDEF files contain commands needed to specify how to format the printed page.
PDEF files can reside in any directory on your network. xPression ships a set ofsample PDEF files located in the following directory:
\\xPression Server\xPression\CompuSet\Format Definition
When you click Find File, xPression displays all the font databases stored inthis directory in a pop-up window. To select a PDEF file from your local clientmachine or any other network directory, click Browse.
To select a font database, click the desired file and click Open.
Font Definition The font definition contains information needed to use a specific font in adocument. Select from a list of existing font definitions.
Override Global Merge Libraries
When a CompuSet job is running, the global merge libraries are locked. This prevents users fromupdating the merge library while the emitter is running. xPression now enables you to define adifferent set of merge libraries to use while running your job, ensuring that your global mergelibraries remain accessible.
66
CompuSet and xAdmin
The new merge libraries are defined in the xAdmin Format Definition page, but youmust first enable this functionality in a properties file. To override your global mergelibraries:1. Open the ofp.properties file in the xPressionHome directory on your server.
2. At the bottom of the file, you should see the following parameter: EnableMergeLibOverride=falseChange this value to true.
3. You must restart your server to implement this change.
4. When the server is restarted, log on to xAdmin and click CompuSet Output Management.
5. Click Format Definition and select an existing format definition or create a new one.
6. On the format definition page, notice the two new settings, DCLib1 and DCLib2.
7. Supply path and name of the merge libraries you want to use with this format definition.xPression will use these merge libraries instead of the globally defined merge libraries inofp.properties each time this format definition is used.
About Web Archive Output
Microsoft Web Archive allows you to save an entire web page, including images, as a single file.xPression creates a Web Archive output in addition to your primary output format. By default, thisoutput is viewed with Internet Explorer, but you can configure xPression so that the Web Archiveoutput is viewable with Microsoft Word.
Note: Web Archive is supported by Word 2002 and 2003 only. It is not supported by Word 2000. Also,xPublish produces a Web Archive output as well. The settings and options described in this sectiondo not apply to the Web Archive output provided by xPublish.
There are three settings related to how the Web Archive output is formatted: TidyOff, EmailDoc,and VariableColor. The TidyOff property determines whether the document will retain all originalformatting or not. For more information about this property, refer to the file section.
The EmailDoc property determines whether the filename extension of the Web Archive output file is.doc or .mht. When TRUE, the extension is .doc. It is recommended that the value for this propertybe the same as the value for TidyOff.
The VariableColor property determines the font color for any variables used in the document, ifother than the default font color. For more information about the EmailDoc and VariableColorproperties, refer to the file section.
To optimize CompuSet’s Web Archive output:1. Open the Tidy.properties file in your text editor. This file is located in the <xPressionHome>
directory on the xPression server.
2. TidyOff is FALSE by default, which tells xPression to remove certain formatting elements suchas page breaks, headers, and footers. This is preferable when viewing the output with InternetExplorer. Set TidyOff to TRUE if you want the Web Archive output to be viewed with all originalformatting. This is preferable when the output will be viewed using Microsoft Word. Theproperty will resemble this example: tidyoff=true.
67
CompuSet and xAdmin
3. Save Tidy.properties.
4. Open DistributionController.properties in your text editor.
5. Set EmailDoc to TRUE if the document is to be viewed in Word. If this property is FALSE thefilename extension will be .mht.It is recommended that EmailDoc be set to the same value that TidyOff was set to in step 2.Although not required, this causes the filename extension to match the format of the file. Ifboth are set to TRUE, the format will be viewable with Word and the filename extension willbe .doc. If they are both FALSE, then the format will be viewable with Internet Explorer andthe filename extension will be .mht.
6. If you want to set the font color for variables to a color other than the default color for thedocument, set VariableColor to the color that you want to use.
7. Save DistributionController.properties.
8. Restart the application server.
Distribution DefinitionsA distribution definition pairs an existing format definition with settings for operating a specificoutput device (e-mail server, print device, or archive system). The distribution definition contains allthe information needed for that device to distribute your document. You need to create a distributiondefinition for each output device you want to use.
Distribution Definitions: List Options
Access the distribution definition page by clicking Distribution Definitions from the CompuSetOutput Management page. The format definition page displays a list of existing format definitions.From this page you can perform the following actions.
Element Name Description
Add Button Enables you to define a new distribution definition. You cannot give yourCompuSet distribution definition the same name as an existing xPublishdistribution definition. See Distribution Definition General Tab Options,page 69 and Distribution Options Tab, page 69 for more information.
Copy Enables you to create a duplicate distribution definition. Select the checkbox next to the distribution definition you want to copy and click Copy.
The duplicate appears in the distribution definition list with the words“Copy of” placed before the name of the original distribution definition.
Delete Deletes an existing distribution definition. Select the check box next to thedistribution definition you want to copy and click Delete.
Distribution DefinitionName List
To edit the settings of an existing item, click the item name.
68
CompuSet and xAdmin
Distribution Definition General Tab Options
To access the distribution definition options, create a new distribution definition by clicking Addfrom the Distribution Definition: List page, or by clicking a distribution definition name from the list.
The distribution definition General tab contains the following elements.
Element Description
Name Type a name for the distribution definition. The name can be 255alphanumeric characters in length. You cannot give your CompuSetdistribution definition the same name as an existing xPublish distributiondefinition. xPression will display an error message at the top of the pagethat the name is already in use.
Distribution Mode:Immediate
Immediately distributes the document to the selected device. Select thisoption if you want your document published and distributed immediatelyupon submission. In all scenarios (e-mail, Print, Archive), the documentwill be distributed immediately. This option can be selected for bothtransactional and batch applications.
Distribution Mode: Queuefor Batch
This option places documents in a batch queue. If you use this optionwith transactional applications, the jobs are placed in queue and processedwhen the batch queue is scheduled to be processed. They can only beprocessed by batch jobs that specifically identify them for processing. Ifyou invoke this option from a batch job, the document is processed as ifyou had selected Immediate. This occurs because there is no need to queuethe documents for batch when xPression Batch is originating the request.
Distribution Mode: Returnto Calling Application
Returns the document to the calling application (such as xResponse orxDesign) where it is presented to the user to send to a local device. Thisoption only returns documents that are clearly defined as single documents(single print files). It will not return archives or partitioned files. Thisoption only returns documents when called from xDesign, xResponse,xRevise, or an xFramework application, and returns one document foreach stream.
Distribution Options Tab
To view and define distribution for your distribution definition, click the Distribution Options tab.These settings are based on your output device. Each device requires a different set of settings.You can select from the following device types.
Device Settings
For e-mail Servers E-mail SMTP server location and name, and e-mail format settings.
To see instructions for defining your e-mail distribution options, see E-mailDistribution Options Tab Options, page 71.
69
CompuSet and xAdmin
Device Settings
For Print Devices Printer tray information, print partition size, print file settings, and the nameand location of the print script.
To see instructions for defining your print distribution options, see PrintDevice Settings, page 72.
For Archive Systems Settings specific to your archive system. Supported archive systems are:FileNet Capture, FileNet HPII/MRII, DocFinity Imaging, IBM OnDemandAFP Indexing, IBM OnDemand Generic Indexing.
To see instructions for defining your archive distribution options, see:
• FileNet Capture Distribution Options Tab Options, page 75
• FileNet HPII/MRII Distribution Options Tab Options, page 75
• DocFinity Imaging Distribution Options Tab Options, page 77
• IBM OnDemand AFP Indexing Distribution Options Tab Options, page 78
• IBM OnDemand Generic Indexing Distribution Options Tab Options,page 79
• Documentum Indexing Distribution Options Tab Options, page 82
70
CompuSet and xAdmin
E-mail Distribution Options Tab Options
To define settings for e-mail distribution, click the Distribution Options tab and select E-mail fromthe Device Type list. This page contains the following elements.
Element Name Description
To This information appears in the TO field of the e-mail. You can get this valuefrom your data source by defining an output variable and mapping thatvariable to the field in your data source that contains your customer’s e-mailaddress. You can also hard-code a value for this parameter by manuallytyping the e-mail address in the Map to Value box.
If you need to add more than one address to this field, you can accomplishthis in two ways:
1. Enter each address separated by a semicolon (;). Do not place a spacebetween the semicolon and the next e-mail address.
2. Set up an e-mail distribution list on your e-mail server and use thedistribution list address in this field.
CC This information appears in the To field of the e-mail. You can get this valuefrom your data source by defining an output variable and mapping thatvariable to the field in your data source that contains your customer’s e-mailaddress. You can also hand-code a value for this parameter by manuallytyping the e-mail address in the Map to Value box.
From This information appears in the FROM field of the e-mail. You can get thisvalue from your data source by defining an output variable and mappingthat variable to the field in your data source that contains this information.You can also hard-code a value for this parameter by manually typing avalue in the Map to Value box.
Subject This information appears in the SUBJECT field of the e-mail. You canget this value from your data source by defining an output variable andmapping that variable to the field in your data source that contains thisinformation. You can also hard-code a value for this parameter by manuallytyping a value in the Map to Value box.
Message This information appears in the body of the e-mail. You can get this valuefrom your data source by defining an output variable and mapping thatvariable to the field in your data source that contains this information. Youcan also hard-code values for this parameter by manually typing a value inthe Map to Value box.
71
CompuSet and xAdmin
Element Name Description
Send As Select either Include document as attachment, or Include documentin message body. Including the document as an attachment sends thedocument as an attachment in PDF form. Including the document in themessage body sends the document in HTML format in the message body. Ifyou are including the document as an attachment, see Send As Attachments,page 72.
SMTP Server Supply the name of your SMTP server. If left blank, xPression uses thedefault e-mail server you defined when installing your xPression Server.
Send As Attachments
If you are including the document as an attachment, you must supply a naming convention for theattached file. To define the naming convention, use the following options.
• Add Literal: This option allows you to type a literal, hand-coded value in the print file name.
• Add Variable: This function enables you to add the Batch Parameter variable to your report filename. This provides a placeholder in the file name for text you manually enter while invoking thebatch job from the command line.
When you use the BatchParameter in your file name, xPression appends the CompuSet andemitter log files with the same BatchParameter. This makes it very easy to locate all of the job filesfor a particular batch run. You define the BatchParameter identifier when you execute yourbatch job. Please see for xDashboard User Guide more information about defining the identifierfor your batch parameter.
• Add Counter: This option adds a three digit counter to the print file name.
• Delete: Select the naming convention to remove and click Delete.
You can not use the dollar sign ($) or “at” (@) symbols as part of the filename. Do not enter afilename extension in this box, the extension is added automatically based on the format used in theoutput profile.
Print Device Settings
The CompuSet print device settings are shown below. To define settings for a print device, selectPrint from the Device Type list. This page contains the following elements.
72
CompuSet and xAdmin
Element Name Description
Partition Print Output By This option defines the print file partitioning your output print files.
If you select Single print file for all customers, xPression creates one largepartition for all customers.
If you want to limit the size of this print file, you can select Print files ofmaximum number of sheets equal to and enter the maximum numberof sheets your partition can hold.
If you select Individual print file for each customer, xPression createsa print file for each individual customer no matter how big or small theprint file is.
Output Directory for PrintFiles
This is the directory that holds output files created by partitioning. Do notinclude the output filename in this box. You must end your definition witha backslash (\) if the directory is on a Windows server, or a forward slash(/) if the directory is on a Unix server.
The directory you define must already exist because xPression will notcreate it for you. This is optional if you chose to create a single print file forall customers and required if you chose to define the maximum number ofsheets for your partitions in the Partition Print Output By section.
You can leave this field blank if you have defined your output directoryin the Print File Naming Convention table. If you do not supply a path ineither place, xPression will not create your output.
Print File NamingConvention
This can be a simple file name if you produce only one file. Otherwise,you must use a counter. For more information, see Print File NamingConventions, page 74.
Name and Location of PrintScript
(Optional) Specify the name and location of the script or program you useto send output to specific printers. xPression runs this script or programand generates an output file (or all of the output files) and then puts anentry into a Table that the Distribution Controller then processes. Thisscript can be any file that is executable by the operating system.
For Windows systems, you can define a batch script (.bat) or executable(.exe). Ensure that the script begins with @ECHO OFF for best results. ForUNIX systems, you can define an executable shell script or program.
xPression installs a sample batch file in the xPression installation directory:
\\xPression\Samples\Scripts\printlpr.bat
Print Script Parameters (Optional) This option enables you to pass parameters to your print scripts.These parameters enable you to write logic into your scripts based on thevalue of the parameters. You can define parameters using literal or variablevalues. These will always come to the script as %2, %3, and %4. %1 isreserved for the print file name.
73
CompuSet and xAdmin
Element Name Description
Printer Tray Information You can add tray selections to your documents in xDesign by placingCompuSet commands into your content items. When you define a tray, anumber for the tray is specified. The tray number, paper weight, and paperthickness in your distribution definition should correspond to the traydefinitions you added to your document.
Override the OP OptionsFile
This feature is for highly specialized situations where a user may want tooverride some of the default conditions set by xPression. The OP optionsfile contains commands that define functionality to be performed by theOutput Processing engine.
To override this file, type the fully qualified path and file name for theoverride file in the provided box.
Print File Naming Conventions
The print file naming convention options consist of Add Literal, Add Variable, Add Counter, Delete,and a preview display of your selections.
If you are using file splitting by choosing Print files of maximum number of sheets equal to orIndividual print file for each customer, you must use a counter in your print file name to preventoverwriting the file with each record.
Add Literal: This option enables you to place a literal, hand-coded value in the print file name. Bydefault, xPression names your output print file PrintFile. To change this name, replace PrintFilewith a different value and click Save.
Add Variable: This option enables you to add an output variable to the print file name. The outputvariable will supply data from your customer data source for each customer record you process. Ifyou selected ‘Single print file for all customers’ above, you will only be able to insert a BatchParameterwith this button. This function enables you to add the Batch Parameter variable to your report filename. This provides a placeholder in the file name for text you manually enter while invokingthe batch job from the command line.
When you use the BatchParameter in your print file name, xPression appends the CompuSet andemitter log files with the same BatchParameter. This makes it very easy to locate all of the job filesfor a particular batch run. You define the BatchParameter identifier when you execute your batchjob. Please see the xDashboard User Guide for more information about defining the identifier foryour batch parameter.
Add Counter: This option adds a three digit counter to the print file name.
Delete: Select the naming convention to remove and click Delete.
Note: (1) You can not use the dollar ($) or “at” (@) symbols as part of the file name. (2) Do notenter a file name extension in the Print File Naming Convention edit box; the extension is addedautomatically based on the format definition used in the output profile.
74
CompuSet and xAdmin
Print Scripts on AIX Platforms
Some AIX commands may not process correctly when contained in a print script. The AIX lp and cpcommands are known to run correctly in a print script.
FileNet Capture Distribution Options Tab Options
This archive format can only accept PDF output from xPression. For this reason, when adding aFileNet Capture distribution definition to an output profile, you may only use it in conjunction with aPDF format definition. Select FileNet Capture from the Archiving Format list to view the archivesystem settings. This page contains the following elements.
Element Name Description
Output Directory forArchive Files
(optional) This is the directory that holds output files created by partitioning. Thedefault output directory is C:\xPression\CompuSet\Output
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise, use a morecomplex naming scheme utilizing the Add Variable and Add counter functions
Click Add Counter to produce a numbered count. If there is no partitioning, thepartition number is always 1.
Click Add Variable to use values defined in your output variables.
Extension of IndexFile
(optional) The extension for the original index file. By default, xPression setsyour index extension to .fna, but you are free to set it to any extension that yourarchiving system may require.
Index Keys andValues Define the archive index keys and values with literal values, output variables,and built-in functions.
Click the browse button next to each entry box to open the Expression Editor,where you can create an expression to define the index keys. For moreinformation, see Working with the Expression Editor, page 57.
FileNet HPII/MRII Distribution Options Tab Options
Select FileNet HPII/MRII from the Archive Format list to view the archive system settings. Thisarchive format can only accept PDF output from xPression. For this reason, when adding a FileNetHPII/MRII distribution definition to an output profile, you may only use it in conjunction with aPDF format definition.
75
CompuSet and xAdmin
This page contains the following elements.
Setting Description
Output Directory forArchive Files
This is the directory that holds output files created by partitioning. Thedefault output directory is C:\xPression\CompuSet\Output#\
This format requires pre-made directories. Create the output directories youneed in advance and xPression will fill them.
Notice that the output directory contains a pound sign (#) at the end of thepath. The pound sign tells xPression how many output directories it has tofill. One pound sign give you ten directories 0-9. Two pound signs givesyou 20 directories, 0-19.
For example, if you used one pound sign, xPression would expect to findthe following directories in the path:
\output0\
\output1\
\output2\
\output3\
...
\output9\
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise, usea more complex naming scheme utilizing the Add Literal, Add Variable,and Add counter functions.
Add Literal enables you to add a literal string to the archive file name.
Add Variable enables you to use values defined in your output variables.Select an output variable from the drop-down list.
Add Counter produces a numbered count. If there is no partitioning, thepartition number is always 1.
Document Class Provide the FileNet class code.
You can provide a literal value, or select a variable. If you use a literal value,the default is 1, and the value must fall between 1 and 99. If you use avariable, select the variable from the list and set the number of characters tobe used. In either case, the value must be numeric.
Field Delimiter Sets the major delimiter in the transact.dat file. The character must be apunctuation or special character; it may not be alphanumeric. Default is acolon (:). See your FileNet documentation for more information.
Item Delimiter Sets the minor delimiter in the transact.dat file. The character must be apunctuation or special character; it may not be alphanumeric. Default is acomma (,). See your FileNet documentation for more information.
76
CompuSet and xAdmin
Setting Description
Files Per Directory By default up to 1000 files are added to a directory before creating a newone. Use this option to set the number of files placed in the directory to adifferent value. If left blank, the default value of 1000 is used.
Index Keys and Values Define the archive index keys and values with literal values, outputvariables, and built-in functions.
Click the browse button next to each entry box to open the ExpressionEditor, where you can create an expression to define the index keys. Formore information, see Working with the Expression Editor, page 57.
DocFinity Imaging Distribution Options Tab Options
Select DocFinity from the Archive Format list to view the archive system settings. This archiveformat can only accept PDF output from xPression. For this reason, when adding a DocFinityImaging distribution definition to an output profile, you may only use it in conjunction with a PDFformat definition.
This page contains the following elements.
Element Name Description
Output Directory forArchive Files
(optional) This is the directory that holds output files created by partitioning.Default Output directory = c:\xpression\compuset\output
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise, use amore complex naming scheme utilizing the Add Variable and Add Literalfunctions.
Click Add Variable to use values defined in your output variables.
Index File Name The name of the index file.
Extension of Index File (optional) The extension for the original index file. By default, xPression setsyour index extension to .ind, but you are free to set it to any extension thatyour archiving system may require.
Final Windows DestinationDirectory
If you are running xPression on an operating system other than Windows,you will need to copy all of the output PDF files from your output directory toa Windows directory so that your archiving system can access them.
Define the name of this Windows directory here. xPression uses thisinformation to update the paths in your index file.
77
CompuSet and xAdmin
Element Name Description
Index Keys and Values Define the archive index keys and values with literal values, output variables,and built-in functions.
Click the browse button next to each entry box to open the Expression Editor,where you can create an expression to define the index keys. For moreinformation, see Working with the Expression Editor, page 57.Index keynumber six is defined automatically by xPression. This key contains the fullpath and output file produced by this output type.
IBM OnDemand AFP Indexing Distribution Options TabOptions
Select IBM OnDemand AFP Indexing from the Archive Format list to view the archive systemsettings. This archive format can only accept AFP output from xPression. For this reason, whenadding a IBM OnDemand AFP Indexing distribution definition to an output profile, you may onlyuse it in conjunction with a PDF format definition.
This page contains the following elements.
Element Name Description
Output Directory forArchive Files
(optional) This is the directory that holds output files created bypartitioning. Default Output directory = c:\xpression\compuset\output
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise,use a more complex naming scheme utilizing the Add Variable and AddLiteral functions.
Click Add Variable to use values defined in your output variables.
Index Filename Type a name for IBM OnDemand index file. This file stores indexinginformation for all the partitions.
Extension of Index File (optional) There is no default extension for the original index file. You arefree to set it to any extension that your archiving system may require.
Index Keys and Values Define the archive index keys and values with literal values, outputvariables, and built-in functions.
Click the browse button next to each entry box to open the ExpressionEditor, where you can create an expression to define the index keys. Formore information, see Working with the Expression Editor, page 57.
78
CompuSet and xAdmin
IBM OnDemand Generic Indexing Distribution OptionsTab Options
Select IBM OnDemand Generic Indexing from the Archive Format list to view the archive settings.This archive format can only accept PDF output from xPression. For this reason, when adding aIBM OnDemand Generic Indexing distribution definition to an output profile, you may only use itin conjunction with a PDF format definition.
79
CompuSet and xAdmin
This page contains the following elements.
Element Name Description
Output Directory for ArchiveFiles
(optional) This is the directory that holds output files created bypartitioning.
Default Output directory = c:\xpression\compuset\output
Index Choose Concatenated or Individual files.
Concatenated creates a single concatenated PDF archive file. With eachrun, xPression appends index information to the end of the originalarchive index file.
Individual files creates one archive file each time the distributiondefinition is executed. When using this setting, xPression enables youto use a counter in the archive file name to prevent overwriting olderarchive files.
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise, usea more complex naming scheme utilizing the Add Literal, Add Variableand Add Counter functions.
Click Add Literal to add hand-coded literal values.
Click Add Variable to add values defined in your output variables.
The Add Counter function is only active when Individual Files is selectedfor the Index parameter (described above). The Add Counter functionadds a 1-9 counter. If you require a two digit counter, you must add twocounter functions to the naming convention.
Index File Name Type a name for your index file.
Extension of Index File (optional) There is no default extension for the original index file. You arefree to set it to any extension that your archiving system may require.
Separator IBM requires that the expressions in your index follow this format:
{Name}{Separator}{Value}
The Separator is a 1-3 character length string that separates a literal namefrom a value in the index. A common default separator is the followingtwo-character string :=
The {Name} is a literal name that you would use to describe a value. Forexample, "FirstName" or "AccountNumber".
The {Value} is a Literal, Variable, or Function that you use to supplya value to the index.
Supply a 1-3 character separator in the Separator box.
80
CompuSet and xAdmin
Element Name Description
Separator (Con’t.) xPression will automatically place your separator between your literalname and the value. You define these expressions in the Index Keys andValues section described below.
Final Windows DestinationDirectory
If you are running xPression on a non-Windows system, you will need tocopy all of the output PDF files from your output directory to a Windowsdirectory so that your archiving system can access them.
Define the name of this Windows directory here. xPression uses thisinformation to update the paths in your index file.
Code Page (Optional) You can specify the code page of the input data from this field.You can define any code page that is between three and five characters inlength. The default code page is 858 for Windows machines and 1140 formainframe systems.
Index Keys and Values IBM requires that your Index keys adhere to the following format:{Name}{Separator}{Value}
The {Name} is a literal name that you would use to describe a value. Forexample, "FirstName" or "AccountNumber". The {Value} is a Literal,Variable, or Function that you use to supply a value to the index.
The Separator is a 1-3 character length string that separates a literal namefrom a value in the index. A common default separator is the followingtwo-character string :=.
Click the browse button next to each entry box to open the ExpressionEditor, where you can create an expression to define the index keys. Formore information, see Working with the Expression Editor, page 57. Forsome index key examples, see Index Keys and Values Example, page 81.
Index Keys and Values Example
IBM Requires the following format for index keys: {Name} {Separator} {Value}. In the followingexamples, the {Value} is provided by output variables that supply the value from a field in your data."FirstName"+":="+Fname
"AccountNumber"+":="+AcctNum
In this example, the Value is provided by the TotalPagesinPackage Built-in Function."TotalPages"+":="+TotalPagesinPackage
81
CompuSet and xAdmin
Documentum Indexing Distribution Options TabOptions
Select Documentum from the Archive Format list to view the archive settings.
Element Name Description
Output Directory forArchive Files
This is the directory that holds output files created by partitioning.
The default output directory is c:\xpression\compuset\output
Store Path in Docbase For this setting, type the path to an existing directory in your Docbase. Thisdirectory will store all Documentum archive output from this distributiondefinition.
Archive File NamingConvention
This can be a simple filename only if one file is produced. Otherwise, use amore complex naming scheme utilizing the Add Literal, Add Variable andAdd Counter functions.
Click Add Literal to add hand-coded literal values.
Click Add Variable to add values defined in your output variables.
The Add Counter function adds a single digit (1-9) counter to the archivename. If you require a two digit counter, you must add two counter functionsto the naming convention.
To remove a value, select the check box for that value and click Delete.
Object Type Every asset stored in the Documentum Docbase is stored as an object.Documentum objects are defined by their object type. Each object type hasits own set of attributes that can be defined by the user or inherited. BecausexPression archive output is stored as an object in the Documentum Docbase,you must define an object type for your archive output.
Select an existing Documentum object type from the Object Type drop-downlist. This list will contain all of the object types associated with thedm_document type. If the selected object type contains attributes that canbe configured by the user, those attribute names will appear below in theObject Attributes Mapping list.
Object Attributes Mapping This list shows any mappable attributes associated with the selected objecttype. The list shows the attribute name and data type. You can map theseattributes to existing xPression output variables. Ensure that the outputvariable is of the same data type as the object type attribute.
Bar CodesThis section assists you in creating, defining, and implementing xPression bar codes with theCompuSet publishing engine. Bar codes enable you to encode information that can be read by a barcode reader, generally attached to a finishing device. CompuSet supports 3 of 9, 2 of 5 Interleaved,
82
CompuSet and xAdmin
POSTNET, Code 128, OMR Marks, and PDF417 bar codes. Refer to the xAdmin Integration Guide forgeneral information on bar codes supported by xPression.
When you define a bar code for xPression, you can specify:• A unique name.
• The bar code type.
• The position of the bar code on the page. You can define horizontal and vertical offsets, as wellas orientation.
• The bar code font name and size.
• Bar code data (in the form of an expression).
• Criteria for placing the bar code on a specific page.
Note: Be aware that barcode position in xPublish is handled differently than bar code positioning inCompuSet. If you are trying to replicate CompuSet bar codes in an xPublish document, the horizontaland vertical offset values will be different.
Bar Codes: List Options
You define bar codes in the bar code section of CompuSet Output Management. From this page youcan perform the following actions.
Element Name Description
Add Button Enables you to define a new bar code definition.
Copy Enables you to create a duplicate bar code definition. Select the check box next tothe bar code definition you want to copy and click Copy.
The duplicate definition appears in the bar code definition list with the words“Copy of” placed before the name of the original bar code definition.
Delete Deletes an existing bar code definition. Select the check box next to the bar codedefinition you want to copy and click Delete.
Bar Code Name List Deletes an existing bar code definition. Select the check box next to the bar codedefinition you want to copy and click Delete.
Bar Code General Tab Options
To define your general bar code options, click the General tab. This page contains the followingelements.
83
CompuSet and xAdmin
Element Name Description
Name Type a unique name for the bar code. The name can be up to 255 alphanumericcharacters. This name cannot contain spaces.
Position xPression enables you to position the bar code anywhere on the page. The procedurefor positioning a bar code is the same for all bar code types. You can define thehorizontal and vertical offsets of the bar code, as well as the orientation of the barcode on the page.
You must allocate enough white space in your document design to accommodate theplacement of the bar code. xPression places the bar code as defined by your settingsand cannot adjust existing text to make room for the bar code. Therefore, if you do notallocate enough space when you design your document, xPression places the bar codeover any text already in the defined location. Define the position of your bar codeon the page with the following options.
Horizontal Offset: The horizontal offset represents the horizontal distance betweenthe left edge of the page and the left edge of the bar code, relative to the orientation.
Vertical Offset: The vertical offset represents the vertical distance between the topedge of the page and the bottom left edge of the bar code, relative to the orientation.
Orientation: Orientation of the bar code as Portrait, Landscape, Inverse Landscape,and Inverse Portrait.
Orientation xPression places bar codes on the page according to your defined offsets, but relativeto the orientation of the page. Therefore, if you need to have a bar code appearin the same location on each page in a document, even if the pages are in differentorientations, you must define a separate bar code for each page orientation. You canthen conditionally include each bar code on the pages with the correct orientations.
Page and DocumentConditions
You can control when and where bar codes appear in your documents with pageand document conditions. Page conditions determine which page of the documentreceives the bar code. Document conditions determine which documents receive abar code. For more information, see Page and Document Conditions, page 85. Clickthe browse button next to each entry box to open the Expression Editor, where youcan create an expression to define the index keys. For more information, see Workingwith the Expression Editor, page 57.
About Orientation
xPression assumes that all of the pages in a document have the same orientation as the first page ofthe document. If you include a bar code in your output that must be placed in the same location onevery page, and your document contains pages of difference orientations, xPression may place thebar code in an unexpected location on the pages that have a different orientation than the first page.
84
CompuSet and xAdmin
xPression places bar codes as shown below.
Page and Document Conditions
Page conditions determine which page of the document receives the bar code. Document conditionsdetermine which documents receive a bar code.
If you create a job with multiple page orientations, you need to define conditions for your bar codesfor each orientation. For example, if you have a portrait document with a landscape page within it,and you need the bar code to appear in the upper left corner of each page, you must define a bar codeto appear on the portrait pages, and a separate one to appear on the landscape page. You can then usean inclusion condition to include the correct bar code on the correct page orientation.
If you do not define page or document conditions, the bar code appears on every page of the documentincluding phantom pages. A phantom page is the backside of a duplex page that contains no text.
Define page and document conditions by creating data expressions. An expression is a row of data,separated by an operator, that results in a condition. For example:
Current Page Count > 100
This simple expression includes a bar code on each document that is more that 100 pages in length.
Caution: xPression places some limitations on the order of your expressions. When you areusing a literal string value in an expression, the literal string value must appear at the beginningof the expression as follows, {Literal} = {Variable}. In the following example, the characters "CA"form a literal value and "Jurisdiction" is an output variable. The expression will fail if you
85
CompuSet and xAdmin
reverse this order. However, if your literal value is date or numeric, the situation is reversed andthe literal must appear at the end of your expression.
For information about how to create page and document conditions using the Expression Editor, seeWorking with the Expression Editor, page 57.
3 of 9 Bar Code Type Tab Options
To use Code 3 of 9 fonts with CompuSet, you must add your Code 3 of 9 font to the xPression system.Do this by creating a font database and widths file.
Next, create a font definition based on your Code 3 of 9 font database and widths file. xPressionreferences the font definition to ensure they are processed correctly. For more information on fontdefinitions, see Font Definitions, page 62. For Code 3 of 9 bar codes, select the 3 of 9 bar code type.This page contains the following elements.
• Font Definition — Select the Font Definition for your Code 3 of 9 fonts.
• Bar Code Font — Select the font for your bar code. The font list is populated with the names ofthe fonts in your font map.
• Point Size — Define the desired point size of the bar code font.
• Include Modulus 43 Check Character — Select this option to place a check character on your barcode. A check character is a decimal (or alphanumeric) digit added to a number for the purpose ofdetecting the sorts of errors humans typically make on data entry.
• Character Set (Full ASCII Format) — Select your character set, Standard (Default) or Full ASCII.The Standard character set supports only 43 alphanumeric, uppercase characters. To use thisoption, do not select the Full ASCII option.
The Full ASCII character set enables lowercase letters and control characters. It uses combinationsof two standard Code 3 of 9 characters for every character in the ASCII character set (0-127). Thismakes the code very big if you have very many lowercase or special characters.
If you define data that contains characters that are not allowed in your chosen set, xPressionreplaces the illegal characters with a space character and issues a warning in the log file.
• Reverse Direction — Select this check box to reverse the direction of the bar code.
• Make Human Readable — You can display human readable text with your bar code. The readabletext shows the value of the bar code. xPression assumes that the readable text has the sameorientation as the bar code. To view the human readable text settings, select Make HumanReadable and define the following options:— Font: Select the font for your bar code from the list.
— Font Stress: Define the stress of the bar code font.
— Point Size: Define the point size of the bar code font.
86
CompuSet and xAdmin
— Horizontal Offset: Define the horizontal offset of the bar code. Use this offset to ensure you donot print the readable text over the actual bar code.
— Vertical Offset: Define the vertical offset of the bar code. Use this offset to ensure you do notprint the readable text over the actual bar code.
2 of 5 Interleaved Bar Code Type Properties Tab Options
To use 2 of 5 bar codes with xPression, you must configure xPression to use your 2 of 5 bar code fonts.Do this by creating a font database and widths file.
Next, create a font definition based on your 2 of 5 font database and widths file. xPression referencesthe font definition to ensure they are processed correctly. For more information on font definitions,see Font Definitions, page 62. To create a 2 of 5 Interleaved bar code, select the 2 of 5 Interleaved barcode type. Define the following 2 of 5 Interleaved bar code options.
• Font Definition — Select the Font Definition for your Code 2 of 5 fonts.
• Bar Code Font — Select the font for your bar code. The font list is populated with the names ofthe fonts in your font map.
• Point Size — Define the desired point size of the bar code font.
• Include Modulus-10 Check Character — Select to place a check character on your bar code. Acheck character is a decimal (or alphanumeric) digit added to a number for the purpose ofdetecting the sorts of errors humans typically make on data entry.
• Reverse Direction — Select this check box to reverse the direction of the bar code.
• Make Human Readable — You can display human readable text with your bar code. The readabletext shows the value of the bar code. xPression assumes that the readable text has the sameorientation as the bar code. To view the human readable text settings, select Make HumanReadable and define the following options:— Font: Select the font for your bar code from the list.
— Font Stress: Define the stress of the bar code font.
— Point Size: Define the point size of the bar code font.
— Horizontal Offset: Define the horizontal offset of the bar code. Use this offset to ensure you donot print the readable text over the actual bar code.
— Vertical Offset: Define the vertical offset of the bar code. Use this offset to ensure you do notprint the readable text over the actual bar code.
Code 128 Bar Code Type Properties Tab Options
To use Code 128 bar codes with xPression, you must configure xPression to use your Code 128 barcode fonts. Do this by creating a font database and widths file.
Next, create a font definition based on your Code 128 font database and widths file. xPressionreferences the font definition to ensure they are processed correctly. For more information on fontdefinitions, see Font Definitions, page 62.
87
CompuSet and xAdmin
To define a Code 128 bar code, select the Code 128 bar code type. This page contains the followingelements.
Element Name Description
Font Definition Select the Font Definition for your Code 128 fonts.
Bar Code Font Select the font for your bar code. The font list is populated with the names of thefonts in your font map.
Point Size Define the desired point size of the bar code font.
Include Modulus-103Check Character
Select to place a check character on your bar code. A check character is a decimal (oralphanumeric) digit added to a number for the purpose of detecting the sorts of errorshumans typically make on data entry.
Encoding Character Set Code 128 comes in three code sets (dubbed A, B, and C) that differ in compaction andencodable character set.
You can define the character set that you want to use for your Code 128 bar code fromthe standard Code 128 A, B, and C sets. If you define data that contains charactersthat are not allowed in your chosen set, xPression replaces the character and issues awarning in the log file.
Set A: A partial ASCII set with no lower case characters. It enables uppercase letters,digits, some symbols, and ASCII control characters.
Set B: A full ASCII set with no ASCII control characters. It enables uppercase andlowercase letters, digits and some symbols.
Set C: A very compact code that enables only digits 0-9, encoded in pairs.
If you choose set A or B, xPression replaces illegal characters with a space character. Ifyou choose set C, xPression replaces illegal characters with a zero.
Reverse Direction Select this check box to reverse the direction of the bar code.
Make Human Readable You can display human readable text with your bar code. The readable text showsthe value of the bar code. xPression assumes that the readable text has the sameorientation as the bar code. To view the human readable text settings, select MakeHuman Readable and define the following options:
• Font: Select the font for your bar code from the list.
• Font Stress: Define the stress of the bar code font.
• Point Size: Define the point size of the bar code font.
• Horizontal Offset: Define the horizontal offset of the bar code. Use this offset toensure you do not print the readable text over the actual bar code.
• Vertical Offset: Define the vertical offset of the bar code. Use this offset to ensureyou do not print the readable text over the actual bar code.
88
CompuSet and xAdmin
PostNet Bar Code Type Properties Tab Options
To use PostNet bar codes with xPression, you must configure xPression to use your PostNet bar codefonts. Do this by creating a font database and widths file.
Next, create a font definition based on your PostNet font database and widths file. xPressionreferences the font definition to ensure they are processed correctly. For more information on fontdefinitions, see Font Definitions, page 62.
From the bar code Type Properties tab, select POSTNET. This page contains the following elements.
Element Name Description
Font Definition Select the font definition that contains your PostNet bar code fonts.
Bar Code Font Select the font for your bar code. The font list is populated with the names of thefonts in your font map.
Point Size Define the point size of the bar code font
POSTNET Type Select Zip, Zip +4, or DPBC.
OMR Bar Code Type Properties Tab Options
To create OMR bar codes, select OMR from the Bar Code Type list. This page contains the followingelements.
Element Name Description
Mark Length Type the length (in points) of the marks. The value you enter must be greaterthan zero, and can be a decimal value.
Weight of Marks Type the weight (in 1/5 points) of the marks. The value you enter must be greaterthan zero (0), and can be a decimal value
Mark Spacing Type the spacing (in points) between the marks. The value you enter must begreater than zero (0), and can be a decimal value.
Use Start Mark Select the Add Start Mark check box to add a start mark to the bar code. Clearthe check box to omit the start mark.
Use End Mark Select the Add End Mark check box to add an end mark to the bar code. Clear thecheck box to omit the end mark.
Reverse Direction Select the Reverse Direction check box to place the bar code on the output pageso it reads in the reverse direction. Clear this check box to place the bar code so itreads in the forward direction.
89
CompuSet and xAdmin
PDF417 Bar Code Type Properties Tab Options
For PDF417 bar codes, select PDF417 for the Bar Code Type. This page contains the followingelements.
Element Name Description
Row and Column Values Determine how to calculate the number of rows and columns in your bar code. Youcan use three methods: Fixed, Limit, or Best Fit.
Fixed and Limit are available from the Row and Column Values list. A third optionnamed Best Fit is available individually from Number of Rows and Number ofColumns options.
Fixed: Forces xPression to produce bar codes with exactly the number of rowsand columns you define.
Limited: Limits the number of bar code rows and columns that xPression cancreate.
Use Best Fit: If checked, this option enables xPression to define the number ofrows or columns in the bar code based on the best fit.
Number of Rows If you selected a Fixed, this number defines exactly the number of rows the barcode will use. If you selected Limit, this number defines the total number of rowsthe bar code is able to use.
Select Best Fit to enable xPression to define the number of rows. You cannot useBest Fit to define both the number of rows and the number of columns.
Number of Columns If you selected a Fixed, this number defines exactly the number of columns thebar code will use. If you selected Limit, this number defines the total numberof columns the bar code is able to use.
Select Best Fit to enable xPression to define the number of columns. You cannotuse Best Fit to define both the number of rows and the number of columns.
Width of Narrowest Bar(x dimension)
The width of the smallest bar is defined as a bar code’s X dimension. In thefollowing picture, you can easily pick out the smallest, or narrowest bar. Bymeasuring this bar, we can determine the bar code’s X dimension. All other barwidths are defined as multiples of the smallest bar. Each bar’s width is expressedrelative to the X dimension. For instance, 3X refers to a bar that is 3 times as wideas the narrowest bar.
Height of Each Row Type the height of each bar in the bar code. The height of each bar is relative to thewidth of the narrowest bar (the value you define in the Width of Narrowest box).
For example, if you define 2.5, xPression produces a bar code where the row heightis two and half times the width of the narrowest bar in the bar code.
Aspect Ratio Type the aspect ratio that you want to use to create the bar code. This option isunavailable if you define a fixed number of rows or columns. xPression expressesthe aspect ratio as a ratio of bar code height to bar code width. You can define avalue between 100 and 0.01. xPression recognizes up to two decimal places.
90
CompuSet and xAdmin
Element Name Description
Error Correction Level PDF417 bar codes have error correction capability. This enables scanners to readthe bar code even if it has been torn, written on, or damaged in other ways. Thelevel of damage a symbol can withstand depends on the amount of error correctionin each PDF417 symbol.
You can select an error correction level of 0 to 8. At level 0, a damaged PDF417cannot be read, but the damage can be detected. At levels 1 through 8, a PDF417symbol can still be read, even when damaged. As the error correction levelincreases, more damage can occur to the symbol and still be read.
Consequently, the higher the error correction level, the larger the symbolbecomes, while the data capacity goes down. See your bar code error correctiondocumentation for specifics.
Type the error correction level that you want to use for the bar code. You can entera value from 0 to 8. The error correction level depends on the number of codewords in the bar code. Increasing the error correction level increases the numberof code words in the bar code.
Truncated Format Select the Truncated Format check box to create the bar code in the truncatedformat. Clear the check box to create the bar code in the standard format.
Support EncodedCharacters
Select this option to include non-printing characters, such as 010 and 013 (linefeed and carriage return). When this option is selected, if the barcode data stringincludes a series in the pattern of \\nnn. The backslashes are literal and nnn is adecimal character code that determines the single character that will replace thefive characters (\\nnn) in the data string. There must be exactly 3 digits with avalue of 000 through 255. The result will be a one byte character. If the format isnot exactly \\nnn, then it will be ignored. For example, the \\11 in the stringabd\\11def will remain the same.
Bar Code Data Tab Options
The data tab is where you define the value of your bar code. You create this value with an expressioncreated in the Expression Editor.
Define the value by creating an expression. The expression can be made up of data you manuallydefine (literal), data in your customer data source (output variable), or a system-generated calculation(built-in function).
The data that you want xPression to encode in the bar code must be defined in the host-nativeformat. If your platform is ASCII-based, you must encode your data in ASCII, and if your platformis EBCDIC-based, your data must be EBCDIC.
If you are creating a 3 of 9 or a Code 128 (Set A) bar code, you can reference non-printable charactersin an ASCII position. To encode these characters on an EBCDIC platform, use the table of decimalvalues located in the xAdmin Integration Guide.
The data tab contains important information about your bar code including your bar code type, thetotal number of characters in your bar code, and a preview of your bar code.
91
CompuSet and xAdmin
This page contains the following elements.
Element Name Description
Bar Code Type xPression displays your current bar code type as a reminder.
Total Number of Characters This piece of information constantly updates based on the selection you make inyour bar code data expression.
Preview The preview displays a numerical representation of the bar code based on yourselections in the bar code data expression.
Entry Edit Box Displays the data expression for this content stamp. Click the browse buttonto open the Expression Editor and define your data expression. For moreinformation, see Working with the Expression Editor, page 57.
A literal is a static, hard-coded number or string that will be placed in the stampor the path to the image file. A bar code is comprised of “fields.” For each datarow you add, a field is added to the bar code.
If you enter a literal value, xPression displays the actual literal value in thepreview.
Because the stamp is not yet tied to any particular customer, the previewrepresents variable parts of the expression with nines.
Creating Bar Code Data Equations
You can create content stamp data or the path to an image based on the results of an equation.You can add, subtract, multiply, divide, or calculate a percentage of any literal, variable, or built-infunction. When you add more than one data element to the same data row, you can add a data rowoperator that defines how one data element relates to the next data element in the row. For a list ofsupported operators, see Supported Operators, page 92.
Supported Operators
You can use the following operators in your expressions.
Symbol Definition Symbol Definition
* Times ! NOT
/ Divide = Equal (string and numeric)
% Modulous != Not equal (string andnumeric)
+ Plus > Greater than
- Minus < Less than
( Open parentheses >= Greater than or equal to
92
CompuSet and xAdmin
Symbol Definition Symbol Definition
) Close parentheses <= Less than or equal to
&& AND + String concatenation
|| OR
Output StreamsAn Output Stream is a collection of assembled documents with similar publishing and distributioncriteria. xPression uses output streams to distribute documents by combining them with a formatdefinition and a distribution definition to create an output profile. Output streams are the methodxPression uses to place documents into your output management settings.
You add documents to an output stream by defining output stream criteria with inclusion conditions.These inclusion conditions query the data in your documents to determine whether or not adocument is eligible for a given output stream. Once you organize your documents into streams, youcan apply additional criteria to them, such as sort logic, recipient processing, finishing information,distribution profiles, and partitioning information. You can also create reports based on thedocuments in your stream.
By splitting documents into different streams, you can send different versions of the same documentto multiple recipients.
For example, one stream can be configured to contain full documents intended for an insurancepolicy customer, a second stream can contain abbreviated documents intended for the insuranceagent, and a third stream for the corporate archive solution. This scenario is achieved by usingthree output streams designated for three separate recipients. All three streams can be executed atonce using a single output profile definition.
How Do Output Streams Work?
The output stream definition page in xAdmin contains four tabs.
Each tab contains a specific set of information.
Tab Information
General This tab contains general information about the documents and recipients included inthe stream. Inclusion conditions are logical expressions defined by you that include orexclude documents from the stream. To learn how to define an inclusion condition, seeDefining Inclusion Conditions, page 95.
You can also define a specific recipient for the documents in the stream. Recipients aredefined in xDesign. You can produce a stream for a single recipient or all recipients.
Sorting This tab enables you to sort and group the documents in your stream. You can sort andgroup the documents based on any piece of data in your data source by using outputvariables. To sort the documents in your stream, see Sorting Tab Options, page 96.
93
CompuSet and xAdmin
Tab Information
Finishing This tab enables you to perform finishing tasks on the documents in the stream. You canmake and distribute copies of the documents in the stream, define simplex or duplexoutput mode, and add bar codes. To define finishing information, see Finishing TabOptions, page 97.
Clicking the Cancel button on the Finishing tab of the CompuSet Output Management —Output Streams caused the Last Modified date to be updated, even though no changeswere made. This interfered with migrations, so there is now a warning that offers theuser the option to save the page before switching tabs. Note that the Last Modified Timeis actually the migration time, not the time of the last modification.
Reporting This tab enables you to create reports based on the documents in your stream. You canrun reports based on custom or preset variables. To learn how to create reports, seeReporting, page 98.
Output Streams: List Options
To access output streams, click Output Streams from the CompuSet Output Management menu.The output streams page displays a list of existing output streams. From this page you can performthe following actions.
Element Name Description
Add Button Enables you to define a new output stream. Click Add.
Copy Enables you to create a duplicate output stream. Select the check box next to the outputstream you want to copy and click Copy. The Duplicate appears in the output streamlist with the words “Copy of” placed before the name of the original output stream.
Delete Deletes an existing output stream. Select the check box next to the output stream youwant to copy and click Delete.
Output Stream NameList
To edit the settings of an existing item, click the item name.
Output Stream General Tab Options
To access the output stream General tab, create a new output stream from the Output Streams: Listpage, or click an existing output stream name from the same page. This page contains the followingelements.
94
CompuSet and xAdmin
Element Name Description
Name Type a unique name for the new output stream in the Name field. The name can be upto 255 alphanumeric characters.
If you set up multiple output streams in your output profile, you must ensure that thePrimary stream is uniquely named. Any stream used as a Primary stream cannot bereused within the same output profile.
Recipient In the Recipient field, select a recipient for this output stream. Only documents for thespecified recipient are included in the output stream. You can select the name of a singlerecipient, or select <ALL> to generate the stream for all recipients.
Inclusion Condition An inclusion condition is a Boolean equation comprised of user fields, system functions,string and numeric literals, and operators that compare the attributes of a documentwith a set of conditions defined by you. If the attributes match, xPression includesthe document in the output stream. To learn about defining inclusion conditions, seeDefining Inclusion Conditions, page 95.
Defining Inclusion Conditions
In the Inclusion Condition section, define inclusion condition criteria to determine whether ornot a document belongs to this stream. For example, this condition might be set to include alldocuments that include a check because those documents require special processing, or it mayinclude documents whose total number of pages is above or below a set amount.
Inclusion conditions can be made up of static, hard-coded values (literals), data from your customerdata source (output variables), and system-generated calculations (built-in functions). All ofthese data elements are available in the Expression Editor. Clicking the browse button opens theExpression Editor. For more information, see Working with the Expression Editor, page 57.
Inclusion conditions can be made up of a single data row, or multiple data rows. An example of asingle data row condition would be a comparison between an output variable and a literal text field.For example, a condition that includes all documents where the Cor_Method output variable mapsto a customer data record whose value equals e-mail (the literal text field). For this example, yourexpression would appear like this:COR_METHOD = "email"
An example of a multiple data row inclusion condition would be the specification of two conditions(each containing a function, an operator, and a literal value), where one or both of the conditionsmust be met. For example, a condition that includes all documents where the total pages in thepackage exceed 100 or the total paper thickness exceeds 10 mm. This inclusion condition willdetermine what goes into an output package. This condition specifies that no package can be largerthan 10 mm total, or cannot have more than 100 pages. If the documents exceed these values, asecond package will be created, but will conform to the same restrictions. For this example, yourexpression would appear like this:TotalPagesInPackage > "100" || TotalPackageThickness > "10"
95
CompuSet and xAdmin
Ignoring Missing Output
You may want to create a scenario where your output profile contains more than one output stream,but may not publish all output streams each time. By default, xPression will create an error to warnyou that one or more of your output streams failed to produce output. You can disable this warning.
Output Type How to Disable Warning
Print Output Add the following setting and value to the ofp.properties file located in yourxPressionHome directory.
IgnoreMissingOutput=true
Email Output Add the following setting and value to the ofp.properties file located in yourxPressionHome directory.
IgnoreMissingEmail=true
Sorting Tab Options
xPression sorts documents in the output stream based on output variables. You select which outputvariables you want to sort by adding them to the sorting list. Using output variables, you can sortdocuments according to the customer’s ID, by the size of their account, or by any piece of data thatresides in your customer data source.
For example, you could sort the documents in an output stream first in descending order by Dateand then in ascending order by CustomerID. This would produce a stream where the most recentdocuments with the lowest CustomerID are output first.
You can sort with up to 10 output variables for each stream. You can also sort documents in ascendingor descending order and change the sort order by moving items up and down the list. To define thesort order for documents in an output stream, click the Sorting tab.
This page contains the following elements.
Element Name Description
Add Enables you to add a new sorting row.
Within this row you can define the output variable you want to sort by and selectthe direction of the sort, Ascending or Descending.
Move Up/ Move Down Enables you to move a sorting row to a higher or lower position.
Remove Select a sorting row and click Remove to remove it from the sorting tab.
96
CompuSet and xAdmin
Element Name Description
Grouping To ensure that documents belonging to the same customer are designated as partof the same print package, you must use sorting in conjunction with grouping.
You can group documents together based on one of the output variables youdefined as sort criteria. Grouping documents makes them part of the same“package”.
A package is a collection of documents "packaged" as a unit for output processingand sent to your print device by the emitter. Typically, the final package containsthe deliverables for one customer.
Grouping (Continued) A package will not be broken by partitioning or page count limitations. Using anoutput variable chosen from the sorting list, you can instruct xPression to beginand end a print package based on the changes in that variable. For example,Figure 105 on page 162 shows a stream that is grouped by CustomerID. In thisscenario, each time a CustomerID changes, xPression ends and starts a newpackage.
When grouping is enabled all documents included in one package are considereda single entity. Variables rules and output variables defined within individualdocuments can no longer be addressed at a document level."
Finishing Tab Options
The tasks on the Finishing tab enable you to create copies of the documents in your stream, definesimplex or duplex printing mode, and add bar codes to the stream. To define finishing tasks, click theFinishing tab. This page contains the following elements.
Element Name Description
Number of CopiesRequired
Select whether or not to produce multiple copies in the stream. Select an outputvariable to define this option from a field in your customer data source.
Copy Method Choose Standard or Efficient.
Using the Standard copy method, xPression sends multiple physical print files tothe output device. If you select 3 copies, xPression will send 3 identical print files tothe output device.
Efficient copy method is possible on certain Metacode, PostScript, and AFP printers.In this method, the xPression output management subsystem uses commands toinstruct the printer to print multiple copies rather than make physical copies inthe output stream.
97
CompuSet and xAdmin
Element Name Description
Document Output Mode Select Simplex for single-sided documents or Duplex for double-sided documents.This setting overrides the simplex/duplex setting in the PDEF.
Barcode If you are including a bar code in your document, click Add in the Bar Codes tableto add a bar code definition.
Click Add to add a new bar code row. From the bar code list, select an existing barcode definition. To add another bar code definition, click Add. To remove a barcode definition from this output stream, select the definition and click Remove.
Note: There is a warning that offers the user the option to save the page before switching tabs whenthe Cancel button on the Finishing tab of the CompuSet Output Management — Output Streamsis clicked because clicking this button causes the Last Modified date to be updated and this mayinterfere with migrations. Note that the Last Modified Time is actually the migration time, not thetime of the last modification.
Reporting
xPression enables you to create reports based on the documents in the stream. You can customizethe name, location, and content of the report. For example, you can use a report identify whichstatements in your output stream have chargebacks by the customer. The report can be submitted forhuman review, or it may be used as input into a secondary system. For example, you might feed thereport as a data file into a system which keeps track of all the printed chargebacks.
A report file begins with zero or more header records, which are followed by a sequence of recordsthat contain data. xPression writes one record (that you define) for each document processed by theoutput stream. Unless you customize the format of the report, xPression returns an unformattedreport where the information for each document is placed on the same line creating one continuousstring that is difficult to read. Use the report functions to create more readable reports. Click theReporting tab to access the xPression reporting options. This page contains the following elements.
Element Name Description
Path Define the path where you would like xPression to save your report. For example:C:\xPression\CompuSet\output\
Report File NamingConvention
Your report name and path can have up to 255 alphanumeric characters andspaces. The default extension for an xPression report file is .ort. The report file isa simple text file that can be viewed or edited with a text editor.
To create a report file name use the Add Literal and Add Batch Parameterfunctions.
Add Literal: This function enables you to add a string of alphanumeric text to thereport file name. By default, xPression creates a literal named "Report".
Add Batch Parameter: This function enables you to add the Batch Parametervariable to your report file name. This provides a placeholder in the file name for
98
CompuSet and xAdmin
Element Name Descriptiontext you manually enter while invoking the batch job from the command line. Seethe documentation for the -n batch parameter in the xDashboard User Guide.
Extension of Report File This option enables you to determine the report file extension. Default is .ort
Report Headers Headers make your reports easier to read by enabling you to place descriptivetext in the report. For example, you can identify the source of the report (jobname, document name) or the type of report data that follows.
You can define one or more header records. The headers appear in the report inthe same order they appear on this page. Headers appear at the beginning of areport, preceding the report data records.
By default, headings and report values are produced without formatting. Allheaders are placed at the beginning of the report file on consecutive lines. Youmust supply a value for each header you create. xPression does not supportblank header values.
Turn on PackageReporting/Turn on PartitionReporting
Select the Turn on Package Reporting check box to create a report based on allthe documents in the stream.
Select the Turn on Partition Reporting check box to create a report based on allthe documents in the partition.
For each report type, use the functions described in Package and PartitionReports, page 99 to define the content of your reports.
Append to Existing Report Use this option when you intend to run your output stream numerous times orwant to concatenate numerous stream reports AND want to save all of yourreports in the same file.
If you do not select this check box, xPression will overwrite the report file eachtime you run your output stream.
Package and Partition Reports
In this section you can select to create a package report or a partition report. A package reportcreates a report based on all of the documents in the stream. A partition report creates a report onall documents in a partition.
The following image show the Package and Partition Reporting options
.
99
CompuSet and xAdmin
A partition is a way of dividing your printed output. From the distribution definition distributionoptions tab, described in Distribution Definitions, page 68, you can define your partition size asa single file for all customers or set a maximum number of pages for a partition. When creatingpartition reports, you must partition your print output in the associated distribution definition. To dothis, select either "Individual print file for each customer ", or "Print files of maximum number ofsheets equal to: ". For more information, see Print Device Settings, page 72.
For both package and partition reports, you can define what data you want to appear in your report.For example, you may want a report on the total number of pages in a package or partition.
You can define your data in the following ways:• Use a predefined batch parameter.
• Use an output variable (Package report only). You can select a mapped output variable to displaythe value of that output variable in your report for each customer record. Some of the morepopular output variables used in reporting return the customer’s account number or name.
• Define a built-in function. When selecting a built-in function, you can format the length of thereturned value by defining the number of characters used in the returned value. For a completelist and definition of available system functions, see the xAdmin User Guide.
• Use a Literal (numeric or string). A literal must consist of alphanumeric characters.
The process for defining report data is the same for both partition and package reports. Click thebrowse button next to either edit box opens the Expression Editor, where you can define an expressionto provide the report content. For more information, see Working with the Expression Editor, page 57.
xPression displays a preview of the data placed in your report. The preview identifies the totalnumber of characters, and shows representations of your literal, variable, and function data.
Output ProfilesCompuSet output profiles tie together all your output settings into one profile. They produce aspecific set of documents (through output streams) in a specific format (through the format definition)for a specific device (through the distribution definition).
Any time you make changes to your output profiles that affect the document assembly, you mustmake sure your designers regenerate XML in xDesign for each document that references the changedoutput profile. This ensures that all the changes will be applied to their documents.
Output profiles can contain one or more sets of streams, distribution definitions, and formatdefinitions, allowing great flexibility in the way you to organize your output production.
If multiple users in xDesign, xResponse, or xPression Batch are using the same output profile at thesame time, and that profile has an output stream that produces a single print file with a static filename, the print output produced by the users may conflict. To avoid this situation, leave the file nameblank when you create the distribution definition. xPression will then produce output files withunique names for each user request.
100
CompuSet and xAdmin
Output Profiles: List Options
To set up your output profile, click Output Profiles from the CompuSet Output Management menu.The main output profile page appears, showing a list of all available output profiles.
This page contains the following elements.
Element Name Description
Add Button Enables you to create a new printer definition.
Copy To create a duplicate item, select the item you want to copy and click Copy.The duplicate item appears in the list with the words “Copy of” placed beforethe original name.
Delete To delete an existing item, select the item you want to remove and click Delete.
Output Profile Name List To edit the settings of an existing item, click the item name.
Output Profile Options
To create a new output profile, click Add. The output profile definition page appears. This pagecontains the following elements.
Element Name Description
Name Type a name for the output profile. It can be up to 255 alphanumeric characters.
Don’t Add Final Verso Pagefor Duplex
When selected, prevents a blank page being inserted to end the document with averso page. Otherwise, a blank verso page is inserted if the last page with contentis recto.
Set Primary Stream Select one of the streams you added to operate as the primary stream. The primarystream determines which output format and paper tray definitions are used. Theprimary stream is highlighted in blue.
Output Stream Select an output stream from the list.
If you set up multiple output streams in your output profile, you must ensure thatthe Primary stream is uniquely named. Any stream used as a Primary streamcannot be reused within the same output profile.
Format Definition Select a format definition to use with the selected output stream from the list.
Please note that xPression does not support any output processing functionalityfor PCL output. This includes file partitioning, file splitting, archiving, multi-fileoutput, and recipient processing. The xAdmin page will allow you to set upRecipient Processing on an output stream associated with a PCL format definition,but the unsupported features will not work.
Distribution Definition Select a distribution definition to use with the selected output stream from the list.
101
CompuSet and xAdmin
To add more output streams to the output profile, click Add. To remove output streams from theoutput profile, select the profile and click Delete. You can produce multiple output streams with asingle output profile, enabling you to produce multiple versions of the same document and distributethem to different recipients or different output devices.
Migration UtilitiesThis section contains these topics:• Output Profile PDPX Contents
• Job Definitions PDPX Contents
• Exporting or Migrating xPression Documents
• Exporting or Migrating xPression Documents
• Exporting and Migrating Jobs
Output Profile PDPX Contents
When you migrate or export your output profile, xPression also migrates all of the supporting outputmanagement files.
For CompuSet, this includes:• Output Profile: Including the association between the output stream, the format definition, thedistribution definition, and the output profile itself.
• Output Streams: Including the association between barcodes and output streams.
• Format Definitions: Including PDEF files. If no PDEF file exists, the migration.log ormigration_batch file will record an error.
• Distribution Definitions.
• Font Definitions: Including all of your CompuSet font files.
• Bar Code Definitions.
Job Definitions PDPX Contents
When you migrate or export your job definition, xPression migrates the following files:• Job Definition: Exported as an XML file.
• Output Profile: Including the association between the output stream, the format definition, thedistribution definition, and the output profile itself.
• The default path for xPublish is: C:\xPression\Publish\Output\
• The default path for CompuSet is: C:\xPression\CompuSet\Output\
102
CompuSet and xAdmin
Exporting or Migrating xPression Documents
After selecting a document for export or migration, do not select Include Fonts. This option onlyapplies to xPublish documents.
Preventing Errors When Migrating Documents toDifferent Platforms
If you are migrating or exporting between different platforms (for example Windows to Solaris),ensure that your font files are suitable for your target environment. You may need to move thefiles manually. .
Exporting and Migrating Jobs
When migrating output profiles, xPression resets the Distribution Definitions option,Output Directory for Print Files, to the default path. The default path for xPublish is:C:\xPression\Publish\Output\
The default path for CompuSet is: C:\xPression\CompuSet\Output\
You may change this path again on the target server.
103
CompuSet and xAdmin
104
Chapter 6xDesign
This chapter contains information specific to the use of CompuSet in xDesign. This chapter will notcover topics that relate to the overall functionality of xDesign or to functions that apply both toxPublish and CompuSet. Please use this chapter as an addendum to the xDesign User Guide and thexDesign Style and Formatting Guide.
About xDesignxDesign 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 containedin your customer data. xDesign stores the content, images, and other document information youcreate in a single database.
The content you create through xDesign can consist of documents created through xDesign’sMicrosoft 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 imagesas you ordinarily would if you were creating a memo or letter. xDesign adds a layer of powerful datamanipulation 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 fromxDesign. When content is assembled, xDesign executes the business rules and other components ofthe 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 whichobjects 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 createa document version. All xPression applications support fax, e-mail, and print distribution.
105
xDesign
The xDesign InterfaceThe following section contains information about elements of the xDesign interface that are exclusiveto CompuSet or for which there is CompuSet-specific information.
The xPression Toolbar
There are some differences in the xPression toolbar when working with CompuSet documents andxPublish documents. The descriptions provided in the xDesign Style and Formatting Guide apply toxPublish. Most of the differences are superficial. The following list summarizes the differences.• Save and return to xPression Design— The tooltip indicates CompuSet when the currentdocument is a CompuSet document.
• Insert Replacement Field— The tooltip indicates CompuSet when the current document is aCompuSet document.
• Format Replacement Field— The tooltip indicates CompuSet when the current document is aCompuSet document.
• Insert xPression Image— The tooltip indicates CompuSet when the current document is aCompuSet document.
• Insert Picture from File— This replaces the xPublish button Insert xPression External ImageReference. xPublish has a more sophisticated system for including external images thanCompuSet; CompuSet simply inserts the image from a selected file.
• Insert xPression Printer-Resident Image— This replaces the xPublish button Rotate xPressionImage 90 degrees. Printer-resident images in xPublish are mapped through printer definitionsfor greater efficiency.
• Insert CompuSet Command—When the document is xPublish this button is labeled InsertxPublish Command. It performs essentially the same function, but xPublish has a differentcommand set.
• Update CompuSet Commands— This is the equivalent of the Remove xPublish Commandsbutton in xPublish documents, but it is used to remove hidden text associated with any CompuSetcommands or images.
• Mark Paragraph for Merge— The tooltip indicates CompuSet when the current document is aCompuSet document.
• Mark Paragraph for Merge (no space)— The tooltip indicates CompuSet when the currentdocument is a CompuSet document.
The Refresh Server Data Button
To provide better performance, xDesign retrieves and stores server data in memory so that it doesnot have to retrieve the data each time the it is needed. The data stored in memory can becomeout of date if another user has updated the information on the server while you are working in
106
xDesign
xDesign. The Refresh Server Data button enables you to download the latest server data withouthaving 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
Copying and Pasting Items in the Tree Pane
You can copy content from a document that uses the xPression Publish composition engine to adocument 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 universal and can be copied and pasted into any document, or shared withother documents along with its rule or by itself.
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). Additionally, you can’t copy contentthat contains an xPublish chart or an xPublish image from an xPublish document and paste it into aCompuSet document (xPublish charts and images are not supported in CompuSet documents).
The Preview Tab Toolbar
When viewing a CompuSet document from the Preview tab, you can choose to view it in AFP,Metacode, PCL, PDF, or PostScript.
107
xDesign
Diagnostic Tools
Document Sciences provides several tools that you can use with Solutions Support to help identifyxDesign problems. You can active application or COM traces or set up files that capture specificinformation 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.
Document Instance
A document instance captures the HTML file generated when you view a document with either theWord or HTML viewers, or the CCF file created when you use the CompuSet viewer. Both files areused to troubleshoot formatting errors.
CompuSet Tagged Text
The CompuSet Tagged Text tool captures the CCF file generated when you view a document withthe CompuSet viewer. It can be used to debug some kinds of formatting problems. A partial fileis shown below:<#DLSDOC=<pn,1,0,0/csm,0/getval,320,^321,1>
<sc,310,0/sc,311,0/sc,312,1/sc,313,1/sc,314,1><sc,315,1/sc,316,1/sc,317,1/sc,318,1/sc,319,1><sc,322,^111/csm,322,7,2><sc,323,^112/csm,323,7,2><sc,324,^113/csm,324,7,2><sc,325,^114/csm,325,7,2><sc,326,^114/ifeq,^326,0,980/ifgt,^326,12,981><sc,327,^326/csm,327,7,2><sc,328,^115/csm,328,7,2><sc,329,^116/csm,329,7,2><sc,400,0/sc,401,0/sc,402,0/sc,403,0/sc,404,0>
<sc,405,0/sc,406,0/sc,407,6/sc,408,0/sc,409,0/sc,410,0><ipsetup/ipnsnp>>
<#eDLSDOC=<putval,100,^321,1/ic,321>><#r980=<sc,326,12>><#r981=<sub,12,^326,326>><#r982=AM><#r983=PM><#r984=am><#r985=pm><#r986=A><#r987=P><#r988=a><#r989=p><#r997=<vptd,^352>><#r998=<vptd,^302>><#r950=January><#r951=February><#r952=March><#r953=April><#r954=May><#r955=June><#r956=July><#r957=August><#r958=September><#r959=October><#r960=November><#r961=December><#r962=Jan><#r963=Feb><#r964=Mar><#r965=Apr><#r966=May><#r967=Jun><#r968=Jul><#r969=Aug><#r970=Sep><#r971=Oct><#r972=Nov><#r973=Dec><#DLSMOTY=<ifeq,^112,1,950><ifeq,^112,2,951><ifeq,^112,3,952><ifeq,^112,4,953>
<ifeq,^112,5,954><ifeq,^112,6,955><ifeq,^112,7,956><ifeq,^112,8,957><ifeq,^112,9,958><ifeq,^112,10,959><ifeq,^112,11,960><ifeq,^112,12,961>><#DLSMOTY3=<ifeq,^112,1,962><ifeq,^112,2,963><ifeq,^112,3,964><ifeq,^112,4,965>
<ifeq,^112,5,966><ifeq,^112,6,967><ifeq,^112,7,968><ifeq,^112,8,969>
<ifeq,^112,9,970><ifeq,^112,10,971><ifeq,^112,11,972><ifeq,^112,12,973>><tmod,0>
108
xDesign
<#zz=><xcfl,0,1,10,0,0,0,1,0/sc,320,0/sc,321,1/nxtf><sk>Word style name: "MsoNormal"<#BP000000=<f,7><ql><pt,12,14><sub,0,^143,301/sc,302,0/sc,303,0/sc,304,0/sc,305,0>><#eP000000=><#BH000000=<f,7><ql><pt,12,14><sub,0,^143,351/sc,352,0/sc,353,0/sc,354,0/sc,355,0>><#eH000000=>
<sk>Word style name: "h1"<#BP000001=<bd/f,5/bd><ql><pt,14,16.4><sub,0,^143,301/sc,302,0/sc,303,0/sc,304,12/sc,305,3>><#eP000001=><#BH000001=<bd/f,5/bd><ql><pt,14,16.4><sub,0,^143,351/sc,352,0/sc,353,0/sc,354,12/sc,355,3>><#eH000001=>
Creating a DocumentWhen you create a document in xDesign, you are required to specify a composition engine. For moreinformation about xPression CompuSet and xPublish, see Chapter 3, The xPression Publishers. It’svery important that you decide which publisher to use.
About Text Content Groups
xPression text content is internally designated as Publish, CompuSet, or Universal depending on whereit’s created and what features it includes. If you create a text content item that doesn’t contain featuresunique to a publishing type, the content becomes universal and can be copied and pasted into anydocument, 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 featureswill be available for use in creating your content. For example, if you create a text content item in aCompuSet document you will be able to include CompuSet commands and named strings, where atext content item created in an xPression Publish document will not be able to use those features.
About Section Rules
If you are using recipient processing in your Section rules, sections without recipients defined maynot be included in the final output under certain circumstances. To be included a section must survivea two-step process. In the first step the section must meet the document’s inclusion criteria. In thesecond step, having satisfied the document criteria, recipient processing is used on the stream of anoutput profile, further refining what is included in the final output. Sections without recipients willdefault to the resultant recipient section that precedes them in the document instance.
For example, if a section without recipients defined follows a section with recipients defined, and thecriteria for the preceding section are satisfied, then the section without recipients will be includedas if it were for that preceding section’s recipient. However, if the criteria for the preceding sectionare not satisfied, the section without recipients will not be included, unless included by way ofa prior section with a recipient. For example:
109
xDesign
Section A — Recipients definedSection B — No recipients defined
In this case Section B is included if the criteria for Section A is satisfied, but not if the criteria forSection A are not satisfied, assuming that there are no sections prior to Section A that would impactthe inclusion logic.
The section with the satisfied criteria need not immediately precede the section without definedrecipients for the latter to be included. For example:
Section A — Recipients defined, criteria satisfied when VAR = “CA”Section B — Recipients defined, criteria satisfied when VAR = “WA”Section C — No recipients defined
In this case Section C would be included if VAR =”CA” OR VAR = “WA” and the proper recipient wasselected for the output stream, but not if VAR was something other than “CA” or “WA”.
In the recipient processing step, if the section without recipients defined is followed, but notpreceded, by a section with recipients, the section without recipients will never be included. Ifthe document includes any sections with recipients, then any sections without recipients must bepreceded by a section with recipients to be included, and the criteria for the section with recipientsmust be satisfied for the section without recipients to be included.
It is more difficult to predict the behavior when sections are nested. When a document withnested sections is assembled, the nesting is lost and the document is effectively a series of recipientcommands. Recipient commands are in effect until another recipient command is encountered. Itis possible to predict the precise behavior, but potentially very complex. It is recommended thatrecipients be defined at the highest level in documents with nested structures since this will be thesimplest to determine the order of execution for the recipient commands.
About Share Rules
The following issues apply to shared rules in xDesign:• You can’t share Chart rules or Subdocument rules between an xPublish document and a CompuSetdocument (Chart rules are not supported in CompuSet documents; Subdocument rules must usethe same composition engine as the master document).
• You can’t share any content that includes an xPublish chart or an xPublish image between anxPublish document and a CompuSet document (xPublish charts and images are not supportedin CompuSet documents).
SubdocumentsCompuSet master documents can only use CompuSet subdocuments. xPublish master documentscan contain CompuSet, xPublish, or xPresso subdocuments. .
110
xDesign
Including CompuSet Subdocuments in xPublish MasterDocuments
CompuSet subdocuments are not merged directly into the master document. They are first convertedto 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 HTMLoutput, 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 viewedin xRevise or xResponse, the PDF will be converted to an image.
When a CompuSet subdocument is used with an xPublish master document it is handled as anexternal 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
• Table of Contents - The subdocument’s table of contents will not be merged into the masterdocument
• Hand-coded CompuSet are not supported
• Conversion Options are not supported
Subdocuments in CompuSet Master Documents
CompuSet master documents can only use CompuSet-based subdocuments. xPresso and xPublishsubdocuments are not supported.
Document Level Settings
When designing your CompuSet master document/subdocument scenario, be aware of anydocument-level settings (such as page numbering, page setup options, or headers and footers) in yoursubdocument 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 thecase in normal xPression documents, a Microsoft Word section break enables xPression to changethese document-level settings. This system works the same in regular xPression documents andmaster document/subdocument scenarios.
For example, if your subdocument contains a different set of headers and footers than your masterdocument, and you would like to retain these differences when the documents are publishedtogether, you must facilitate this change with a section break at the beginning of the first contentitem in your subdocument. A section break placed at the end of the content item that precedes thesubdocument will not produce the correct result.
Be aware that a Next Page section break will result in the subdocument starting at the beginning ofa new page. If you want the subdocument to appear within the flow of the master document, usea Continuous section break.
111
xDesign
Note: If you place a Next Page section break at the beginning of the subdocument, then yoursubdocument 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 anysection breaks that occur in the subdocument will cause the subdocument settings to supersede themaster document settings.
Publishing an xPresso Package Through xRevise
xRevise does not allow you to place two external content items in the same Revision Unit. WhenCompuSet content items and xPresso packages are included as subdocuments, they are converted toPDF and treated as external content items. If your document includes two external content items, youmust ensure that each content item is placed in a separate Revision Unit. You can accomplish this byplacing each external content item in a separate section rule with a different Revision Unit name.
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 withCompuSet 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 youcannot assign recipients in both the master and subdocument at the same time. Also, you can placeyour subdocument in a section rule in your master document and assign recipients to that section rule.
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 inthe print file. You will not receive a print file for each subdocument.
Bar Codes
If you set up bar codes on your output stream for your master document, the bar codes will carrythrough to your subdocuments. If you installed the xPression sample applications, you can see barcodes defined on the Policy Package master document by publishing it through the “Multiple”output profile.
112
xDesign
Adding a CompuSet SubdocumentTo 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 fromthe 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 thecriteria you establish. The information in your data source must match all of the criteria attachedto the content group before xDesign can use the content items it contains. Selection criteria areoptional, so you can click Next to skip this step. .
6. The Document Name page appears. Select your category and document name.From this page you can select the document you want include as a subdocument. In theDocument Type list, you can only select CompuSet document.
7. From the Categories list, select the category where your CompuSet document resides.
8. After you select a category from the Categories list, the Documents list populates with all theCompuSet 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 thedown arrow next to the Key Field box and choose one of the keys.Notice that the Key Fields from the subdocument are listed in the bottom portion of the page.
10. Give the key a value that can be specified as a Literal value that you type into the field, a Fieldfrom 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 forthe document to assemble correctly.
11. Each time you set the value for a key, click Update and you will see the assignment in the listat the bottom of the page.
12. When all keys have associated values, click Finish to complete the rule. If there are any keys thatdon’t have assignments you will not be allowed to complete the rule.
Document VersionsThink of a document version as a snapshot of a document taken at a certain point in time. Thisprocess captures a snapshot of the following document properties and files to create an image of thedocument:• Content groups
• Business rules
• Criteria
• Replacements
113
xDesign
• 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 documentversion to make the document available to xPression production services like xPression Batch,xResponse, or an xPression Framework application. These applications use the document version toassemble, customize, and distribute your document.
Note: If you rename a document, xDesign automatically renames all existing document versions.
Recipient ProcessingSection rules enable you to designate sections of your document for inclusion in document instancesfor specific recipients. For example, if you are creating an insurance policy document, you may needto create different packages to go to the client, the agent, and to the home office. xPression enablesyou 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 yourdocument 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 streamsare referenced in an output profile which you define while setting up your output configuration.
Differences Between CompuSet and xPublishRecipients
To set up recipient processing for CompuSet, you must set up page sequences in your recipientenabled section rules. Recipients will not be honored unless they are identified by page sequences.Please see Create Recipient-Enabled Section Rule, page 115 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 overridethis automatic designation by simply setting up page sequences in your content item.
114
xDesign
Defining RecipientsTo 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.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 namesahead of time) and click Define. Repeat as necessary.
4. To associate one of the recipients with the current document, select the recipient in the AvailableRecipients list and click Add.
5. Click the Output Profile tab. 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 RuleTo define portions of your document for recipients, complete the following steps:1. Add 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 recipientsand 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 youwant to designate for inclusion by recipient. xPublish does this step automatically. If you are creatingan xPublish document, proceed to Create xPublish Page Sequences, page 116.
Note: Sections marked as page sequences in a subdocument of a CompuSet master document willbe ignored. The subdocument is processed it its entirety for the recipients defined in the masterdocument.
115
xDesign
You must create at least one content item under each recipient processing-enabled Section rule. WhenxPression assembles a document that contains a recipient processing-enabled Section rule, the contentitem that immediately follows the Section rule must begin with a Microsoft Word Odd page sectionbreak. The combination of a recipient processing-enabled Section rule and a Word Odd page sectionbreak marks the beginning of a new page sequence.
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 xPressionwhen you publish through CompuSet. Page-level formatting includes settings such as paper sizeand 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-breakingsection break, whichever comes first.
You may want to define one or more special content items that contain only an Odd page sectionbreak, 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 yourdocument more manageable in the long run.
To prevent unwanted blank pages from appearing at the beginning of your xPression-generatedCompuSet documents, you must use a CompuSet conversion option, Omit document-initial NS/NPcommands, to disable the automatic insertion of NP commands. See your system administrator tohave 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 OutputProcessing for your product, you had to add a Section rule as the first rule in your product, and enableit 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 anyrecipient-enabled section rule. If you want to define a smaller page sequence that would encompassonly a subsection of the content item, simply define a page sequence by adding a Next Page SectionBreak 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 onconditions, and configure finishing information like bar codes. Output streams are then referencedin an output profile (the same profiles you made available to the document) where they are joinedwith a format definition or output definition (which specifies a particular output format type, such asPostScript) and a distribution definition (to distribute the document to the correct output device).
Note: If you make any changes in xAdmin to your output profiles, or any of the componentscontained within them, or you decide to add recipient processing functionality to your documents ata later time, you must regenerate the XML for your xPression document in xDesign before any of thechanges will be applied to the output documents.
116
xDesign
Formatting Variable ReplacementsFormatted variables within CompuSet hidden text is not supported. If attempted, the documentgenerally cannot be previewed or published. However, in most cases, a User Exit can be used toachieve the desired result. Refer to the eBooks for more information on using User Exits withxPression.
117
xDesign
118
Chapter 7Batch and xDashboard
xDashboard is a thin-client application that enables you to run and administer the batch capabilitiesof xPression and manage the xPression Server. This chapter only contains information aboutxDashboard features that are exclusive to CompuSet. Most of the documentation in the xDashboardUser Guide applies to CompuSet as well.
CompuSet and xPublish Job DefinitionsThe Job Management page handles job definitions for both CompuSet and xPublish documents.When creating a job definition you can identify the job as a CompuSet or xPublish job. Ensure you payclose attention to this designation as CompuSet and xPublish job definitions are not interchangeable,and only documents that match the job type will be available in Job Management.
All batch configuration work is done from the Job Management Page in xDashboard. The jobdefinition page enables you to create and execute a job definition. The General section contains basicsettings for your job definition, such as name, publisher, output profile, and job steps.
Note: The performance of CompuSet Batch runs can be significantly impacted by the Pass-By-ValueReference setting in WebSphere or the Call By Value setting in JBoss. In WebSphere the setting forPass-By-Value should be selected. This option is located in the WebSphere administrative console for[server name] under Container Services, ORB Service. In JBoss the Call By Value element should beFalse. This element is in the ear-deployer.xml file located in [JbossHome]/server/default/deploy/. Theelement should resemble this: <attribute name’”CallByValue”>false</attribute>.
Job Definition Page
The general section of the job definition page contains basic information about your job definition.The general section contains the following options.
Element Name Description
Name Type a 1-255 alphanumeric job name. Make the name as descriptive as possible,but keep in mind that you will be referencing this name from batch scripts, andshorter names are easier to work with.
Type Select your CompuSet as your publisher type.
119
Batch and xDashboard
Element Name Description
Output Profile Select the output profile that you want to associate with this job definition. Thisoutput profile will apply to all the documents included in the batch run (unlessyou are using queued documents, which enables you to override it). An outputprofile is a set of output streams, each of which is associated with a format orprinter definition, and a distribution definition.
Job Options: Save toIntermediate Output only
Creates the intermediate output required by job steps using previously run jobs.You can specify the location where the intermediate output should be saved.
If the output profile you choose produces only HTML, xPression won’t produceintermediate output.
JobOptions: Save CompuSettagged text
Saves CompuSet tagged text to the location of your choice. Tagged text can beused to verify that the CompuSet publishing engine is functioning properly. Usethis option only for troubleshooting your output.
Job Options: Override theOP Setup File
This feature is for highly specialized situations where a user may want tooverride the default OP Setup file created by xPression.
The OP setup file defines the master page group template, describes the sortorder objects, and designates OP fields as merge keys. It also contains commandsthat define the tasks to be performed by Output Processing.
xPression automatically generates the OP setup file. To override this file, selectthis option and type the fully qualified path and file name for the override file inthe provided box.
Thread Pool Size Defines the number of worker threads available for each batch run. TheCustomer Data Reader and xPression Assembly components of the batch processuse this setting to distribute customer records across parallel threads to improveperformance.
Note: Some DOCX, HTML, and text output files may be lost if Thread Pool Sizeis greater than 1 and a counter is used as the sole means of ensuring unique filenames for the output. Files with identical names may be produced by parallelthreads and counters do not reliably reflect different threads, so files withduplicate names are overwritten.
Customer Record Buffer Number of customer records the main batch thread reads in at a time.
Job Level Indicates what type of information will be collected for your job.
Statistics - Collects only batch statistics, such as start time, end time, and publishtype.
Statistics with errors - Collects all the statistics information and informationabout failed customer documents.
Statistics with details - Collects all the statistics information and customerdocument information for all documents. Select this option for information toappear on the Job History tab.
This information is displayed on the Job History tab, after clicking the Job Name.
120
Batch and xDashboard
Element Name Description
Batch Parameters This box enables you to specify a string value that can be appended to your printfile name, batch log file name, CompuSet log, and CompuSet emitter log. Whencreating your file names, xPression enables you to add the “batch parameter”to your naming convention. Each time you run batch from xDashboard whileusing the batch parameter, xPression appends this string to the beginning ofyour CompuSet and emitter log files names. This helps you locate all the logfiles for a particular batch run.
Pre-Processing Scripts This section enables you to define scripts that will be executed by the xPRSServer prior to executing the batch process.
Job Steps This section enables you to add job steps. Each step identifies a set of documentsyou want included in the batch run. Choose the type of batch job, the documentsource, and the data source. Job steps allow you to execute multiple documentsources at once.
Post-Processing Scripts This section enables you to define scripts that will be executed by the xPressionServer after the batch process completes.
Job Log File Naming Conventions
Most of the material in this section also applies to xPublish. CompuSet-only material is noted. Useone or both of the following options to create a method for naming your job log. A preview of yourjob log appears at the top of the job file naming table.
You can manually type a name for your error log by clicking Add Literal and typing the name in theprovided box. If you create a job log file name using two or more consecutive literals, xPression willcombine those literal definitions into a single literal definition when you click Save.
For example, if you create a job log file name using three separate literals as follows:Report_ Receipts_ October
When you click Save, xPression concatenates these literal values into the following single literaldefinition:Report_Receipts_October
The Add Function button enables you to name your job log using the job ID, job name, theBatchParameter, or the current date.
121
Batch and xDashboard
From this section you can add the following elements.
Element Name Description
Current Job ID Adds the Job ID to the job log name.
Current Job Name Adds the name of the job definition to the job log name.
BatchParameter The BatchParameter enables you to add an identifier to your log files. Thisidentifier helps you identify output files for a particular job. This is especiallyhelpful when output from more than one job resides in the same directory.
When you select the BatchParameter function, xPression will add theBatchParameter value to the job log name. The BatchParameter value is set at thetime the batch job is executed from the command line.
When you use the BatchParameter in your job log name, xPression also appendsthe parameter to the beginning of your CompuSet and emitter log files. This makesit very easy to locate all of the job files for a particular batch run.
Date Adds the current date to the job log name.
Use the up and down arrows to move the selected item up or down in the list. Items at the top of thelist appear first in the job file name, and items at the bottom appear last.
About Job Steps
Most of the material in this section also applies to xPublish. CompuSet-only material is noted. A jobdefinition must contain one or more job steps. A job step selects documents and defines customerdata for your job definition. You can use multiple job steps to select different types of documentsand publish them in the same job definition.
An individual job step can select xPression documents or xPRS packages for the job definition. Jobsteps for xPression documents can select xPublish and CompuSet documents created in xDesign. Jobsteps for xPRS packages can include xPresso packages created in xPresso for InDesign, xPresso forDreamweaver, and xPresso for Word and imported into your xPression enterprise edition server. Theoptions for xPression and xPRS job steps are different.
To access the job steps page, click Add Step from the job steps section on the job definition page. Thejob step options appear in the following pop-up page.
122
Batch and xDashboard
At the top of the job step page you will see settings for Name, Type, and Document Type. As forthe job type, there are several different job types to choose from, and each type contains uniqueoptions and functions.
Job Type Description
Name Supply a name for the Name box. The name must be between 1 and 255 alphanumericcharacters.
Type: Assemble An Assemble job type should be used when you want to directly specify whichdocuments you want to assemble.
This job type provides several methods for identifying your document:
• Directly specifying the document category, name, and data source
• Retrieving the document name from a data source
• Using a trigger file data source
Type: QueuedDocuments
Use the Queued Documents job type when you want to process documents thathave already been “queued for batch” by a transactional distribution request sent byxPression Response or any application built with xPression Framework.
Type: Previously RunJobs
This option is only available for CompuSet job definitions. You should use this job typeif you are merging intermediate output from a previous batch run.
Type: CustomDocuments
Use Custom Documents when you want to pull completed work items from thexPression Revise Completed Work queue or from a field in a data source, and add“personalization data” to each. The data must be provided in a trigger file and isrestricted to a single “record” of information for each customer.
Document Type You can choose xPression and xPRS. To create an xPression document job step, ensureyou select xPression.
Job Steps for Previously Run JobsPreviously Run Job is a CompuSet-only feature. Previously run jobs are jobs that were intercepted byxPression before the final output was created. This intermediate output is saved to a network locationdefined by the user. The purpose of saving the intermediate output is to merge it with another batchjob through the use of a Previously Run Job step. A Previously Run Job step performs the sole actionof merging intermediate output into your current job definition. For instructions on configuring yourPreviously Run Job from beginning-to-end, see Previously Run Jobs, page 127.
To merge the intermediate output:1. Click Add Step to create a new job step.
2. From the job step page, select Previously Run Job from the Type list.Supply the fully qualified path and filename of the intermediate output you want to mergeinto the current job. The path you define here is the same path that you used when savingintermediate output from your previous job definitions.
123
Batch and xDashboard
3. Click Save. The job definition page shows the new job step.Each job step can only contain a reference to one piece of intermediate output. To merge inanother intermediate output file, create an additional job step using the same instructions.
4. Next, you must use an Assemble job step as the final job step for your Previously Run Job jobdefinition. The Assemble job step provides a key for merging the intermediate output from theprevious documents into the final document.
Running a Batch JobBatch e-mail jobs can be run from Windows (DOS) or UNIX (batch or shell scripts). If a CompuSetPDF batch job encounters an e-mail recipient whose e-mail address (“To” variable) is missing, thejob fails and does not identify the record that had the missing e-mail address. If an xPublish jobencounters the same situation and fails, the log will indicate the bad record.
Server ManagementThe Queued Document Management tab located in Server Management enables you to sort queuedCompuSet documents by output profile and delete individual documents from the list. This listshows all queued CompuSet documents by default. To sort the list by output profile, select the outputprofile from the View By OP drop-down box. This page contains the following elements.
Element Name Description
View by OP Select the Output Profile for the CompuSet documents that you want to deletefrom the queue. Select All to show all documents in the queue.
Delete Click this icon to delete the selected documents. You must view each documentthat you want to delete before you can delete it.
DOC ID The document’s ID.
Output Profile Name The name of the document’s output profile.
Output Profile ID The ID of the document’s output profile.
BDT ID The document’s Business Document Template ID.
Document Name The name of the CompuSet document.
Category Name The name of the document’s category.
View Click this button to view the document. You must view the document before youcan delete it from the queue.
You must view a document before you can delete it. To delete a document:1. Click View to review it in the viewer.
2. Click Back to return to the Queued Document Management list when you have finishedreviewing the document.
3. Select the document check box, and click Delete.
124
Batch and xDashboard
The Job History TabxPression enables you to view a detailed listing of recently executed batch jobs. Click Job History tabto display the job history list.
The Job History details will not contain any information that was created or altered by a print script.For example, if your print script is designed to rename the output files generated by xPression,the job history page will not show the updated names. It will show the output file names as theywere when they left the xPression system. The Job History details will also not contain the outputfile name for CompuSet jobs.
File Naming Recommendations for Batch JobsIf you are running a CompuSet batch job that can conditionally execute one or more output streamsbased on a set of criteria, Document Sciences recommends creating unique names for your print filesusing counters or variables, or deleting each print file with a print script after it completes processing.
The reason for this suggestion is that the print files created by the batch job are not automaticallydeleted after each run. Remember that the DistributionController service processes any recordsthat it finds in the T_PRINTINFO table in your content repository. xPression populates this tablebased on the output files it finds in the output file directory you specified. If the output files are notautomatically deleted after each run, xPression will continue populating T_PRINTINFO with all ofthe files in that directory regardless if they were generated by the new batch run or not.
For example, if you ran a batch job that produced two files (file A and file B), both file A and file Bwould be saved to your output file directory. If you then ran the batch job a second time and itproduced only one file (file A), xPression would overwrite the existing file A but not delete the existingfile B. xPression would then process both file A and the unneeded file B for the second batch job.
You can avoid this problem by giving your output files unique names or by deleting the outputfiles after each batch run through a print script.
Command Line Batch ProcessingMost of the material in this section also applies to xPublish. CompuSet-only material is noted. ForWindows 2000 and Windows XP operating systems, Document Sciences provides BatchRunner as abatch file. For UNIX platforms, Document Sciences provides Batch Runner as a shell script.
To run xPression Batch directly from the command line, navigate to the xPression .ear directory inyour application server installation directory and type the BatchRunner command. The BatchRunnercommand uses the following parameters:
• For Windows operating systems, type:
BatchRunner -j JobDefName -f JobDefLocation -q OutDataOverrideFile -oInDataOverrideFile -n BatchParameter -p OutputFilePath -ignoreDebug -dDiagnosticOutput -disableReporting -r JobRunIDOverride
• For UNIX operating systems, the command is case sensitive. Type:
125
Batch and xDashboard
$ BatchRunner.sh -j JobDefName -f JobDefLocation -q OutDataOverrideFile-o InDataOverrideFile -n BatchParameter -p OutputFilePath -ignoreDebug-d DiagnosticOutput -disableReporting -r JobRunIDOverride
For example, if you installed WebSphere to the C:\ directory, your BatchRunner command wouldlook like this: C:\WebSphere\appServer\installedApps\xPression.ear\BatchRunner-j NightlyBatchRun
The default location of xPression Batch output is:• For CompuSet: <xPressionHome>\CompuSet\Output\
• For xPublish: <xPressionHome>\Publish\Output\
Command Line Parameters
The BatchParameter (-n) enables you to add an identifier to your report file, log file, and print filenames. This identifier helps you identify output files for a particular job. This is especially helpfulwhen output from more than one job resides in the same directory. Follow the -n parameter withtext to identify the output files of a batch run.
For example: -n 1stRun
If you have added the BatchParameter variable to your report file, log file, or print file names,xPression will take the identifier and apply it to those file names. Anytime you use a BatchParameterin xDashboard, xPression appends the BatchParameter to the beginning of your CompuSet andemitter log file names. This helps you locate all the log files for a particular batch run.
The -xc parameter causes comments to be added to the tagged text stream with information abouteach content object just before the content to which the comment applies. The final output is notaffected by this parameter.
This option may be useful in locating output problems, especially in complex documents.
This option only applies to Batch, and only for CompuSet. Tagged Text Capture must be specifiedin the job definition.
This option will not work if the output profile contains an HTML stream.
126
Batch and xDashboard
Previously Run JobsPreviously Run Job is a CompuSet-only feature. Previously run jobs are jobs that were intercepted byxPression before the final output was created. This intermediate output is saved to a network locationdefined by the user. The purpose of saving the intermediate output is to merge it with another batchjob through the use of a Previously Run Job step.
A Previously Run Job step performs the sole action of merging intermediate output into your currentjob definition. This chapter covers how to set up a complete Previously Run Job scenario.
Overview of a Previously Run Jobs Scenario
In most cases, a Previously Run Jobs scenario is similar to the following setup:
Job Definition Description
Job 1 The first job definition is configured to save intermediate output toa network location.
Job 2 The second job definition is configured to save additional intermediateoutput to a network location.
Job 3 The third job definition contains the Previously Run Job step thatmerges together the intermediate output from Job 1 and Job 2.
Notice that this scenario uses three different job definitions.
The first two job definitions create separate pieces of intermediate output. These job definitions donot use a Previously Run Jobs step. The third job definition uses the Previously Run Jobs step tomerge the intermediate output.
Important Requirement
A Previously Run Jobs scenario contains one crucial requirement. Intermediate output can only bemerged and published by the same output stream(s) that originally created it. This means that theoutput stream used in the output profile for your Previously Run Job definition will only produceoutput if that same stream was used to initially create the intermediate output.
For example, consider the following scenario:
Job 1 uses output profile A which contains two output streams, Stream X and Stream Y. This jobcreates output named CCF1.
Job 2 uses output profile B which contains two output streams, Stream Y and Stream Z. This jobcreates output named CCF2.
Job 3 attempts to merge and publish intermediate output from both jobs.
127
Batch and xDashboard
If Job 3 uses output profile A which contains Stream X and Stream Y, your final output will be asfollows:• Stream X from output profile A will produce all documents from CCF1 and no documents fromCCF2
• Stream Y from output profile A will produce all documents from CCF1 and CCF2
128
Batch and xDashboard
Stream X does not produce documents for CCF2 because stream X was not used to create CCF2.
For this reason, Document Sciences recommends that any stream you want to output fromintermediate output be included in the job that creates the intermediate output.
Creating the Intermediate Output
This section describes how to setup a job definition that creates intermediate output as described inthe table in Overview of a Previously Run Jobs Scenario, page 127 (Job 1 and Job 2).
To create intermediate output, complete the following steps:1. Create a new CompuSet job definition and supply a name for the job definition.
2. Select the output profile. It is important to remember the name of the profile you select. Thejob definition that will eventually merge together your intermediate output (Job 3 in the tablein Overview of a Previously Run Jobs Scenario, page 127) must reference an output profile thatuses an output stream that was previously used in one of the job definitions that created theintermediate output (Jobs 1 and 2 from the table in Overview of a Previously Run Jobs Scenario,page 127).
3. This job definition requires a job step to select your documents and customer records. Do notselect Previously Run Jobs for this job step. Select Assemble or Queued Documents.
4. Select the Save to Intermediate Output Only check box and provide a path and filename for theintermediate output in the field indicated. All documents processed through this job definitionare saved to the path you define in the Path to directory box.Remember the path you specify here, you’ll need to reference it from the Previously Run Jobs
definition.
5. Repeat these steps to create additional intermediate output jobs if necessary.
129
Batch and xDashboard
Creating the Previously Run Jobs Job Step
This section describes how to setup a Previously Run Job definition that merges intermediate outputas described in the table in Overview of a Previously Run Jobs Scenario, page 127 (Job 3).
To create your Previously Run Job definition, create a CompuSet job definition (as shown in Creatingthe Intermediate Output, page 129) that uses a valid output profile. This job definition must referencean output profiles that uses an output stream that was previously used in one of the output profilesfrom the job definition that created the intermediate output (Jobs 1 and 2 from the table in Overviewof a Previously Run Jobs Scenario, page 127).
For example, the following scenario is valid:• Job1 creates intermediate output and uses an output profile that contains output stream A.
• Job2 creates intermediate output and uses an output profile that contains output stream B
• Job3 uses a Previously Run Job steps to merge together the intermediate output, and uses anoutput profile that contains output stream B.
The following scenario is also valid:• Job1 creates intermediate output and uses an output profile that contains output stream A.
• Job2 creates intermediate output and uses an output profile that contains output stream A
• Job3 uses a Previously Run Job steps to merge together the intermediate output, and uses anoutput profile that contains output stream A.
The following scenario is invalid:• Job1 creates intermediate output and uses an output profile that contains output stream A.
• Job2 creates intermediate output and uses an output profile that contains output stream B
• Job3 uses a Previously Run Job steps to merge together the intermediate output, and uses anoutput profile that contains output stream C.
To merge the intermediate output:1. Click Add Step to create a new job step.
2. From the job step page, select Previously Run Jobs from the Type list.Supply the fully qualified path and filename of the intermediate output you want to mergeinto the current job. The path you define here is the same path that you used when savingintermediate output from your previous job definitions on .Supply path and filename to intermediate output.
3. Click Update. The job definition page shows the new job step.Each job step can only contain a reference to one piece of intermediate output. To merge inanother intermediate output file, create an additional job step using the same instructions.
4. Next, you must use an Assemble job step as the final job step for your Previously Run Jobs jobdefinition. The Assemble job step provides a key for merging the intermediate output from theprevious documents into the final document.
130
Batch and xDashboard
Multi-Threading in xPressionMost of the material in this section also applies to xPublish. CompuSet-only material is noted. Theconcept behind multi-threading is to enable xPression to process more than one customer record at atime. xPression’s batch capabilities were designed to be thread-safe, enabling xPression to open upseveral concurrent processing threads, significantly improving batch performance.
xPression sends these multiple threads to either xPublish or the CompuSet publishing engine. WhilexPression Batch and xPublish are thread-safe, the CompuSet publishing engine is not. CompuSetreceives the multiple threads, but can only process them consecutively, not concurrently.
This image illustrates a high-level view of multi-threading in xPressionbatch. The following section describes the batch process in more detail
.
An In-Depth Look at Multi-Threading in xPression Batch
xPression uses its main thread, the batch job reading thread, to launch an instance of the customerdata reader. The customer data reader parses data according to the instructions contained in the jobdefinition. After the customer data reader reads a block of data, xPression processes it by launching aconfigurable amount of parallel threads. Each thread invokes an instance of the assembly engine.While the assembly engine threads are assembling personalized documents for one block of customerdata, the customer data reader reads in the next block.
131
Batch and xDashboard
This image shows how the batch component moves customer data into the assembly
engine.
For CompuSet, all of these threads feed into a single thread of the Output Processing Controller(OPC), which in turn calls the CompuSet composition engine. xPression uses a single thread becauseCompuSet is not thread safe. xPression can invoke only a single instance of it within a process. Themultiple threads of the Assembly Engine EJB are synchronized through a queue. Since the AssemblyEngine is faster than the Composition Engine, it is important to control the length of this queue sothat it doesn’t use too much memory and hang the application server. For xPublish, these threadsfeed into the multiple worker threads of the Streamer, which in turn calls xPublish. The Streamerperforms the same functions for xPublish that the OPC performs for CompuSet.
132
Batch and xDashboard
This image shows multi-threading through CompuSet and xPublish
.
For both xPublish and CompuSet, the TaskQueue and the OPCQueue synchronize the work ofBatchRunner, the customer data reader, the assembly engine, and the OPC or Streamer. Both areimplemented using the same Java class called SyncQueue().
The TaskQueue is a data synchronization channel between Batch Runner’s main thread (also knownas the batch job reading thread) and the assembly engine threads. The OPCQueue is the datasynchronization channel between the assembly engine threads and the OPC or Streamer. Both queueshave two configurable thresholds: EnqueueThreshold and DequeueThreshold.
133
Batch and xDashboard
This image shows TaskQueue and OPCQueue
.
When the number of records in a queue exceeds the configuration value in the EnqueueThreshold, thecomponent that is moving records into the queue must stop and wait until the number of records hasfallen to the value in the DequeueThreshold. When the value falls to the level of DequeueThresholdxPression initiates the component that moves records into the queue to start moving records again.
134
Batch and xDashboard
This image shows an example of moving records into the queue
.
You can set this threshold in your xDashboard job definition page.
Configuring Multi-Threading
The settings that control multi-threading reside in the BatchRunner.properties file, thexPressionPublish.properties file, and on the xAdmin Job Definition page. You should configurexPression Batch to run most efficiently on your system.
BatchRunner.properties is located in the xPression installation directory on your application server.It contains the following properties.
Parameter Definition
TaskQueue_DequeueThreshold The customer data reader reads in blocks of datato the TaskQueue. If too many records accumulatein the TaskQueue, the customer data reader stopsreading new blocks of data until the number ofrecords in the queue match this value.
When the number of records in the TaskQueuematches or is lower than this value, the customerdata reader resumes reading new blocks of customerdata records. Document Sciences recommends avalue of 5. See .
TaskQueue_EnqueueThreshold The maximum number of customer job recordsthat can be queued up for assembly. When theTaskQueue surpasses this value, the customer datareader ceases reading new blocks of data until theDequeueThreshold is met. Document Sciencesrecommends a value of 10000.
OPCQueue_DequeueThreshold This is not needed, but is included for completion.This value should always be zero.
OPCQueue_EnqueueThreshold The maximum number of assembled documentsthat can be queued for processing. It is importantto set the value to prevent the OPC queue fromgrowing too large in memory. Document Sciencesrecommends a value of 10.
135
Batch and xDashboard
The xAdmin Job Definition page contains performance parameters.
These parameters configure multi-threading in xPression.
Parameter Definition
Thread Pool Size Defines the number of worker threads available for each batch run. TheCustomer Data Reader and xPression Assembly components of the batch processuse this setting to distribute customer records across parallel threads to improveperformance.
Customer Record Buffer Number of customer records the main batch thread reads in at a time.
Job Level Indicates what type of information will be collected for your job.
Statistics - Collects only batch statistics, such as start time, end time, and publishtype.
Statistics with errors - Collects all the statistics information and informationabout failed customer documents.
Statistics with details - Collects all the statistics information and customerdocument information for all documents.
There is one more setting that can affect multi-threading, it is the EnableSubstream setting inxPressionPublish.properties that activates or deactivates the multiple thread capabilities of thexPublish emitters. Once a document is composed by xPublish, it is sent to an emitter that creates thefile in the proper format. When you disable the multiple thread capabilities of the xPression emitters,the emitter is only capable of processing one document at a time.
It is necessary to disable this setting when you wish to produce all of your customer records in asingle output file.
EnableSubstream is disabled by default in the xPressionPublish.properties file located in yourxPression installation directory on the application server. Disabling this setting should not producea significant performance downgrade for typical xPublish documents, such as statements. Emitterperformance is generally an issue for long text-based documents, such as policies and contracts.
If you are using multi-threading, are not producing a single print file, and need increased emitterperformance, configure the following parameters in the xPressionPublish.properties file.
Parameter Definition
EnableSubStream This value can be set to true or false. If set to true, the xPublish emittersare capable of processing multiple streams of documents concurrently.
SubstreamNumber This parameter is only used if EnableSubstream=true. This valuedefines the number of parallel substreams you want your emitter touse. This value must be set to an integer.
136
Batch and xDashboard
The recommendations provided above may not be ideal for your specific installation because ofvarious factors, such as CPU speed, available memory, and I/O speed. You may need to adjust theconfigurations based on observed performance.
137
Batch and xDashboard
138
Chapter 8xResponse and CompuSet
For information about CompuSet and xResponse, see the following topics:• About xResponse , page 139
• Previewing a PDF in xResponse, page 139
About xResponsexResponse is a transactional application available to the xPression Enterprise Edition Server. Mostinformation about this application appears in xResponse User Guide. This chapter contains informationspecific to using xResponse with CompuSet documents.
xResponse
xResponse is a web-based application that provides secure online transactional services for creating,editing, and publishing personalized xPression documents from Web browsers.
xResponse currently allows you to choose between two editing technologies depending upon thelevel of editing required by your users. Use the Java applet editor for simple editing tasks. This editordoes not require a Microsoft Word license installed on each xResponse desktop. For heavier editingtasks, you can select the Microsoft Word-based editor for a richer editing experience.
xResponse enables you to respond quickly to customer inquiries with personalized, fully-compliantcommunications. It easily integrates with your CRM system and enables you to assemble anddistribute approved documents. For more information, see the xResponse User Guide.
Previewing a PDF in xResponseYou can now preview PDFs from the xResponse preview pages for the Build a letter, Work inProgress, and Approval tabs for CompuSet documents.
When this functionality is activated, a Preview PDF button will appear on the preview pages for theBuild a letter, Work in Progress, and Approval tabs. After clicking the button, the preview PDF willbe displayed in a pop-up window.
139
xResponse and CompuSet
Activate Preview PDF
To activate this feature, set EnablePreviewPDF=true in your eCor.properties file. eCor.propertiesreside in the xPressionHome directory on your server (C:\xPression by default).
Use Preview PDF
After setting these properties, the Preview PDF button will appear on the preview pages for the Builda letter, Work in Progress, and Approval tabs for CompuSet documents.
Click the Preview PDF button to display the preview PDF in a pop-up window.
140
Chapter 9xRevise and CompuSet
For information about xRevise and CompuSet, see the following topics:• About xRevise, page 141
• Previewing a Work Item in xRevise, page 141
• Working with Tables in xRevise, page 142
• xRevise Documents Using CompuSet Commands, page 142
• Variables in xRevise, page 142
About xRevisexRevise is a separately licensed transactional application available to the xPression Enterprise EditionServer. Most information about this application appears in the xRevise User Guide. This chaptercontains information specific to using xRevise with CompuSet documents.
xRevise
xRevise is a browser-based application that enables swift production of custom documents through asearchable library of customized text and attributes. It enables you to modify the text of standarddocuments to reflect your negotiations with specific customers. For more information, see the xReviseUser Guide.
Previewing a Work Item in xReviseWhen previewing a work item in xRevise that uses the ‘Omit document initial NP’ CompuSetConversion Option, xRevise will display an extra blank page at the beginning of your document. Thisblank page will be removed when publishing or viewing the output. You can suppress this blankpage in xRevise by designating the document-initial page breaking section as “hidden”. However,this action will suppress headers and footers on the first page of the document in xRevise. Theheaders and footers will appear in the output as expected
141
xRevise and CompuSet
Working with Tables in xReviseThe column/cell widths determine the table structure when publishing through CompuSet. So, ifyou are using the CompuSet publishing engine, ensure that Preferred Width on the Table tab of theTable Options dialog box is not selected, and that the column widths are set as required for the tableto be constructed correctly.
xRevise Documents Using CompuSetCommandsIf any content in an xRevise document uses formatting intended for CompuSet commands, such asthe DLSFMT or DSCdls paragraph formats or hidden text, the text may not appear in the xReviseeditor and page layout may not be correct.
Variables in xReviseWhen you create a new work item, xRevise retrieves the values for any variables used in thedocument. When working with the document, the values are displayed but the variables are retained,unless there is a conflict. A conflict occurs when a variable is used multiple times in the sameRevision Unit, but not all instances of the variable have the same value. In case of a conflict, xRevisereplaces the variable with plain text.
In addition to when the work item is created, xRevise retrieves variable values from the data sourcewhen content containing a variable is moved in the Search or Carry Forward utilities. When moving acontent item containing a variable using Search or Carry Forward you are given the opportunity toapply a value to the variable other than the value in the data source.
xRevise displays the value of the variable in most cases, but not in the Search feature. When youpreview a content item returned in the Search feature, the variable itself is displayed, not the valueof the variable.
You can prevent xRevise from replacing variable values. If “replaceVariables=true” inxRevise.properties then xRevise replaces variables as expected. If “replaceVariables=false” thenvariables are not resolved when work item is assembled and will appear with curly braces (ex:{tablename.fieldname}).
Note: (1) If variable is in a table rule or loop, then that variable will show as resolved in the workitem regardless of the “replaceVariables” property value. (2) This feature is only implemented forxPublish documents (CompuSet work items will ignore this flag).
142
Chapter 10CompuSet Bridge
The CompuSet Bridge is an xPression feature that enables xPression to be used as the host for legacyCompuSet applications. This document provides a number of techniques that enable CompuSetapplications and tagged text to be leveraged within xPression.
ConfigurationTo use the CompuSet Bridge it is necessary to enable the bridge and configure CompuSet.
Enabling the Bridge
The CompuSet Bridge is a licensed feature. An appropriate license file is required to activate theCompuSet Bridge feature. Contact your EMC Document Sciences representative for information onobtaining a license for this feature.
CompuSet and Emitter Options Files
Using CompuSet and/or the emitters requires configuration through the typical method of optionsfiles that specify the file units and other features. Examples are provided in the following sections forthe two different ways of running CompuSet and the emitters: CompuSet with Linked Emitters andRunning CompuSet and Then Running An Emitter. Note that the third merge library specifies CR(content repository) which tells CompuSet to look to xPression for the licensing. Also, FILE 80 is aconfiguration file for xPression, which is included in the xPression installation.
Note: The term “Content Repository” has been replaced with “xPression Database,” but thecommand in the options file for a merge library retains the legacy terminology. For discussion thetwo terms can be used interchangeably, but any examples should be used verbatim.
143
CompuSet Bridge
CompuSet with Linked Emitters
Using xPression CompuSet with a linked emitter requires that the tagged text or style file include anEMLINK tag. Refer to the CompuSet documentation for a complete description of the parametersand other details. An example of an EMLINK command is:<EMLINK,,,2,0,0>
Example
In this example FILE 18 (second input file) is not specified since that will be passed within xPression(see later sections of this document). This must be left out of configuration files used in places wherea tagged text file is also specified. Note that File 1 must have a file specified, usually a style file,and this file must include an NXTF command to specify that CompuSet should retrieve a secondinput file on File 18.TWOP I4,200000,I4,200000,FILE 3, "/data/xPression/CompuSet/MYPROJECT/Afp.cnf", Config FileFILE 8, "/data/xPression/CompuSet/MYPROJECT/scr1.tmp", scratch fileFILE 9, "/data/xPression/CompuSet/MYPROJECT/scr2.tmp", scratch fileFILE 10, "/data/xPression/CompuSet/MYPROJECT/scr3.tmp", scratch fileFILE 34, "/data/xPression/CompuSet/MYPROJECT/scr4.tmp", scratch fileFILE 17, "/data/xPression/CompuSet/MYPROJECT/src5.gal", galley fileFILE 80, "/data/xPression/com2ejbbridge.properties", com2ejbbridge.properties fileFILE 25, "/data/xPression/CompuSet/xicsmsg.mdb", message data baseFILE 4, "/data/xPression/CompuSet/MYPROJECT/Newhdc.cnf", hyp dictionaryFILE 1, "/data/xPression/CompuSet/MYPROJECT/MYPROJECT.STY"FILE 7, "/data/xPression/CompuSet/MYPROJECT/afp.wid", widths fileFILE 45, "/data/xPression/CompuSet/MYPROJECT/myproject.pde", AFP pdef fileFILE 11, "/data/xPression/CompuSet/MYPROJECT/1.inx", index fileFILE 12, "/data/xPression/CompuSet/MYPROJECT/2.inx", index fileFILE 13, "/data/xPression/CompuSet/MYPROJECT/3.inx", index fileFILE 30, "/data/xPression/CompuSet/MYPROJECT/myproject.dmg", read dclibFILE 31, "/data/xPression/CompuSet/MYPROJECT/library2.dmg", read dclibFILE 32, CR, dclib 3FILE 37, "/data/xPression/CompuSet/MYPROJECT/output/MYPROJECT2.afp"FILE 6, "/data/xPression/CompuSet/MYPROJECT/output/MYPROJECT2.log"// , end of file definitions
Running CompuSet and Then Running An Emitter
When a feature is needed that cannot be accomplished by running the linked emitter, it is necessaryto run CompuSet to produce a CIF or CCF file, and then run the emitter separately.
Example
This is the options file for CompuSet, where the tagged text is specified in xPression. Note there isno File Unit 18.TWOP I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,I4,1M,FILE 8, "/data/xPression/CompuSet/MY-PostScript/scr1.tmp", scratch fileFILE 9, "/data/xPression/CompuSet/MY-PostScript/scr2.tmp", scratch file
144
CompuSet Bridge
FILE 10, "/data/xPression/CompuSet/MY-PostScript/scr3.tmp", scratch fileFILE 3, "/data/xPression/CompuSet/MY-PostScript/Post.cnf", Config FileFILE 34, "/data/xPression/CompuSet/MY-PostScript/scr4.tmp", scratch fileFILE 17, "/data/xPression/CompuSet/MY-PostScript/src5.gal", galley fileFILE 80, "/data/xPression/com2ejbbridge.properties", com2ejbbridge.properties fileFILE 25, "/data/xPression/CompuSet/xicsmsg.mdb", message data baseFILE 4, "/data/xPression/CompuSet/newhdc.cnf", hyp dictionaryFILE 1, "/data/xPression/CompuSet/MY-PostScript/RBCDS_CLI.sty",FILE 7, "/data/xPression/CompuSet/MY-PostScript/Post.wid", widths fileFILE 45, "/data/xPression/CompuSet/MY-PostScript/rbcd.pde", AFP pdef fileFILE 11, "/data/xPression/CompuSet/MY-PostScript/1.inx", index fileFILE 12, "/data/xPression/CompuSet/MY-PostScript/2.inx", index fileFILE 13, "/data/xPression/CompuSet/MY-PostScript/3.inx", index fileFILE 30, "/data/xPression/CompuSet/MY-PostScript/rbcds.DMG", read dclibFILE 31, "/data/xPression/CompuSet/MY-PostScript/Library2.dmg", read dclibFILE 32, CR, dclib 3FILE 37, "/data/xPression/CompuSet/MY-PostScript/output/MY-PS1.cif",FILE 6, "/data/xPression/CompuSet/MY-PostScript/output/MY-PS1.log"// , end of file definitions
Note: For the .pde file (File 45) the DMRG command p2 must be set to 1 when employing an externaltagged text rule. This applies to all output types. Also, ALWAYS specify a PDEF file in the optionsfile when using tagged text in an xDesign external content rule. The PDEF file contains the DMRGcommand and it must be referenced in order for the DMRG command to enable the DSAV.
This is the options file for the emitter that uses the output from the CompuSet step.FILE 25, "/data/xPression/CompuSet/xicsmsg.mdb", message data baseFILE 1, "/data/xPression/CompuSet/RBCDS-PostScript/output/RBCDS-PS1.cif",input cifFILE 8, "/data/xPression/CompuSet/RBCDS-PostScript/rbcd.pde", pdef fileFILE 14, "/data/xPression/CompuSet/RBCDS-PostScript/Post.wid", widths fileFILE 4, "/data/xPression/CompuSet/RBCDS-PostScript/output/RBCDS-PS1.ps,FILE 9, "/data/xPression/CompuSet/RBCDS-PostScript/rbcds.DMG", read dclibFILE 10, "/data/xPression/CompuSet/RBCDS-PostScript/Library2.dmg", read dclibFILE 11, CR, dclib 3FILE 80, "/data/xPression/com2ejbbridge.properties", com2ejbbridge.properties fileFILE 29, "/data/xPression/CompuSet/RBCDS-PostScript/1.inx", index fileFILE 30, "/data/xPression/CompuSet/RBCDS-PostScript/2.inx", index fileFILE 31, "/data/xPression/CompuSet/RBCDS-PostScript/3.inx", index file// , end of file definitions
CompuSet and the Emitters in xPression
CompuSet and the emitters in xPression use different licensing than in a typical CompuSetinstallation. In the options files discussed in the previous sections, note the inclusion of FileUnit 80. File Unit 80 is the configuration for CompuSet and the emitters to access the ContentRepository (xPression Database). This includes license validation. Whenever using the xPressionversions CompuSet or the emitters, both the CR as a DCLIB (merge library) and File Unit 80 for thecom2ejbbridge.properties file must be specified.
145
CompuSet Bridge
Logging
If diagnostic logging is enabled in xDesign or in Batch the temporary file used to pass text fromthe tagged text rule to CompuSet will not be deleted. The file can be retrieved from the server’stemporary folder and will be named following the convention of xPCset*.txt.
Batch ApplicationsLegacy CompuSet applications are usually run as batch applications where large numbers of recordsare run, producing many pages of documents. xPression allows this in the most basic way as aPre-Processing or Post-Processing Scripts in an xDashboard job.
Pre and Post Processing Scripts
A batch or script file can be specified in xDashboard, which will executed from xPression. The returncode is checked and reported in the xPression log. Multiple scripts can be specified in both the Preand Post areas of the xDashboard user interface. These scripts are run as independent processes in thecomputing environment. Refer to the xDashboard User Guide for details on the xDashboard interface.
CompuSet.exe and CompEmit.exe
In addition to the internal callable CompuSet and the emitter executables already included withxPression are two executables to enable batch jobs from pre and post processing scripts. They areCompuSet (the standalone executable) and CompEmit, which is a CompuSet executable that includesthe linked emitters. These are provided so that xPression is a complete CompuSet system enablingany legacy batch applications to still run through the xPression installation.
Script Examples
A script would resemble the following:@echo offREMREM Batch file to execute compset from Java for xPressionREMC:\xPression\CompuSet\compemit < C:\opts\AFP.opt > C:\logs\AFP.log
The script file is added in xDashBoard. A Pre-Processing script is depicted in the example below, butthe same can be done for a Post-Processing Script. Any number of different scripts can be included,performing any action that can be performed from the command line with a script file.
Add scripts in xDashboard to use CompuSet executables in pre and post processing actions. Refer tothe xDashboard User Guide for instructions on adding scripts to a job.
146
CompuSet Bridge
Job StepsJob steps in xDashboard provide another approach to running CompuSet jobs. There are threeadditional types of job steps available when the CompuSet Bridge is enabled:• Compose Tagged Text
• Submit z/OS Job
• Download From z/OS
The user can select when to run any of these steps, either before regular job steps or after. Thisprovides the option to utilize results of one of these steps within a regular job step, or the results ofa regular step in one of these steps.
Compose Tagged Text
The Compose Tagged Text job step enables specifying a tagged text file and an options file. Thetagged text file is passed to callable CompuSet on File Unit 18, so that it need not be included in theoptions file. However, the style file, or tagged text file, specified on File Unit 1 must include an NXTFcommand for File Unit 18 to be read as input. In some cases, that may be the only command in the filespecified on File Unit 1 of the options file in order to get CompuSet to look at File Unit 18. Returncodes from the step will be reported in the log and will affect the return code of the batch job.
Submit z/OS Job
This job step type enables submitting a job on a z/OS system. When this job type is selected relevantoptions become available.
When using a z/OS job set the Server, User ID, and Password in xDashboard. Refer to the xDashboardUser Guide for more information on working with the z/OS job type.
Note: If z/OS is set up with JESINTERFACELEVEL=1 (which is the default value), the job name mustbe the user ID plus one character, and the message class must not be HELD.
Download From z/OS
Specify a job step to download one or more files from a mainframe. Any number of files can be binaryor text files so that PDL output can be downloaded as binary, or tagged text files can be downloadedfor processing on the xPression system. The follow screen shows an example of downloading asbinary format, a PDF file that was composed on the mainframe. Similarly, it could have been multiplePDF files, a tagged text file (as text format), or multiple tagged text files.
When using the Download from z/OS job type the necessary options are made available in thexDashboard interface. Refer to the xDashboard User Guide for more information on working withthe z/OS job type.
147
CompuSet Bridge
Examples
The preceding actions can be used to accomplish any of the following:• Submit a z/OS job that produces a tagged text file
• Download that tagged text file from z/OS
• Call CompuSet to compose that tagged text file to final output format
Many complex scenarios are possible. The following is one example:1. Submit a z/OS job that produces individual PDF output files, via CompuSet and emitter with
Output Processing.
2. Download those files.
3. Include them as external PDF in an xPression document for final output to be distributed throughan xPublish output profile.
Automating Batch ApplicationsInternally, xPression uses XML to specify a job. Even though the UI shows a series of options withthe capability to run the job, the system creates a description of the job in XML format and this iswhat BatchRunner uses to run the job. The user can also specify the job to run by name on theBatchRunner command line.
Refer to the xDashboard User Guide for more information on job definitions.
148
CompuSet Bridge
An example of the command line execution for a batch job name FirstJob would be:C:\xPression\BatchRunner.bat –j FirstJob
Internally, the XML for this job would resemble the following example. All aspects of the UI arereflected in the XML.
<xPressionCSetJob outputProfileName="PDF To File"deletePreviousJobsFirst="no"threadPoolSize=""nextTasksNumber=""jobLevel="1">
<PreStep name="A Step"type="ComposeTaggedText"taggedText="C:\LegacyCompuSetStuff\Config\ComposeToPDL.txt"optionsFile="C:\LegacyCompuSetStuff\Config\ComposeToPDL.opt" />
<PostProcessingScript><Script name="Run the Emitter"
command="c:\xPression\CompuSet\emitter.bat" /></PostProcessingScript><JobLog logLevel="DEBUG"
logPath="C:\xPressionMainline\xPressionHome\"logFile="Job_{JobRunID}.log"errorThreshold="100"appendToExisting="no" />
</xPressionCSetJob></Job>
BatchRunner can also take a command line argument to retrieve the XML for the job. This enablesthe caller to automate the creation of the jobs, especially in the area of the CompuSet Bridge. Thisprovides great flexibility and the ability to uniquely name and specify options files as well as log files.Here is an example of running a job by defining the job in an XML file.
C:\xPression\BatchRunner.bat –f “C:\xPression\myJobs\Job123456.xml”
Note that the –f command, like options, specifies an XML job file.
xDesign - External Content Tagged Text RulexDesign supports an External Content rule. The CompuSet Bridge allows specifying CompuSettagged text as the content. This allows the embedding of legacy CompuSet tagged text into thexPression document, or as a stand-alone xPression document generated from the tagged text. Thistagged text is currently supported on the page boundary.
The tagged text file is passed to callable CompuSet on File Unit 18, so that it need not be included inthe options file. However, the style file, or tagged text file, specified on File Unit 1 must include aNXTF command for File Unit 18 to be read as input. In some cases, that may be the only command inthe file specified on File Unit 1 of the options file in order to get CompuSet to look at File Unit 18.
The mechanism for embedding the tagged text into a document is to compose the document withCompuSet into the format(s) needed for output, saving that document with a CompuSet DSAVcommand, and then merging that document into the output at the xPression emitter stage ofprocessing. This ensures that the legacy tagged text will be compatible with the xPression taggedtext, since they are composed independently.
149
CompuSet Bridge
Note: The DSAV action is completed automatically; the user does not need to take any action toaccomplish this.
If multiple output formats are needed, multiple options files must be specified in a “.list” file, and thefont indexes in the tagged text should be consistent between the multiple widths files.
External Tagged Text File
A tagged text file can be used as the source of the document. This option has limited usability sincestatic tagged text files are included repeatedly. Only the reference to the tagged text file is migrated,not the actual file.
Note: Since DSAV is the mechanism used to compose and merge the external document into thexDesign document, the external document itself cannot include any DSAV commands since thetagged text DSAVs would terminate the overall DSAV upon execution.
Using Customer Data
A more useful approach than using an external tagged text file involves formulating the filenameby using a combination of literal and customer data fields, thereby personalizing the tagged textto be used.
Customized User Exit
A user exit (custom code) can be used to retrieve the tagged text. The user exit provides completeflexibility to retrieve the tagged text from a database stored procedure, different machine, and justabout anyplace where custom code can be used to accomplish the retrieval. Refer to the xAdmin UserGuide for details of using custom user exits. When using a customized user exit with the CompuSetBridge, the user exit must return well formed tagged text. Migration works the same as a standarduser exit as described in the User Guide. That is, the user must move the jar file and update the classpath on the target machine.
The Options File
The tagged text rule must define a Compuset options file. Like the tagged text file, the options file isaccessed by the xPression server. Only the reference to the options file is migrated. The actual filemust be migrated manually.
Note: ALWAYS specify a PDEF file in the options file when using tagged text in an xDesign externalcontent rule. The PDEF file contains the DMRG command and it must be referenced in order for theDMRG command to enable the DSAV.
150
CompuSet Bridge
Default Paths
Either the options file or the tagged text file may be specified without a path. If the server sees noforward or backward slash anywhere in the file name, it will check to see if default paths have beendefined. Do this by adding one or both of these lines to ofp.properties, substituting your actualpath for “your_path”:csetOptFileDir=your_path/csetTextFileDir=your_path/
The file name will be concatenated to this value.
Specifying Multiple Option Files
Part of the configuration of the Tagged Text rule is to specify the CompuSet options file. Because adocument may be used in multiple output types (PostScript, AFP, PDF, PCL) it may be necessaryto specify an options file for each of the output types desired. If file with an extension of “.list” isspecified, then it will be treated as a file designating multiple options files, and each line within thatfile will be considered a different option file and the document will be saved (DSAV) multiple times.CompuSet requires that a saved (DSAV) document be done for each output format to be supported,and the emitter will know which format to include, based on the format being produced.
Example
Contents of a file with a .list extension may resemble:/data/xPression/CompuSet/bridge/PDF.opt/data/xPression/CompuSet/bridge/AFP.opt
Ensure the widths files are made to match between output formats, so that all font indexes includedin the tagged text must exist. For matching fidelity between output types, the font widths must alsomatch (as is always the case for multiple format output in CompuSet).
151
CompuSet Bridge
SubdocumentsAn effective way to use a document that is either primarily an External Content rule with TaggedText, or utilizes one, is to embed it within a master document as a subdocument. A master documentcan combine multiple documents from either xPression or legacy tagged text, and xPression outputprocessing features can then be applied to the combined documents for a wide variety of functionality.
CompuSet Master Document
If the master document is a CompuSet document, then the subdocuments will be processed throughCompuSet natively. The document can be published through a CompuSet output profile, providedthe same output format and widths files are used , the fidelity of the output should be consistentwith legacy CompuSet applications.
xPublish Master Document
When using an xPublish master document, all CompuSet subdocuments are processed to PDF formatand included in the master document as external PDF. This is also true for a CompuSet subdocumentthat has External Content as Tagged Text (a legacy CompuSet bridge document). When the masterdocument is output as PDF, the resultant fidelity is excellent. The fidelity of other output formatsmay be degraded to some extent, as the PDF is converted to an image format, and some degradationof fidelity can occur. The result should be tested to determine whether the fidelity is acceptablefor a given application.
Web ServicesxPression supports custom applications that utilize web services. For details of Web services, refer tothe xPression documentation, in particular the xFramework Developer’s Guide. This section outlines aseries of a web service that has been setup in xPression to permit using the CompuSet Bridge.
Enabling/Installing the Bridge Web Service
To enable the Web service that supports the CompuSet Bridge, import the CsetBridgeDoc_PDP.zipPDP.
This import will add the category CSetBridgeCat1 to the server. Use this category to add permissionsfor users to invoke the web service. Any valid application name, either built-in or user-defined, canbe used. Pass the same application name into the web service methods. Only read access to thecategory is required to call the methods.
152
CompuSet Bridge
Available Methods
The following Web service methods are available.
Publish Tagged Text
The publishTaggedText Web service publishes the specified tagged text using the specified outputprofile.
153
CompuSet Bridge
Syntax
public String publishTaggedText( String userName,String password,String application,String text,String optionPath,String outputProfile)
Parameters
userName : String
A string specifying the user who has been granted access rights to the category and applicationin xAdmin.
passWord : String
A password for the user who has been granted access rights to the category and application inxAdmin.
application : String
An xPression application name. Use this name to assign read permissions in xAdmin to the categoryCSetBridgeCat1 to the users who will call this method.
text : String
The CompuSet tagged text to publish.
optionsPath : String
A path and filename for the options file with which to compose tagged.
outputProfile: String
The name of the output profile to publish the composed tagged text through.
Preview Text to PDF
The previewTaggedText Web service created a PDF preview of the specified tagged text.
Syntax
public byte[] previewTaggedText( String userName,String password,String application,String text,String optionPath)
154
CompuSet Bridge
Parameters
userName : String
A string specifying the user who has been granted access rights to the category and applicationin xAdmin.
passWord : String
A password for the user who has been granted access rights to the category and application inxAdmin.
application : String
An xPression application name. Use this name to assign read permissions in xAdmin to the categoryCSetBridgeCat1 to the users who will call this method.
text : String
The CompuSet tagged text to publish.
optionsPath : String
A path and filename for the options file with which to compose tagged.
Publish Tagged Text with OP Fields
The publishTaggedTextOP Web service publishes the tagged text with OP fields using the specifiedoutput profile.
Syntax
public String publishTaggedTextOP( String userName,String password,String application,String text,String optionPath,String outputProfile,String fields)
Note: When passing data to be assigned to Output Variables with this web service, the user mustmap those variables to this data source’s appropriate variables, and then pass the values within theassociated XML Elements for those data elements. The result will be that those Output Variables willhave the desired values in the Publish Profile which references to those variables. For example, youcould pass in an email address and have the distribution definition email the legacy CompuSetdocument to that address.
Parameters
userName : String
155
CompuSet Bridge
A string specifying the user who has been granted access rights to the category and applicationin xAdmin.
passWord : String
A password for the user who has been granted access rights to the category and application inxAdmin.
application : String
An xPression application name. Use this name to assign read permissions in xAdmin to the categoryCSetBridgeCat1 to the users who will call this method.
text : String
The CompuSet tagged text to publish.
optionsPath : String
A path and filename for the options file with which to compose tagged.
outputProfile: String
The name of the output profile to publish the composed tagged text through.
fields: String
The XML data to define the data fields to be referenced in the output profile. For example, you couldmodel the customer data and pass the values that match the data source mapped output variables,and the values you send would show up in the Output Profile. See Setting up output variables, page157 for more information on working with output variables.<Data><NAME>John Doe</NAME><EMAIL>[email protected]</EMAIL></Data>
The opening and closing <Data> tags are mandatory. The tags inside the <Data> tags must match thefield name described in the reading definition.
Examples
The following interface and application is a sample created from the CompuSet Bridge web servicemethods. The server, user name and password, and an output profile can be specified. There is anoption to Preview to PDF (return a PDF document), or publish the document through an outputprofile. This has all the benefits of an output profile, like multi-channel, e-mail, archive distribution,as well as plain PDL file output.
156
CompuSet Bridge
This is an example of Web service usage with the CompuSet Bridge
.
The following is a C# code snippet from the demo program.XPressionRequestService adapterService = getAdapterWebService();
String response = adapterService.publishTaggedText(this.userNameTextBox.Text,this.passwordTextBox.Text,“xPression Design”,this.customerDataTextBox.Text.ToString(),this.applicationNameTextBox.Text,this.outputProfileComboBox.Text.ToString());
Setting up output variablesTo use the publishTaggedTextOP service, define the fields to xPression. The OP fields so definedwill be mapped to a specific data source group.
157
CompuSet Bridge
Adding the data to the DSG
Begin by opening the data source group CSetBridgeDSN1, and open the only table: CUST. Add thefields needed to pass to the service. The fields ID, TT, and OPT are required.
Save this change by clicking Updateand then Save.
Modifying the XML Reading Def
Next, edit the customer data reading definition.
In xAdmin, open data source CSetBridgeDSN1, and update the reading definition.
This defines the new fields for the XML data reader. Click Save.
Define and Map the OP Variable
In xAdmin, under Resources, locate and select Output Variables. Then find or create thedesired output variable. Click the OP variable to get a list of data source groups to map. SelectCSetBridgeDSG, click click to map. Select the new field.
Pass the Values to the Web Service
By passing the data values defined to publishTaggedTextOP, the corresponding output variablesbecome available to the Output Profile.import org.jdom.Element;import org.jdom.output.XMLOutputter;
private String getFields (String policyNumber, String emailAddress){Element dataEl = new Element ("Data");dataEl.addContent(getField("POL_NUM", policyNumber));dataEl.addContent(getField("EMAIL_ADDR", emailAddress));return new XMLOutputter().outputString(dataEl);}
private Element getField (String name, String value) {Element field = new Element(name);field.addContent(value);return field;}
This Java sample code shows a method getFields, which returns a String to be passed as the fieldsparameter of publishTaggedTextOP.
158
CompuSet Bridge
Updating Legacy CompuSet Batch ApplicationsConfigurationThe CompuSet and Autograph system provided Batch script files for running CompuSet and thevarious emitters. There was a uniform approach to these Batch script files. They would setup theenvironment by setting environment variables, then calling one of the standard Batch script files forCompuSet or the emitters that reference the environment variables.
The following example of one of the Batch script files delivered with CompuSet/Autograph as usedto run CompuSet to compose to a CIF file in preparation for producing PDF output. There is someexpectation in this configuration that the directory structure available on the system is in the formatof an Autograph installation. One common installation on a Windows platform puts the CompuSetexecutables in the C:\Comset\System\Win32 directory. You can see this reflected in this statement:%CSET%\system\%OSYS%\compuset < %TEMP%\pdfc.tmp > .\log\pdfcomp.log
The %CSET% system variable would be the C:\Comset directory, and the %OSYS% variable wouldbe the Win32 directory, resulting in the mentioned path. Because the directory structure of xPressioninstallations differ from Autograph, this would need to be changed in an xPression installation. Thereare similar directory references in the following example.@echo offremrem Batch file to run Compuset and generate an intermediate file for inputrem to the Portable Document Format (PDF) Emitter. Syntax is:remrem pdfcomp style ttextremrem where 'style' and 'ttext' are the names of the style and tagged textrem files (without extensions), respectively.remif "%1" == "" goto errorremrem Choose correct extensions for files and verify that file 1 is valid.rem Set file 2 to nul if it does not exist.remset file1=%1.styif exist %1.txt set file1=%1.txtif exist %1.sty set file1=%1.styif not exist %file1% goto nofileif not "%2" == "" set file2=%2.txtif "%2" == "" set file2=nulif not exist %file2% set file2=nulremecho Running CompuSet - Log file saved to .\log\pdfcomp.log . . .echo %CSET%\system\%OSYS%\compuset > .\log\pdfcomp.logecho *>%TEMP%\pdfc.tmp
echo * FILE DEFINITIONS FOR COMPUSET>>%TEMP%\pdfc.tmpecho *>>%TEMP%\pdfc.tmpecho FILE 1, %file1% ,primary input file>>%TEMP%\pdfc.tmpecho FILE 18, %file2% ,secondary input file>>%TEMP%\pdfc.tmpecho FILE 2, .\cif\%1.cif ,intermediate file output>>%TEMP%\pdfc.tmpecho FILE 3, %CSET%\system\null.cnf ,null config file>>%TEMP%\pdfc.tmpecho FILE 4, %CSET%\system\newhdc.cnf ,hyphenation dictionary
159
CompuSet Bridge
>>%TEMP%\pdfc.tmpecho FILE 7, %CSET%\system\%WRDTYP%\pdf.wid ,PDF widths file>>%TEMP%\pdfc.tmpecho FILE 11, .\index\%1i1.inx ,index file 1>>%TEMP%\pdfc.tmpecho FILE 12, .\index\%1i2.inx ,index file 2>>%TEMP%\pdfc.tmpecho FILE 13, .\index\%1i3.inx ,index file 3>>%TEMP%\pdfc.tmpecho FILE 14, .\index\%1i4.inx ,index file 4>>%TEMP%\pdfc.tmpecho FILE 15, .\index\%1i5.inx ,index file 5>>%TEMP%\pdfc.tmpecho FILE 16, .\index\%1i6.inx ,index file 6>>%TEMP%\pdfc.tmpecho FILE 19, .\index\%1i7.inx ,index file 7>>%TEMP%\pdfc.tmpecho FILE 26, .\index\%1i8.inx ,index file 8>>%TEMP%\pdfc.tmpecho FILE 21, .\index\%1i9.inx ,index file 9>>%TEMP%\pdfc.tmpecho FILE 22, .\index\%1i10.inx ,index file 10>>%TEMP%\pdfc.tmpecho FILE 23, .\index\%1i11.inx ,index file 11>>%TEMP%\pdfc.tmpecho FILE 24, .\index\%1i12.inx ,index file 12>>%TEMP%\pdfc.tmpecho FILE 17, .\output\%1.gal ,galley output file>>%TEMP%\pdfc.tmpecho FILE 30, .\merge\mrglib1.dmg ,merge library 1>>%TEMP%\pdfc.tmpecho FILE 31, .\merge\mrglib2.dmg ,merge library 2>>%TEMP%\pdfc.tmpecho FILE 32, .\merge\mrglib3.dmg ,merge library 3>>%TEMP%\pdfc.tmpecho FILE 25, %CSET%\system\%WRDTYP%\xicsmsg.mdb ,CompuSet message database>>%TEMP%\pdfc.tmpecho // END OF FILE DEFINITIONS>>%TEMP%\pdfc.tmp
rem -- run WIN32 version if OSYS is NOT set...if "%OSYS%"=="" goto WIN32if "%OSYS%"=="WIN32" goto WIN32
:WIN32%CSET%\system\%OSYS%\compuset < %TEMP%\pdfc.tmp > .\log\pdfcomp.loggoto cleanup
:cleanupdel %TEMP%\pdfc.tmp > nulgoto end
:errorecho Please re-run batch file with proper parameter(s) specified.goto end
:nofileecho File %1.sty or %1.txt is not found.goto end
:endset file1=set file2=echo Done.
160
CompuSet Bridge
In Calling the above Batch file, users will often use a second Batch file that sets the environment,as in the following example:
PATH=%PATH%;C:\COMSET\RUN\SET CSET=C:\COMSETSET OSYS=WIN32SET WRDTYP=LITTLE32SET TEMP=C:\COMSET\DATA\MyApp\TEMP\CD C:\COMSET\DATA\MyAppCALL PDFCOMP MyApp_pdf C:\COMSET\DATA\MyApp\Tagged\%1
The combination of these two Batch files sets the environment, and makes the call to the stockAutograph batch/script file. It will be required to change the first file, and then the second file tomatch the paths as would be in xPression.
The second Batch file would be the one to be called as a pre or post processing script in xDashboard.
All paths in the first of the two preceding Batch files need to be considered and adjusted to fit thexPression environment.
161
CompuSet Bridge
Some examples include:
echo FILE 4, %CSET%\system\newhdc.cnf ,hyphenation dictionary>>%TEMP%\pdfc.tmp
becomes
echo FILE 4, C:\xPression\CompuSet\newhdc.cnf ,hyphenation dictionary>>%TEMP%\pdfc.tmp
echo FILE 7, %CSET%\system\%WRDTYP%\pdf.wid ,PDF widths file>>%TEMP%\pdfc.tmp
becomes
echo FILE 7, C:\xpression\CompuSet\Font Definition\pdf.wid ,PDF widths file>>%TEMP%\pdfc.tmp
Also note the FILE 80 would need to be added as described in CompuSet and the Emitters inxPression to include the com2ejbbridge.properties file, and the CR needs to be specified on FILE 32,as the third merge library for licensing.
An alternate approach would be to capture the options file that is created in the TEMP directory,specified in the first batch file above as pdfc.tmp, and modify the paths within it to match yourxPression environment, then using it in a Compose Tagged Text job step in xDashboard. This wouldrequire removing the “cleanup” part of the Batch file since it deletes this options file after it is used.
Updating Legacy Batch Applications on Mainframes
When bringing merge libraries and/or widths files from the mainframe, they should be exported onthe mainframe, and then imported onto the new platform with the appropriate utilities supplied withAutograph or CompuSet. This ensures the format is compatible with the new platform. For moreinformation, refer to your Autograph or CompuSet documentation.
162
Recommended
