OBJECTIF LUNE PlanetPress Production 7.6 User guide

User Guide

www.objectiflune.com

Copyright Information

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any

other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical,

magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc.

Objectif Lune Inc.disclaims all warranties as to this software, whether expressed or implied, including without limitation any

implied warranties of merchantability, fitness for a particular purpose, functionality, data integrity or protection.

PlanetPress and PrintShop Mail are registered trademarks of Objectif Lune Inc.

PostScript and Acrobat are registered trademarks of Adobe Systems Inc.

Pentium is a registered trademark of Intel Corporation.

Windows is a registered trademark of Microsoft Corporation.

Adobe, Adobe PDF Library, Adobe Acrobat, Adobe Distiller, Adobe Reader, Adobe Illustrator, Adobe Photoshop, Optimized

Postcript Stream, the Adobe logo, the Adobe PDF logo are either registered trademarks or trademarks of Adobe Systems Incor-

porated in the United States and/or other countries.

Trademarks of other companies mentioned in this documentation appear for identification purposes only and are the property

of their respective companies.

Title PlanetPress Workflow Tools User Guide

Revision 2012-05-03

Copyright Information

Table of Content

Copyright Information 3

Table of Content 5

Overview 15

Icons used in this guide 15

Other Documentation 15

Getting Started 17

Environment Considerations 17

Terminal Services 17

VMWare/ESX 17

32-Bit or 64-Bit? 17

Antivirus Considerations 17

Backup Considerations 18

Microsoft Office Compatibility 18

Network Considerations 18

Local and Network Rights 18

Account Requirements 19

Mapped Drives 19

Network Ports used by each service 19

Activate Your Printers 20

PlanetPress Suite Workflow Tools Service Logon 20

Understanding PlanetPress Suite Workflow Tools 23

The Nature of PlanetPress Suite Workflow Tools 23

The Three Flavors of the PlanetPress Suite Workflow Tools 23

Terms and Definitions 23

About Configurations 24

About Processes 25

About Subprocesses 25

About Tasks 25

About Branches and Conditions 26

About Data 26

About Data Selections 27

AboutData Emulation 27

Emulations in the PlanetPress Workflow Tools: 27

About Related Programs and Services 28

Available Input Services 28

Available Output Services 28

About Documents 29

About Printing 29

The PlanetPress Suite Workflow Tools Configuration Program 31

Start the PlanetPress Suite Workflow Tools Configuration Program 32

The PlanetPress Suite Button 32

Table of Content

Create a New Configuration 33
Open a PlanetPress Suite Configuration File 33
Saving and Sending a Configuration 34
Save your Configuration 34
Send your Configuration 34
Import Processes from Another Configuration File 35
Import Documents 36
Import PrintShop Mail Documents 36
Change the Interface Language 36
Exit the PlanetPress Suite Workflow Tools Configuration Program 37
The Quick Access Toolbar 37
The PlanetPress Suite Ribbon 38
Start and Stop the PlanetPress Suite Workflow Tools Service 39
The Configuration Components Pane 40
Access Process Properties 41
Add a PlanetPress Suite Process 44
Manipulate Local Variables 45
Activate or Deactivate a Process 45
Convert a Branch to a Subprocess 46
Manipulate Global Variables 46
View Document Properties 47
Use Data and Metadata Files Attached to Documents 48
Use Attached Document Preview 49
Add Resident Documents in the Configuration Components Pane 49
Associate Documents and PlanetPress Watch Printer Queues 50
Using the Clipboard and Drag & Drop 50
Rename Objects in the Configuration Components Pane 52
Reorder Objects in the Configuration Components Pane 52
Grouping Configuration Components 53
Expand and Collapse Categories and Groups in the Configuration Components Pane 54
Delete Objects and Groups from the Configuration Components Pane 54
The Process Area 54
Zoom In or Out within Process Area 55
Adding Tasks 55
Adding Branches 55
Edit a Task 55
Replacing Tasks, Conditions or Branches 56
Remove Tasks or Branches 56
Task Properties Dialog 56
Cutting, Copying and Pasting Tasks and Branches 57
Moving a Task or Branch Using Drag-and-Drop 58
Ignoring Tasks and Branches 59
Resize Rows and Columns of the Process Area 59
Selecting Documents in Tasks 59
Highlight a Task or Branch 60
Undo a Command 60
Table of Content

