Objectif Lune PlanetPress Connect - 1.4 Instruction Manual

User Guide

Version:1.4.2

User Guide Version 1.4.2 Last Revision:2016-06-30

Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8

+1 (514) 875-5863

www.objectiflune.com

All trademarks displayed are the property of their respective owners.

© Objectif Lune, Inc. 1994-2016. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc. disclaims responsibility for any errors and omissions in this documentation and accepts no responsibility for damages arising from such inconsistencies or their further consequences of any kind. Objectif Lune Inc. Inc reserves the right to alter the information contained in this documentation without notice.

Table of Contents 4

Welcome to PlanetPress Connect 1.4.2 7

Icons used in this guide 8

Setup And Configuration 9

System and Hardware Considerations 9

Installation and Activation 16

Server Settings 37

DataMapper Module 41

Basics 41

Features 41

DataMapper User Interface 92

Defining Boolean Values 166

Defining String Values 166

Building String Values 167

Defining Integer Values 168

Building Integer Values 168

Defining Float Values 169

Page 4

Building Float Values 169

Defining Currency Values 169

Building Currency Values 170

Defining Date Values 170

Defining Object Values 171

The Designer 174

API 174

Basic Steps 218

Features 220

Designer User Interface 452

Mark Position Options 538

Additional Text 543

Additional Images 543

Additional Barcodes 544

Additional OMRMarks 544

Additional Text Settings 546

Additional Image Settings 547

Barcode Options 548

Standard Barcode Settings 548

Page 5

Codabar Settings 550

Code 128 Settings 552

Code 39 Settings 554

Additional Datamatrix Settings 556

Additional EAN 128 Settings 558

Additional EAN 13 Settings 559

Additional EAN 8 Settings 561

Additional Interleave 2 of 5 Settings 563

Additional PDF417 Settings 565

Additional QR Code Settings 567

Additional UPC A Settings 569

Additional UPC E Settings 571

Additional OMR Mark Settings 573

Keystore 578

PDF Signature 580

Legal Notices and Acknowledgements 602

Page 6

Welcome to PlanetPress Connect

Note

In our continuous effort to facilitate your PlanetPress Connect experience, our entire documentation is being overhauled. Since we are still in the process of restructuring all this information, expect to see our online help evolve frequently over the next few weeks. We apologize for any inconvenience, but know we are working hard to improve your experience as quickly as possible.

Since we are always looking for new ways to make your life easier, we welcome your questions and comments about our products and documentation. A feedback tool will soon be at the bottom of each page. In the meantime, shoot us an email at

doc@ca.objectiflune.com.

1.4.2

PlanetPress Connect is a series of four tools designed to optimize and automate customer communications management. They work together to improve the creation, distribution, interaction and maintenance of your communications.

The PlanetPress Connect Datamapper and Designer is designed to create output for print, email and the web within a single template and from any data type, including formatted print streams. Output presets applied outside the design phase make printing device independent.

The Designer has an easy-to-use interface that makes it possible for almost anyone to create multi-channel output. More advanced users may use native HTML, CSS and JavaScript.

PlanetPress Connect also includes a process automation server, called Workflow. It is capable of servicing response form web pages and email to provide interactive business communications.

PlanetPress Connect can create documents for tablets and mobile devices that run a free CaptureOnTheGo App. Users with a CaptureOnTheGo subscription can then download documents to their own devices, interact with them and send the captured data back to PlanetPress for conversion into additional documents or workflows.

Page 7

This online documentation covers PlanetPress Connect version 1.4.2.

Note

Complementary information that is not critical, but may help you better use PlanetPress Connect.

Tip

Information that is useful or suggests an easier method.

Technical

Information that may require specific knowledge to understand.

Warning

Information that is potentially critical to using PlanetPress Connect. Pay close attention.

Icons used in this guide

Icons are used throughout this guide to point your attention to certain information.

Page 8

Setup And Configuration

Note

Windows XP, Windows 2003 and older versions of Windows are not supported by

This chapter describes the PlanetPress Connect installation and the different considerations that are important in regards to the installation and use of PlanetPress Connect.

l "System and Hardware Considerations" below l "Installation and Activation" on page 16 l "Server Settings" on page 37

System and Hardware Considerations

There are a variety of considerations to be aware of. These are documented in the following pages:

l "System Requirements" below l "Environment considerations" on the facing page l "Database Considerations" on page 12 l "Network considerations" on page 12 l "Language and Encoding considerations" on page 13 l "Performance Considerations" on page 13

