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
Control Script: Setting a Print section's background
In the Print context, an image file can be used as a Print section's background; see "Using a
PDF file or other image as background" on page492.
If you want the section background to be switched automatically, depending on the value of a
data field, you need a Control Script. There is a Script Wizard that can generate that script for
you, provided that certain conditions are met; see: "Dynamic Print section backgrounds" on
page844.
Otherwise, you will have to write the Control Script yourself. This topic explains how to write a
Control Script that sets a Print section's background.
Note that the settings made in a Control Script take precedence over the settings made in the
Print Section Properties dialog.
Note
Encrypted PDF files are not supported in PDF pass-through mode.
For information about Control Scripts in general, see "Control Scripts" on page913 and
"Control Script API" on page1405. If you don't know how to write scripts, see "Writing your own
scripts" on page877.
Setting a background in script
The Control Script should first enable a background on the section, in case an initial
background wasn't set via the user interface. This is done by setting the source type for the
background of the section to either DataMapper PDF orResource PDF (see
"BackgroundResource" on page1438). For example:
merge.template.contexts.PRINT.sections['Policy'].background.source
= BackgroundResource.RESOURCE_PDF;
For a DataMapper PDF, nothing else has to be done to set the background.For a Resource
PDF, the Control Script should specify a path, for example:
var resourceUrl = 'images/policy-' + record.fields.policy + '.pdf';
merge.template.contexts.PRINT.sections['Policy'].background.url =
resourceUrl;
Page 922