Redo a Command 60
The Plug-in Bar 60
The Object Inspector Pane 61
Toggle the Run on Desktop Property 62
The Debug Information Pane 62
The Message Area Pane 63
Customizing the Program Window 63
Dock and Undock Areas of the Program Window 64
Show or Hide Areas of the Program Window 64
Combine and Attach Areas 65
Resize the Program Window Areas 68
Preferences 68
General User Options 69
Object Inspector User Options 69
Configuration Components Pane User Options 70
Default Configuration User Options 70
Notification Messages Preferences 70
Sample Data User Options 72
Network User Options 72
PlanetPress Capture User Options 73
PDF Text Extraction Tolerance Factors 77
Logging User Options 78
Messenger User Options 79
HTTP Server Input User Options 79
HTTPServer Input 2 User Options 80
LPD Input Preferences 80
Serial Input Service User Options 81
Telnet Input User Options 82
PlanetPress Fax User Options 82
FTP Output Service User Options 84
PlanetPress Image User Options 84
LPR Output User Options 86
PrintShop Web Connect Service User Options 87
Editor Options 87
Other Dialogs 90
Advanced SQL Statement dialog 90
Access Manager 90
SOAPAccess 92
PDF Viewer 93
The PlanetPress Suite Service Console 95
Add or Delete Document Instances 96
Virtual Drive Manager 97
Working With Variables 99
Types of Variables 99
Job Info Variables 99
Table of Content

Standard Variables 100

Available Standard Variables 100

The %i Loop Count Variable 101

Data in PlanetPress Suite Workflow Tools 103

Choosing a Sample Data File 103

The Data Selector 103

Metadata tab 105

Metadata 106

Using the Metadata Data Selector 111

Using the File Viewer 112

Choosing a Database Type Sample Data File 112

Data Selections in PlanetPress Workflow Tools 112

Text-Based Data Selections 112

Database Data Selections 113

PDF Data Selections 113

Metadata Selections 114

Data File and Job File 114

Actual Data and Sample Data 115

Job File Names and Output File Names 115

Task Properties Reference 117

Input Tasks 119

Initial Input Tasks 119

Secondary Input Tasks 119

Concatenate PDF Files 120

Create File 122

Email Input 123

Folder Capture 125

Folder Listing 126

FTP Input 127

HTTP Client Input 128

HTTP Server Input 129

Input Error Bin 131

Input SOAP 132

LPD Input 133

Serial Input 134

PrintShop Web Connect 135

Telnet Input 136

WinQueue Input 137

Action Tasks 139

Add Document 139

Add/Remove Text 140

Advanced Search and Replace 141

Barcode Scan 143

Change Emulation 146

Create PDF 147

Table of Content

Decompress File(s) 148

Digital Action 149

Download to Printer 149

External Program 150

Load External File 152

Mathematical Operations 152

Open XSLT 153

PlanetPress Database 154

Rename 157

Run Script 158

Send Images to Printer 160

Search and Replace 161

Send to Folder 162

Set Job Infos and Variables 162

SOAP Client Plug-in 163

Standard Filter 165

Translator 165

Windows Print Converter 166

Data Splitters 168

About Using Emulations with Splitters 169

Database Splitter 169

Emulated Data Splitter 171

In-Stream Splitter 172

Generic Splitter 173

PDF Splitter 176

XML Splitter 178

Process Logic Tasks 181

Branch 181

Comment 182

