2021.2
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Connect 2021.2
- Setup And Configuration
- System and Hardware Considerations
- Installation and Activation
- Where to obtain the installers
- Installation prerequisites
- User accounts and security
- Installing PlanetPress Connect on Machines without Internet Access
- Installation Wizard
- Running Connect installer in Silent Mode
- Activating a License
- Migrating to a new workstation
- Information about PlanetPress Workflow
- Upgrading
- Server Configuration Settings
- Known Issues
- Uninstalling
- General information
- OL Connect projects
- The DataMapper
- DataMapper basics
- Data mapping configurations
- Creating a new data mapping configuration
- Opening a data mapping configuration
- Saving a data mapping configuration
- Down-saving a data mapping configuration
- Using the wizard for CSV and Excel files
- Using the wizard for databases
- Using the wizard for JSON files
- Using the wizard for PDF/VT or AFP files
- Using the wizard for XML files
- Advanced PCL to PDF options
- Data mapping workflow
- The Data Model
- DataMapper User Interface
- DataMapper Scripts API
- The Designer
- Designer basics
- Web
- Capture OnTheGo
- COTG Forms
- Creating a COTG Form
- Filling a COTG template
- Sending the template to the Workflow tool
- Receiving and extracting data from a COTG Form
- Using COTG data in a template
- Designing a COTG Template
- Capture OnTheGo template wizards
- Using Foundation
- COTG Elements
- Using COTG Elements
- Testing a Capture OnTheGo Template
- Using the COTG plugin
- Dynamically adding COTG widgets
- Saving and restoring custom data and widgets
- Using submitted COTG data in a template
- Capture OnTheGo API
- Content elements
- Snippets
- Styling and formatting
- Personalizing content
- Preferences
- General preferences
- Clean-up Service preferences
- DataMapper preferences
- Database Connection preferences
- Editing preferences
- Email preferences
- Emmet preferences
- Engines preferences
- Hardware for Digital Signing preferences
- Language preferences
- Logging preferences
- Parallel Processing preferences
- Print preferences
- Project Wizards preferences
- Save preferences
- Scripting preferences
- Servers preferences
- Web preferences
- Writing your own scripts
- Script types
- Creating a new Standard Script
- Writing a script
- Setting the scope of a script
- Managing scripts
- Testing scripts
- Optimizing scripts
- The script flow: when scripts run
- Selectors in Connect
- Loading a snippet via a script
- Loading content using a server's API
- Using scripts in Dynamic Tables
- Control Scripts
- Post Pagination Scripts
- Translating templates
- Designer User Interface
- Designer Script API
- Functions and fields
- Example
- Functions and fields
- html()
- margins
- front, back
- Generating output
- Print output
- Email output
- Web output
- Generating Print output
- Generating Print output from the Designer
- Generating Print output from Workflow
- Print settings in a template
- Aborting content creation
- Print using standard print output settings
- Print Presets
- Print using Advanced Printer Wizard
- Adding print output Models to the Print Wizard
- Splitting printing into more than one file
- Print output variables
- Generating Fax output
- Generating Tags for Image output
- Generating Email output
- Generating Web output
- Optimizing a template
- Runtime parameters
- PlanetPress Connect Release Notes
- OL PlanetPress Connect Release Notes 2021.2.1
- License Update Required for Upgrade to OL Connect 2021.x
- Backup before Upgrading
- Overview
- OL Connect 2021.2.1 Improvements
- OL Connect 2021.2 Designer Improvements
- OL Connect 2021.2 DataMapper Improvements
- OL Connect 2021.2 Output Improvements
- Workflow 2021.2 Improvements
- OL Connect 2021.2 Improvements
- Known Issues
- Previous Releases
- OL PlanetPress Connect Release Notes 2021.1
- OL PlanetPress ConnectRelease Notes 2020.2.1
- OL PlanetPress Connect Release Notes 2020.1
- OL PlanetPress Connect Release Notes 2019.2
- OL PlanetPress Connect Release Notes 2019.1
- PlanetPress Connect Release Notes 2018.2.1
- PlanetPress Connect Release Notes 2018.1.6
- PlanetPress Connect Release Notes 1.8
- PlanetPress Connect Release Notes 1.7.1
- PlanetPress Connect Release Notes 1.6.1
- PlanetPress Connect Release Notes 1.5
- PlanetPress Connect Release Notes 1.4.2
- Connect 1.4.2 Enhancements and Fixes
- Connect 1.4.1 New Features and Enhancements
- Connect 1.4.1 Designer Enhancements and Fixes
- Connect 1.4.1 DataMapping Enhancements and Fixes
- Connect 1.4.1 Output Enhancements and Fixes
- Connect 8.4.1 Workflow Enhancements and Fixes
- Known Issues
- OL PlanetPress Connect Release Notes 2021.2.1
- Knowledge Base
- Legal Notices and Acknowledgements
Designer API
Features like results and record do not exist in the native JavaScript library. These are
additional JavaScript features, designed for use in Connect scripts only. All features designed
for use in the Designer are listed in the Designer's API, with a lot of examples; see "Standard
Script API" on page1283.
Tip
Do you find yourself copy-pasting the same function into every new script? You can avoid
this by defining your function in a Control Script. Control Scripts are executed first, so the
function will then be available in all Standard Scripts and Post Pagination Scripts.
Setting the scope of a script
The selector of a script can match multiple elements. By setting the scope of the script you can
determine whether you want to run the script once, or once for each element that matches the
selector. The second option is especially useful when a script targets rows or cells in a
Dynamic Table (see "Using scripts in Dynamic Tables" on page909).
To set the scope of a script, click on Options at the bottom of the Script Editor window. The
options are:
l Result set: The script will run once, regardless of the number of elements that match the
selector. It will have access to all elements that match the selector via the results
object (see "results" on page1448). The each() function could be used to iterate over
elements in the results.
l Each matched element: The script runs once for each element that matches the selector.
The current element is accessible via the this object (see "this" on page1364). If the
script targets (something in) a row that is bound to a detail table, the current detail record
is accessible via this.record.
Note
The scope of Control Scripts can't be set, because they don't have a selector.
Page 883