You are on page 1of 40

Pitney Bowes Business Insight

Customer
Communications
Management

®
DOC1 Series 5.6
DOC1 Designer, DOC1 Generate

Release Notes
March 2010
Copyright ©2010 Pitney Bowes Software Europe Limited. All rights reserved.

This publication and the software described in it is supplied under license and may only be used or copied in
accordance with the terms of such license. The information in this publication is provided for information only,
is subject to change without notice, and should not be construed as a commitment by Pitney Bowes Software
Europe Limited ("PBSE"). To the fullest extent permitted by applicable laws PBSE excludes all warranties,
representations and undertakings (express or implied) in relation to this publication and assumes no liability or
responsibility for any errors or inaccuracies that may appear in this publication and shall not be liable for loss or
damage of any kind arising from its use.

Except as permitted by such license, reproduction of any part of this publication by mechanical, electronic,
recording means or otherwise, including fax transmission, without the express permission of PBSE is prohibited
to the fullest extent permitted by applicable laws.

Nothing in this notice shall limit or exclude PBSE liability in respect of fraud or for death or personal injury
arising from its negligence. Statutory rights of the user, if any, are unaffected.
*TALO Hyphenators and Spellers are used. Developed by TALO B.V., Bussum, Netherlands
Copyright © 1998 *TALO B.V., Bussum, NL
*TALO is a registered trademark ®
Encryption algorithms licensed from Unisys Corp. under U.S. Patent No. 4,558,302 and foreign counterparts.
Security algorithms Copyright ©
1991-1992 RSA Data Security Inc.
Datamatrix and PDF417 encoding, fonts and derivations
Copyright © 1999, 2000 DL Technology Ltd.
All rights reserved
Barcode fonts Copyright © 1997 Terrapin Solutions Ltd. with NRB Systems Ltd.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product contains the Regex++ library
Copyright © 1998-2000
Dr. John Maddock
PostScript is a trademark of Adobe Systems Incorporated.
PCL is a trademark of Hewlett Packard Company.
ICU License – ICU 1.8.1 and later
Copyright (c) 1995-2006 International Business Machines Corporation and others
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,
distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this
permission notice appear in supporting documentation.
Otherwise all product names are trademarks or registered trademarks of their respective holders.
Contents
ABOUT THIS RELEASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Release content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Localization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
License keycodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Hardware key (Dongle) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
DOC1 Designer & DOC1 Generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Message1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
e2 Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

CHANGES IN THIS RELEASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10


New features & enhancements in 5.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Previous new features & enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Problem fixes & known restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

DOC1 DESIGNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
The repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Standalone install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Client/Server install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Distributed install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuring for application virtualization . . . . . . . . . . . . . . . . . . . . . . . . . 25

DOC1 5.6 – March 2010 3


Contents

Start-up & login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Changing the repository database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

DOC1 GENERATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
z/OS installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Confirmation testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

OS/400 installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Release media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Installation procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Confirmation testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

UNIX installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Release media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Installation procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Confirmation testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

OpenVMS Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Release Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Confirmation Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Windows installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Release media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Installation procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Confirmation testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

APPENDIX 1 – SERIES 5 PRIMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38


Development process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Old vs. New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DOC1 5.6 – March 2010 4


About this release
DOC1 5.6 is a point release and provides new features and enhancements for DOC1 Series 5.
DOC1 is part of the Pitney Bowes Business Insight CCM (Customer Communications
Management) range and primarily consists of DOC1 Designer and DOC1 Generate. Details of
the changes can be found in “Changes in this release” on page 10.

Release content
Software and associated documentation is provided on a set of DVD/CDs.

The products supplied to you (and therefore the number of DVD/CDs distributed) will depend
on the DOC1 licenses you hold. Additionally you will only be able to install products for which
you have a valid license keycode. If you believe that you have not received the correct material
or keycodes please contact your DOC1 supplier.

Localization
DOC1 Designer and DOC1 Generate are available for the following languages:
– English
– French
– German
– Unified Spanish
– Brazilian Portuguese
– Russian
– Simplified Chinese
– Japanese
Note that DOC1 in languages other than English may not be available at the same time as the
English release.
The main DOC1 User’s Guide is also available in these languages. All other documentation,
utility programs and other resources are in English only.

Note that if you want to install or upgrade to a different language version of DOC1 Designer
you must use the Windows Add/Remove Programs utility to un-install DOC1 Designer before
installing the new language version from the DVD.

DOC1 5.6 – March 2010 5


About this release

Security
License keycodes
All DOC1 software is protected against unauthorized use by a system of license keycodes. Your
license keycode information is supplied in a keycode report included with your DOC1
distribution material.

You will be required to supply your keycode details as part of the various installation
processes. For DOC1 Generate you will also need to supply the information for each job to be
processed. This is specified as part of the Host object used when creating a HIP file that
controls the DOC1 production environment. Refer to the DOC1 Users Guide for details.

Should you experience any difficulties with your keycodes please contact your DOC1 supplier.

Hardware key (Dongle)


A hardware key security device may be provided with the release material. This plugs either
into a USB port or into the parallel printer port of the IBM compatible computer on which
DOC1 is to run. The software will only then run when the appropriate drivers have been
installed and the key is in place.

| To install the dongle driver:


run \windows\Dongle\Sentinel Protection Installer 7.2.1.exe

| To attach a USB hardware key: plug it into any USB port on your PC.

| To attach a parallel printer port hardware key:


1. Remove the printer cable if one is attached.
2. The hardware key has a 25-pin connector. Plug this into the parallel port of your PC.
Tighten the screws to connect the hardware key securely to the port.
3. Replace the printer cable – if any – by plugging it in to the back of the hardware key. It is
recommended that you use a shielded printer cable.

DOC1 5.6 – March 2010 6


About this release

Compatibility
DOC1 Designer & DOC1 Generate
Applications created in DOC15.1 onwards, including 5.4.1, are compatible with this release
of DOC1 5.6. The application database from these earlier versions will automatically be
upgraded and application design rules will run without the need to regenerate them.

Upgrading from 5.5.1 – please note the following:

Request to restart system


When removing or upgrading DOC1 5.5.1 you may be asked to restart your system for
configuration changes. You must restart your system as requested, but will only be required to
do this once.

XML imports
The software used to support XML has been upgraded to enable new XML features.

Viewing available message areas


When creating a message box or message stream you will not be able to use the Show by
project option when using a message environment file generated by Content Author 5.5.1 and
earlier or Message1.

Upgrading from 5.4 – please note the issues above and the following:

Resource Maps
From 5.4 you can no longer update the Default resource map. If upgrading from previous point
releases, resources mapped for your existing publications will automatically be placed in User
defined Resource Map and these can be edited.