System Requirements

These are the system requirements for PlanetPress Connect 1.4.2

Operating System (64-bit only)

l Microsoft Windows 2008/2008 R2 Server l Microsoft Windows 2012/2012 R2 Server l Microsoft Windows Vista l Microsoft Windows 7 l Microsoft Windows 8.1 l Microsoft Windows 10

Page 9

PlanetPress Connect.

Minimum Hardware Requirements

Note

For tips and tricks on performance, see "Performance Considerations" on page 13.

Warning

Copying (duplicating) a Virtual Machine with Connect installed and using both images simultaneously constitutes an infringement of our End-User License Agreement.

Note

While some VMWare (from VMWare, Inc.) and Microsoft virtual machine environments are supported, other virtual environments (such as Parallels, Xen and others) are not supported at this time.

l NTFS Filesystem (FAT32 is not supported) l CPU Intel Core i7-4770 Haswell (4 Core) l 8GB RAM (16GB Recommended) l Disk Space: At least 10GB (20GB recommended)

Environment considerations

Virtual Machine Support

PlanetPress Connect supports VMWare Workstation, VMWare Server, VMWare Player, VMWare ESX, Microsoft Hyper-V and Microsoft Hyper-V/Azure infrastructure environments as software installed on the Guest operating system. PlanetPress Connect does not officially support VMotion under ESX at the moment.

Page 10

Terminal Server/Service

PlanetPress Connect does not support Terminal Server (or Terminal Service) environment as possible under Windows 2000, 2003 and 2008. This is to say, if Terminal Service is installed on the server where PlanetPress Connect is located, unexpected behaviours may occur and will not be supported by Objectif Lune Inc.. Furthermore, using PlanetPress Connect in a Terminal Service environment is an infringement of our End-User License Agreement.

Remote Desktop

Tests have demonstrated that PlanetPress Connect can be used through Remote Desktop. It is however possible that certain combination of OS could cause issues. If problems are encountered, please contact OLSupport and we will investigate.

PlanetPress Connect 1.3 and later have been certified under Remote Desktop.

64-bit Operating Systems

PlanetPress Connect is a 64-bit software and can only be installed on 64-bit operating systems.

Antivirus Considerations

l Antivirus software may slow down processing or cause issues if they are scanning in

temporary folders or those used by PlanetPress Connect. Please see KB-002: Antivirus Exclusions for more information.

l Antivirus software might interfere with installation scripts, notably a vbs script to install

fonts. McAfee, in particular, should be disabled temporarily during installation in order for MICR fonts to install and the installation to complete successfully.

Windows Search Indexing Service

Tests have concluded that the Windows Search service, used to provide indexing for Windows Search, can interfere with Connect when installing on a virtual machine. If the installation hangs during the last steps, it is necessary to completely disable this service during installation.

l Click on Start, Run.

Type in services.msc and click OK.

Locate the Windows Searchservice and double-click on it.

Change the Startup Type to Disable, and click Stop to stop the service.

Try the installation again.

Once completely, you may re-enable the service and start it.

Page 11

Database Considerations

This page describes the different considerations and pre-requisites for the database back-end used by PlanetPress Connect, whether using the MySQL instance provided by the installer, or pre-existing instance.

Using the MySQL Instance from the Installer

The MySQL Instance provided in the Installation Wizard is already pre-configured with options to provide the most stable back-end setup.

These are the specific options that have been changed in our version of "my.ini":

max_connections = 200 : PlanetPress Connect uses a lot of database connections. This number ensures that even in high volume environments, enough connections will be available.

max_allowed_packet = 500M : In some implementations, especially when using Capture OnTheGo, large packet sizes are required to allow transferring binary files. This substantial packet size maximum setting ensures that the data received by PlanetPress Connect will be able to be stored within the database.

character-set-server = utf8 , collation-server = utf8_unicode_ci , default-characterset=utf8 : These indicate database support for UTF-8/Unicode.

Using a pre-existing MySQL Instance

If MySQL server is already installed and you wish to use it, the following should be taken into consideration:

l The MySQL account must have access to all permissions using the GRANT Command,

including creating databases.

l The database configuration must include the options detailed in the "Using the MySQL

Instance from the Installer" above section.

l The SQL instance must be open to access from other computers. This means the bind-

address option should not be set to 127.0.0.1 or localhost.

Network considerations

The following should be taken into consideration in regards to network settings and communications

Page 12

