2022.2
Table Of Contents
- Welcome to PReS Workflow 2022.2
- Installation and setup
- Basics
- Features
- About Workflow Configurations
- Workflow Configuration resource files
- About data
- Data Repository
- Debugging and error handling
- About printing
- OL Connect print jobs
- PlanetPress Suite print jobs
- PReS Workflow printer queues
- Shared printer queue properties
- Windows Output printer queue
- LPR Output Printer Queue
- FTP Output Printer Queue
- Send to Folder printer queue
- Load balancing
- Associating PlanetPress Design documents and PReS printer queues
- Triggers
- Objectif Lune Printer Driver (PS)
- About processes and subprocesses
- Using Scripts
- Run Script task
- APIs
- The Script Editor and XSLT Editor
- SOAP Server API Reference
- The Watch Object
- Data Repository API
- Metadata API
- Attributes
- Count
- Fields
- Index
- NodeType
- Parent
- Selected
- SelectedCount
- SelectedState
- Add(Integer Index)
- AttributeByIndex(Integer Index)
- AttributeByName(const String Name)
- Clear()
- Copy()
- Cut()
- DatapageCount()
- Delete()
- DocumentCount()
- FieldByIndex(Integer Index)
- FieldByName(const String Name)
- FieldByNameIndex(const String Name, Integer Index)
- IndexInDocument()
- IndexInGroup()
- IndexInJob()
- Item(Integer Index)
- PageCount()
- Paste()
- PasteAt(Integer Index)
- Select(TSelectWhat SelectWhat)
- SelectedDatapageCount()
- SelectedDocumentCount()
- SelectedIndexInDocument()
- SelectedIndexInGroup()
- SelectedIndexInJob()
- SelectedPageCount()
- Sort(const String Name, optional TSortFlags Flags, optional const String Name...
- Parameters
- Exceptions
- Parameters
- Exceptions
- Parameters
- Returns
- Parameters
- Exceptions
- Parameters
- Returns
- Exceptions
- Parameters
- Returns
- Parameters
- Returns
- Exceptions
- Parameters
- Returns
- Exceptions
- AlambicEdit API reference
- Stopping execution
- Special workflow types
- About variables
- Workflow add-ons
- About related programs and services
- About Tasks
- Adding tasks
- Editing a task
- Task properties
- Masks
- Selecting a resource file in task properties
- Input tasks
- Initial Input tasks
- Secondary Input tasks
- Properties common to all input tasks
- Available Input tasks
- Create File
- Email Input
- File Count
- Folder Capture
- Folder Listing
- FTP Input
- HTTP Client Input
- Input Error Bin
- Input SOAP
- LPD Input
- Merge PDF Files
- Microsoft 365 Email Input
- Microsoft 365 OneDrive Input
- NodeJS Server Input
- PrintShop Web Connect
- Secure Email Input
- Serial Input
- SFTP Input
- SMTP Input
- Telnet Input
- WinQueue Input
- Action tasks
- Add/Remove Text
- Advanced Search and Replace
- Barcode Scan
- Change Emulation
- Create PDF
- Database Query
- Decompress File(s)
- Digital Action
- External Program
- Load External File
- Logger
- Mathematical Operations
- Open XSLT
- PDF/A-3 Attachments
- Push to Repository
- Rename
- Run Script
- Search and Replace
- Send to Folder
- Set Job Infos and Variables
- SOAP Client plugin
- Standard Filter
- Translator
- XML/JSON Conversion
- Data splitters
- Process logic tasks
- Connector tasks
- Metadata tasks
- OL Connect Send
- OL Connect tasks
- All In One
- Create Email Content
- Create Job
- Create Output
- Create PDF/VT
- Create Preview PDF
- Create Print Content
- Create Web Content
- Download EML Messages
- Execute Data Mapping
- File Store - Delete File
- File Store - Download File
- File Store - Upload File
- Mark Connect Sets for Deletion
- Merge Jobs
- PDF to Bitmap
- Render Email Content
- Retrieve Items
- Set Properties
- Update Data Records
- Output tasks
- Document Management tasks
- Email Services
- Legacy tasks
- Unknown tasks
- Preferences
- Other preferences and settings
- General appearance preferences
- Object Inspector appearance preferences
- Configuration Components pane appearance preferences
- Default configuration behavior preferences
- Notification Messages behavior preferences
- Sample Data behavior preferences
- Network behavior preferences
- PlanetPress Capture preferences
- OL Connect preferences
- PDF text extraction tolerance factors
- General and logging preferences
- Messenger plugin preferences
- HTTP Server Input plugin preferences 1
- HTTP Server Input plugin preferences 2
- LPD Input plugin preferences
- NodeJS Server Input plugin preferences 1
- NodeJS Server Input plugin preferences 2
- NodeJS Server Input plugin preferences 3
- Serial Input plugin preferences
- SMTP Input preferences
- Telnet Input plugin preferences
- PReS Fax plugin preferences
- FTP Output Service preferences
- PReS Image preferences
- LPR Output preferences
- PrintShop Web Connect Service preferences
- Editor Options
- The user interface
- Customizing the Workspace
- PReS Workflow Button
- Configuration Components pane
- Components Area Sections
- PlanetPress Design document properties
- Moving and copying configuration components
- Renaming objects in the Configuration Components Pane
- Reordering objects in the Configuration Components pane
- Grouping Configuration Components
- Expanding and collapsing categories and groups in the Configuration Component...
- Deleting something from the Configuration Components pane
- Dialogs
- Access Manager
- Access Manager hosts.allow File
- Activate a printer
- Advanced SQL Statement Dialog
- Data Repository Manager
- The Data Selector
- Data Selector display preferences
- The File Viewer
- LaserFiche Repository Output Task - Configure Tags
- LaserFiche Repository Output Task - Configure Templates
- PDF Viewer
- Printer utilities
- Process properties
- Rule Interface
- The PReS Workflow Service Console
- Task Properties dialog
- Update document
- Virtual Drive Manager
- The Debug Information pane
- The Message Area Pane
- The Object Inspector pane
- The Plug-in Bar
- The Process area
- Cutting, copying and pasting tasks and branches
- Highlight a task or branch
- Disabling tasks and branches
- Moving a task or branch using drag-and-drop
- Redo a command
- Removing tasks or branches
- Replacing tasks, conditions or branches
- Resize the rows and columns of the Process area
- Collapse and expand branches and conditions
- Undo a command
- Zoom in or out within the Process Area
- The Quick Access Toolbar
- The PReS Workflow Ribbon
- The Task Comments Pane
- The PReS Workflow Service Console
- Knowledge Base
- Legal Notices and Acknowledgments
Using Scripts
Scripts can be used to perform various operations, such as to manipulate data, for example. PReS
Workflow can perform scripts written in four different scripting languages and also provides an interface
for editing scripts.
Note: While this chapter provides some very useful and detailed information about scripting
within PReS Workflow, its focus is to inform you about the features, variables and functions
unique to this environment. This chapter assumes that you have a working knowledge of the
scripting language you wish to use and does not purport to teaching you anything about this lan-
guage that you don't already know. Learning any of these language is beyond the scope of this
documentation.
Run Script task
Scripts are incorporated in a process via the Run Script task (see "Run Script" on page426).
When using the Run Script task as a condition, you need a way to tell your process whether the result
is true or false. The condition result is returned by the "Script.ReturnValue" on page145 variable. If the
return value is zero (the default), the condition is false. Otherwise, it is true.
When using the Run Script as an action task, the job file going out of the Run Script action task will be
the same as the one coming in, unless you have specifically changed it within your script by writing to
the file that is the target of the "Watch.GetJobFileName" on page136 function. The same goes for any
Job Info, local or global variables, unless you use the "Watch.SetJobInfo" on page143 or
"Watch.SetVariable" on page144 functions to modify them.
Scripting languages
There are four scripting languages available through the Run Script task: JavaScript (JScript and
Enhanced JScript), VBScript, Python and Perl. Each language has its own strengths and weaknesses
which we will not cover in this documentation. While VBScript is the most used language at the
moment, the examples provided in this chapter are presented in all supported languages.
Note:
l
The JScript engine is Microsoft’s JScript 5.8, which is the equivalent of JavaScript 1.5
(ECMA-262 3rd edition + ECMA-327 (ES-CP) + JSON).
Enhanced JScript allows the use of more recent JavaScript syntax. Many methods - basic
methods like Date.now(), String.trim(), btoa()/atob() and more advanced meth-
ods like Array.forEach() - are added to the JScript engine via the polyfill.js library.
Page 117