Upgrading from 5.3 – please note the issues above and the following:

Keycoded features
An issue has been resolved whereby the following licensed features were not keycoded
correctly and therefore not protected against unlicensed use. If you use any of these features,
please contact Customer Support so we can verify your configuration and re-issue your
keycodes if necessary. Note that this relates to DOC1 Designer only and the changes will have
no impact on applications already prepared for DOC1 Generate.
– Advanced charts
– XML data
– External documents

DOC1 5.6 – March 2010 7


About this release

Dates with a zero value


A year with a value of zero is treated as an invalid date, which causes Generate to issue an error
and stop. Previously it was not considered to be invalid, so did not cause an error in Generate.

Pattern style for charts in PDF


This option is now fully supported for PDF output. Previously, if a pattern style was specified,
the different sections of the chart would be output as solid shaded areas for PDF. Now the
correct pattern will be generated – lines, hatching etc.

PDF resource map


The default resource map for PDF is not carried forward into the new version. Note that all
other mappings will be transferred correctly.

Upgrading from 5.1 or 5.2 – please note the issues above and the following:

Purging the recycle bin


Purging of the recycle bin has been improved, including a more thorough checking procedure
when attempting to delete a resource. As a result, resources that have previously been purged
will reappear in the recycle bin, as they may have been deleted when they shouldn’t have been.

You should therefore purge these resources again. A warning will be issued if a resource is still
in use, in which case it will be returned back in its original location with a timestamp
appended to its name.

Rules for inserting objects


Control of when and where objects can be inserted in the Designer has been tightened. A
warning message will be issued if you try to place an object where it should not go, for
example, a presentation object in the start of page logic.

Documents from earlier versions of DOC1 may contain objects that do not follow these
insertion rules. On opening such documents, a list of warnings will be shown identifying each
mis-placed object. These should be corrected, otherwise the output from Generate may not be
as expected.

Upgrading from 5.0 – be aware of the issues above and the following:

If you are upgrading from 5.0, you must use Add/Remove Programs in the Windows Control
Panel to un-install 5.0 before installing this release.

Message1
No new version of Message1 is available with this release. From v5.4 onwards CCM Content
Author is the recommended environment for creating messages for use with DOC1.

DOC1 5.6 – March 2010 8


About this release

e2 Vault
If you wish to ingest documents from DOC1 into an existing e2 Vault, you must ensure that
your e2 Vault environment uses the latest version.

Documentation
The following manuals are available in PDF format with this release:

Series 5 Document Issue


DOC1 User’s Guide 5.6-1

For DOC1 Designer and DOC1 Generate. This guide


provides end-to-end information about designing a DOC1
publication and putting it into production.
DOC1 Programmer’s Guide 5.6-1

This guide provides information about those parts of the


core DOC1 environment that require some direct
programming and utilities that require command line
submission. In particular it covers creating and running
DOC1 PCE scripts, information about user exits and
working with the DOC1 RPU and DOC1 DIME utilities.
The guide is provided in English only.

Updates to the User Guides


All manuals are also published in PDF format on the DOC1 Support Net website –
http://www.doc1supportnet.com. Corrections and updates to the manuals will also be
published on this site. Amended versions of the manuals (as distinct from new issues) are
identified with a modified issue number – usually with a letter appended to the issue number.

Changes within the manuals themselves are indicated by change bars in the margin next to the
amended material in the updated version.

DOC1 5.6 – March 2010 9


Changes in this release

New features & enhancements in 5.6


This section summarizes the changes that have been made in this release since DOC1 5.5.1.
(See the section on page 13 for a summary of changes made in DOC1 5.5.1.) Details of these
features and enhancements can be found in the user guides issued with this release.

White space management


A new design object has been created to allow specific management of space remaining on the
last page of a document section or where a page throw is specifically requested. This
remaining space, or 'white space' can be used for optional content such as advertisements or
promotional material. Content objects that form part of a remaining space group will be
placed only where there is sufficient space left over in the main body of the relevant page. You
can specify any amount of additional content in this way which DOC1 will attempt to add to
the page in the sequence it is defined in the logic map.

Batch publishing

You can now create production resources for DOC1 Generate or EngageOne Interactive
without the need to open DOC1 Designer by using a command line utility and associated
script file. This may be useful if you have large amounts of production resources to update
regularly and need to automate the publishing process.

Custom bar chart labelling


Custom bar labels can now be defined for 2D and 3D bar charts.

Barcode enhancements
• The GS1 Databar barcode that is commonly used for goods tracking and discount
coupons is now supported in DOC1 using the font scaling method.
• The font scaling method itself has been extended to support AFP, IJPDS and PCL output

Dynamic paragraph merging


Text from two consecutive paragraph objects in the publication logic map can now be merged
together to form a single paragraph on the page. This feature can be used in conjunction with
condition objects or active content to build a single paragraph from multiple sources.

DOC1 5.6 – March 2010 10


Changes in this release

Keep text together


A new character property allows you to mark phrases that should always be kept together on
the same line. The ‘keep together’ option works for both regular text and variable data added
to a paragraph.

Document Editor enhancements


• Once localized paragraphs have been enabled at the document level you are given the
option to assign the multiple language attribute automatically to all paragraphs in the
document or on a paragraph by paragraph basis.
• In addition to browsing back and forth through the publication data sets sequentially you
can now directly access a publication dataset by entering its record number. This
feature is also available in the Data Format Editor.
• Some dialog boxes can now be resized by using the drag marker in the bottom right hand
corner.
• Some columns in dialog boxes can now be sorted in ascending or descending
alphabetical order by clicking in the column header.

Extended language support for the HTML driver

The DOC1 HTML driver now supports the use of extended character sets required for
Chinese, Japanese and Korean text.

Changing the sample data when previewing


Once you have previewed a publication, you can use the preview window to specify a different
sample data and run preview again.

Structured XML Journals


A new journal type provides a consistent and automated method of logging commonly
required run-time data such as page count and offset information. Custom elements can also
be added to the journal as required. A schema is provided to allow the Structured XML journal
to be easily interpreted by non-DOC1 post-composition processes.

Enhanced support for XML input data


Support for XML as the DOC1 input source has been extended to include <xs:sequence> and
<xsi:type> constructs.

Referencing printer resident fonts


Fonts from the printer environment can be referenced Postscript, VIPP and VPS output
datastreams. When referencing certain types of PostScript fonts you have the option to specify
a mapping file.

DOC1 5.6 – March 2010 11


Changes in this release

Optimizing fonts and images for AFP


When fonts or images are embedded in AFP output datastream they can now be optimized so
that only those that are actually used in the publication are embedded.

