OBJECTIF LUNE PRes Workflow 2022.2 User manual

User Guide

Version 2022.2.3

Last Revision:2023-02-22

Upland Objectif Lune

2409 46e Avenue

Lachine

QC H8T 3C9

Canada

All trademarks displayed are the property of their respective owners.

duced, transmitted or distributed outside of Upland Objectif Lune by any means whatsoever without the

express written permission of Upland Objectif Lune. Upland Objectif Lune 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. Upland Objectif Lune reserves the right

to alter the information contained in this documentation without notice.

Table of Contents

Welcome to PReS Workflow 2022.2 15

Installation and setup 15

System requirements 16

Operating System 16

Virtual environments 16

Minimum hardware requirements 17

Recommended hardware requirements 17

Requirements for individual Connect modules 17

Environment considerations 18

Terminal Services 18

Virtual environments 18

32-bit or 64-bit? 19

Antivirus considerations 19

Backup software 20

Microsoft Office compatibility 20

Installing PReS Connect Workflow 20

Upgrading 20

Using the PReS Connect Workflow installer 21

The Product Update Manager 23

Product activation 23

Silent installation 23

Command line parameters 23

Example 24

Backup existing Workflow version 24

Backing up a virtual machine 24

Backing up a real machine 24

Setting up the working environment 24

Network considerations 25

Local and network rights 25

Account requirements 25

Mapped drives 25

Network ports used by each service 26

Known Issues 27

Microsoft patch causing handling of XLS to fail 27

Data Repository error 28

Other known issues 28

Obtaining a certificate 31

Creating self-signed certificates 31

Basics 32

Related tools and resource files 32

Features 33

About Workflow Configurations 33

Creating a new configuration 34

Open a PReS Workflow configuration file 34

Saving and sending a Workflow Configuration 35

Exit PReS Workflow Configuration program 37

Workflow Configuration resource files 37

Connect resources 38

PlanetPress Design documents 41

PrintShop Mail documents 45

About data 46

About documents and variable data 46

Job file 47

Job file names and output file names 47

Data selections 48

About data emulation 54

Sample Data 62

Metadata 66

Working with JSON 76

Data Repository 79

Structure 80

Accessing the Data Repository 80

Where to find the Data Repository 81

ConnectionString 81

Debugging and error handling 82

About error handling 82

Using the On Error tab 82

Creating and using Error processes 84

Accessing the Logs 85

Resubmit backed up input files to a process 86

Debugging your PReS Workflow process 88

About printing 91

OL Connect print jobs 92

PlanetPress Suite print jobs 93

PReS Workflow printer queues 93

Shared printer queue properties 94

Windows Output printer queue 95

LPR Output Printer Queue 96

FTP Output Printer Queue 98

Send to Folder printer queue 99

Load balancing 100

Associating PlanetPress Design documents and PReS printer queues 101

Page 5

Triggers 102

Objectif Lune Printer Driver (PS) 102

About processes and subprocesses 104

Processes 104

Startup processes 106

Subprocesses 106

Creating a process 106

Importing processes 108

Activating or deactivating a process 109

Process properties 110

About branches and conditions 113

Converting a branch to a subprocess 115

Using Scripts 117

Run Script task 117

APIs 118

The Script Editor and XSLT Editor 118

SOAP Server API Reference 123

The Watch Object 129

Data Repository API 146

Metadata API 162

Attributes 174

Count 174

Fields 174

Index 174

NodeType 174

Parent 175

Selected 175

SelectedCount 175

SelectedState 175

Add(Integer Index) 176

AttributeByIndex(Integer Index) 176

AttributeByName(const String Name) 177

Clear() 177

Copy() 177

Cut() 177

DatapageCount() 177

Delete() 177

DocumentCount() 178

FieldByIndex(Integer Index) 178

FieldByName(const String Name) 178

FieldByNameIndex(const String Name, Integer Index) 179

IndexInDocument() 179

IndexInGroup() 179

IndexInJob() 179

Item(Integer Index) 180

PageCount() 180

Paste() 180

Page 6

PasteAt(Integer Index) 181

Select(TSelectWhat SelectWhat) 181

SelectedDatapageCount() 181

SelectedDocumentCount() 182

SelectedIndexInDocument() 182

SelectedIndexInGroup() 182

SelectedIndexInJob() 182

SelectedPageCount() 183

Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2,

optional const String Name3, optional TSortFlags Flags3) 183

Parameters 186

Exceptions 186

Parameters 187

Exceptions 187

Parameters 188

Returns 188