File Name Condition 182

File Size Condition 182

Go Sub 183

Loop 184

Run Script 184

Send to Process 186

SNMP Condition 186

Text Condition 188

Time of Day Condition 189

Connector Tasks 190

Create MRDX 190

Input from SharePoint 190

Laserfiche Repository Output 192

Lookup in Microsoft® Excel® Documents 195

Microsoft® Word® Documents To PDF Conversion 197

Output to SharePoint 198

About PlanetPress Fax 201

Table of Content

PlanetPress Fax 201

Captaris RightFax Configuration 202

About PlanetPress Image 205

PlanetPress Image 205

Overview of the PDF/A and PDF/X Standards 213

PrintShop Mail 213

PlanetPress Capture 215

Capture Condition 215

Capture Fields Generator 218

Capture Fields Processor 219

Capture PGC Splitter 221

Find Capture Documents 222

Get Capture Document 224

PGC to PDF Converter 225

Metadata Tasks 227

Create Metadata 227

Embed/Extract PlanetPress Suite Metadata 228

Metadata Fields Management 228

Metadata File Management 230

Metadata Filter 231

Metadata Level Creation 232

Metadata Sequencer 232

Metadata Sorter 233

Metadata to PDI 234

Metadata-Based N-Up 235

Rule Interface 235

Output Tasks 239

Delete 239

FTP Output 240

Print Using a Windows Driver 241

Printer Queue Output 242

Send Email 243

Send to Folder 245

SOAP Client Plug-in 246

Variable Properties 247

Unknown Tasks 248

Masks 249

Date and Time Format 249

Special Workflow Types 251

Special Workflows 251

PDFWorkflow 251

PlanetPress Capture Workflow 251

HTTPServer workflow 251

PlanetPress Capture Workflow 251

The PlanetPress Capture workflow 252

Table of Content

The Examples 253

PlanetPress Capture Glossary 253

General Considerations 255

Security Considerations 256

10,000 Patterns 257

THE NUMBERS 257

EXAMPLE 258

EXTENDING 258

CONTAMINATION 259

SAFEGUARDS 260

CONCLUSION 260

Anoto penDirector 260

PlanetPress Mobile Application 261

PlanetPress Capture Implementation Restrictions 266

Printer limitations 266

Black ink close to patterns 266

Paper quality 267

Pattern sizes 267

Distance between patterns 268

Basic Functional Capture Workflow 269

Capture Post Processing Workflow 269

Capture Web Manager Workflow 271

Installation 272

Explanation 272

Considerations 272

HTTP Server Workflow 272

Important Configuration, Setup and Options 273

Request/Process/Response cycle 274

Example HTTPWorkflows 275

HTTP PDF Invoice Request 275

Breakdown of this URL: 275

Process Illustration 275

Task Breakdown 276

HTTP Brochure Request 276

Resources 276

Installation 276

Task Breakdown 276

PDF Workflow 277

Examples 278

Daily Sales Report from PDF Files 278

Resources 278

Task Breakdown 278

Printer Queues and Documents 279

PlanetPress Suite Workflow Tools Printer Queues 279

Shared Printer Queue Properties 279

Table of Content