Workspace options
You now have the option to manage temporary work files used by Generate through new
Workspace settings in the host object. Generate creates temporary work files in the host
environment for processes that involve subsetting, disk caching, keyed images etc. If you are
working in a memory constrained host environment you may want to use the memory handling
options in the Publish Wizard in conjunction with these settings. Note that this option is not
for use on z/OS.

AFP outline (FOCA Type1) fonts in PCE


The support for AFP outline (FOCA Type1) fonts that was added to DOC1 Generate in 5.5 and
5.5.1 has now been extended to PCE.

Images in PDF output


You can now override the default setting of preserving the color space in images for PDF
output.

Optimizing images for Postscript


When images are embedded in Postscript output datastream they can now be optimized so
that only those that are actually used in the publication are embedded.

Background images in eHTML output


Images can now be used as background for pages produced by the eHTML driver when viewed
in the browser. They can be either tiled as necessary to fit the window or placed just once.

Beta level support for virtualization of DOC1 Designer


Several changes have been made to the DOC1 Designer to allow it to be installed and run as a
virtualized client/server application using server software such as Citrix XenApp or Microsoft
RemoteApp. We have conducted initial testing of these changes but we are aware that
customer configurations of these type of environments can vary significantly and may not be
reflected in our local test facilities. For this reason we are launching support for such
application virtualization as a Beta level feature in version 5.6 of DOC1. There is no extra
software or license keys required to install DOC1 Designer for virtualization so customers are
free to trial this support as required. However, we are naturally very keen to get your feedback
about how well this support performs and any problems that might be encountered. You can
send your comments directly to our User Acceptance team at AAP@pb.com. Alternatively
please contact your regional Customer Support office.

DOC1 5.6 – March 2010 12


Changes in this release

Content Author features and enhancements


• A 'message signal' attribute can now be assigned to messages in the Content Author that
can allow DOC1 applications to respond to specific messages being placed in a
publication. This can be used for example to initiate a DOC1 journal entry that in turn
can indicate a post-processing action associated with a particular message such as the
inclusion of an insert in the mailing package.
• When setting up message boxes, message streams or data fields for Content Author
messages, you can now filter the available message areas or data fields by project. This
improves navigation in a large message environment.

EngageOne Interactive new features and enhancements


• External keyed images are now supported in templates.
• You can now group interactive prompts together logically in a single prompt dialog.
• Support has been added for multi-document templates.
• When a resource cannot be found during publishing, you can now import missing
resources into your repository and continue publishing.

Previous new features & enhancements


For reference purposes this section summarizes the changes that were made in the previous
point release DOC1 5.5.1. Details of these features and enhancements can be found in the
user guides issued with this release.

5.5.1 Business logic / Active Content


The existing business logic feature has been renamed Active Content. The functionality is the
same, with the following enhancements:
• Active Content can be published independently and then used dynamically to update
publications that are already in production.
• Active Content groups are now available. These groups of files can provide a mechanism
for dynamically building frequently used sequences of content. They can also be used to
provide a list of optional content for end user selection in the EngageOne interactive
editor.

5.5.1 Snapshot enhancements


Snapshots were previously limited to a one-way transfer to a clean repository. It is now possible
to use snapshots for repository-to-repository transfers. These can be used to provide version
control and backup of repositories.

DOC1 5.6 – March 2010 13


Changes in this release

5.5.1 Extended language support for eHTML drivers


Support has been added to eHTML for right-to-left and bi-directional text, as used for Arabic
and Indian dialects.

5.5.1 Russian localization


The DOC1 user interface is now available in Russian.

5.5.1 PDF/A compliancy


PDF output can now be made specifically compliant with the PDF archiving standard PDF/A.

5.5.1 AFP and Metacode overlays


AFP and Metacode overlays (or forms) can be imported for use in the background of your
document design.

5.5.1 Changing sample data in advanced preview.


When using advanced preview on a publication you can use a different sample data to the one
that is assigned to the publication.

5.5.1 PDF encryption


This can now be set to 128-bit RC4 as well as the default 40-bit RC4.

5.5.1 DBCS support for AFP


DBCS support has been added for AFP outline (FOCA Type1) fonts.

5.5.1 Tumble printing


Roll feed layout formats such as tumble and tumble duplex are now supported for IJPDS, AFP.
and PCL output.

5.5.1 Sorting lists of variables and message data fields


Lists of variables and message data fields can now be sorted alphabetically. This can help when
trying to navigate very long lists.

5.5.1 Enhancements to newspaper column layouts


Headers and footers can now span across all the columns in the column layout. They can be
used in addition to the normal column headers and footers.

Lines can be added between columns to give them a visual separation. You can customize the
weight and color.

DOC1 5.6 – March 2010 14


Changes in this release

5.5.1 Color management in AFP


Support has been added for the AFP CMOCA standard that allows for ICC profiles in
embedded images. Note that this can only be used where supported by the target AFP device.

5.5.1 Publishing resources separately


It is now possible to publish a publication design separately from the font and image resources
that it requires. While these options need to be used with care to avoid unexpected results in
the production environment, it may save time where complex applications need to be
republished without resource changes.

5.5.1 EngageOne Interactive


Support has been added for EngageOne Interactive, an interactive document production
system that enables the creation and delivery of ad hoc customer correspondence.
DOC1 Designer is used to develop and publish the document templates on which EngageOne
Interactive is based and to define and edit the data.
• Editable content allows the front-office user to edit or create free form text in an
EngageOne document. This enables the user to add their own comments to the
customer’s correspondence.
• The Interactive Data Editor is used to define all data that is required for the EngageOne
document, including:
– data gathered from the front-office user via on-screen prompts,
– data supplied directly from external sources, such as system supplied data, to be used
directly in the document.
• The Preview for EngageOne feature allows you to view a template as it would be seen by
a correspondent in a front-office EngageOne environment. This allows you to see how the
user will interact with prompted input fields.

5.5.1 Enhancements to the EngageOne Interactive Data Editor


• Annotations can be defined for creating a self-documenting schema. These allow you to
pass additional information through the EngageOne schema to your system data
integration program.
• You can now define default data for repeating groups of data. This will be shown as
‘sample’ data when viewing the document.

DOC1 5.6 – March 2010 15


Changes in this release

Problem fixes & known restrictions


Reported problems that have been fixed in recent releases, and known restrictions in the latest
product release can be viewed on our website on www.doc1supportnet.com.

The following items highlight some of the known restrictions against expected behavior that
you should be aware of when using certain features in DOC1. It is not a comprehensive list of
problems.

Snapshot processing
Data maps and sample data associated with public Active Content are not exported.
The default locale of English United States is always associated with exported items.

Fixed graphics in columns