Parameters 188

Exceptions 188

Parameters 188

Returns 188

Exceptions 188

Parameters 188

Returns 189

Parameters 189

Returns 189

Exceptions 189

Parameters 189

Returns 189

Exceptions 189

AlambicEdit API reference 192

Stopping execution 218

Special workflow types 220

HTTP Server workflow 221

PDF Workflow 228

PlanetPress Capture Workflow 229

Workflow processes in a Connect Send solution 237

About variables 238

Job Info variables 239

System variables 240

Local variables 242

Global variables 243

Variable task properties 245

Workflow add-ons 247

PlanetPress Capture Tasks 247

Capture OnTheGo (COTG) 278

About PReS Fax 278

Page 7

About PReS Image 279

OL Connect Send 280

ZUGFeRD 280

About related programs and services 281

Available Input services 282

Available Output services 282

Start and stop PReS Workflow Service 283

Users and configurations 284

Workflow Services 285

About Tasks 286

Adding tasks 287

Editing a task 288

Task properties 288

Variable task properties 289

Masks 291

Date and Time Format 291

Masks 291

Selecting a resource file in task properties 292

Variable file name 293

Input tasks 295

Initial Input tasks 295

Secondary Input tasks 296

Properties common to all input tasks 296

Available Input tasks 297

Create File 297

Email Input 299

File Count 302

Folder Capture 304

Folder Listing 307

FTP Input 309

HTTP Client Input 311

Input Error Bin 313

Input SOAP 314

LPD Input 316

Merge PDF Files 317

Microsoft 365 Email Input 320

Microsoft 365 OneDrive Input 324

NodeJS Server Input 327

PrintShop Web Connect 333

Secure Email Input 335

Serial Input 339

SFTP Input 340

SMTP Input 343

Telnet Input 346

Page 8

WinQueue Input 348

Action tasks 350

Add/Remove Text 351

Advanced Search and Replace 352

Barcode Scan 355

Change Emulation 360

Create PDF 364

Database Query 368

Decompress File(s) 373

Digital Action 374

External Program 383

Load External File 385

Logger 385

Mathematical Operations 386

Open XSLT 387

PDF/A-3 Attachments 389

Push to Repository 392

Rename 393

Run Script 394

Search and Replace 396

Send to Folder 397

Set Job Infos and Variables 398

SOAP Client plugin 399

Standard Filter 401

Translator 402

XML/JSON Conversion 404

Data splitters 405

About using emulations with data splitters 405

Database Splitter 406

Emulated Data Splitter 408

In-Stream Splitter 411

PDF Splitter 412

XML Splitter 415

Process logic tasks 418

Available Process logic tasks 418

Branch 419

Comment 420

File Count 420

File/Folder Condition 422

File Name Condition 423

File Size Condition 423

Go Sub 424

Loop 425

Run Script 426

Send to Process 428

SNMP Condition 429

Page 9

Text Condition 431

Time of Day Condition 432

Connector tasks 433

Available Connector tasks 434

Delete Capture OnTheGo Document 434

Input from SharePoint 435

Laserfiche Repository Output 438

Lookup in Microsoft® Excel® Documents 440

Output to Capture OnTheGo 443

Output to SharePoint 446

PReS Fax 448

PReS Image 450

PReS Print Controls 458

ZUGFeRD plugin 461

Metadata tasks 467

Create Metadata 467

Embed/Extract PReS Workflow Metadata 469

Metadata Fields Management 470

Metadata File Management 472

Metadata Filter 473

Metadata Level Creation 474

Metadata Sequencer 476

Metadata Sorter 477

Metadata to PDI 478

Metadata-Based N-Up 479

OL Connect Send 481

Workflow processes in Connect Send 481

OL Connect Send tasks 481

Get Data 481

Get Job Data 485

Job Processor 489

OL Connect tasks 492

All In One 493

Create Email Content 500

Create Job 504

Create Output 506

Create PDF/VT 508

Create Preview PDF 509

Create Print Content 513

Create Web Content 516

Download EML Messages 520

Execute Data Mapping 522

File Store - Delete File 526

File Store - Download File 527

File Store - Upload File 528

Mark Connect Sets for Deletion 530

Page 10

Merge Jobs 531

PDF to Bitmap 531

Render Email Content 533

Retrieve Items 537

Set Properties 541

Update Data Records 542

Output tasks 543

Available Output tasks 544

Delete 544

FTP Output 545

Microsoft 365 Email Output 546

Microsoft 365 OneDrive Output 549

SFTP Output 551