If a local proxy is configured (in the Internet Explorer Optionsdialog, the option Bypass proxy server for local addresses must be checked, or some features depending on

local communication will not work.

Language and Encoding considerations

Please note the following considerations:

Language:

l PlanetPress Connect is currently offered in several languages. These languages

can be switch between via the Preferences dialog. The current languages include:

l English l French l German l Spanish l Italian l Portuguese l Chinese (Simplified) l Chinese (Traditional) l Japanese.

The default language is English. The PlanetPress Connect help system (this document) is currently only available in English.

Encoding:

l Issues can sometimes be encountered in menus and templates when running

PlanetPress Connect on a non-English operating system. These are due to encoding issues and will be addressed in a later release.

Performance Considerations

This page is a comprehensive guide to getting the most performance out of PlanetPress Connect as well as a rough guideline to indicate when it's best to upgrade.

Performance Analysis Details

In order to get the most out of PlanetPress Connect, it is important to determine how best to maximize performance. The following guidelines will be helpful in extracting the best

Page 13

performance from PlanetPress Connect before looking into hardware upgrades or extra PlanetPress Connect performance packs.

Job Sizes and Speed: In terms of pure output speed, it's important to first determine what job size is expected, and adjust Scheduling Preferences accordingly. The basic rules are:

l If processing a small number of very large records (when each individual record is

composed of a large number of pages), more instances with an equal amount of speed units is better. For hardware, RAM and Hard Drive speeds are most important, since the smallest divisible part (the record) cannot be split on multiple machines or even cores.

l If creating a very large number of small records (hundreds of thousands of 2-3 page

individual records, for instance), a smaller number of instances with a large number of speed packs would be better. As for hardware, then the number of cores becomes critical, whereas RAM and hard drive are secondary. Performance Packs, as well as the MySQL instance being separate, would be helpful if your most powerful machine starts struggling.

l Mix and match. For example, one instance prioritized for large jobs and the rest for

smaller, quicker jobs. Or the contrary. Or, whatever you want, really.

RAM Configuration: By default, each instance of the Merge Engine and Weaver Engine is set to use 640MB of RAM. This means that regardless of speed units, if not enough memory is available, output speed might not be as expected. Assuming that the machine itself is not running any other software, the rule of thumb is the following: The total number of used memory in the machine should be pretty much the maximum available (around 95%).

For each engine, it's necessary to modify the .ini file that controls its JAVA arguments. Edit as follows:

l For the Merge Engine: see C:\Program Files\Objectif Lune\OL

Connect\MergeEngine\Mergeengine.ini

l For the Weaver Engine: see C:\Program Files\Objectif Lune\OL

Connect\weaverengine\Weaverengine.ini

l The parameters are -Xms640m for the minimum RAM size, -Xmx640m for the

maximum RAM size. Explaining Java arguments is beyond the scope of this document. Please read references here, here and here for more details (fair warning: these can get pretty technical!).

Template and data mapping optimization: Some functionality offered by the Designer modules are very useful, and sometimes downright awesome, but can cause the generation of records and of contents items to slow down due to their nature. Here are some of them:

Page 14

Preprocessor and Postprocessor scripts: manipulating data using a script may cause delays before and after the data mapping action has actually taken place, especially file conversion and data enrichment from other sources.

Loading external and network resources: In Designer, using images, javascript or css resources located on a slow network or on a slow internet connection will obviously lead to a loss of speed. While we do our best for caching, a document with 100,000 records which queries a page that takes 1 second to return a different image each time will, naturally, slow output generation down by up to 27 hours.

External JavaScript Librairies: While loading a single javascript library from the web is generally very fast (and only done once for the record set), actually running a script on each generated page can take some time. Because yes, JavaScript will run for each record, and often take the same time for each record.

Inefficient Selectors: Using very precise ID selectors in script wizards can be much faster than using a text selector, especially on very large documents. (more details on this in another upcoming page).

Complex Scripts: Custom scripts with large, complex or non-optimized loops can lead to slowing down content creation. While it is sometimes difficult to troubleshoot, there are many resources online to help learn about JavaScript performance and coding mistakes. Here, here, and here are a few. Note that most resources on the web are about JavaScript in the browser, but the greatest majority of the tips do, indeed, apply to scripts in general, wherever they are used.

High-Performance Hardware

The following is suggested when processing speed is important. Before looking into a Performance Packs to enhance performance, ensure that the below requirements are met.

A physical, non-virtualized server. ESX and VMWare servers are great for reducing the numbers of physical machines in your IT space, but they must share the hardware between each other. While you can create a virtual machine that seems as powerful as a physical, it will still be sharing hardware with any other virtual machines, and this will adversely affect performance.

MySQL Database on a separate machine. MySQL's main possible bottleneck is file I/O, and as such a high-performance setup will require this server to be on a separate machine, ideally with a high-performance, low-latency hard drive. A Solid State Drive (SSD) would be recommended.

High-Quality 16+ GB Ram. This is especially true when working with many server instances ("speed units") running in parallel. The more parallel processing, the more RAM is recommended.

Page 15

Note

A PDF version of this guide is available for use in offline installations. Click here to

download it.

4 or 8 physical cores. We're not talking Hyper-Threading here, but physical cores. Hyper-Threading is great with small applications, but the overhead of "switching" between the virtual cores, and the fact that, well, they're virtual, means the performance is much lesser on high-power applications such as OL Connect. In short, a dual-core processor with Hyper-Threading enabled is not equivalent to a quad-core processor.

Installation and Activation

This section provides detailed information about the installation and activation of PlanetPress Connect 1.4.2.

PlanetPress Connect 1.4.2 is comprised of 2 different installers: one for the PlanetPress Connect software and one for PlanetPress Workflow 8.

Where to Obtain the Installers:

The installers for PlanetPress Connect 1.4.2 and PlanetPress Workflow 8 can be obtained on DVD or downloaded as follows:

l If you are a Customer, the installers can be downloaded from the Objectif Lune Web

Activations page: http://www.objectiflune.com/activations

l If you are a Reseller, the installers can be downloaded from the Objectif Lune Partner

Portal: http://extranet.objectiflune.com/

For information on licensing, please see Activating your license.

Installation Pre-Requisites

l Make sure your system meets the System requirements. l PlanetPress Version 1.4.2 can be installed under a regular user account with

Administrator privileges.

You must install on an NTFS file system.

Page 16

l PlanetPress requires Microsoft .NET Framework 3.5 already be installed on the target

Note

From PlanetPress Connect Version 1.2 onwards, the new version (1.1.8)of the Update Client is included by default with all setups.

system.

l In order to use the automation feature in Version 1.4.2, you need to install PlanetPress

Workflow 8. This can be installed on the same machine as an existing PlanetPress® Suite 7.6 installation or on a new computer. For more information, please see Information

about PlanetPress Workflow 8.

l As with any JAVA application, the more RAM available, the faster the product will

execute.

Users of Connect 1.1

In order for users of PlanetPress Connect 1.1 to upgrade to any later version through the Update Manager it is necessary to install a later version (1.1.8 or later) of the Objectif Lune Update Client.

If you do not have such a version installed already, the next time you run your Update Client it will show that there is an update available of itself to Version 1.1.8 (or later).

Simply click on the download button in the dialog to install the new version of the Update Client. Note that it is no problem to run the update while the Client is open. It will automatically update itself.

Once you have done this, PlanetPress Connect 1.4.2 will become available for download.

Users of Connect 1.0

Users of this Connect version 1.0 cannot upgrade directly to Version 1.4.2. This is because Connect Version 1.0 is a 32 bit version of Connect. Users must first upgrade to Version 1.1 and from there upgrade to Version 1.4.2

If you are updating manually you must first upgrade to Version 1.1 before installing 1.4.2. If you attempt go directly from Version 1.0 to Version 1.4.2 the installation will fail.

Page 17

Also see "Users of Connect 1.1" on the previous page for extra information about updating from that version.

Installing PlanetPress Connect on Machines without Internet Access

In order to install PlanetPress Connect it is necessary for the GoDaddy Root Certificate Authority to be installed (G2 Certificate) on the host machine and for this to be verified online. When a machine hosting the installation does not have access to the Internet, the installation will fail because the verification cannot be performed. To solve this problem you must first ensure that all Windows updates have been installed on the host machine. You then need to complete the following steps:

1. Go to https://certs.godaddy.com/repository and download the following two certificates to copy to the offline machine:

l GoDaddy Class 2 Certification Authority Root Certificate - G2 - the file is gdroot-

g2.crt

l GoDaddy Secure Server Certificate (Intermediate Certificate) - G2 - the file is

gdig2.crt

2. Install the certificates: Right mouse click -> Install Certificate, and follow the steps through the subsequent wizard.

3. Now copy the PlanetPress Connect installer to the offline machine and start the installation as normal

Installation Wizard

Starting the PlanetPress Connect installer

The PlanetPress Connect installer may be supplied as an ISO image or on a DVD:

l If an ISO image, either burn the ISO onto a DVD or unzip the contents to a folder (keeping

the folder structure)

l If on a DVD, either insert the DVD and initiate the installation from there or copy the

contents to a folder (keeping the folder structure)

Navigate to the PlanetPress_Connect_Setup_x64.exe or and double-click on it. After a short while the Setup Wizard will appear as a guide through the installation steps.

Page 18

Note

PlanetPress Connect requires prior installation of Microsoft .NET Framework 3.5 (please refer to

https://www.microsoft.com/en-us/download/details.aspx?id=21 for more details).

Selecting the required components

After clicking the Next button, the component selection page appears, where the different components of PlanetPress Connect can be selected for installation. Currently, the following are available:

PlanetPress Connect Designer: The Designer module. It may be used as a standalone with no other installed modules, but it will not have certain capabilities such as automation and commingling.

PlanetPress Connect Server: The Server back-end giving capabilities such as automation, commingling, picking. It saves all entities generated from the Automation module into a database for future use.

MySQL Product: The database used by the PlanetPress Connect Engine to save its items. This item is optional if an existing MySQL server, either on the same computer or a separate server, is to be used.

Installation Path: This is the location where modules are to be installed.

The installer can also calculate how much disk space is required for installing the selected components as well as how much space is available:

Disk space required: Displays the amount of space required on the disk by the selected components.

Disk space available on drive: Displays the amount of space available for installation on the drive currently in the Installation Path.

Recalculate disk space: Click to re-check available disk space. This is useful if space has been made available for the installation while the installer was open.

Source repository location: Displays the path where the installation files are located. This can be a local drive, installation media, or a network path.

Selection Confirmation

The next page confirms the installation selections made. Click Next to start the installation itself.

Page 19

End User License Agreement

Note

When updating from an earlier Connect version, the appropriate MySQL password must be entered or the update will fail.

If the password is subsequently forgotten, then the MySQL product must be uninstalled and its database deleted from disk before attempting to reinstall.

The next page displays the End User License Agreement, which needs to be read and accepted before clicking Next.

MySQL Configuration

The Default Database Configuration page only appears if the MySQL Product module was selected in the Product Selection screen. It defines the administrative password for the MySQL server as well as which port it uses for communication. Note that the installer will automatically configure the Server to use the supplied password and port.

MySQL user 'root' Password: Enter the password for the 'root', or administration account, for the MySQL server. The password must be at least 8 characters long and contain at least one of each of the following:

l a lower case character (a, b, c ... ) l an upper case character (A, B, C ...) l a numeric digit (1, 2, 3 ...) l a punctuation character (@, $, ~ ...)

For example:"Th1sIs@K"

Confirm 'root' Password: Re-enter to confirm the password. Both passwords must match for installation to continue.

TCP/IP Port Number: The port on which MySQL will expect, and respond to, requests. A check is run to confirm whether the specified TCP\IP Port Number is available on the local machine. If it is already being used by another service (generally, an existing MySQL installation), the number is highlighted in red and a warning message is displayed at the top of the dialog.

Allow MySQL Server to accept non-local TCP connections: Click to enable external access to the MySQL server. This is required if MySQL Server will need to be accessed

Page 20

from any other machine. It is also required if MySQL is on a separate machine than

Note

The last option may represent a security risk if the machine is open to the internet. It is recommended to ensure your firewall blocks access to port 3306 from external requests!

PlanetPress Connect.

The Database Connection page appears if the MySQL Product module was not selected. It defines the necessary information required to connect to an existing database.

Database Configuration: Select the database type to use for the PlanetPress Connect Engine. Currently, only MySQL is supported.

Administrator Username: Enter the username for a user with administrative rights on the database. Administrative rights are required since tables need to be created in the database. If accessing a database on a different machine, the server must also be able to accept non-local TCPconnections, and the username must also be configured to accept remote connection. For example, the "root"MySQLuser entered as root@localhost is not allowed to connect from any other machine than the one where MySQLis installed.

Administrator Password: Enter the password for the above user. The appropriate MySQL password must be entered or the Connect installation will fail.

TCP/IP Port Number: Enter the port on which the database server expects connections. For MySQL, this is 3306 by default.

Database Host Name: Enter the existing database server's IP or host name.

Server Schema/Table: Enter the name of the MySQL database into which the tables will be created. The Connect standard name is "objectiflune".

Test Connection button: Click to verify that the information provide into previous fields is valid by connecting to the database.

PlanetPress Connect Server Configuration

The Server Configuration page is where the Server component is configured.

Run Server as: Defines the machine username and password that thePlanetPress Connect Server module's service uses. This account should be administrator on the

local machine. Note that the "Server Security Settings" on page 37 dialog can only be executed from the user specified here.

Page 21

l l

Username: The username the service uses to login. If the machine is on a domain, use the format domain\username.

Password: The password associated with the username.

Validate user button: Click to verify that the entered username and password combination is correct and that the service is able to login. This button must be clicked and the user validated before the Next button becomes available.

Click Next to start the actual installation process. This process can take several minutes.

Completing the installation

This screen describes a summary of the components that have been installed.

Configure Update Check checkbox: This option is enabled by default. It causes the Product Update Manager to run after the installation is complete. This allows

configuring PlanetPress Connect to regularly check for entitled updates. Note: this checkbox may not be available in the event that an issue was encountered during the installation.

Show Log... : If an issue was encountered during the installation, click this button to obtain details. This information can then be provided to Objectif Lune for troubleshooting.

l When ready, click the Finish button to close the installation wizard, and initialize the

Product Update Manager, if it was selected.

The Product Update Manager

If the Configure Update Check option has been selected, the following message will be displayed after clicking “Finish” in the setup:

Click “Yes” to install or open the Product Update Manager where the frequency with which the updates can be checked and a proxy server (if required) can be specified. Note: if the Product Update Manager was already installed by another Objectif Lune application, it will be updated to the latest version and will retain the settings previously specified.

Select the desired options and then click OK to query the server and obtain a list of any updates that are available for your software.

l Note that the Product Update Manager can also be called from the “Objectif Lune Update

Client” option in the Start menu.

Page 22

l It can be uninstalled via Control Panel | Programs | Programs and Features.

Technical

Before activating the software, please wait 5 minutes for the database to initialize. If the software is activated and the services rebooted too quickly, the database can become corrupted and require a re-installation.

Product Activation

After installation, it is necessary to activate the software. See Activating your license for more information.

How to Run Connect Installer in Silent Mode

The trigger for the Connect Installer to run in silent mode is a text file with the fixed name install.properties, which is located either in the same folder as the PlanetPress_Connect_ Setup_x86_64.exe or in the unpacked folder of the installer.exe.

The file needs to be a properties file with the following line types:

l Comment Lines, starting with # (e.g. # The options to configure an external database) l Key=Value pairs (e.g. install.product.0 = Connect Designer)

For supported keys, please refer to the next paragraph.

Required and Optional Properties

Here is an example of an install.properties file.

# Verbose logging

logging.verbose = true

# Product selection

install.product.0 = Connect Designer

install.product.1 = Connect Server

# Server settings

server.runas.username = Localadmin

Page 23

server.runas.password = admin

# Database configuration

database.type = mysql

database.host = 192.168.116.10

database.port = 3308

database.username = root

database.password = admin

database.schema = my_ol

Verbose Logging (Optional)

By default, the Silent Installer will log in the same way as the GUI installer. That means logging of error and warnings, and certain information during database configuration. A more verbose logging can be switched on by using logging.verbose = true.

Product Selection (Optional)

By default, the Silent Installer will install all products which are visible to the user in the respective brand (except for the Server Extension, because only Server or Server Extension can be installed at the same time).

However, it is possible to define the products to be installed using their visible product names, and using a counter for the install.product property, e.g.

l install.product.0 = Connect Designer l install.product.1 = Connect Server

Other possible product names are Connect Print Manager, Connect Server Extension and MySQL Product.

Server / Extension configuration (required if Server / Extension is selected for install)

For both, Server and Server Extension, the user credentials who will be running the Server service need to be provided:

l server.runas.username l server.runas.password

Additionally for the Server Extension, some properties to define the Master Server are required:

Page 24

l server.master.host l server.master.port l server.master.authenticate = true_or_false l server.master.username l server.master.password

Database configuration

If the MySQL Product is part of the installation, the following properties should be defined:

l database.type = mysql (required) l database.password (required, needs to match the security rules) l database.port (optional, the default is 3306. The defined port needs to be available.)

Additional properties are required when the configuration of an external MySQL database is required (this is the case if a Server product but not MySQL product is installed):

l database.host l database.username

Optionally, the "schema" name can be defined (the default is objectiflune):

database.schema

Information about PlanetPress Workflow 8

If you wish to use PlanetPress Workflow (automation) in conjunction with PlanetPress Connect, you will need to install PlanetPress Workflow 8 onto the same machine. Workflow 8 is provided through a separate installer which is available on CD or for download as follows:

l If you are a Customer, the installer can be downloaded from the Objectif Lune Web

Activations page: http://www.objectiflune.com/activations

l If you are a Reseller, the installer can be downloaded from the Objectif Lune Partner

Portal: http://extranet.objectiflune.com/

PlanetPress Workflow 8 can be installed in parallel on the same machine as an existing PlanetPress® Suite 7.x installation. Note however:

l If both versions need to be hosted on the same machine, PlanetPress Workflow 8 should

always be installed after the legacy PlanetPress® Suite 7.x installation.

Page 25

l When uninstalling PlanetPress Workflow 8, you may be prompted to repair your legacy

PlanetPress® Suite 7.x installation.

l If PlanetPress Workflow 8 has been installed alongside PlanetPress® Suite 7, Capture

can no longer be used with Workflow 7. The plugins are now registered uniquely to Workflow 8 and the messenger for Workflow 7 is taken offline. It is only then possible to use Capture from PlanetPress Workflow 8.

l PlanetPress Workflow 8 and PlanetPress® Workflow 7 cannot run simultaneously, since

only one version of the Messenger service can run at a time. In fact, no 2 versions of PlanetPress Workflow can on the same machine simultaneously, whatever version is installed.

l It is possible to switch between different versions running by shutting down one version's

services and then starting the other. However, this is not recommended. There are no technical limitations that prevent processes from previous PlanetPress Workflow versions (as far back as Version 4) to run on PlanetPress Workflow 8, removing the need to run both versions.

For more information on the licensing of Workflow 8, please see Activating your license.

Activating a License

PlanetPress Connect and PlanetPress Workflow 8 includes separate 30 day trial periods during which it is not necessary to have a license for reviewing basic functionality. If a modification to the license if required, such as to allow an extension to the trial period, or for extra functionality or plugins (e.g., the PReS Plugin for Workflow 8), then a new activation code will need to be requested.

Obtaining the PlanetPress Connect Magic Number

To obtain an activation file the OL™ Magic Number must first be retrieved. The Magic Number is a machine-specific code that is generated based on the computer's hardware and software using a top-secret Objectif Lune family recipe. Each physical computer or virtual computer should have a different Magic Number, thus require a separate license file to be functional.

To get the PlanetPress Connect Magic Number, open the PlanetPress Connect Designer application:

Open the Start Menu

Click on All Programs, then Objectif Lune, then PlanetPress Connect

Open the PlanetPress Connect Designer [version] shortcut.

Page 26

l When the application opens, if it has never been activated or the activation has expired,

the Software Activation dialog appears:

License Information section:

Magic Number: Displays the PlanetPress Connect Magic Number.

Copy to Clipboard: Click to copy the Magic Number to the clipboard. It can then be pasted in the activation request email using the CTRL+V keyboard shortcut.

Licensed Products section:

Name: Displays the name of the application or module relevant to this activation.

Serial Number: Displays the activation serial number if the product has been activated in the past.

Expiration Date: Displays the date when the activation will expire (or the current date if the product is not activated)

Web Activations: Click to be taken to the online activation page (not yet functional).

End-User License Agreement (Appears only when loading a license file):

License: This box displays the EULA. Please note that this agreement is legally binding.

I agree: Select to accept the EULA. This option must be selected to install the license.

I don't agree: Select if you do not accept the EULA. You cannot install the license if this option is selected.

Load License File: Click to browse to the .olconnectlicense file, once it has been received.

Install License: Click to install the license and activate the software (only available when a license file is loaded).

Close: Click to cancel this dialog. If a license file has been loaded, it will not automatically be installed.

The Software Activation dialog can also be reached through a shortcut located in All Programs, then

Objectif Lune, then PlanetPress Connect and is named Software Activation. Since it does not

load the software, it is faster to access for the initial activation.

Requesting a license

After getting the Magic Number, a license request must be done for bothPlanetPress Connect and Workflow 8:

Page 27

Customersmust submit their Magic Number and serial number to Objectif Lune via the Web Activations page: http://www.objectiflune.com/activations. The OL Customer Care team will then send the PlanetPress Connect license file via email.

Resellerscan create an evaluation license via the the Objectif Lune Partner Portal by following the instructions there: http://extranet.objectiflune.com/

Note that if you do not have a serial number, one will be issued to you by the OL Activations team.

Accepting the license will activate it, after which the PlanetPress Connect services will need to be restarted. Note that in some case the service may not restart on its own. To resolve this issue, restart the computer, or start the service manually from the computer's Control Panel.

Activating PlanetPress Workflow 8

PlanetPress Workflow 8 uses the same licensing scheme as PlanetPress Connect. There are two ways of activating the license for Workflow 8 after saving it to a suitable location:

l If only PlanetPress Workflow 8 is installed, double-click on the license for the PlanetPress

Workflow 8 License Activation dialog to open. Applying the license here activates all of the Workflow 8 components.

If you have both PlanetPress Workflow 8 and PlanetPress Connect installed, it will not be possible to double-click on the license file as this will always open the PlanetPress Connect Activations Tool. Instead, open PlanetPress Workflow 8 manually and apply the license through the activations dialog within.

Activating PlanetPress Connect

To activate PlanetPress Connect, simply save the license file somewhere on your computer where you can easily find it, such as on your desktop. You can then load the license by doubleclicking on it, or through the start menu:

Open the Start Menu

Click on All Programs, then Objectif Lune, then PlanetPress Connect

Open the PlanetPress Connect Designer [version] shortcut. The “PlanetPress Connect Software Activation” tool displays information about the license and the End-User License

Agreement (EULA).

Click the Load License File button.

l Read the EULA and click I agree option to accept it.

Page 28

Click Install License to activate the license. The license will then be registered on the computer and you will be able to start using the software.

After installation message will appear warning that the Server services will need to be restarted. Just click OK to proceed.

Migrating to a new computer

Currently there are no special migration tools to move data from one PlanetPress Connect installation to another. Instructions for migration will be available for later versions of the software when those tools become available.

User accounts and security

Permissions for PlanetPress Connect Designer

PlanetPress Connect Designer does not require any special permissions to run besides a regular program. It does not require administrative rights and only needs permission to read/write in any folder where Templates or Data Mapping Configurations are located.

If generating Print output, PlanetPress Connect Designer requires permission on the printer or printer queue to send files.

Permissions for PlanetPress Connect Server

The PlanetPress Connect Server module, used by the Automation module, requires some special permissions to run. These permissions are set during installation, in the Engine Configuration section of the Installation Wizard, but it can also be configured later by modifying permissions for the service. To do this:

l In Windows, open the Control Panel, Administrative Tools, then Services (this may

depend on your operating system).

l Locate the service called Serverengine_UUID , where UUID is a series of characters that

depend on the machine where the software is installed.

Right-click on the service and select Properties.

In the Connection tab, define the account name and password that the service should use. This can be a local account on the computer or an account on a Windows Domain. The account must have administrative access on the machine. It should also correspond to the user account set up in PlanetPress Worfklow.

Page 29

The Importance of User Credentials on Installation and Running

OL Connect and required credentials depends heavily on the Connect component and respective tasks and what sort of user credentials are needed.

First of all, it is important to distinguish between installation and run-time

Installation

The Connect installer puts all required files, folders, registry entries and much more to their correct places and locations. As many of these locations are protected against malicious accesses, that very user under whose context the Connect installation is started and running, needs very extensive rights on the respective computer. This user must belong to the Local Administrators group on that machine. Here are some required capabilities, this user:

l Must be able to write into the "Programs" folder. l Must be allowed to check for existing certificates and must also be allowed to install new

ones into the global certificate store on that machine.

l Must be able to write into HKLM and any subtree of it in the registry. l Must be able to INSTALL, START and RUN services and also to MODIFY service

settings.

l Must be known in the network the machine belongs to and must also need to be able to

use shared network resources like shared drives and/or printers etc.

This list may not be complete, but it gives the extent of the requirements. Generally, the local administrator of the machine will have all these credentials, but there may exist network restrictions and policies, which will block one or more of these capabilities. In such cases, the respective network administrator should provide a valid user account for the installation.

User Account

The user account shall be used to later RUN one of the Connect Server flavors (Server or Server Extension). This dedicated user account has to be entered on the respective installer dialog page and must be allowed to START, STOP and RUN services on this machine. This is different from the credentials of the installation user account, which additionally requires the right to INSTALL services. Please be aware of this fact!

Additionally, the Server user must be able to access any network resources that are required for OL Connect to function properly. This includes e.g. additional drives, printers, scanners, other

Page 30

+ 576 hidden pages