Shapes and graphics with a fixed anchor in column headers or footers may not be positioned
correctly or may not show at all in Preview or Generate.
Workaround: position the graphic as anchored.

Font spacing issues


Designing with Windows raster or bitmap fonts for output datastreams that require different
font resources (e.g. AFP, Metacode) can result in slightly inaccurate font spacing. This is
evident when changing font within a paragraph or applying a style such as bold or
underlining.
Workaround: import the required fonts into DOC1 for use with your publication design.

Fixed graphics and text flow


In some circumstances a graphic with a fixed anchor may get overwritten with paragraph text,
even though it looks correct in the Designer. This can happen when the order of presentation
objects in the logic map is not the same as the flow on the page – i.e. the graphic is defined in
the logic map after the paragraph that it has been placed next to on the page.
Workaround: in the logic map move the graphic so that it is before the paragraph that it is
intended to appear next to.

Presentation objects in page logic


Objects with displayable content are now not allowed in the start or end of page logic – see
“Rules for inserting objects” on page 8.

Postscript font subsetting and messages


When Font subsetting is used for Postscript output in DOC1, it will not be applied to the
messages file (.HIM).

DOC1 5.6 – March 2010 16


DOC1 Designer
DOC1 Designer consists of the DOC1 design editors and publication tools plus a repository
within which all design resources are managed. Access to all system features and control of
DOC1 workflow is carried out within the DOC1 Designer client.

Depending on your license configuration you can create either a single user Standalone
environment, a multi-user Client/Server environment, or a Distributed environment where the
Designer is installed on a separate machine to your SQL Server.

In the Standalone version the Designer is installed for immediate access to a local resource
repository, which is created if required.
In the Client/Server environment the client software is copied to a network location and the
server control programs are installed for use by the local machine. A resource repository is
created (or referenced) as with the Standalone install. Client machines must then install from
this location.
The Distributed environment is similar to the Client/Server setup, except that your existing
SQL Server is used and the Designer can be installed on a different machine to the SQL Server.
For more details about environments see the required setup type under “Installation” on
page 21

The repository
The first installation of DOC1 Designer at a
site must create a new resource repository. L NOTE THAT AN SQL SERVER EXPRESS DATABASE
IS NOT RECOMMENDED FOR A CLIENT/SERVER
This uses Microsoft SQL Server as its INSTALLATION WITH MORE THAN FIVE USERS.
database. If you do not have an SQL database
available, the DOC1 Designer installation process (except Distributed) will install a limited user
version of this software known as SQL Server Express. If you already have SQL Server, SQL
Server Express, or MSDE you can create your repository in the existing environment.

The repository consists of a database and a filestore. The database is used to provide revision
control for the repository and will be in the default location as specified in the SQL Server.
The filestore is where DOC1 design files and resources are stored, and is specified as a folder
location.

If you are re-installing the software make sure the Upgrade option is checked in the Install
wizard. This will ensure that the existing repository is preserved correctly.

DOC1 5.6 – March 2010 17


DOC1 Designer

Setting the option to compact the database will


defragment the database and rebuild its L NOTE THAT IF YOU ARE USING THE FULL SQL
SERVER, THE SIZE OF THE LOG FILE CAN BE
index. This will reduce the size of the RESTRICTED WHEN A DATABASE IS SET UP. IT IS
database, but can take some time, especially RECOMMENDED THAT THIS RESTRICTION IS NOT
for large repositories. Be aware that DOC1 USED FOR ANY DOC1 DATABASE.
performance might also be affected.

Client/Server and Distributed considerations


In a Client/Server or Distributed environment
the filestore should either be on the server L NOTE THAT THE CLIENT AND SERVER MUST BE
INSTALLED ON SEPARATE MACHINES.
machine, or on another server machine that
is accessible to all clients and the server.

The database will automatically be made available via the SQL Server. However, you must
ensure that both the filestore and the client diskset folders are available to all users who will be
accessing them.

Use the Sharing and Security option in Windows Explorer to:


• share the folder
• give full security control to the appropriate users/groups.

You will also need:


• write access to your working folder. By default this is your local 'temp' folder.
• access to the registry entries:
– on first installation
HKEY_LOCAL_MACHINE\SOFTWARE\PBBI CCM
HKEY_CURRENT_USER\Software\PBBI CCM\DOC1 Series

– when upgrading
HKEY_LOCAL_MACHINE\SOFTWARE\GROUP1
HKEY_CURRENT_USER\Software\Group1\DOC1 Series

• permission to install any new fonts used.


• permissions for the Windows account that the SQL Server is running under. Note that if
you have installed the SQL Server to run under the Local System account then you will
need to change this to a named Windows user account. This is required because the
DOC1 Backup, Restore and Snapshot functions execute within the SQL Server to zip and
unzip files to and from the filestore.

Note that when specifying locations during installation, the full UNC path must be given,
e.g. \\server\DOC1\filestore.

DOC1 5.6 – March 2010 18


DOC1 Designer

Hardware requirements
The following list shows the recommended configurations. As with most software, the more
resources you have available the more quickly and effectively DOC1 Designer will run.

Recommended

Processor 2+GHz

Hard disk 4 Gb

RAM 1 Gb

Monitor 17"

Graphics 1600 x 1200

Colors 24 bit true

Software requirements
DOC1 Designer has been tested on the following platforms.
Note that DOC1 is not supported for 64 bit Windows.
• Microsoft Windows 7 Professional
• Microsoft Windows Vista Business (SP1)
• Microsoft Windows XP Professional (SP3)
• Microsoft Windows Server 2008 Standard (SP2)
• Microsoft Windows Server 2003 (SP2)
• Microsoft Windows 2000 (SP4)
• Citrix 5

It has been tested with the following versions of Microsoft SQL Server:
• SQL Server 2008 (SP1)
• SQL Server 2008 Express Edition
• SQL Server 2005 (SP2)
• SQL Server 2005 Express Edition (SP2)

DOC1 5.6 – March 2010 19


DOC1 Designer

• SQL Server 2000 (SP3a)


• MSDE 2000 (SP3a)

DOC1 also requires the following software, which the installation process will install
automatically if necessary.
• Microsoft Visual C++ 2005 Redistributable
• Microsoft .NET Framework 2.0
• Microsoft Windows Installer 4.5
Note that Windows 2000 requires Microsoft Windows Installer 3.1 rather than 4.5 so if
you are installing DOC1 for the first time on this platform you must ensure that you
already have Microsoft Windows Installer 3.1 installed.
• Microsoft Data Access Components (MDAC) 2.8
• CCM Resource Access Service

If you are going to use EPS images or the external documents feature to import PDF or EPS
you must have the following installed:
• Ghostscript
Note that DOC1 has been tested with Ghostscript 8.63