Print using a Windows driver 553

Printer Queue Output 555

Secure Email Output 557

Send Email 560

Send to Folder 563

Document Management tasks 564

DocuWare 564

M-Files 574

Input from SharePoint 581

Output to SharePoint 584

Email Services 586

Mailjet 587

SendGrid 590

Legacy tasks 592

Add document 593

Create MRDX 594

Download to Printer 595

Generic Splitter 596

HTTP Server Input 601

Microsoft® Word® Documents To PDF Conversion 605

PrintShop Mail 608

Send Images to Printer 610

SOAP Client plugin 612

Action-EMF Converter (Windows Print Converter) 614

PlanetPress Capture Tasks 617

Unknown tasks 635

Preferences 636

Other preferences and settings 637

General appearance preferences 637

Ribbon Color Scheme 637

Colors 638

Page 11

Inactive process 638

Object Inspector appearance preferences 638

Colors 638

Options 638

Configuration Components pane appearance preferences 639

Colors 639

Options 639

Default configuration behavior preferences 639

Notification Messages behavior preferences 640

Preferences 641

Sample Data behavior preferences 643

Preferences 643

Network behavior preferences 643

Preferences 644

PlanetPress Capture preferences 644

The available PlanetPress Capture user options are: 645

PlanetPress Capture Server/Client 645

PlanetPress Document Manager 646

PlanetPress Capture ODBC Settings 647

PlanetPress Capture Pen Management Tool 650

PlanetPress Capture License Management 651

OL Connect preferences 652

PDF text extraction tolerance factors 653

Delta Width 653

Delta Height 654

Font Delta Height 654

Gap 654

General and logging preferences 654

Messenger plugin preferences 656

Preferences 656

HTTP Server Input plugin preferences 1 656

Preferences 656

HTTP Server Input plugin preferences 2 660

LPD Input plugin preferences 661

Preferences 661

NodeJS Server Input plugin preferences 1 662

NodeJS Server Input plugin preferences 2 664

NodeJS Server Input plugin preferences 3 664

Testing the server 665

Changing the Log in page 665

Setting the duration of the authentication 666

Serial Input plugin preferences 666

Preferences 666

Page 12

SMTP Input preferences 667

Preferences 667

Telnet Input plugin preferences 668

Preferences 668

PReS Fax plugin preferences 668

Preferences 669

OpenText RightFax options 671

FTP Output Service preferences 671

Options 671

PReS Image preferences 672

PReS Image 1 or logging tab 672

PReS Image 2 or database tab 673

PReS Image 3 or network tab 674

PReS Image 4 or login tab 674

LPR Output preferences 675

Options 675

PrintShop Web Connect Service preferences 676

Editor Options 676

The user interface 680

Customizing the Workspace 681

Dock and undock areas of the Program Window 682

Show or hide areas of the program window 683

Combine and attach areas 683

Resize the program window areas 687

Change the Interface language 688

PReS Workflow Button 688

Options 688

Configuration Components pane 689

Components Area Sections 689

PlanetPress Design document properties 692

Moving and copying configuration components 694

Renaming objects in the Configuration Components Pane 697

Reordering objects in the Configuration Components pane 697

Grouping Configuration Components 698

Expanding and collapsing categories and groups in the Configuration Components pane 699

Deleting something from the Configuration Components pane 699

Dialogs 700

Access Manager 700

Access Manager hosts.allow File 704

Activate a printer 705

Advanced SQL Statement Dialog 706

Data Repository Manager 707

The Data Selector 710

Page 13

Data Selector display preferences 713

The File Viewer 716

LaserFiche Repository Output Task - Configure Tags 716

LaserFiche Repository Output Task - Configure Templates 716

PDF Viewer 718

Printer utilities 719

Process properties 721

Rule Interface 724

The PReS Workflow Service Console 727

Task Properties dialog 730

Update document 731

Virtual Drive Manager 731

The Debug Information pane 731

The Message Area Pane 732

The Object Inspector pane 733

Editing properties 733

The Plug-in Bar 734

Categories 734

Settings and customization 735

The Process area 736

Cutting, copying and pasting tasks and branches 737

Highlight a task or branch 738

Disabling tasks and branches 739

Moving a task or branch using drag-and-drop 739

Redo a command 740

Removing tasks or branches 740

Replacing tasks, conditions or branches 741

Resize the rows and columns of the Process area 741

Collapse and expand branches and conditions 741

Undo a command 742

Zoom in or out within the Process Area 742

The Quick Access Toolbar 742

Adding buttons 742

