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
Loading content using a server's API
Content in a template is usually static (apart from being personalized) and part of the main text
flow. It can also be located in a snippet (see "Snippets" on page741).
It is also possible to include content that is served by another server. Many servers provide an
API to fetch publicly available content from their site. That content may even be dynamic: the
most recent blog posts on a Wordpress website, for example, or the current weather forecast
for a certain city.
This topic explains how to retrieve content using a server's API and insert that content in a
template.
Step 1: Getting the appropriate link
To request content from another server, you will need a link.
Some websites give the option to embed their content in your website by providing a link or the
complete HTML. Youtube.com, for example, offers not only a link to share a certain video, but
also the full HTML to embed that video in your website.
If that option is not available, you will have to build the link yourself. Find the server's API and
look through it to get the exact endpoint and parameters that you need.
With many servers it is required to use an API key in the link; this key generally comes for free
after you sign up to their website. The key will be part of the link that is used to make a request
to the server.
Note
Pay attention to the service's Terms of Service. Many servers have limitations on the
number of calls that can be made to them for free. Beyond these limits, their content will
not show up in your template unless you purchase a business plan.
Step 2: Preparing the template
The next step is to set up a template. If you've got the HTML to embed content in your template
you can paste that HTML on the Source tab (and skip Step 3).
Otherwise your template has to contain an element that can be replaced or followed by the
remote content: an empty paragraph, for example, or a heading. If the element isn't unique in
the template, give the element an ID.
Page 907