Windows Output Printer Queue 280
LPR Output Printer Queue 280
FTP Output Printer Queue 281
Send to Folder Printer Queue 282
PlanetPress Suite Workflow Tools and PlanetPress Design Documents 283
Variable Content Document File Formats: PTZ, PTK and PS 283
PlanetPress Suite Workflow Tools and Printshop Mail Documents 284
Triggers 284
Load Balancing 285
Location of Documents and Resources 287
Debugging and Error Handling 289
Debugging your PlanetPress Suite Process 289
Debugging and Emulation changes 290
About Error Handling 291
Using the On Error tab 291
Creating and Using Error Processes 291
Accessing the Logs 292
Resubmit Backed Up Input Files to a Process 293
Knowing What to Resubmit 294
Using Scripts 295
The Script Editor and XSLT Editor 295
Use the Editor 296
Import and Export Scripts 296
Find Strings in a Script 296
Find and Replace Strings in a Script 297
Go to a Line in a Script 298
Toggle Bookmarks 298
Jump to Bookmarks 299
SOAP Server API Reference 299
SOAP API - SubmitJob 299
SOAP API - PostJob 300
SOAP API - GetProcessList 300
SOAP API - GetProcessTaskList 301
SOAP API - GetSOAPProcessList 302
SOAP API - PostJobInfoStruc 302
SOAP API - SubmitJobInfStruc 303
The Watch Object 303
Watch.ShowMessage 304
Watch.ExecuteExternalProgram 305
Watch.GetJobFileName 306
Watch.GetOriginalFileName 306
Watch.GetMetadataFilename 306
Watch.InputBox 307
Watch.GetJobInfo 308
Table of Content

Watch.SetJobInfo 308

Watch.GetVariable 309

Watch.SetVariable 309

Watch.ExpandString 310

Watch.Log 310

Watch.Sleep 311

Script.ReturnValue 312

Stopping Execution 313

Index 315

Table of Content

Overview

This PDF documentation covers version 7.4. To view the documentation of previous versions please refer to the PDF files

available in the Downloads section of our website:

http://www.objectiflune.com/OL/Download/DownloadCenter.

Icons used in this guide

Some icons are used throughout this guide in order to catch your attention to certain particular information.

Notes: This icon shows you something that complements the information around it. Understanding notes is not crit-

ical but may be helpful when using PlanetPress Workflow Tools.

Warnings: This icon shows information that may be critical when using PlanetPress Workflow Tools. It is important

to pay attention to these warnings.

Technical: This icon shows technical information that may require some technical knowledge to understand.

Other Documentation

For other related documentation , please see the drop-down menu at the top-right corner of this page.

Overview

Getting Started

This chapter describes how to install the PlanetPress Suite Workflow Tools and how to set up your working environment.

Environment Considerations

This page is intended to provide technical information about the environment in which PlanetPress Workflow is intended to

run.

Terminal Services

PlanetPress Suite does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008. This is to

say, if Terminal Services is installed on the server where PlanetPress Suite is located, unexpected behaviors may occur and

will not be supported by our company. Furthermore, using PlanetPress Suite in a Terminal Service environment is probably an

infringement of our End-User License Agreement.

Terminal Services may also be referred to as Terminal Server or Remote Administration Mode (Windows Server 2003 and

2008).

Single-User Remote Desktop Protocol (RDP)(where only one person can use RDPat a time) is supported for PlanetPress Suite

version 6.2 and higher, however it is only supported in Windows XP or Windows 2003. While later versions of Windows may

not cause issues when accessing PlanetPress Suite through RDP, these combinations are no longer tested and may not be func-

tional.

VMWare/ESX

PlanetPress Suite supports VMWare Workstation, VMWare Server, VMWare Player and VMWare ESX infrastructure envi-

ronments as software installed on the Guest operating system. However, note that only PlanetPress version 7.1.3 and higher

support VMotion under ESX. Also note that copying (duplicating) your VMWare Guest Machine and using it simultaneously con-

stitutes an infringement of our End-User License Agreement.

Furthermore, if your backup solution includes the use of virtual machine snapshots, please keep in mind that if a snapshot is

taken during a time when PlanetPress Workflow Tool is processing a job, this job may process again if the snapshot is

restored. It is thus recommended that you take your snapshots outside of processing hours, whenever that may be.

Note that while VMWare ESX, Workstation, Server and Player (from VMWare, Inc.) are supported, other virtual environments

(such as Microsoft Virtual PC, Parallels, Xen and others) are not supported at this time.

32-Bit or 64-Bit?

PlanetPress Suite version 7.1.3 and higher support 64-Bit operating system. However, our application remains 32-bits in this