Removing buttons 743

Moving the toolbar 743

The PReS Workflow Ribbon 743

The Task Comments Pane 746

The PReS Workflow Service Console 746

Controlling Services 746

Viewing log files 747

Knowledge Base 748

Legal Notices and Acknowledgments 748

Copyright Information 754

Page 14

Welcome to PReS Workflow 2022.2

This PDF documentation covers version 2022.2. 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.

Workflow plays a major role in many of our solutions. Working in conjunction with PReS Connect, PReS

Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps improve your

communications processes. Processes such as communication creation, interaction, distribution and

even maintenance.

Workflow is a "super dispatcher". It caters for inputs from a huge variety of sources, such as email, web

pages, databases, individual files (PDF, csv, XML, etc), print streams, FTP, Telnet and ERP systems.

This data can then be analyzed, modified, stored, verified, routed and used as triggers for other pro-

cesses from entirely within Workflow. Finally it is passed to one of our other products (or not) to be out-

putted in multiple ways (printed, emailed, posted, archived, sent to third party solutions, etc..).

Consider Workflow as a set of buildings blocks that enable you to build your own customized auto-

mated processes which will fit your environment and not the other way around. Create processes that

will save you time and money!

Notes in this guide

Notes are used throughout this guide to draw your attention to certain information.

Note: Important information that deserves your attention.

Tip: Information that may help you use PReS Workflow better or that suggests an easier method.

Caution: Information that is potentially critical to using PReS Workflow

Installation and setup

The installation procedure for Workflow is described in the topic "Installing PReS Connect Workflow" on

page20.

The following topics describe the different considerations that are important in regards to the install-

ation and use of PReS Workflow.

l"System requirements" on the next page

l"Environment considerations" on page18

Page 15

l"Setting up the working environment" on page24

l"Known Issues" on page27

System requirements

These are the recommended system requirements for PReS Workflow 2022.2.

Operating System

lMicrosoft Windows 11

lMicrosoft Windows 10 (Pro and Enterprise versions only)

lMicrosoft Windows 8.1

lMicrosoft Windows Server 2022

lMicrosoft Windows Server 2019

lMicrosoft Windows Server 2016

lMicrosoft Windows Server 2012/2012 R2

Note: PReS Workflow2022.2 is expected to run on some older operating systems, but just as

Microsoft no longer supports these older operating systems, Upland Objectif Lune will not

provide support for Upland Objectif Lune products running on them.

Virtual environments

PReS Workflow supports the following virtual environments:

lVMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare

ESX Server.

lVMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically

moved from one ESX server to another in a clustered installation.

lMicrosoft Hyper-V/Azure infrastructure environments.

lAmazon Web Services (AWS)

PReS Workflow is not officially supported on any other virtual machines such as Virtual PC, Parallels,

Bochs, Xen, etc. While running PReS Workflow on these virtual machines may work finewe have not

tested them and cannot offer support for them.

Caution: The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Work-

flow software license may only be used on a single virtual or physical PC at a time. While copying

a virtual machine for backup purposes is acceptable, running two instances of the same

machine, using the same serial number, is strictly prohibited.

Page 16

Minimum hardware requirements

As with any software application, minimum hardware requirements represent the basic hardware on

which the software will run. Note however that settling for the minimum specification is unlikely to pro-

duce the performance you expect from the system. It can be used when configuring a trial or a devel-

opment system, however.

lFile system: NTFS (FAT32 is not supported)

lCPU:multi-core

lRAM: 6GB

lDisk Space:At least 10GB*1

*1: Requirements will depend upon the amount of data you process through PReS Workflow. For instance, a

PostScript file containing several thousands of documents could easily take up several GBs.

Recommended hardware requirements

Due to its versatility, OL Connect is used for a wide variety of applications. Consequently, it is difficult to

determine which hardware configuration will produce the best results for any given implementation.

The following specs should therefore be viewed as a general guideline that is most likely to produce

expected results for most implementations. You should, however, keep in mind that it may not rep-

resent the optimal setup for your particular application.

lFile system: NTFS (FAT32 is not supported)

lCPU:Intel Core i7-4770 Haswell or equivalent

lRAM: 16GB

lDisk Space: 20GB*

lStorage Type: Solid State Drive (SSD)

lNetworking: 10Gb Ethernet

*: Requirements will depend upon the amount of data you process through PReS Workflow. For instance, a

PostScript file containing several thousands of documents could easily take up several GBs.

Requirements for individual Connect modules

OL Connect Products comprises multiple modules that can be operated separately on multiple PCs.