DOC1 Designer can now be installed on Citrix for use with application virtualization.

It is recommended that you use Microsoft SQL Server as your design repository database. Note
that this is not a requirement if you choose a Standalone or Client/Server install, as limited user
repository software (SQL Server Express) will automatically be installed.
Versions prior to 2000 (SP3a) are not supported.

Some DOC1 components make use of modules provided by Microsoft Internet Explorer
version 6 (SP1) or later and this software must be available prior to installing DOC1 material.

Adobe Reader 6.0 or later must be available to read previews of your publications. You can use
the link on the contents window (launched automatically when you load the DVD) to
download Adobe Reader.

SQL Server considerations


The default installation of DOC1 requires SQL Server 2000, 2005 and 2008 to be configured
in SQL Mixed Authentication mode. If you use a firewall you must ensure that the SQL Server
ports are open.

DOC1 5.6 – March 2010 20


DOC1 Designer

Install issues with MDAC


If your system requires MDAC software to be installed during the main install, this may
terminate the process. Re-start the main install and continue to follow the instructions
provided by the install wizard.

Issues with Windows Firewall


Windows Firewall is automatically enabled in versions of Windows from XP onwards (such as
2003, Vista, Windows 7). This will block some of the DOC1 executable files from running. You
can either:
• unblock these files when prompted by Windows Firewall
– cockpit.exe
– g1eventhub.exe
Note that you will only have to do this once, when the files are first used.
• or turn off Windows Firewall. This is not advisable unless you are using another firewall.
See your system administrator for advice.

Note that with a firewall you must ensure that the SQL Server ports are open.

Installation
The Windows account under which the software is installed must have Administrator access to
the local machine.

A contents window is launched automatically when the DVD is loaded. Select the product you
want to install:
– DOC1 Designer will install Standalone or Client/Server on the current machine.
– the Distributed Install options allow you to install the Application Server and the Repository
Configuration Tool separately. See “Distributed install” on page 23 for details on how to
install.

The installation process will then commence. Follow the instructions given by the install
wizard. If the window is not automatically launched, then browse to your DVD drive and run
doc1setup.hta

Stand alone or Client/Server:

On the Customer Information page enter a user name and organization to be associated with the
installed software.

DOC1 5.6 – March 2010 21


DOC1 Designer

Use the Setup Type option to specify the type


of DOC1 Designer environment you want to L IF YOU ALREADY HAVE AN EXISTING INSTALLATION,
YOU WILL ONLY BE ABLE TO UPGRADE IT.
create: TO CHANGE BETWEEN CLIENT/SERVER AND
Standalone – creates a single user STANDALONE INSERT THE DVD YOU LAST
environment INSTALLED AND REMOVE THE EXISTING

Client/Server – installs the server and creates INSTALLATION. THEN INSTALL AFRESH AS
a copy of the client software ready for REQUIRED.

installation by client systems.

Once the software has been copied from the DVD the install process will gather details to
configure the resource repository. In most cases, the default settings can be used for this. See
the sections below for more detailed information.

However, if you want to use an existing


repository and filestore, you may need to L IT IS RECOMMENDED THAT THE LATEST WINDOWS
UPDATES HAVE BEEN APPLIED BEFORE
tailor the configuration of the repository. INSTALLATION.
Please see your database administrator for
information.

Standalone install
This option installs all the DOC1 Designer components on one machine. In addition, if there
is no version of SQL Server available as listed under “Software requirements” on page 19, then
an instance of SQL Server Express will be installed.

Client/Server install
For a Client/Server environment you must first create a folder for the filestore and be aware of
Sharing and Security options. For example, read/write access must be granted to all users
running DOC1 Designer and the Windows account that the SQL Server is running under.
See “Client/Server and Distributed considerations” on page 18 for more details.

On the client machine browse to the location where the Client installer software was installed
on the Server machine and from the \Server\Client Diskset directory run the setup.exe
program. This runs a simple installation wizard that installs the client software and registers
the repository location. Note that the default location for the client diskset is
c:\Program files\PBBI CCM\DOC1\Designer\Client Diskset.

Once installed the Administrator can login to DOC1 Designer and create user accounts for
other users. The Administrator should then notify other users of their account details and the
location from which the client software can be installed.

DOC1 5.6 – March 2010 22


DOC1 Designer

This is an example of a completed Client/Server installation.

Client Machine

DOC1 DOC1 Resource


Work Center Access
Service

TCP Port 5001,445 TCP Port 37719,135

Server Machine
DOC1 Application
Server DOC1 Designer
Repository
(BusObjService) Client Installer
Configuration
Tool

SQL Server

DOC1 DOC1
Filestore Repository

TCP Port 5001,445

Distributed install
In a Distributed environment the DOC1
Application Server can be installed on a L NOTE THAT SQL EXPRESS IS NOT INCLUDED IN
THIS INSTALL. YOU MUST ALREADY HAVE ONE OF
different machine to the one running your THE SUPPORTED VERSIONS OF SQL SERVER
SQL Server. The Repository Configuration INSTALLED (SEE “SOFTWARE REQUIREMENTS” ON
Tool must also be installed on the SQL Server. PAGE 19) ON YOUR SQL SERVER MACHINE.

You must first create a folder for the filestore and share, and grant read/write access as with the
Client/Server install – see “Client/Server and Distributed considerations” on page 18 for
details. Note that the filestore does not have to reside on the same machine as the SQL Server.

| To install the Repository Configuration Tool on the SQL Server:


1. Insert the DVD on the SQL Server and select the Install Repository Configuration Tool
option in the contents window. The installation material will be copied to the Windows
directory %temp% and start to run. Enter the SQL server name and instance if required.
2. If this is a new installation you must enter the file store location
(i.e. \\<server>\<filestore>).
3. The Repository Configuration Tool will be installed.
Select OK/Finish as necessary to complete the installation process.

DOC1 5.6 – March 2010 23


DOC1 Designer

| To install the DOC1 Application Server:


1. Insert the DVD on the DOC1 Server machine and select the Install Application Server
option in the contents window. The installation material will be copied to the Windows
directory %temp% and start to run.
2. Pre-requisites will be installed automatically as necessary.
3. The DOC1 Designer installation will then start.
Step through the screens to run the installation process.
4. The Repository Configuration Tool will be run. Supply the connection details to the SQL
server. Enter the server name and instance if required.
In the next screen select the required DOC1 repository and the DOC1 Default User.
The final screen displays the path to the client diskset. Navigate to this and share the
folder for clients to be able to install.