environment, which means that for all intents and purposes there is no difference between those two environments as far as

PlanetPress Suite is concerned.

Antivirus Considerations

PlanetPress Suite Workflow Tools generates a very large amount of temporary data on your hard disk, especially when manip-

ulating or creating PDF files. This can sometimes cause issues when any other software is trying to access the temporary files

at the same time as PlanetPress Workflow and its components are trying to read, write, create or delete those files.

Getting Started

In this respect, any antivirus software installed on the machine should ignore the following folders in it's live scans as well as

daily "deep" or "complete" scans:

l On Windows 2000/2003/XP:

l C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Suite 7\

l C:\Documents and Settings\planetpress\Local Settings\Temp\ (where planetpress is the user under which

Watch is configured)

l On Windows Vista/7/2008:

l C:\ProgramData\Objectif Lune\PlanetPress Suite 7\

l C:\Users\planetpress\AppData\Local\Temp\ (where planetpress is the user under which Watch is configured)

l On all systems:

l C:\Windows\Temp\

Note: C:\Windows\Temp\ is used by multiple software which may cause risks on your computer. However, PlanetPress Work-

flow may use this folder as temporary storage, especially in the case of creating PDF files. We do not recommend disabling

scan on this folder, unless you notice performance issues when generating PDFs, and then only as a test.

Backup Considerations

For similar reasons, it is important to know that backup software can also access files while copying them to a remote backup

location, so you should make sure that no PlanetPress Workflow process is working during your backups.

Microsoft Office Compatibility

The Microsoft Office 2010 line of products has not been certified for use with PlanetPress Suite. Some of its products may not

be compatible with the connectors included in the Suite.

Network Considerations

While PlanetPress Suite Workflow Tools is typically installed on a server machine that is only accessed by one single user such

as an ITperson, multiple users logging on to that machine is a possibility (except with terminal servers, see Environment Con-

siderations). Because each user may have different local and network rights, it may be important to consider the implications

in regards to the PlanetPress Suite Workflow Tools. To change the service logon information, see PlanetPress Suite Workflow

Tools Service Logon.

Local and Network Rights

Programs, such as PlanetPress Suite Workflow Tools and all its services, must identify themselves in order to be granted per-

mission to perform operations on the computer on which they run as well as on other computers accessible via a network con-

nection. On a given workstation, you can configure your PlanetPress Suite Workflow Tools to use either the local system

account or any specific user account. When you do this, you grant the PlanetPress Suite Workflow Tools and all its services the

same rights associated with the selected account (except for PlanetPress Messenger Service which always runs on the Local

System account).

When you are running the PlanetPress Suite Workflow Tools Configuration program on a workstation, if it is associated with an

account that is different from your account, the following icon is displayed in the lower right corner of the PlanetPress Suite

Workflow Tools Configuration program: . The icon reminds you that the logon information is different for the PlanetPress

Suite services, and that some network resources may not be accessibly by PlanetPress Suite when running a live con-

figuration.

Getting Started

Account Requirements

PlanetPress Suite Workflow Tools and its services require administrator rights to run on any given computer and must there-

fore be associated with an account that has such rights.

We recommend creating a network or domain account specifically for the PlanetPress Suite services (typically called

"planetpress"or "ppress"), which has administrator credentials on the machine where it is installed, and is given proper rights

for any network resources your configuration may request.

Mapped Drives

Mapped drives (for example, drive X: leading to \\server\public\)are always user-specific and are created at logon. This

means that mapped drives are typically not available by the PlanetPress Suite services when running a live configuration. Fur-

thermore, while the mapped drives are not shared, they are still limited to one map per computer, meaning if one user maps

the X: drive, a different user (or a service)will not be able to map it again.

This creates a limitation in the PlanetPress Suite Workflow Tools:if you create a mapped drive as a user, you will not have