Each module has its own set of requirements that may differ from the other modules. While the hard-

ware requirements described above are relatively generic when installing all Connect modules on a

single server, they should not be interpreted literally for each individual module.

When installing on multiple PCs, keep the following rules of thumb in mind:

Page 17

lThe Connect Workflow module requires less RAM but fast hard drive access. It also benefits from

fast multi-core CPUs, in order to run processes in parallel.

lThe Connect Server module requires more RAM and benefits from fast multi-core CPUs. Disk

access speed is less of a concern.

lThe Connect Designer module requires more RAM and fast disk access to provide a responsive

user-experience.

lThe back-end database (MySQL by default) benefits from more RAM, speedy disk access and

fast networking as it will be solicited by all modules simultaneously.

Environment considerations

This page provides technical information about the environment in which PReS Workflow is intended to

run.

Terminal Services

PReS Workflow does not support Remote Desktop (Terminal) Services because Workflow runs on

single server and only one user can log on at once.

Terminal Services may also be referred to as Terminal Server or Remote Administration Mode (Win-

dows Server 2003 and 2008).

Single-User Remote Desktop Protocol (RDP) (where only one person can use RDP at a time) is sup-

ported for PReS Workflow version 6.2 and higher, however it is only supported in Windows XP or Win-

dows 2003. While later versions of Windows may not cause issues when accessing PReS Workflow

through RDP, these combinations are no longer tested and may not be functional.

Virtual environments

PReS Workflow supports the following virtual environments:

lVMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare

ESX Server.

lVMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically

moved from one ESX server to another in a clustered installation.

lMicrosoft Hyper-V/Azure infrastructure environments.

lAmazon Web Services (AWS)

PReS Workflow is not officially supported on any other virtual machines such as Virtual PC, Parallels,

Bochs, Xen, etc. While running PReS Workflow on these virtual machines may work finewe have not

tested them and cannot offer support for them.

Page 18

Caution: The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Work-

flow software license may only be used on a single virtual or physical PC at a time. While copying

a virtual machine for backup purposes is acceptable, running two instances of the same

machine, using the same serial number, is strictly prohibited.

32-bit or 64-bit?

PlanetPress Suite version 7.1.3 and higher, as well as PReS Connect, support a 64-bit operating sys-

tem. However, PReS Workflow 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 PReS Workflow is con-

cerned.

Antivirus considerations

PReS Workflow generates a very large amount of temporary data on your hard disk, especially when

manipulating 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 PReS Workflow and its components are trying to

read, write, create or delete those files.

If you experience these issues you may want to temporarily disable your antivirus "live", "daily" or

"deep" scans for the following folders and processes:

Caution: Disabling any antivirus scanning permanently on any folder or program is not recom-

mended, and Objectif Lune cannot be held reliable for any consequence of disabling your anti-

virus or whitelisting the folders or executables listed here, or any other change in your antivirus

protection setup!

lOn Windows 7/2008 and later:

lC:\ProgramData\Objectif Lune\PlanetPress Workflow 8\

lC:\Users\[user]\AppData\Local\Temp\ (where [user] is the user under which Workflow is

configured)

lC:\Users\[user]\Connect (where [user] is the user under which Workflow is configured)

lOn all systems:

lC:\Windows\Temp\

Note: C:\Windows\Temp\ is used by multiple software which may cause risks on

your computer. However, PReS Workflow may use this folder as temporary storage,

especially in the case of creating PDF files. We do not recommend disabling scan on

Page 19

this folder, unless you notice performance issues when generating PDFs, and then

only as a test.

lProcesses:

lFTPPutService.exe

lHTTPService.exe

lLPDService.exe

lLPRService.exe

lPPWatchService.exe

lPSWService.exe

lSerialService.exe

lSMTPService.exe

lTelnetService.exe

lppNode.exe

lPPFaxService.exe

lPPImageService.exe

lMessengerService.exe

Backup software

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 PReS Workflow process is working

during your backups.

Microsoft Office compatibility

The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use

with PReS Workflow. Some of its products may not be compatible with the connectors included in OL

Connect.

Installing PReS Connect Workflow

Upgrading

Upgrading from Workflow versions predating 2019.1

In order to update Workflow to 2019.2 or higher from Workflow versions prior to 2019.1 it is first neces-

sary to update the Connect License.

Page 20

Page is loading ...

OBJECTIF LUNE PRes Workflow 2022.2 User manual

OBJECTIF LUNE PRes Workflow 2022.2 User manual

Related papers

Other documents