2020.2
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Connect 2020.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
- The Designer
- Designer basics
- Web
- Capture OnTheGo
- COTG Forms
- Creating a COTG Form
- Filling a COTG template
- Sending the template to the Workflow tool
- 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: cotg-2.0.0.js
- 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
- 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 ConnectRelease Notes 2020.2.1
- License Update Required for Upgrade to Connect 2020.x
- Backup before Upgrading
- Overview
- OL Connect 2020.2.1 Enhancements
- OL Connect 2020.2 Enhancements
- Connect 2020.2 Designer Improvements
- Connect 2020.2 DataMapper Improvements
- Connect 2020.2 Output Improvements
- Workflow 2020.2 Improvements
- OL Connect Send Improvements
- Known Issues
- Previous Releases
- OL PlanetPress Connect Release Notes 2020.1
- License Update Required for Upgrade to Connect 2019.x
- Backup before Upgrading
- Overview
- OL Connect 2019.2 Enhancements
- Connect 2019.2 Designer Improvements
- Connect 2019.2 DataMapping Improvements
- Connect 2019.2 Output Improvements
- Workflow 2019.2 Improvements
- Known Issues
- License Update Required for Upgrade to Connect 2019.1
- Overview
- OL Connect 2019.1 Enhancements
- Connect 2019.1 Designer Updates
- Connect 2019.1 DataMapping Updates
- Connect 2019.1 Output updates
- Print Wizard and Preset Wizard Improvements
- Workflow 2019.1 Updates
- Known Issues
- Overview
- Connect 2018.2.1 Enhancements/Fixes
- Connect 2018.2 Enhancements
- Connect 2018.2 Designer Updates
- Connect 2018.2 DataMapping Updates
- Connect 2018.2 Server Enhancements
- Connect 2018.2 Output updates
- Print Wizard and Preset Wizard Improvements
- Workflow 2018.2 Updates
- Known Issues
- Overview
- Connect 2018.1.6 Enhancements/Fixes
- Connect 2018.1.5 Enhancements/Fixes
- Connect 2018.1.4 Enhancements/Fixes
- Connect 2018.1.3 Enhancements/Fixes
- Connect 2018.1.2 Enhancements/Fixes
- Connect 2018.1.1 Enhancements/Fixes
- Connect 2018.1 General Enhancements
- Connect 2018.1 Designer Enhancements/Fixes
- Connect 2018.1 DataMapping Enhancements/Fixes
- Connect 2018.1 Output Enhancements/Fixes
- Workflow 2018.1 Enhancements/Fixes
- Known Issues
- Overview
- Connect 1.8 General Enhancements and Fixes
- Connect 1.8 Performance Related Enhancements and Fixes
- Connect 1.8 Designer Enhancements and Fixes
- Connect 1.8 DataMapping Enhancements and Fixes
- Connect 1.8 Output Enhancements and Fixes
- Capture OnTheGo (COTG) Enhancements and Fixes
- Workflow 8.8 Enhancements and Fixes
- Known Issues
- Overview
- Connect 1.7.1 General Enhancements and Fixes
- Connect 1.7.1 Designer Enhancements and Fixes
- Connect 1.7.1 DataMapping Enhancements and Fixes
- Connect 1.7.1 Output Enhancements and Fixes
- Workflow 8.7 Enhancements and Fixes
- Known Issues
- Overview
- OL Connect Send
- Connect 1.6.1 General Enhancements and Fixes
- Connect 1.6.1 Designer Enhancements and Fixes
- Connect 1.6.1 DataMapping Enhancements and Fixes
- Connect 1.6.1 Output Enhancements and Fixes
- Connect Workflow 8.6 Enhancements and Fixes
- Known Issues
- Overview
- Connect 1.5 Designer Enhancements and Fixes
- Connect 1.5 DataMapping Enhancements and Fixes
- Connect 1.5 Output Enhancements and Fixes
- Connect 1.5 General Enhancements and Fixes
- Connect 8.5 Workflow Enhancements and Fixes
- Known Issues
- Overview
- 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 ConnectRelease Notes 2020.2.1
- Knowledge Base
- Legal Notices and Acknowledgements
Standard Script API
This page lists the global objects and functions that are available in Standard Scripts, created
inside the Scripts pane. Click through to an object or function to get a description and
examples.
Most of these objects and functions are also available in Control Scripts ("Control Scripts" on
page890) and Post Pagination Scripts ("Post Pagination Scripts" on page906).
For objects and functions restricted to Control Scripts see "Control Script API" on page1379,
and for the Post Pagination Script API see "Post Pagination Script API" on page1415.
The basics of script-writing in the Designer are explained in the following topic: "Writing your
own scripts" on page853.
Objects
Object Description
"results" on
page1420
This object - of the type: QueryResults - is used to manipulate the content
of the template. It contains the HTML element or set of HTML elements that
match the selector of the script, specified in the script editor.
This object is not available in Control Scripts, because that type of script
doesn't have a selector (see "Control Scripts" on page890).
"this" on
page1338
A Standard script or Post Pagination script that has its scope set to "Each
matched element" (see "Setting the scope of a script" on page860) will be
called in a loop over the elements that match the selector of the script - the
results (see "results" on page1420). In such a script, this is an object of
the type QueryResult. It represents the current element in the loop.
This object is not available in Control Scripts, because that type of script
doesn't have a selector (see "Control Scripts" on page890).
"record" on
page1295
The record in the main data set that is currently being merged. To get the
value of a field in the record, use record.fields['fieldname'] or
record.fields.fieldname.
"logger" on
page1289
Global object that allows you to log messages.
Page 1267