access to this mapped drive while running as a service unless you log off, and then have PlanetPress Workflow Tools map the

drive using a Run Script action inside a Startup Process.

We strongly recommended that instead of using mapped drives, you use full UNCpaths for your network drives. PlanetPress

Suite Worfklow Tools can automatically convert mapped paths to UNCpaths. For more information, please see Network User

Options.

Network Ports used by each service

The port configuration for each PlanetPress Suite Workflow Tools component is described in the following table. The port

number assignments comply with Internet standards. If the PlanetPress Suite Workflow Tools component is not active, the

port is not used.

Component Protocol Local Port Remote Port

Email Input (POP3 mode) TCP Default

1

110

Email Input (Outlook mode) TCP see Remote Port See Microsoft Knowledge Base article 278339

Folder Capture TCP/UDP Default

1

Standard Windows file and printer sharing ports

2

:

l UDP 137, 138; TCP 139 (NetBIOS over

TCP/IP (NetBT))

l UDP 445; TCP 445 (SMB over TCP/IP)

LPD Input TCP 515 (listening port) N/A

FTP Input TCP Default

1

21

Telnet Input TCP Default

1

9100 (configurable)

FTP Output TCP Default

1

21

Email Output (SMTP mode) TCP Default

1

25

Email Output (Outlook mode) TCP

See Email Input (Outlook

mode)

See Email Input (Outlook mode)

Send to Folder Windows Queue

Output

TCP Default

1

Standard Windows file and printer sharing ports

2

:

l 137, 138 and/or 139 (NetBIOS over TCP/IP

(NetBT))

l 445 (SMB Over TCP/IP)

LPR Output TCP Default or 721 to 731

3

515

Getting Started

Component Protocol Local Port Remote Port

PlanetPress Database

TCP or

UDP

Unknown

4

Unknown

4

SNMP Condition UDP Default

1

161

1. Value is greater than 1024 and is assigned by Windows XP. This is the default.

2. Windows NT 4.0 uses NetBIOS over TCP/IP for file and printer sharing, while Windows 2000, Windows XP, and Win-

dows Server 2003 may be configured to use NetBIOS over TCP/IP or SMB over TCP/IP. The operating system may use

additional ports. Refer to the Windows documentation for further information.

3. If the “No source port range restriction” option is checked (recommended), see footnote a. If the option is unchecked,

the local port will be chosen from a range going from 721 to 731.

4. Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database.

Activate Your Printers

The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations.

Printer activations are normally given to you by the activations department electronically, including a file that will auto-

matically add all your printers in this dialog.

The printer list displays the following information

l License Number:Reference number of the activation, linked to your customer account.

l Magic Number:The magic number generated by the printer. If the magic number is incorrect, your jobs will output

with a watermark on that printer.

l Activation Code:The activation code generated by your license number and magic number. If the activation code is

incorrect, your jobs will output with a watermark on that printer.

l Printer Name (Optional):Name and/or model of the printer.

l Comments (Optional):Comments about the printer.

The following buttons are available in this dialog:

l Add:Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous sec-

tion), then click OKto save the new activation.

l Delete:Removes the currently selected activation from the list.

l Web Activation:Click to access the online activation manager on our website.

l OK:Save changes and exit.

l Cancel:Exit without saving changes.

You can also double-click on any existing activation to edit it.

PlanetPress Suite Workflow Tools Service Logon

To be able to run and to have access to local files as well as to files available on other computers in your network, PlanetPress

Suite applications and services must identify themselves using a local or network account.

The first time you start the PlanetPress Suite Workflow Tools Configuration program, the application automatically asks you to

choose an account (see procedure below).

You can also manually start this procedure from the PlanetPress SuiteWorkflow Tools by following this procedure:

Getting Started

Page is loading ...

OBJECTIF LUNE PlanetPress Production 7.6 User guide

OBJECTIF LUNE PlanetPress Production 7.6 User guide

Related papers

Other documents