Professional Documents
Culture Documents
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
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 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
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.
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.
| To attach a USB hardware key: plug it into any USB port on your PC.
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.
XML imports
The software used to support XML has been upgraded to enable new XML features.
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
Upgrading from 5.1 or 5.2 – please note the issues above and the following:
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.
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.
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:
Changes within the manuals themselves are indicated by change bars in the margin next to the
amended material in the updated version.
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.
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
The DOC1 HTML driver now supports the use of extended character sets required for
Chinese, Japanese and Korean text.
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.
Lines can be added between columns to give them a visual separation. You can customize the
weight and color.
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.
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.
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.
– when upgrading
HKEY_LOCAL_MACHINE\SOFTWARE\GROUP1
HKEY_CURRENT_USER\Software\Group1\DOC1 Series
Note that when specifying locations during installation, the full UNC path must be given,
e.g. \\server\DOC1\filestore.
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"
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 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.
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
On the Customer Information page enter a user name and organization to be associated with the
installed software.
Client/Server – installs the server and creates INSTALLATION. THEN INSTALL AFRESH AS
a copy of the client software ready for REQUIRED.
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.
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.
Client Machine
Server Machine
DOC1 Application
Server DOC1 Designer
Repository
(BusObjService) Client Installer
Configuration
Tool
SQL Server
DOC1 DOC1
Filestore Repository
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 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.
Client Machine
SQL Server
DOC1 DOC1
Filestore Repository
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.
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.
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.
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
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.
DOC1HOST.LOADLIB PDS U 0 32760 Contains all the program modules. These are
ready to run; no local linking is required.
DOC1HOST.AFP PDS VBM 32756 32760 AFP confirmation material for PCE
DOC1HOST.MTC PDS VBM 300 2000 Metacode confirmation material for PCE
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.
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.
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.
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:
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.
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:
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.
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
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
… 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:
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.
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.
• 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.