| To install DOC1 Designer client on to a client machine: on the client machine browse
to where the Client installer software was installed on the Application Server machine and from
the Client Diskset directory run the setup-designer-client.exe program.
This runs a simple installation wizard that
installs the client software and registers the L NOTE THAT WHEN INSTALLING ON WINDOWS VISTA
YOU MUST COPY THE CONTENTS OF THE CLIENT
repository location. Note that the default DISKSET FROM THE APPLICATION SERVER TO A
location for the client diskset is C:\Program LOCAL DRIVE OF THE CLIENT MACHINE AND RUN
Files\PBBI CCM\DOC1\Designer\Client THEM ON A COMMAND LINE IN ADMINISTRATOR

Diskset. MODE.

DOC1 5.6 – March 2010 24


DOC1 Designer

This is an example of a Distributed installation:

Client Machine

DOC1 DOC1 Resource


Work Center Access
Service

TCP Port 5001,445 TCP Port 37719,135

Application Server Machine


Repository DOC1 Application DOC1 Designer
Configuration Server
Client Installer
Tool (BusObjService)

SQL Server Machine


Repository
Configuration
Tool

SQL Server

DOC1 DOC1
Filestore Repository

TCP Port 37719,135

Configuring for application virtualization


DOC1 Designer can be installed as a single-instance server using Citrix application
virtualization. This allows multiple users to connect to and run the Designer remotely using
web protocols.

Installing Designer on Citrix

Run the required installation as normal – Client/Server or Distributed – on the Citrix machine.
You must then edit the configuration file EventHub.XML in the installation folder and set
the option EnableCitrixMode to True.

DOC1 5.6 – March 2010 25


DOC1 Designer

Start-up & login


Once you have completed a Standalone, Client/Server or Distributed installation you can start
the DOC1 Designer program from the desktop icon or the Start menu. You will be prompted to
enter your license information if not already entered via the Start menu.

The login screen will appear requesting a user name and password for the DOC1 Designer.
The first time you log on (in all environments) you should specify the default Administrator
account name and password. Both are 'admin' (ensure lower case characters are used).

If DOC1 has previously been configured to allow multiple repositories to be used then use the
Options button to select the one you want to use.

Changing the repository database


The Repository Configuration Tool allows you to change various aspects of your repository
usage. For instance, you can switch from using SQL Server Express to a full SQL Server
environment, or use a different repository.

In both a Standalone environment and on a machine running the Server component this tool is
available from the Group1 or PBBI CCM folder within the Start menu.

Note that you must log out of DOC1 before changing the repository. In a Client/Server
environment you must ensure that all clients are also logged out.

| To switch the repository database server: connect to an appropriate server in the


SQL Server Connection page. Then set up the repository using the Repository Setup page.

| To use a different repository: either use


the Repository Configuration Tool and L FOR MORE INFORMATION ON REPOSITORY
MANAGEMENT AND THE DOC1 REPOSITORY TOOL,
specify a different repository in the SEE THE DOC1 USER ’S GUIDE.
Repository Setup page
– or –
select the required repository when logging in (only if configured – see “Switching the
repository database” above).

DOC1 5.6 – March 2010 26


DOC1 Generate
DOC1 Generate includes the main DOC1 production engine (DOC1GEN), the Post
Composition Engine (DOC1PCE) and various production utilities. You can use DOC1GEN to
create one or more types of output datastream.

This release is intended for use on processors running the following operating systems:

z/OS
OS/400
UNIX
– AIX
– HP-UX
– HP-UXi (Itanium)
– Red Hat Enterprise Linux
– Sun Solaris
– SUSE Linux
– Tru64
OpenVMSi
Windows 7, XP, Vista, 2000 and Server 2003 and 2008

DOC1 5.6 – March 2010 27


DOC1 Generate

z/OS installation
System requirements
DOC1 Generate operates in a batch IBM z/OS environment. In addition to the program files
supplied you will need the IBM Language Environment (LE) Run-time Libraries. Refer to your
IBM representative for more information. It has been tested under the following software
levels:
• z/OS 1.9

The DOC1 Generate modules have been compiled with a compatibility level of z/OS 1.7

Later versions of z/OS will normally be able to run the software without modification. Earlier
versions are also normally compatible but are not guaranteed.

Datasets included with distribution material

Name Org RECFM LRECL BLKSIZE Contents


DOC1HOST.INSTALL PDS FB 80 27920 Installation JCL

DOC1HOST.LOADLIB PDS U 0 32760 Contains all the program modules. These are
ready to run; no local linking is required.

DOC1HOST.RESOURCE PDS VB 256 27998 Resources & confirmation test jobs

DOC1HOST.CNTL PDS FB 80 3120 JCL for confirmation tests

DOC1HOST.AFP PDS VBM 32756 32760 AFP confirmation material for PCE
DOC1HOST.MTC PDS VBM 300 2000 Metacode confirmation material for PCE

DOC1HOST.PST PDS VB 300 2000 PostScript confirmation material for PCE

DOC1HOST.VPS PDS VB 300 2000 VPS confirmation material for PCE

DOC1 5.6 – March 2010 28


DOC1 Generate

Installation
DOC1 Generate is provided on a CD.

The datasets are provided as TSO Transmitted files on the DOC1 Generate CD under the
directory zos and \SAMPLES\zos. The datasets within the TSOs are as detailed on page 28.

Upload the TSO files from the CD to a temporary dataset on your z/OS service as binary files
with a record length of 80 bytes and no carriage returns (NOASCII NOCRLF LRECL 80).

Use the TSO RECEIVE command to restore the data and the dataset attributes:
RECEIVE INDSN(‘seq_dataset_name’)
where seq_dataset_name is the temporary sequential dataset
and respond to the prompt with
DSN(‘pds_dataset_name’)
where pds_dataset_name is the name of a new partitioned dataset which will receive the DOC1
files. Be sure to give the recipient dataset a meaningful name in accordance with the
transmitted dataset name displayed as part of the prompt.

Confirmation testing
In order to confirm that the installation has been successful a range of confidence test jobs
are supplied that produce sample output for each supported type of output datastream. To run
such a job open the appropriate JCL deck within the DOC1HOST.CNTL dataset and customize
it for your installation. You will also need to edit the OPS (override production settings) file in
the RESOURCE dataset to specify your license keycode details for DOC1 Generate. These are
provided on the keycode report that should accompany your DOC1 distribution material.

The JCL decks are set up to write actual print datastream output from the test jobs to held
SYSOUT or disk file depending on the format most suitable for the datastream being
generated. You can, of course, redirect this output as required using the DD names indicated
above.

DOC1 5.6 – March 2010 29


DOC1 Generate

OS/400 installation
System requirements
DOC1 Generate & Print operates in a batch OS/400 environment. No additional software is
required. It has been tested under the following software level:
• OS/400 V5R4M0
Later versions of OS/400 will normally be able to run the software without modification.
Earlier versions may be compatible but are not recommended.
Note that the size of the output file is limited to 4Gb.

