EngageOne Designer. Designer Release Notes. Version 6.6 Maintenance

Transcription

1 Customer Engagement EngageOne Designer Version 6.6 Maintenance Designer Release Notes This document contains information about the EngageOne Designer 6.6 Maintenance release. Global contact numbers can be found on the technical support website at UNITED STATES pb.com/software Technical Support: support.pb.com CANADA pb.com/software Technical Support: support.pb.com EUROPE/UNITED KINGDOM pitneybowes.co.uk/software Technical Support: pitneybowes.co.uk/software/support ASIA PACIFIC/AUSTRALIA pitneybowes.com.au/software Technical Support: pbinsight.com.au/support 2017 Pitney Bowes, Inc.

2 Copyright 2017 Pitney Bowes Software 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 (PBS). To the fullest extent permitted by applicable laws PBS 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 PBS is prohibited to the fullest extent permitted by applicable laws. Nothing in this notice shall limit or exclude PBS 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 RSA Data Security Inc. Copyright DL Technology Ltd Barcode fonts Copyright 1997 Terrapin Solutions Ltd. with NRB Systems Ltd. This product includes software developed by the Apache Software Foundation ( Artifex and the Ghostscript logo are registered trademarks and the Artifex logo and Ghostscript are trademarks of Artifex Software, Inc. Copyright (c) The Legion of the Bouncy Castle Inc. ( This product contains RestSharp, version number , which is licensed under the Apache License, version number 2.0. The license can be downloaded from The source code for this software is available from This product contains Json.NET, version number 8.0.2, which is licensed under the MIT License. The license can be downloaded from github.com/jamesnk/newtonsoft.json/blob/master/license.md. The source code for this software is available from This product contains the Regex++ library Copyright Dr. John Maddock PostScript is a trademark of Adobe Systems Incorporated. PCL is a trademark of Hewlett Packard Company. ICU License - ICU and later Copyright (c) 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. Pitney Bowes

3 Matra 0.8b ( The contents of this documentation are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this documentation except in compliance with the License. You may obtain a copy of the License at Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. Otherwise all product names are trademarks or registered trademarks of their respective holders. Pitney Bowes

4 Contents ABOUT THIS RELEASE EngageOne Communication Suite Release content Localization Security License keycodes Accessibility Hardware key (Dongle) Compatibility Designer Issue with Windows Fonts EngageOne Content Author Message Vault Documentation CHANGES IN THIS RELEASE Known issues Restrictions Withdrawn support REQUIREMENTS, INSTALLATION AND BEST PRACTICES The repository Client/Server and Distributed considerations Hardware requirements Software requirements Installation EngageOne Designer 6.6 Maintenance Page 4

5 Contents Standalone install Client/Server install Distributed install Configuring for application virtualization Configuring Project Services Start-up & login Changing the repository database Resources for samples /confidence tests Preventative maintenance and best practices EngageOne Designer 6.6 Maintenance Page 5

6 About this release EngageOne Designer is part of the Pitney Bowes Software EngageOne Communication Suite and this maintenance release of Designer 6.6 contains fixes to certain reported issues. Software and associated documentation is provided on CD. EngageOne Communication Suite Pitney Bowes Software is renaming several products to bring our product offering under the EngageOne Communication Suite brand. The following table summarizes the product components in the suite: Previous name CCM Content Author DOC1 Designer DOC1 Generate EngageOne Administration EngageOne Interactive Correspondent EngageOne Interactive e-messaging e2 Vault New name EngageOne Content Author EngageOne Designer EngageOne Generate EngageOne Administration EngageOne Interactive EngageOne Server EngageOne Digital Delivery EngageOne Vault Release content Software and associated documentation is provided on DVD. The products supplied to you (and therefore the number of DVDs distributed) will depend on the licenses you hold and 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 product supplier. EngageOne Designer 6.6 Maintenance Page 6

7 Localization Designer is available and has been tested for this release in: English French French Canadian Spanish German The main Designer 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 Designer you must use the Windows Add/Remove Programs utility to un-install Designer before installing the new language version from the DVD. Security License keycodes All Designer 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 product distribution material. You will be required to supply your keycode details as part of the various installation processes. Refer to the Designer Users Guide for details. Should you experience any difficulties with your keycodes please contact your product supplier. Accessibility This version of Designer has been assessed by Simply Accessible. A statement of conformance is available on request. EngageOne Designer 6.6 Maintenance Page 7

8 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 Designer 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 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. EngageOne Designer 6.6 Maintenance Page 8

9 Compatibility Designer Applications created in DOC1 5.1 onwards are compatible with this maintenance release of Designer 6.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.6 please note the following: Designer objects and version control The enhanced version control feature will cause existing objects (except code pages, fonts and locales) to be put in a project called Master during the upgrade process. Note that only the last issued and latest draft versions of publications, documents and Active Content will be copied. If an object was issued separately since it was last published, then the last published version will not be copied. Publishing In 5.x the last issued version of a publication, document, Active Content and most objects was normally used when publishing. In 6.0 there is no concept of issued and draft versions so the publish process will by default, use the last saved version of the object irrespective of its previous status in 5.x. You can however choose to publish the last version issued in 5.x if required. DOC1Publish The backward slash character \ is no longer supported in path names for batch publishing. They must be replaced by the forward slash /. Also when identifying an object in the Designer repository you must now include the project name. If you have upgraded from a repository prior to 6.0 then you should prefix all object names with //Master. DOC1Publish configuration files must be edited to reflect these changes. Object names The characters \ and / are now not allowed in object names and are automatically replaced with an underscore _ during the repository upgrade process. OpenVMS Support for OpenVMS is not available in 6.0 onwards. EngageOne Designer 6.6 Maintenance Page 9

10 SQL 2000 Support for SQL 2000 and MSDE 2000 is not available in 6.0 onwards. Upgrading from please note the issues above and the following: Request to restart system When removing or upgrading DOC 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 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 Designer only and the changes will have no impact on applications already prepared for Generate. Advanced charts XML data External documents 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. EngageOne Designer 6.6 Maintenance Page 10

11 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 Designer 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. Issue with Windows Fonts Successive updates to fonts in Windows 7, 8.1 and Windows 10 have made some font files significantly larger on each successive Windows version which when republishing on later Windows versions can impact performance in Generate due to larger overall font and final printstream output size. EngageOne Designer 6.6 Maintenance Page 11

12 EngageOne When opening interactive data created in Designer prior to 6.0, a new field DocumentSelector appears in the DeliveryInformation node. If you wish to use it you must save the interactive data before closing so that it is updated correctly and you must update the data map and data dictionary accordingly. From EngageOne 4.4 the dependency on Internet Explorer for the creation of interactive communications using the ActiveX interactive editor has been removed. Many publications can be used with an alternative and complimentary, multi-browser form-fill mechanism. Note that the multi-browser capability is available for publications created in Designer 6.6 onwards. Refer to the Working with publications and documents section in the Designer User s Guide for details on the Cross Browser Support publication attribute. Content Author If you are using Content Author messages in your design, then the message environment file should be re-imported into Designer; this is necessary if you intend to publish to EngageOne. Message1 Message1 is no longer supported and Content Author is the recommended environment for creating messages for use with Designer. See the Content Author Release Notes for information on migrating Message1 applications to Content Author. Vault If you wish to ingest documents from Designer into an existing Vault, you must ensure that your Vault environment uses the latest version. EngageOne Designer 6.6 Maintenance Page 12

13 Documentation The following manuals are available in PDF format with this release: Guide Designer User s Guide Version-Issue 6.6-1b This guide provides end-to-end information about designing a publication and preparing it for production. Designer Utilities This guide provides information on utilities that are available with Designer and that require some direct programming or command line submission. In particular it covers the Application Import utility and running DOC1 Publish. The guide is provided in English only. Production Guide This guide provides information on putting publications into production. It also provides information about those parts of the core environment that require some direct programming and utilities that require command line submission. In particular it covers running Generate, creating and running PCE scripts, information about user exits and working with the RPU and 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 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. EngageOne Designer 6.6 Maintenance Page 13

14 Changes in this release This maintenance build is an update to an earlier point or maintenance release and provides software changes intended to address one or more urgent problem reports. For details of the specific software changes refer to the separate Software changes in this Release Document that accompanies this release. Note that maintenance builds are cumulative and incorporate changes from all previous Generate maintenance builds. While every effort is made to ensure the functioning of this build, testing is primarily focused on the specific fixes being made available. The changes will be formalized in the next service pack or point release of Designer (whichever comes sooner) and you are strongly advised to upgrade to this version as soon as it becomes available. If you are migrating from a release prior to 6.6 directly to this maintenance release, please refer to the Release Notes for DOC1 Series 6.6. If you are migrating from 4.x products, then you should also refer to the Release Notes for DOC1 Series 5.0. Previous release notes and user guides can be found on our website Known issues Issues publishing Keyed Active Content containing Interactive Variables Publishing will abort with an inaccurate error message when publishing Active Content containing interactive variables. Configuring the SQL Server connection port By default, Designer connects to port If you wish to configure a specific connection port, you will need to enter a connection string directly into the SQL Server: entry field using the following format: ServerName[\InstanceName],Port It is important to note that although the ServerName and InstanceName information is preserved by the Designer Repository Configuration Tool on each run, you will need to re-enter the port number each time the Designer Repository Configuration Tool is executed. EngageOne Designer 6.6 Maintenance Page 14

15 Language issues with context menu options when logging into a localized version of Designer The context menu displays English options when clicking on the right mouse button within the password field of the logon dialog. Fix: install the appropriate language pack for.net 4 on the client machine. Issues loading "Resource Only" production job in the Publish Wizard Saved settings are not loaded. Font spacing issues When Designing with Windows True Type fonts when output to datastreams that require different format (Bitmap) font resources (e.g. AFP, Metacode, IJPDS) 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. Workarounds: Import the required Printer fonts into Designer for use with your publication design. AFP Users can also Publish to AFP Outline font format instead of to AFP Bitmap font format to resolve font spacing issues. Issues with mapped fonts during publishing Mapped fonts missing in your local environment are not installed automatically during publishing. Workaround: 1. Expand your repository s Font Library. 2. Expand the folder associated with the missing font family. 3. Open any font item in the selected font family. Note that selecting the font item automatically installs all font sizes and styles for the selected font family. Restrictions In most cases restrictions related to a particular feature are described in the appropriate section of the release documentation. However, for the e-html output driver, restrictions are fully detailed in the Designer Best Practice Recommendations for ehtml.pdf, distributed with the documentation for this release. EngageOne Designer 6.6 Maintenance Page 15

16 Withdrawn support From Designer 6.1, support has been withdrawn from the following platforms/sql versions: Microsoft Windows XP (SP3) Microsoft Windows Vista (SP1) Microsoft Windows 2003 (SP2) Microsoft SQL Server 2005 From Designer 6.6 onwards, support is withdrawn for; Microsoft Windows 2008 Server Standard (SP2) 32 and 64 Bit EngageOne Designer 6.6 Maintenance Page 16

17 Requirements, installation and best practices Designer consists of the design editors and publication tools plus a repository within which all design resources are managed. Access to all system features and control of the workflow is carried out within the 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 25. The repository The first installation of Designer at a site must create a new resource repository. This uses Microsoft SQL Server as its database. If you already have SQL Server, or SQL Server Express you can create your repository in the existing environment. NOTE THAT AN SQL SERVER EXPRESS DATABASE IS NOT RECOMMENDED FOR A CLIENT/SERVER INSTALLATION WITH MORE THAN FIVE USERS. 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 the 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. EngageOne Designer 6.6 Maintenance Page 17

18 Setting the option to compact the database will defragment the database and rebuild its index. This will reduce the size of the database, but can take some time, especially for large repositories. Be aware that performance might also be affected. NOTE THAT IF YOU ARE USING THE FULL SQL SERVER, THE SIZE OF THE LOG FILE CAN BE RESTRICTED WHEN A DATABASE IS SET UP. IT IS RECOMMENDED THAT THIS RESTRICTION IS NOT USED FOR ANY DESIGNER DATABASE. The table below shows the size and content of the default repository as created by the installation process. SQL Database Filestore Repository size 14 MB 8.5 MB SQL Database 15.1 MB (.mdf) 504 KB (.ldf) transaction log Filestore (windows files) 9.2 MB 427 files Designer native objects 10 Active Content Client/Server and Distributed considerations In a Client/Server or Distributed environment the filestore should either be on the server machine, or on another server machine that is accessible to all clients and the server. NOTE THAT THE CLIENT AND SERVER MUST BE INSTALLED ON SEPARATE MACHINES. 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: EngageOne Designer 6.6 Maintenance Page 18

19 on first installation and 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 Designer 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\ecs\filestore. Securing data transfer in a Client/Server environment To ensure client/server data is securely transferred you can configure all data communications to use secure channels. This mode of data transfer contains a set of security protocols that provide identity authentication and secure communication through encryption. To activate this method of data transfer you will need to modify the following files: BusObj.config on the server machine Processor.dll.config on all client machines. ResourceAccessService.exe.config on all client machines Note that by default these configuration files are shipped with Secure Channel deactivated. To implement secure channel data communications: 1. For 64 bit Windows, on the server machine use the following path to locate the BusObj.config file: C:\Program Files (x86)\pbbi CCM\DOC1\Designer\Server\ For 32 bit Windows: C:\Program Files\PBBI CCM\DOC1\Designer\Server\ EngageOne Designer 6.6 Maintenance Page 19

20 2. Edit the BusObj.config file using a text editor such as notepad to ensure that the channel tag secure attribute is set to true, as highlighted below: <system.runtime.remoting> <customerrors mode="off"/> <application> <channels> <channel ref="tcp" secure="true" port="37719"> <serverproviders> <formatter ref="binary" /> </serverproviders> </channel> </channels> 3. For 64 bit Windows, on the client machine(s) use the following path to locate the Processor.dll.config file: C:\Program Files (x86)\pbbi CCM\DOC1\Designer\Client\ For 32 bit Windows: C:\Program Files\PBBI CCM\DOC1\Designer\Client\ 4. Edit the Processor.dll.config file using a text editor to ensure that the channel tag secure attribute is set to true,as shown below: <configuration> <system.runtime.remoting> <application> <channels> <channel ref="tcp" secure="true"> <clientproviders> <formatter ref="binary" /> </clientproviders> </channel> </channels> EngageOne Designer 6.6 Maintenance Page 20

21 5. For 64 bit Windows, on the client machine(s) use the following path to locate the ResourceAccessService.exe.config file: C:\Program Files (x86)\pbbi CCM\DOC1\Resource Access Service\ For 32 bit Windows: C:\Program Files\PBBI CCM\DOC1\Resource Access Service\ 6. Edit ResourceAccessService.exe.config file with a text editor to ensure that the channel tag secure attribute is set to true, as shown below: <?xml version="1.0" encoding="utf-8"?> <configuration> <appsettings> <add key="resourceserver" value="localhost" /> <add key="resourceserverport" value="50241" /> <add key="protocol" value="tcp" /> <add key="scratchdir" value="" /> </appsettings> <system.runtime.remoting> <application> <channels> <channel ref="tcp" port="50242" secure="true"> <serverproviders> <formatter ref="binary" /> </serverproviders> </channel> </channels> </application> </system.runtime.remoting> </configuration> Note that the EngageOne Resource Access Service must be restarted after the ResourceAccessService.exe.config file has been edited. 7. On the server machine restart EngageOne Template Designer Application Service using the Windows Start button, use run to execute services.msc Locate EngageOne Template Designer Application Service and restart the service. 8. Restart Designer on the client machines. EngageOne Designer 6.6 Maintenance Page 21

22 Hardware requirements The following list shows the minimum requirements. As with most software, the more resources you have available the more quickly and effectively Designer will run. Standalone Designer Client Application Server SQL Server Processor 2.4 GHz 2.4 GHz 4x 2.4 GHz 4x 2.4 GHz Hard disk 8 GB 4 GB 50 GB 50 GB RAM 4GB 1GB 4GB 8GB Monitor 20" 20" Graphics 1600 x x 1200 Colors 24 bit true 24 bit true Software requirements Designer has been tested on the following platforms: Microsoft Windows Server 2016 Standard (64 Bit) Microsoft Windows Server 2012 R2 Update (KB ) (64 Bit) Microsoft Windows Server 2008 R2 (64 Bit) Microsoft Windows 10 (64 Bit) Microsoft Windows 8.1 Update (KB ) (64 Bit) Microsoft Windows 7 SP1 (32 and 64Bit) It has been tested with the following versions of Microsoft SQL Server: SQL Server 2008 Standard (32 Bit) SQL Server 2008 R2 (64 Bit) SQL Server 2012 (32 and 64 Bit) SQL Server 2014 (64 Bit) Note that the following operating systems are also supported if you are running SQL Server 2008: Microsoft Windows 7 Professional Citrix XenApp 5 EngageOne Designer 6.6 Maintenance Page 22

23 Designer requires the following components, which will be installed if necessary. If a later version is detected, the component will not be installed. Standalone Designer Client client/server Application Server client/server, distributed SQL Server distributed a Microsoft Visual C Redistributable Microsoft.NET Framework Microsoft Shared Management Objects for SQL Server Microsoft System CLR Types for SQL Server Resource Access Service a Microsoft Visual C Redistributable Microsoft.NET Framework Resource Access Service Microsoft.NET Framework Microsoft Shared Management Objects for SQL Server Microsoft System CLR Types for SQL Server Resource Access Service Microsoft Shared Management Objects for SQL Server Microsoft System CLR Types for SQL Server a. Also includes the Windows Update for Universal C Runtime in Windows (KB ), which requires that other updates have already been installed. See for details. 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 Designer has been tested with Ghostscript 9.0 (32 bit only) Designer can now be installed on Citrix and Windows Terminal Services Server 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 install, as limited user repository software (SQL Server Express) can be downloaded from the Microsoft web site. Some Designer components make use of modules provided by Microsoft Internet Explorer version 6 (SP1) or later and this software must be available prior to installing Designer 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. EngageOne Designer 6.6 Maintenance Page 23

24 Upgrading SQL Server 2000 repositories to SQL Server 2012 and later If you are working with a repository created in SQL Server 2000 it is not possible to upgrade your repository directly to an environment running SQL Server 2012 or later. To overcome this issue it is necessary to upgrade the repository from SQL Server 2000 to SQL Server To upgrade a repository created in SQL Server 2000: 1. If there is no instance of SQL Server 2008, then install SQL Server 2008 Express edition. Note that this is available from the Microsoft web site. 2. Install Designer and connect to the SQL Server 2008 instance when prompted during the installation. 3. Restore the repository created in SQL Server 2000 using Repository Configuration Tool. 4. Backup the repository using Repository Configuration Tool. 5. Start the Repository Configuration tool and connect to the SQL Server 2012 instance. 6. Using the Repository Configuration tool, restore the repository backup from step 4. Other SQL Server considerations The default installation of Designer requires SQL Server to be configured in SQL Mixed Authentication mode. If you use a firewall you must ensure that the SQL Server ports are open. If you are running a distributed install ensure that your Database Engine has the TCP/IP protocol enabled. Snapshot limitations Snapshots created within an SQL Server 2000 or later environment cannot be imported directly to SQL Server To overcome this limitation it is necessary to perform the following steps: 1. Import the SQL Server 2000 snapshot to SQL Server 2008 based repository. 2. Export the required objects from your SQL Server 2008 based repository. 3. Import the snapshot created in the previous step into your SQL repository. Install issues on Windows Server If Microsoft SQL Server is installed prior to Designer, then the install HTA application may be prompted for the HTML application to be associated. After associating the HTML application, the HTA will need to be closed and reopened in order to use the Designer installation links. EngageOne Designer 6.6 Maintenance Page 24

25 IIssues with Windows Firewall Windows Firewall is automatically enabled in versions of Windows from 7 onwards. This will block some of the Designer 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: 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 27 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 setup.hta Stand alone or Client/Server: On the Customer Information page enter a user name and organization to be associated with the installed software. Use the Setup Type option to specify the type of Designer environment you want to create: Standalone creates a single user environment Client/Server installs the server and creates a copy of the client software ready for installation by client systems. IF YOU ALREADY HAVE AN EXISTING INSTALLATION, YOU WILL ONLY BE ABLE TO UPGRADE IT. TO CHANGE BETWEEN CLIENT/SERVER AND STANDALONE INSERT THE DVD YOU LAST INSTALLED AND REMOVE THE EXISTING INSTALLATION. THEN INSTALL AFRESH AS REQUIRED. EngageOne Designer 6.6 Maintenance Page 25

26 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 tailor the configuration of the repository. Please see your database administrator for information. IT IS RECOMMENDED THAT THE LATEST WINDOWS UPDATES HAVE BEEN APPLIED BEFORE INSTALLATION. Standalone install This option installs all the Designer components on a single machine. Client/Server install The Designer Repository Configuration tool allows you to set up your repository. This application is supplied with the product distribution material and can be run separately. To run the Repository Configuration Tool: 1. From the Start menu select Programs\PBBI CCM\Repository Configuration Tool 2. In the Connect to SQL Server dialog box click the Browse button to select the server that is being used for the repository from the SQL Server list or local if it is on your machine. 3. If you are connecting to an SQL server that requires its own login, i.e. not the Windows user name and password, clear the Use Windows authentication check box and enter the SQL Login Name and Password. 4. Click Connect. Refer to the Designer User's Guide for detailed information about the Repository configuration tool. 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 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 and on 64 bit hardware: C:\Program Files (x86)\pbbi CCM\DOC1\Designer\ClientDiskSet EngageOne Designer 6.6 Maintenance Page 26

27 Once installed the Administrator can login to 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. This is an example of a completed Client/Server installation. Client Machine Designer Resource Access Service TCP Port 5001,445 TCP Port 37719,135 Server Machine Repository Configuration Tool Designer Filestore Application Server (BusObjService) SQL Server Designer Repository BusObjService sends updates to EngageOne Services Designer Client Installer Designer Project Services (EngageOneProjectServices) EngageOneProjectServices responds to requests from EngageOne Services EngageOne Services TCP Port 5001,445 Distributed install In a Distributed environment the Application Server is installed on a different machine to the one running your SQL Server. Also, the Repository Configuration Tool must be installed on the SQL Server. IMPORTANT: REMOTE CONNECTIONS MUST BE ENABLED FOR THE SQL SERVER INSTALLED IN YOUR DISTRIBUTED ENVIRONMENT. REFER TO THE SQL SERVER DOCUMENTATION FOR DETAILS ON HOW TO DO THIS. 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. Click Open/Yes/OK as appropriate to open files, allow programs and install requirements. EngageOne Designer 6.6 Maintenance Page 27

28 2. If this is a new installation you must enter the filestore location (i.e. \\<server>\<filestore>). 3. The Repository Configuration Tool will be installed. Select OK/Finish as necessary to complete the installation process. To install the Application Server: 1. Insert the DVD on the 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. Click Open/Yes/OK as appropriate to open files, allow programs and install requirements. 2. Pre-requisites will be installed automatically as necessary. 3. The 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 Designer repository and the Designer Default User. To install 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 repository location. Note that the default location for the client diskset is: C:\Program Files\PBBI CCM\DOC1\Designer\Client Diskset. EngageOne Designer 6.6 Maintenance Page 28

29 This is an example of a Distributed installation: Client Machine Designer Resource Access Service TCP Port 5001,445 TCP Port 37719,135 Application Server Machine BusObjService sends updates to EngageOne Services Repository Configuration Tool Application Server (BusObjService) Designer Client Installer Designer Project Services (EngageOneProjectServices) EngageOne Services EngageOneProjectServices responds to requests from EngageOne Services SQL Server Machine Repository Configuration Tool SQL Server Designer Filestore Designer Repository TCP Port 37719,135 Configuring for application virtualization 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 and Windows Terminal Services Server Run the required installation as normal Client/Server or Distributed on the Citrix or Windows Terminal Services Server machine. You must then edit the configuration file EventHub.XML in the installation folder and set the option EnableCitrixMode to True. EngageOne Designer 6.6 Maintenance Page 29

30 Configuring Project Services Use the Designer Repository Configuration Tool - Project Services tab to enable the review and approval of Designer publications by EngageOne Portal users. The Project Services tab allows you to import service settings from a properties file(deploy.properties), available from your EngageOne Administrator. Refer to the table below for detailed information: Designer Repository Configuration tool Project Services tab Local service URL deploy.properties field designer.services.url Comments Key store Trust store tls.key.store.location tls.key.store.password tls.trust.store.location tls.trust.store.password Optional, configured if your organization uses TLS security. If configured an encrypted password is set in the properties file but is not visible on the Project Services tab in Designer. Optional, configured when using TLS security. If configured an encrypted password is set in the properties file but is not visible on the Project Services tab in Designer. Alias designer.tls.key.alias Optional, configured when using TLS security Project services URL Security services URL Service user name core.services.url security.services.url system.user.username system.user.password An encrypted password is set in the properties file but is not visible on the Project Services tab in Designer. For information about the Designer Repository Configuration Tool refer to the Designer User s Guide. EngageOne Designer 6.6 Maintenance Page 30

31 Start-up & login Once you have completed a Standalone, Client/Server or Distributed installation you can start the Designer program from the desktop icon or the Start menu. You will be prompted to enter your license information. The login screen will appear requesting a user name and password for the 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 Designer 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 Designer 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 FOR MORE INFORMATION ON REPOSITORY use the Repository Configuration Tool and specify a different repository in the TOOL, SEE THE DESIGNER USER S GUIDE. Repository Setup page or select the required repository when logging in (only if configured see Switching the repository database above). MANAGEMENT AND THE DESIGNER REPOSITORY EngageOne Designer 6.6 Maintenance Page 31

32 Resources for samples /confidence tests Two publications are provided with the release material. These can be used as samples on which to base your own publications. They are also used as the source for the confidence tests supplied with Generate see the Confidence testing sections in the Generate Release Notes. The publications are supplied as individual snapshots and can be imported into Designer by using the Tasks/Import/Snapshot option in Designer and browsing to \snapshots on the Designer DVD. See Snapshots in the Designer Users Guide for more information. Preventative maintenance and best practices This section describes recommended procedures you should perform to protect the data stored in your Designer repository and to help achieve optimal performance from your Designer applications. Document design guidance is also provided in this section. Designer repository backups/restore and snapshots Perform regular backups of your Designer repository. The backup process takes a copy of your entire repository protecting against the possibility of data loss or corruption. Use the restore process to recover the required Designer repository from your backups. Additionally, the snapshot feature allows you to capture and export a project or any of the objects within it such as a folder, a publication or Active Content. You can capture the current state or any previously labelled version. The snapshot can then be imported into a Designer repository as a new project. This enables you to copy objects from one Designer repository to another; for instance when you need to transfer resources to Pitney Bowes Software Support for analysis. Refer to the Repository Management section in the Designer Users guide for detailed information on these features. Working with projects and branching. Version control allows you to bring together resources and objects in projects for a common purpose, such as grouping together all the resources used in a publication for a particular marketing campaign or for new development. A project can be subdivided into folders if required, giving more structure to the organization of your work. You can branch a project, folder, or anything within them, at any time. This will create a new project which could, for example be used for separate development, leaving the original unchanged. During branching deleted items are not carried forward to the new branch. This can help improve performance where many deletions have been made within a project. In this scenario it is recommended you branch your project and work with the new branch. Refer to the Version Control section in the Designer Users guide for detailed information on projects and branching. EngageOne Designer 6.6 Maintenance Page 32