Release media
DOC1 Generate is provided on CD.

Program files (and associated files) are supplied as objects; all other files are supplied as
members.

Objects included with distribution material

Object name Type Attributes Contents


<program> *PGM CLE All program files

<program> *SRVPGM CLE Service programs

RESOURCE *FILE PF-SRC Resources for generating test applications

Installation procedure
Load the DOC1 Generate OS/400 CD into a drive and enter the following commands:
CPYFRMSTMF FROMSTMF('/QOPT/DOC1/SAVHOST') TOMBR('/QSYS.LIB/TMPLIB.LIB/TMPFIL.FILE')
MBROPT(*REPLACE)
RSTLIB SAVLIB(DOC1HOST) DEV(*SAVF) SAVF(TMPLIB/TMPFIL) [RSTLIB(LIBRARY)]

This will restore all the objects from the specified device (i.e. CD). If you do not specify the
RSTLIB(LIBRARY) option the default library name of DOC1HOST will be used. This is the
recommended library name – if you use another name, significant changes to the OPS
members in the RESOURCE file and start up commands will be required before you can run
confirmation tests (see page 31).

Note that the SAVHOST SAV file is in the root directory of the CD.

You must ensure that the library to which the installation material was restored is included in
the library list.

DOC1 5.6 – March 2010 30


DOC1 Generate

Confirmation testing
In order to confirm that the installation has been successful a range of confidence test jobs
are supplied that produce sample output for each supported type of output datastream.

You will need to edit the KEYCODE member in the RESOURCE file to specify your license
keycode details for DOC1 Generate. These are provided on the keycode report that should
accompany your DOC1 distribution material.

To run a test job execute a command similar to the one shown in the example below,
substituting the HIP and OPS options as appropriate for the type of output required.

Example of running the AFPDS 240 confirmation test, after installing to DOC1USRLIB:

CALL DOC1GEN ('RESOURCE(AFP24HIP)' 'OPS=RESOURCE(AFP24OPS)'


['DOC1LIB=DOC1USRLIB'])

DOC1 5.6 – March 2010 31


DOC1 Generate

UNIX installation
DOC1 Generate is available for AIX, HP-UX, Linux and Sun Solaris. Other than the program
modules themselves, the same release material and installation procedures are provided for all
platforms.

System requirements
DOC1 Generate operates as standard UNIX batch programs. No additional software is
required. It has been tested under the following software levels:
• IBM AIX 5.3 (TL4) Runtime Library Level 9 (32-bit)
• Tru64 5.1B (64-bit)
• HP-UX B 11.11 (64-bit)
• HP-UX Itanium B 11.23 (32-bit)
• Red Hat Enterprise Linux 3.0AS (32-bit)
• SUN Solaris 10 on SPARC (64-bit)
• SUSE Linux Enterprise Server 10 – x86, s390x (64-bit)
Later versions of these operating systems will normally be able to run the software without
modification. Earlier versions may also be compatible but are not guaranteed.

Release media
DOC1 release material for UNIX platforms is provided on a single CD. This may also contain
material for other platforms. The release material is provided as two TAR files – one for the
DOC1 host Generate material and one for the sample confirmation files:

/<host>/doc1<host>host.tar
/samples/unix/samples.tar

Installation procedure
Insert the DOC1 Generate CD into a drive and mount the volume, i.e.:
mount /dev/<cd-device> <cdpath>
Note that on HP-UX, you must use the -o cdcase switch when mounting: i.e.:
mount -o cdcase /dev/<cddevice> <cdpath>)

Extract the entire contents of both the Generate TAR file and the samples TAR file to a
suitable location where you will run Generate.

tar -xf /<cdpath>/<host>/doc1<host>host.tar


tar -xf /<cdpath>/samples/unix/samples.tar

DOC1 5.6 – March 2010 32


DOC1 Generate

Add the DOC1 installation directory into your library search path. To do this in C shell:
on IBM AIX:
setenv LIBPATH /<installdir>
on SUN Solaris, Tru64 & Linux:
setenv LD_LIBRARY_PATH /<installdir>
on HP-UX & HP-UXi:
setenv SHLIB_PATH /<installdir>

Confirmation testing
In order to confirm that the installation has been successful a range of confidence test jobs
are supplied that produce sample output for each supported type of output datastream.

You will need to edit the keycode.ops (override production settings) file to specify your license
keycode details for DOC1 Generate. These are provided on the keycode report that should
accompany your DOC1 distribution material.

To run a test job, first check the list of available job files (.hip) in the installed directory and
identify the one related to the output datastream you want to create. Ensure the DOC1
directory is the current path and enter the following on the command line:

doc1gen <testname>.hip ops=keycode.ops

DOC1 5.6 – March 2010 33


DOC1 Generate

OpenVMS Installation
System Requirements
DOC1 Generate operates as standard OpenVMS batch programs. No additional software is
required. It has been tested under the following software level:
• OpenVMS Itanium 8.3
Later versions of this operating system will normally be able to run the software without
modification. Earlier versions may also be compatible but are not guaranteed.
There is no cross compatibility for DOC1 between the Itanium OpenVMS and the previous
OpenVMS (ALPHA) versions.

Release Media
Material for OpenVMS is supplied on a single CD. This may also contain material for other
platforms. The release material is provided as BCK files.

Installation Procedure
To install DOC1 Generate load the DOC1 Generate CD into the drive, mount the volume:
(e.g. mount /media=cdrom <cd-device> doc1 cdrom)
and install:
copy <cd-device>:[000000.vmsi]*.bck;* [<dir>]
copy <cd-device>:[000000.samples.vmsi]*.bck;* [<dir>]
set file/attr=lrl:32256 *.bck
set file/attr=rfm:fix *.bck
backup *.bck /save_set *.*;* /log

where:
<dir> is an existing directory to receive the DOC1 material.
<cd-device> is the alias of the CD drive.

Confirmation Testing
In order to confirm that the installation has been successful a range of confidence test jobs
are supplied that produce sample output for each supported type of output datastream.

You will need to edit the keycode.ops (override production settings) file to specify your license
keycode details for DOC1 Generate. These are provided on the keycode report that should
accompany your DOC1 distribution material.

DOC1 5.6 – March 2010 34


DOC1 Generate

To run a test job, first check the list of available job files (.hip) in the installed directory and
identify the one related to the output datastream you want to create. Ensure the DOC1
directory is the current path and enter the following on the command line:
doc1gen := $SYS$LOGIN_DEVICE:[]DOC1GEN.EXE
doc1gen <testname>.hip ops=keycode.ops

DOC1 5.6 – March 2010 35


DOC1 Generate

Windows installation
System requirements
DOC1 Generate operates as standard batch programs. No additional software is required. It
has been tested under the following operating system levels:
• Microsoft Windows 7 Professional
• Microsoft Windows Vista Business (SP1)
• Microsoft Windows XP Professional (SP3)
• Microsoft Windows Server 2008 Standard (SP2)
• Microsoft Windows Server 2003 (SP2)
• Microsoft Windows 2000 (SP4)
Note that Windows 2000 requires Microsoft Windows Installer 3.1 rather than 4.5 so if
you are installing DOC1 for the first time on this platform you must ensure that you
already have Microsoft Windows Installer 3.1 installed.

Later versions of these operating systems will normally be able to run the software without
modification.

Release media
DOC1 release material for Windows is provided on a single CD. This may also contain material
for other platforms. The release material is provided as two ZIP files – one for the DOC1 host
Generate material and one for the sample confirmation files:

\windows\doc1host.zip
\samples\windows\samples.zip

Installation procedure
Load the DOC1 Generate CD into a drive and extract the entire contents of both
doc1host.zip and samples.zip to a suitable location on the machine that is to run
Generate.

DOC1MAKE utility
If you are going to use the DOC1MAKE utility for generating external key maps you must also
install:
• Ghostscript
Note that DOC1 has been tested with Ghostscript 8.63

DOC1 5.6 – March 2010 36


DOC1 Generate

… and if DOC1 Designer is not installed on the same machine as Generate then you will also
need to install:
• Microsoft Visual C++ 2005 Redistributable
run \windows\Microsoft Visual C++ 2005 Redistributable\vcredist_x86.exe

Confirmation testing
In order to confirm that the installation has been successful a range of confidence test jobs
are supplied that produce sample output for each supported type of output datastream.

You will need to edit the keycode.ops (override production settings) file to specify your license
keycode details for DOC1 Generate. These are provided on the keycode report that should
accompany your DOC1 distribution material.

To run a test job first check the list of available job files (.hip) in the installed directory and
identify the one related to the output datastream you want to create. Ensure the DOC1
directory is the current path and enter the following on the command line:

doc1gen <testname>.hip ops=keycode.ops

DOC1 5.6 – March 2010 37


Appendix 1 – Series 5 Primer
One of our primary goals in developing the user interface for DOC1 Series 5 has been to make
the development of complex documents and applications as intuitive and straightforward as
possible. However, the following information may help you get up-and-running quickly and
clarify some conceptual differences between Series 5 and its predecessors.

Development process
The DOC1 Series 5 User Interface itself does not force you to follow a fixed process but based
on our experience from building applications during the alpha testing of the new product you
may find the following suggestions helpful when considering how to structure your
development process.
1. Publications vs. Documents
DOC1 Series 5 uses the concept of 'Publications' as the main design unit of an
application and this is the object you need to create to start work. When you create a
Publication a 'Document' is automatically created within it ready for you to work with.
Additional documents can be added to a publication if required.
2. Develop the layout of your application before defining data
DOC1 Series 5 is logic not data driven and there is no need to source and define your
data before you start the development of your application. Insert named place-holders
(known as data fields and data records and generically as 'data aliases') for any data
references that you wish to use as you develop your design. When you create a data field
you will need to specify the type of data that is expected. You can also enter example data
for display purposes as part of the definition.
The aliases can be mapped to the actual data that you wish to use just before you build
the application for production. Furthermore, you can create as many different mappings
as you need allowing you to use the same design for different data feeds.
3. Place static objects on the background layer
The background layer is part of the Page Setup view of the document editor. You can use
conditional logic if required to determine the page(s) on which such objects should
appear.
4. Relative positioning is the norm for the main document body
The document view is where you add the content for the main body of documents. In
DOC1 Series 5 such content is always assumed to be relatively positioned (as in a typical
word processor). Text is typed directly into the document layout and graphics added as
required. The relationship between the objects is presented in the logic map as in earlier
versions of DOC1.

DOC1 5.6 – March 2010 38


Appendix 1 – Series 5 Primer

5. Use a Transaction Table when you need to lay out repeated data
The Transaction Table object is designed to make structuring and formatting repeated
data (e.g. transactional data) straightforward. This is usually the most complex part of any
transaction document and there are a large number of possible permutations. The Table
Wizard will step you through the complexities and allow you to select the settings that you
require. Note that you can also set how many times you want your example data to repeat.
If you have not yet sourced real transaction data you can use this feature to test how your
transaction table behaves when it spans multiple pages.
6. Create a data format for your sample production data
An updated version of the familiar Data Format Editor is available to define flat file data.
You can re-use your existing DOC1 data formats by using the import facilities. If you have
XML data with a DTD or Schema the system will automatically create a data definition
using the information they contain. Additionally, DOC1 Series 5 also supports delimited
data; this is a variation of keyed record data that allows the location of fields within
records to be determined automatically according to one or more field separator
characters. Note that you will still need to provide information manually about field data
types in both these cases.
7. Map your data fields to data format elements.
A data map cross-references the data fields defined in your publication with the elements
in a data format. You may create a data map either independently or as part of the
Publishing process.
8. Publish your application
If you have not already mapped your data then you will be prompted to do so and then
the single Rules file that controls the Production Engine will be created.

Old vs. New


If you are migrating to Series 5 for the first time with this release, you may also find it helpful
to know that:
• Application logic in DOC1 Series 5 is always executed as it appears in the logic map and
has no direct association with input data. As a result, non-compulsory records in the data
does not influence whether a piece of logic is executed or not.
• Relative positioning is now the default for all objects in the main body of a document
design. If you want an object to appear at a fixed position on a page you must now set its
properties to ensure that it does.
• All the data in a single publication data set (previously know as a data document or data
frame) is available at all times when a publication is being processed. This means you can
use and re-use data elements without restriction at any point in the design. You can also
sort repeated data dynamically and reuse it in different ways if required.

DOC1 5.6 – March 2010 39


Appendix 1 – Series 5 Primer

• Data within an XML data set can be presented in any order provided the initial record is
constant and the data conforms to the DTD.
• There is no longer an unbreakable linkage between a particular data format and an
application. The same publication can be mapped to any number of different data
definitions using the data mapping feature.
• Publishing is the equivalent of the old Build process or 'Convert to Rules' as it was
sometimes known. Unlike the previous DOC1 product that needs three Rules files and an
INI file to control the production environment, DOC1 Series 5 produces a single file
known as a HIP to drive the production engine.
• A HIP file contains within it all the settings for the production engine that were formerly
in the INI file. You now customize your production environment within the design system
itself by creating Host and Output Device objects and specifying them when publishing.

DOC1 5.6 – March 2010 40

You might also like