-
User Guide Version: 1.7.
-
-
User Guide Version 1.7.1 Last Revision: 2017-11-28 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2017. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc.
-
Table of Contents Table of Contents 4 Welcome to PlanetPress Connect 1.7.
-
Impacts upon other Applications and Services Uninstallation Wizard The DataMapper Module 76 77 78 Basics What's next? Data mapping configurations Creating a new data mapping configuration Opening a data mapping configuration Saving a data mapping configuration Using the wizard for CSV files Using the wizard for databases Using the wizard for PDF/VT and AFP files Using the wizard for XML files Data mapping workflow Creating a data mapping workflow Testing the extraction workflow Data source settings Extrac
-
CSV and Database Files XML File Text and PDF Files CSV and Database Files XML Files Left operand, Right operand Condition Operators Text file PDF File CSV File XML File JavaScript Toolbar Welcome Screen DataMapper Scripts API Using scripts in the DataMapper Setting boundaries using JavaScript Objects Example Example Examples Example Example Example Examples Examples Example Example Example Text XML Functions The Designer Basic Steps Features Templates 204 205 209 211 213 217 219 219 220 221 223 223 225 225
-
Contexts Sections Print Creating a Print template with a Wizard Print context Print sections Pages Master Pages Media Email Designing an Email template Creating an Email template with a Wizard Email context Email templates Email header settings Email attachments Web Creating a Web template with a Wizard Web Context Web pages Forms Using Form Elements Using JavaScript Capture OnTheGo COTG Forms Creating a COTG Form Filling a COTG template Testing the template Sending the template to the Workflow tool Using C
-
Element types Editing HTML Attributes Inserting an element Selecting an element Deleting an element Styling and formatting an element Barcode Boxes Business graphics COTG Elements Date Forms Form Elements Hyperlink and mailto link Images Table Text and special characters Snippets Adding a snippet to the Resources Adding a snippet to a section Creating a snippet JSON Snippets Styling and formatting Local formatting versus style sheets Layout properties Styling templates with CSS files Styling text and paragr
-
Personalizing Content Variable data Conditional content Dynamic images Dynamic tables Snippets Scripts Loading data Variable Data Formatting variable data Showing content conditionally Dynamic Images Dynamic table Personalized URL Writing your own scripts Script types Creating a new script Writing a script Managing scripts Testing scripts Optimizing scripts Loading a snippet via a script Control Scripts The script flow: when scripts run Designer User Interface Dialogs Keyboard shortcuts Menus Panes Toolbars
-
Examples Examples Examples Examples Examples Examples Examples Examples Examples Examples Examples Examples Example Example Example Example Example Examples Creating a table of contents Example Examples Examples Examples Examples Replace elements with a snippet Replace elements with a set of snippets Example Example Control Script API Generating output Print output Email output Web output Optimizing a template Scripts Images Generating Print output 815 816 818 821 821 822 824 824 826 827 827 828 829 829 83
-
Saving Printing options in Printing Presets. Connect Printing options that cannot be changed from within the Printer Wizard.
-
Connect Workflow 8.6 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.
-
Welcome to PlanetPress Connect 1.7.1 Note Since we are always looking for new ways to make your life easier, we welcome your questions and comments about our products and documentation. Use the feedback tool at the bottom of the page or shoot us an email at doc@ca.objectiflune.com. PlanetPress Connect is a series of four tools designed to optimize and automate customer communications management. They work together to improve the creation, distribution, interaction and maintenance of your communications.
-
Note Complementary information that is not critical, but may help you better use PlanetPress Connect. Tip Information that is useful or suggests an easier method. Warning Information that is potentially critical to using PlanetPress Connect. Pay close attention.
-
Setup And Configuration This chapter describes the PlanetPress Connect installation and the different considerations that are important in regards to the installation and use of PlanetPress Connect. l "System and Hardware Considerations" below l "Installation and Activation" on page 28 l "Server Configuration Settings" on page 70 l Uninstalling System and Hardware Considerations There are a variety of considerations to be aware of.
-
l Microsoft Windows 8.1 l Microsoft Windows 10 (Pro and Enterprise versions only) Note Windows 8.0, Windows XP, Windows 2003 and older versions of Windows are not supported by PlanetPress Connect. Minimum Hardware Requirements l NTFS Filesystem (FAT32 is not supported) l CPU Intel Core i7-4770 Haswell (4 Core) l 8GB RAM (16GB Recommended) l Disk Space: At least 10GB (20GB recommended) Note For tips and tricks on performance, see "Performance Considerations" on page 24.
-
Note While some virtual machine environments (from VMWare and Microsoft) are supported, other virtual environments (such as Parallels, Xen and others) are not supported at this time. Terminal Server/Service PlanetPress Connect does not support Terminal Server (or Terminal Service) environment as possible under Windows 2000, 2003 and 2008.
-
l Click on Start, Run. l Type in services.msc and click OK. l Locate the Windows Search service and double-click on it. l Change the Startup Type to Disable, and click Stop to stop the service. l Try the installation again. l Once completely, you may re-enable the service and start it. Commandline switches and .ini entries PlanetPress Connect is intended to work stably and reliably, based on Java and the Eclipse framework.
-
available. l l max_allowed_packet = 500M : In some implementations, especially when using Capture OnTheGo, large packet sizes are required to allow transferring binary files. This substantial packet size maximum setting ensures that the data received by PlanetPress Connect will be able to be stored within the database. character-set-server = utf8 , collation-server = utf8_unicode_ci , default-characterset=utf8 : These indicate database support for UTF-8/Unicode.
-
Installing Connect using an existing Microsoft SQL Server instance If Microsoft SQL Server is already present and you wish to use it, the following should be taken into consideration: Warning If you chose not to install the supplied MySQL database, and instead opt for using a preexisting (External) database then you yourself must ensure that the External database is accessible to Connect. Objectif Lune Inc. will take no responsibility for database connections to any but the supplied MySQL database.
-
l On Update from 1.4.2 or earlier, the DB Configuration Page will always default to MySQL connection settings, and if the installation was manually tweaked to connect to MS SQL Server, the user has to switch to "Microsoft SQL Server" type and enter connection details again. When modifying Connect l l If local MySQL is removed from an installation, the DB Configuration page will offer additionally the Microsoft SQL Server db type with respective default values.
-
7. After the dependency has been removed, it is possible to stop the supplied MySQL service (OLConnect_MySQL). Warning If a Connect 1.5 user wants to use Microsoft SQL instead of MySQL for the Connect Server, there are several points to be taken care of: l l IF there should possibly be available some foreign MySQL instance, which could be used intermediately, then this should be selected during the setup. This ensures, that no stuff gets installed.
-
external MySQL was configured as database), then the Update to 1.6 will allow to select either external MySQL or external Microsoft SQL on the DB Configuration Page. Network considerations The following should be taken into consideration in regards to network settings and communications l If a local proxy is configured (in the Internet Explorer Optionsdialog, the option Bypass proxy server for local addresses must be checked, or some features depending on local communication will not work.
-
l Issues can sometimes be encountered in menus and templates when running PlanetPress Connect on a non-English operating system. These are due to encoding issues and will be addressed in a later release. Performance Considerations This page is a comprehensive guide to getting the most performance out of PlanetPress Connect as well as a rough guideline to indicate when it's best to upgrade.
-
For each engine, it's necessary to modify the .ini file that controls its JAVA arguments. Edit as follows: l l l l For the Merge Engine: see C:\Program Files\Objectif Lune\OL Connect\MergeEngine\Mergeengine.ini For the Weaver Engine: see C:\Program Files\Objectif Lune\OL Connect\weaverengine\Weaverengine.ini The parameters are -Xms640m for the minimum RAM size, -Xmx640m for the maximum RAM size. Explaining Java arguments is beyond the scope of this document.
-
High-Performance Hardware The following is suggested when processing speed is important. Before looking into a Performance Packs to enhance performance, ensure that the below requirements are met. l l l l A physical, non-virtualized server. VMWare servers are great for reducing the numbers of physical machines in your IT space, but they must share the hardware between each other.
-
Directories and folders Main installation folder All Connect applications are installed under an arbitrarily selectable main folder. We will speak of the "Installation Target" in the following. This installation target will hold the executables and required files and folders for the operation of the whole product suite. All these files and folders are static after their installation. It depends on the company virus protection strategy, if such files and folders will be monitored or not.
-
Database 2 Another database instance for Connect will be hold and used under the folder, which is intended to hold data, accessible by and for all users. The path to this folder is stored in the standardized system variable %PROGRAMDATA%. The Connect database instance is located in the subfolder "Connect\MySQL". As this database will be in extremely strong usage, virus protection on this folder and its subfolders may have a serious impact on the performance of Connect.
-
l Installation Prerequisites l User accounts and security l The importance of User Credentials when installing and running Connect l Migrating to a new computer Installation - "How to" guides For information on how to conduct the installation itself, chose from the following topics: l Installation l Silent Installation l Installation on machines without Internet access Activation For information on licensing, please see Activating your license.
-
Update Client. If you do not have such a version installed already, the next time you run your Update Client it will show that there is an update available of itself to Version 1.1.8 (or later). Simply click on the download button in the dialog to install the new version of the Update Client. Note that it is no problem to run the update while the Client is open. It will automatically update itself. Once you have done this, PlanetPress Connect 1.7.1 will become available for download.
-
Permissions for PlanetPress Connect Server The PlanetPress Connect Server module, used by the Automation module, requires some special permissions to run. These permissions are set during installation, in the Engine Configuration portion of the Installation Wizard, but it can also be configured later by modifying permissions for the service. To do this: l l l l In Windows, open the Control Panel, Administrative Tools, then Services (this may depend on your operating system).
-
l l Must be able to INSTALL, START and RUN services and also to MODIFY service settings. Must be known in the network the machine belongs to and must also need to be able to use shared network resources like shared drives and/or printers etc. This list may not be complete, but it gives the extent of the requirements. Generally, the local administrator of the machine will have all these credentials, but there may exist network restrictions and policies, which will block one or more of these capabilities.
-
MySQL MySQL database service is installed by the install user (thus again the requirement of installing, starting, running and modifying services). Once running it will just work. Merge and Weaver Engines These components do run under the Designer (if only Designer is installed) or the Server / Extension service(s) and inherit the rights of their parent application. Server (Extension) Configuration Tool This component needs to access the settings of the Server.
-
2. Install the certificates: Right mouse click -> Install Certificate, and follow the steps through the subsequent wizard. 3. Now copy the PlanetPress Connect installer to the offline machine and start the installation as normal Windows certificate validation - Certificate Revocation List retrieval should be switched off For your security Objectif Lune digitally signs all relevant files with our own name and certificate.
-
l l If an ISO image, either burn the ISO onto a DVD or unzip the contents to a folder (keeping the folder structure) If on a DVD, either insert the DVD and initiate the installation from there or copy the contents to a folder (keeping the folder structure) Navigate to the PlanetPress_Connect_Setup_x64.exe or and double-click on it. After a short while the Setup Wizard will appear as a guide through the installation steps. Note PlanetPress Connect requires prior installation of Microsoft .
-
l MySQL Product: Install the supplied MySQL database used by PlanetPress Connect. The database is used for referencing shared and temporary Connect files, as well as for sorting temporarily extracted data, and the like. A pre-existing MySQL or Microsoft SQL server (referred to as an External database, in this documentation) could be used for the same purpose, however. The external database could reside on either the same computer or on a separate server.
-
End User License Agreement The next page displays the End User License Agreement, which needs to be read and accepted before clicking Next. Configuring Supplied Database Connection The Default Database Configuration page appears if the supplied MySQL Product module was selected for installation in the Product Selection screen. It defines the administrative password for the MySQL server as well as which port it uses for communication.
-
displayed at the top of the dialog. Note The MySQL Product controlled by the OLConnect_MySQL service communicates through port 3306 by default. l Allow MySQL Server to accept non-local TCP connections: Click to enable external access to the MySQL server. Note This option is required if MySQL Server will need to be accessed from any other machine. It is also required if the MySQL database is on a separate machine to PlanetPress Connect.
-
non-local TCP connections, and the username must also be configured to accept remote connection. For example, the "root" MySQL user entered as root@localhost is not allowed to connect from any other machine than the one where MySQL is installed. l l l l l Administrator Password: Enter the password for the above user. The appropriate MySQL password must be entered or the Connect installation will fail. TCP/IP Port Number: Enter the port on which the database server expects connections.
-
l l l Username: The account that the service uses to login. If the machine is on a domain, use the format domain\username. This account must be an existing Windows profile with local administrator rights. Password: The password associated with the selected user. Validate user button: Click to verify that the entered username and password combination is correct and that the service is able to login. This button must be clicked and the user validated before the Next button becomes available.
-
l l Note that the Product Update Manager can also be called from the “Objectif Lune Update Client” option in the Start menu. It can be uninstalled via Control Panel | Programs | Programs and Features. Product Activation After installation, it is necessary to activate the software. See Activating your license for more information. Note Before activating the software, please wait 5 minutes for the database to initialize.
-
Note install.properties file notation must follow commons configuration rules. Please refer to Properties files for more details. Required and optional properties Required properties depend on the specified product. Only fields related to that specified product must be entered. If no product is mentioned, properties must be specified for all valid Connect products. Here is an example of an install.properties file. # Verbose logging logging.verbose = true # Product selection install.product.
-
Product selection (optional) By default, if nothing is entered for the products to be installed (install.product.X), Silent Installer will install all products which are visible to the user for the respective brand (except for the Server Extension, because only Server or Server Extension can be installed at the same time). PlanetPress defaults install.product.0 = Connect Designer install.product.1 = Connect Server install.product.2 = MySQL Product Note The values of install.
-
Database configuration Case 1: MySQL is among the selected Connect products to be installed (new MySQL installation) If MySQL is selected and there is no previous MySQL configuration on the machine, the following properties should be defined: database.password = (required and must meet the rules) database.port = (3306 is the default port value) database.
-
2a: Configuring an external MySQL database To configure an external MySQL database, the following properties should be defined: database.type = mysql (required) database.host = (default value is localhost, otherwise required) database.port = (default value is 3306, otherwise required) database.username = (default value is root, otherwise required) database.password = (required) database.
-
In Silent Installer mode, the installation process looks for the property product.repository in the install.properties file and then proceeds with the following steps: 1. If the property exists, and its value contains an existing file location with a repository, the installer will attempt to install from that repository. 2. If the property exists, and its value starts with http://, the installer will attempt to install from that location. It will fail if no repository can be found at this location. 3.
-
l ja-JP (Japanese, Japan) l zh-CN (Chinese, China) l zh-HK (Chinese, Hongkong) l zh-MO (Chinese, Macau) l zh-TW (Chinese, Taiwan) l it-IT (Italian, Italy) l pt-BR (Portuguese, Brazil) l es-419 (Spanish, Latin America) Locale selection by defining user.language and user.country If both user.language and user.country are defined in the install.properties file, the combination must match exactly one of the supported locales, otherwise the Installer will exit with an error. For example, user.
-
3. As last resort, the first Locale in the preinstall.ini is selected (usually that should be enUS). Getting the exit code of a silent installation If getting the exit code of a silent installation is desirable, use the following procedure. 1. Create a new local folder on the machine (or VM) on which Connect shall be installed and copy/extract the contents of the Connect ISO into this folder. 2. Open a command prompt with Administrator privileges and cd into this local folder. 3.
-
Sample batch file @echo off preinstall.exe if errorlevel 10 goto err_installer if errorlevel 2 goto err_unknown if errorlevel 1 goto err_preinstall echo Success goto:eof :err_installer echo "Installer error - see OL_Install_.log" goto:eof :err_unknown echo "Unknown preinstall error - see preinstall_err.log" goto:eof :err_preinstall echo "Preinstall error - see preinstall_err.
-
l Open the Start Menu l Click on All Programs, then Objectif Lune, then PlanetPress Connect l Open the PlanetPress Connect Designer [version] shortcut. l When the application opens, if it has never been activated or the activation has expired, the Software Activation dialog appears: l License Information subsection: l l l l l l l l l l Name: Displays the name of the application or module relevant to this activation.
-
Note The Software Activation dialog can also be reached through a shortcut located in All Programs, then Objectif Lune, then PlanetPress Connect and is named Software Activation. Since it does not load the software, it is faster to access for the initial activation.
-
Activating PlanetPress Connect To activate PlanetPress Connect, simply save the license file somewhere on your computer where you can easily find it, such as on your desktop. You can then load the license by doubleclicking on it, or through the start menu: l Open the Start Menu l Click on All Programs, then Objectif Lune, then PlanetPress Connect l Open the PlanetPress Connect Designer [version] shortcut.
-
l Environment Considerations l Installation Pre-Requisites l Antivirus Exclusions Downloading and Installing the Software In order to migrate to a new workstation, the software must already be installed on the new workstation. Follow the Installation and Activation Guide to download and install the newest version of PlanetPress Connect on the new workstation.
-
l l l l l l l l l l The Workflow configuration file itself is named ppwatch.cfg, and is backed up with the folders. However, it needs to be re-sent to the Service to be used. To do this, rename the file to .OL-Workflow, open the file with the Workflow tool, and send the configuration. Locate Custom Plugins (.dll) from the below folder on the old workstation and import them onto the new workstation C:\Program Files (x86)\Common Files\Objectif Lune\PlanetPress Workflow 8\Plugins To import the plugin
-
l l Click on Tools in the Workflow Configuration menu bar l Click on Access Manager l Grant necessary permissions to remote machines l Restart the Workflow Messenger service Reconfigure the Workflow Preferences as previously by clicking on the Workflow button on top left corner and clicking on Preferences: l l l l Reconfigure the Server Connection Settings under Behavior > OL Connect For PlanetPress Capture users, reconfigure the PlanetPress Capture options under Behavior > PlanetPress Capture
-
l l l l OL Connect Designer Templates , Data Mapper or Package files, copied from the folder where they reside. All Postscript, TrueType, Open Type and other host based fonts used in templates must be reinstalled on the new workstation. Import all dynamic images and make sure their paths match those in the old server. Make sure the new workstation can also access network or remote images, JavaScript, CSS, JSON, and HTML resources referenced in the Connect templates.
-
PlanetPress Capture options under Behavior >PlanetPress Capture > Use ODBC Database l Start the Messenger 8 service on new server from the Workflow menu bar > Tools > Service Console > Messenger > right-click and select Start. OL Connect Send • Re-install OL Connect Send on the new Workstation.
-
l l C:\Program Files\Objectif Lune\OL Connect\weaverengine\weaverengine.ini Now start the OLConnect_Server service Configuring the Server Extensions In the case where the OLConnect MySQL is installed on the new Master Server, it is important to reconnect all Server Extension systems to the new Master Server.
-
To apply the license file received from the Activation Team: l Start the PReS Connect, PlanetPress Connect or PrintShopMail Connect Software Activation module: C:\Program Files\Objectif Lune\OL Connect\Connect Software Activation\ SoftwareActivation.exe l Click on Load License File to import the license.OLConnectLicense l Start the Software Activation module on the Extension servers, where applicable l Click on Load License File to import the above same license.
-
PlanetPress Workflow 8 can be installed in parallel on the same machine as an existing PlanetPress® Suite 7.x installation. Note however: l l l l l If both versions need to be hosted on the same machine, PlanetPress Workflow 8 must always be installed after the legacy PlanetPress® Suite 7.x installation. When uninstalling PlanetPress Workflow 8, you may be prompted to repair your legacy PlanetPress® Suite 7.x installation.
-
This document provides information on the migration process and the requirements and considerations for existing PlanetPress Suite users to upgrade to the latest generation of our products. Note PlanetPress Connect Print-Only is available for existing users of PlanetPress version 7 or 6 with a valid OL Care agreement. If you are using a previous version or are not covered by OL Care, please contact your reseller or your Objectif Lune Account Manager for more information.
-
GOOD NEWS: PlanetPress Connect does not need any printer licenses to print from PlanetPress Connect or PlanetPress Suite. It can also print PrintShop Mail 7 and PReS 6 documents if these programs are licensed. You can keep everything you have The first thing to know is that you can keep your current PlanetPress Workflow 7 configuration and your PlanetPress Design documents. When upgrading to PlanetPress Connect, they will remain functional.
-
What do I gain by upgrading to PlanetPress Connect? PlanetPress Watch users When upgrading to PlanetPress Connect, you receive key features of PlanetPress Office such as the following: l l l l Ability to input data from PDF Ability to print your PlanetPress Suite documents on any Windows printer (no need for printer licenses) Ability to create standard PDF output from your PlanetPress Suite documents Even if you don’t recreate your existing PlanetPress Suite documents, you can easily change your workflow
-
Create new documents and integrate them into your workflow at your own pace You can start benefiting from the innovative technology of the new PlanetPress Connect Designer right away by designing new documents, or re-doing existing ones at your own pace.
-
l Custom scripts l Content of your virtual drive l PlanetPress Messenger configuration If you installed PlanetPress Workflow 8 on a different computer, contact support for help importing all those settings, if you wish to import them. 4. To launch the Upgrade wizard, open the PlanetPress Workflow 8 configuration tool and, from the Tools menu, launch the Upgrade Wizard. IMPORTANT: Before you start this process, make sure you have a backup of your current installation/computer.
-
5.
-
6. Then select the product from which you wish to upgrade: 7.
-
8.
-
9. After that you will need to get the activation file for your product. To obtain your activation, download the PlanetPress Connect installer from the Web Activation Manager, follow the instructions for the installation using the serial number provided to you. You can activate your license through the Web Activation Manager. 10.
-
Server Configuration Settings This chapter describes configuring the PlanetPress Connect Server. The Connect Sever settings are maintained by the "Connect Server Configuration" utility tool which is installed alongside PlanetPress Connect. "Connect Server Configuration" can be launched from the Start Menu, as seen in the following screen-shot: The "Connect Server Configuration" dialog is separated into individual pages, where each page controls certain aspects of the software.
-
Scheduling Preferences The scheduling preferences are a way to control precisely how the PlanetPress Connect services work in the background.
-
Merge Engine Scheduling This preferences page defines how different instances and speed units are attributed to different jobs when creating Content Items (Print Content, as well as Web and Email output generation). For information on the terminology and some performance tips, see Performance Considerations. Note that in this dialog, the use of the word "Engine" is synonymous to both "Instance" and "Speed Unit" since a single Speed Unit can be used for each Engine.
-
l l l l l l l Floating: Read-only box indicating the number of floating speed units that can be used for any type of job. This number is equal to the Total Engines Available Reservations. For example if 6 engines are launched and 4 are reserved for small jobs, 2 will be Floating. Small job speed unit reservations: Enter a number of speed units reserved for small print jobs. Medium job speed unit reservations: Enter a number of speed units reserved for medium print jobs.
-
the use of the term "Speed Unit" is in relation of the available speed for each engine. One speed unit = one unit of speed at the maximum speed your licence and number of Performance Packs allows. With no Performance Pack, PlanetPress Connect's Weaver engine can generate output at 500ppm (pages per minute). Additional Performance Packs increases this base speed per engine. l l l l l l l l Use one internal engine: Check to limit to a single instance of the server.
-
l Maximum speed units: l l l Small job limit: Enter the maximum number of speed units that can run small print jobs. Medium job limit: Enter the maximum number of speed units that can run medium print jobs. Large job limit: Enter the maximum number of speed units that can run large print jobs.
-
l Default session length (min): Enter a session time (in minutes) that the authentication stays valid for the requested process. This can reduce the number of requests to the server since an authentication request is not necessary during the session. Uninstalling This topic provides some important information about uninstalling (removing) PlanetPress Connect1.7.1. To uninstall PlanetPress Connect select the application from within the Add/Remove programs option under the Control Panel.
-
Uninstallation Wizard The uninstallation is done by running the PlanetPress Connect Setup Wizard in uninstall mode. The Wizard consists of the following pages: 1. PlanetPress Connect Setup: An information page, listing what will be uninstalled, and also warning about impacts upon running Applications and Services. 2. Data Management: A page that provides options for backing up or deleting Connect data.
-
The DataMapper Module The DataMapper is the tool to create a data mapping configuration. A data mapping configuration file contains the information necessary for data mapping: the settings to read the source file (Delimiter and Boundary settings), the data mapping workflow with its extraction instructions ('Steps'), the Data Model and any imported data samples.
-
2. Configure settings for the data source. The data source can be a file (CSV, PDF, TXT, XML) or a particular database. Configure how the data source is read by the DataMapper and create a record structure. See "Data source settings" on page 92. 3. Build the data mapping workflow. A data mapping workflow always starts with the Preprocessor step and ends with the Postprocessor step. You can add as many steps as you like and edit the Data Model of the extracted data as required.
-
preview a template with data instead of field names. It is also possible to generate output of a data mapping configuration directly from the Designer (see "Generating output" on page 858). Creating a new data mapping configuration A new data mapping configuration can be made with or without a wizard. When you open a data file with a DataMapper wizard, the wizard automatically detects a number of settings. You can adjust these settings.
-
3. Click Next. 4. Click the Browse button and open the file you want to work with. 5. Click Finish. Note PCL and PostScript (PS) files are automatically converted to PDF format. When used in a production environment (a Connect Workflow process) this may influence the processing speed, depending on the available processing power. After opening the file, you have to make settings for the input data (see "Data source settings" on page 92). Then you can start building the data extraction workflow.
-
The steps to take with the wizard depend on the file type. See: l "Using the wizard for CSV files" on page 84 l "Using the wizard for databases" on page 85 l "Using the wizard for PDF/VT and AFP files" on page 88 l "Using the wizard for XML files" on page 89 Generating a counter Instead of creating a data mapping configuration for a certain type of data file, you may create a data mapping configuration that only contains a series of sequential numbers.
-
l l l l l l Increment Value: The value by which to increment the counter for each record. For example, an increment value of 3 and starting value of 1 would give the counter values of 1, 4, 7, 10, [...] Number of records: The total number of counter records to generate. This is not the end value but rather the total number of actual records to generate. Padding character: Which character to add if the counter's value is smaller than the width. Width: The number of digits the counter will have.
-
Using the wizard for CSV files The DataMapper wizard for CSV files helps you create a data mapping configuration for a CSV file. The wizard automatically detects delimiters and extracts all data in one extraction step. The wizard interprets each line in the file as a record. If your data file contains transactional data, you will probably want more lines to go in one record and put the transactional data in detail tables. The wizard cannot create detail tables.
-
The wizard will then display the different settings it has detected, allowing you to change them: l Encoding: Defines which encoding is used to read the file. l Separator: Defines which character separates each field in the file. l Comment Delimiter: Defines which character starts a comment line. l l l Text Delimiter: Defines which character surrounds text fields in the file. Separators and comment delimiters within text are not interpreted as separator or delimiter; they are seen as text.
-
4. Use the drop-down to select the database type. 5. Click Next. l From the File menu 1. In the menu, click File > New. 2. Click the Data mapping Wizards drop-down and select From databases. 3. Click Next. 4. Use the drop-down to select the database type. 5. Click Next. Wizard settings for a database file After opening a database file with a wizard there are a number of settings to make, depending on the database type (see below).
-
Microsoft Access l l l Password: Enter a password if one is required. Table name: The selected database is a set of related tables composed of rows and columns corresponding respectively to source records and fields. Select a table from which you want to extract data. Encoding: Choose the correct encoding to read the file. ODBC Data Source l l ODBC Source: Use the drop-down to select an ODBC System Data Source.
-
l l l l l l Server: Enter the server address for the database server. Database name: Enter the exact name of the database from where the data should be extracted. User name: Enter a user name that has access to the server and specified database. The user only requires Read access to the database. Password: Enter the password that matches the user name above. Advanced mode: Check to enable the Connection String field to manually enter the database connection string.
-
3. From the Using a wizard pane, select PDF/VT. 4. Click the Browse button and open the PDF/VT file you want to work with. Click Next. l From the File menu 1. In the menu, click File > New. 2. Click the Data mapping Wizards drop-down and select From PDF/VT or AFP. 3. Click Next. 4. Click the Browse button and open the PDF/VT file you want to work with. Click Next.
-
l From the Welcome screen 1. Open the PlanetPress ConnectWelcome page by clicking the or select the Help menu and then Welcome. icon at the top right 2. Click Create a New Configuration. 3. From the Using a wizard pane, select XML. 4. Click the Browse button and open the XML file you want to work with. Click Next. l From the File menu 1. In the menu, click File > New. 2. Click the Data mapping Wizards drop-down and select From XML File. 3. Click Next. 4.
-
determined in the Data Model (see "The Data Model" on page 125). Together with the data source settings, the Data Model, and the sample data, this is what makes a data mapping configuration (See "Data mapping configurations" on page 79). The data mapping workflow is shown on the Steps pane at the left (see "Steps pane" on page 187). Creating a data mapping workflow A data mapping workflow always starts with the Preprocessor step and ends with the Postprocessor step.
-
Rearranging steps To rearrange steps, simply drag & drop them somewhere else on the dotted line in the Steps pane. Alternatively you can right-click on a step and select Cut Step or use the Cut button in the Toolbar. If the step is Repeat or Condition, all steps under it will also be placed in the clipboard. To place the step at its destination, right-click the step in the position before the desired location and click Paste Step, or use the Paste button in the toolbar.
-
l l l Input Data settings help the DataMapper read the data source and recognize data correctly. Boundaries mark the start of a new record. They let you organize the data, depending on how you want to use them. Data format settings define how dates, times and numbers are formatted in the data source. Input data settings (Delimiters) The Input Data settings (on the Settings pane at the left) specify how the input data must be interpreted. These settings are different for each data type.
-
supports. For an explanation of all the options, see: "Database Input Data settings" on page 178. For a text file Because text files have many different shapes and sizes, there are a lot of input data settings for these files. You can add or remove characters in lines if it has a header you want to get rid of, or strange characters at the beginning of your file, for example; you can set a line width if you are still working with old line printer data; etc. It is important that pages are defined properly.
-
page in a PDF file. It can also be something in the data that is either static (for example, the text "Page 1 of" in a PDF file) or changing (a customer ID, a user name, etc). To define a more complex trigger you could write a script (see "Setting boundaries using JavaScript" on page 233). A new record cannot start in the middle of a data field, so if the trigger is something in the data, the boundary will be set on the nearest preceding natural delimiter.
-
source. They don't determine how these data are formatted in the Data Model or in a template. In the Data Model, data are converted to the native data type. Dates, for example, are converted to a DateTime object in the Data Model, and will always be shown as "year-month-day" plus the time stamp, for example: 2012-04-11 12.00 AM.
-
Note For optimization purposes, it is better to add data to an existing Extract step than to have a succession of extraction steps. To do that, select that step on the Steps pane first; then right-click on the selected data and choose Add Extract Field. l Alternatively, drag & drop the selected fields into the Data Model pane. Tip In a PDF or Text file, use the Drag icon Data Model.
-
Note Fields cannot be used twice in one extraction workflow. Different Extract steps can only write extracted data to the same field in the Data Model, if: l l l The field name is the same. (See: "Renaming and ordering fields" on page 131.) The Extract steps are mutually exclusive. This is the case when they are located in different branches of a Condition step or Multiple Conditions step. The option Append values to current record is checked in the Step properties pane under Extraction Definition.
-
When data are dropped on the Data Model, they are by default added to the last added Extract step. Editing fields After extracting some data, you may want to: l Change the names of fields that are included in the extraction. l Change the order in which fields are extracted. l Set the data type, data format and default value of each field. l Modify the extracted data through a script. l Delete a field.
-
Data selections are used to extract promotional data ("Extracting data" on page 96), transactional data ("Extracting transactional data" on the next page) and to apply a condition to an extraction (Condition step). Right-clicking on a data selection displays a contextual menu with the actions that can be done with that selection or the steps that can be added to them. That menu also displays the keyboard shortcuts.
-
XML File XML data is displayed as a tree view inside the Data Viewer. To get a better overview you can also collapse any XML level. In this tree view you can select nodes just like files in the Windows Explorer: keep the Ctrl button pressed down while clicking on nodes to select or deselect them, or keep the Shift button pressed down to select consecutive nodes. You can select multiple fields even if those fields are in different nodes.
-
Detail tables are created when an Extract step is added within a Repeat step. The Repeat step goes through a number of lines or nodes. An Extract step within that loop extracts data from each line or node. It depends on the type of source data how this loop is constructed exactly. For more information about detail tables, multiple detail tables and nested detail tables, see "Example " on page 170. From a CSV file or a Database The transactional data (also called line items) appear in multiple rows.
-
1. Select a field in the column that contains the first line item information. 2. Right-click this data selection and select Add Repeat. This adds a Repeat step with a GoTo step inside it. The GoTo step moves the cursor down to the next line, until there are no more lines (see "Goto step" on page 120). 3. (Optional.) Add an empty detail table via the Data Model pane: right-click the Data Model and select Add a table. Give the detail table a name. 4. Select the Repeat step on the Steps pane. 5.
-
Page 104
-
From an XML file The transactional data appears in repeated elements. 1. Right-click one of the repeating elements and select Add Repeat. This adds a Repeat step to the data mapping configuration.
-
elements is extracted. You can see this on the Step properties pane, as long as the Repeat step is selected on the Steps pane. In the Collection field, you will find the corresponding node path. The Goto step isn't used in XML extraction workflows The DataMapper moves through the file using Xpath, a path-like syntax to identify and navigate nodes in an XML document. 2. (Optional.) Add an empty detail table via the Data Model pane: right-click the Data Model and select Add a table.
-
1. Add a Goto step if necessary. Make sure that the cursor is located where the extraction loop must start. By default the cursor is located at the top of the page, but previous steps may have moved it. Note that an Extract step does not move the cursor. 1. Select something in the first line item. 2. Right-click on the selection and select Add Goto. The Goto step will move the cursor to the start of the first line item. 2. Add a Repeat step where the loop must stop. 1.
-
have to be included. This is done by adding a Condition step within the Repeat step. 1. Select the start of the Repeat step on the Steps pane. 2. Look for something in the data that distinguishes lines with a line item from other lines (or the other way around). Often, a "." or "," appears in prices or totals at the same place in every line item, but not on other lines. 3. Select that data, right-click on it and select Add Conditional.
-
4. (Optional.) Add an empty detail table to the Data Model: right-click the Data Model and select Add a table. Give the detail table a name.
-
5. Extract the data (see "Adding an extraction" on page 96). When you drag & drop data on the name of a detail table in the Data Model pane, the data are added to that detail table. Dropping the data somewhere else on the Data Model pane, or using the contextual menu in the Data Viewer, creates a new detail table, with a default name that you can change later on (see "Renaming a detail table" on page 167).
-
Note In a PDF or Text file, pieces of data often have a variable size: a product description, for example, may be short and fit on one line, or be long and cover two lines. To learn how to handle this, see "Extracting data of variable length" on the facing page. 6. Extract the sum or totals. If the record contains sums or totals at the end of the line items list, the end of the Repeat step is a good place to add an Extract step for these data.
-
Extracting data of variable length In PDF and Text files, transactional data isn't structured uniformly, as in a CSV, database or XML file. Data can be located anywhere on a page. Therefore, data are extracted from a certain region on the page. The data can be spread over multiple lines and multiple pages, however: l l Line items may continue on the next page, separated from the line items on the first page by a line break, a number of empty lines and a letterhead.
-
l l l The field name is the same. (See: "Renaming and ordering fields" on page 131.) The Extract steps are mutually exclusive. This is the case when they are located in different branches of a Condition step or Multiple Conditions step. The option Append values to current record is checked in the Step properties pane under Extraction Definition.
-
Using a script A script could also provide a solution when data needs to be extracted from a variable region. This requires using a Javascript-based field.
-
1. Add a field to an Extract step, preferably by extracting data from one of the possible regions; see "Extracting data" on page 96. To add a field without extracting data, see "Adding a JavaScript-based field" on page 130. 2. On the Step properties pane, under Field Definition, select the field and change its Mode to Javascript. If the field was created with its Mode set to Location, you will see that the script already contains one line of code to extract data from the original location. 3.
-
The Preprocessor and Postprocessor steps are special in that the first can be used to modify the incoming data prior to executing the rest of the extraction workflow while the latter can be used to further process the resulting record set after the entire extraction workflow has been executed.
-
To set the value of a property you can use an Action step (see "Action step" on page 123). Preprocessors The Preprocessor step can contain any number of preprocessors. They will be run in sequence before the data is sent to the Data Mapping workflow. To add a preprocessor: 1. Select the Preprocessor step on the Steps pane. 2. On the Step properties pane, under Preprocessor, click the Add button . 3. Under Preprocessor definition, add the script.
-
Configuring the Preprocessor step For an explanation of the settings for preprocessors, see: "Preprocessor step properties" on page 189. Extract step The Extract step is essential in each and every data mapping configuration. It extracts data from the data source, based on their location (a row and column in CSV or tabular data, an XPath in XML, or a region of the page in PDF and Text) or on a JavaScript. The data is placed in the record set that is the result of the extraction workflow.
-
l The option Append values to current record is checked in the Step properties pane under Extraction Definition. Repeat step The Repeat step is a loop that may run 0 or more times, depending on the condition specified. It is used for the extraction of transactional data; see "Extracting transactional data" on page 101. Repeat steps do not automatically move the pointer in the source file.
-
Goto step Although invisible, there is a cursor in the Data Viewer. In an extraction workflow, the cursor starts off at the top-left corner of each record in the source data. The Goto step can move the cursor to a certain location in the current record. The new location can be relative to the top of the record or to the current position. When the Goto step is used within a Repeat step, it moves the cursor in each loop of the Repeat step.
-
In the Data Viewer pane, icons on the left indicate the result of the evaluation in the Condition step: when true and when false. Adding a Condition step To add a Condition step: l On the Steps pane, select the step after which to insert the Condition step; then, in the Data Viewer, select some data, right-click that data and choose Add Conditional.
-
Rules are by default combined with AND. To change the way rules are combined, right-click "AND" in the Rule Tree, on the Step properties pane, and select OR or XOR instead. (XOR means one or the other, but not both.) Renaming a rule To rename a rule, double-click its name in the Rule Tree and type a new name. Multiple Conditions step The Multiple Conditions step is useful to avoid the use of nested Condition steps: Condition steps inside other Condition steps.
-
Adding a Multiple Conditions step To add a Multiple Conditions step, right-click the Steps pane and select Add a Step > Add Multiple Conditions. To add a case, click the Add case button to the right of the Condition field in the Step properties pane. Configuring a Multiple Conditions step For information about how to configure the Multiple Conditions step, see "Left operand, Right operand" on page 217. The settings for a Case are the same as for a Condition step; see "Condition step properties" on page 214.
-
l l l Execute JavaScript code. Set the value for a record property. Record properties are defined in the Preprocessor step; see "Preprocessor step" on page 116. Stop the processing of the current record. Normally an extraction workflow is automatically executed on all records in the source data. By stopping the processing of the current record, you can filter records or skip records partially. The Action step can run multiple specific actions one after the other in order.
-
Configuring the Postprocessor step For an explanation of the settings for postprocessors, see "JavaScript " on page 225. The Data Model The Data Model is the structure of records into which extracted data are stored. It contains the names and types of the fields in a record and in its detail tables. A detail table is a field that contains a record set instead of a single value.
-
pane, filled with data from the current record. The Data Model is not related to the type of data source: whether it is XML, CSV, PDF, Text or a database does not matter. The Data Model is a new structure, designed to contain only the required data. About records A record is a block of information that may be merged with a template to generate a single document (invoice, email, web page...) for a single recipient. It is part of the record set that is generated by a data mapping configuration.
-
Importing/exporting a Data Model To use a Data Model in another data mapping configuration, or to use it in a Designer template without a data mapping configuration, you have to export that Data Model and import it into a data mapping configuration or template. Importing and exporting Data Models is done from within the Data model Pane, using the topright icons and . For information about the structure of the exported Data Model file, see "Data Model file structure" on page 150.
-
Using the Data Model The Data Model is what enables you to create personalized templates in the Designer module. You can drag & drop fields from the Data Model into the template that you are creating (see "Variable Data" on page 534). For this, you have to have a template and a data mapping configuration open at the same time, or import a Data Model (see "Importing/exporting a Data Model" on the previous page).
-
1. Use an Execute Data Mapping task or Retrieve Items task to create a record set. On the General tab select Outputs records in Metadata. 2. Add a value to a field in the Metadata using the Metadata Fields Management task. Data added to the _vger_fld_ExtraData field on the Document level will appear in the record's ExtraData field, once the records are updated from the Metadata (in the next step). Other fields have the same prefix: _vger_fld_. 3. Update the record/s from the Metadata.
-
Alternatively, you can add fields and detail tables directly in the Data Model pane. Right-click anywhere on the Data Model and a contextual menu will appear. Which menu items are available depends on where you've clicked. If you right-click inside the record itself, you can add a field or a detail table. A field will be added at the end with no extraction, while a detail table will be added with no fields inside. After adding a field or detail table this way, you can drag & drop data into it.
-
By changing a field's mode Alternatively you can change a location-based into a JavaScript-based field. 1. Select the field in the Data Model. 2. On the Step properties pane, under Field Definition, change its Mode to JavaScript. 3. Enter the script in the Expression field. Adding fields dynamically Outside of the DataMapper the Data Model cannot be changed. It isn't possible to add fields to it when using the data mapping configuration in Workflow.
-
Note Remember that fields cannot have the same name, unless they are on a different level in the record. Setting the data type Fields store extracted data as a String by default. The data type of a field can be changed via the properties of the Extract step that the field belongs to. 1. Select the Extract step that contains the field. You can do this by clicking on the field in the Data Model, or on the step in the Steps pane that contains the field. 2.
-
field. Post function On the Step properties pane, under Field Definition, you can enter a script in the Post function field to be run after the extraction. (Click the Use JavaScript Editor button to open the Script Editor dialog if you need more space.) A Post function script operates directly on the extracted data. Its results replace the extracted data. For example, the Post function script replace("-", ""); replaces the first dash character that occurs inside the extracted string.
-
2. In the Step properties pane, under Field Definition, click the Remove Extract Field button next to the Field List drop-down. Detail tables A detail table is a field in the Data Model that contains a record set instead of a single value. Detail tables contain transactional data. They are created when an Extract step is added within a Repeat step; see "Extracting transactional data" on page 101. In the most basic of transactional communications, a single detail table is sufficient.
-
Creating multiple detail tables Multiple detail tables are useful when more than one type of transactional data is present in the source data, for example purchases (items with a set price, quantity, item number) and services (with a price, frequency, contract end date, etc). To create more than one detail table, simply extract transactional data in different Repeat steps (see "Extracting transactional data" on page 101).
-
Page 136
-
Nested detail tables Nested detail tables are used to extract transactional data that are relative to other data. They are created just like multiple detail tables, with two differences: l l For the tables to be actually nested, the Repeat step and its Extract step that extract the nested transactional data must be located within the Repeat step that extracts data to a detail table. In their name, the dot notation (record.services) must contain one extra level (record.services.charges).
-
a number of "details" such as movie rentals or long distance calls.
-
The services can be extracted to a detail table called record.services. The "charges" and "details" can be extracted to two nested detail tables.
-
The nested tables can be called record.services.charges and record.services.details.
-
Now one "charges" table and one "details" table are created for each row in the "services" table. Data types By default the data type of extracted data is a String, but each field in the Data Model can be set to contain another data type. To do this: 1. In the Data Model, select a field. 2. On the Step properties pane, under Field Definition choose a data type from the Type drop-down. Changing the type does not only set the data type inside the record.
-
l "HTMLString" on page 148 l "Integer" on page 148 l "Float" on page 147 l "Currency" on the next page l "Date" on page 144 l "Object" on page 149 Note The Object data type is only available in the DataMapper module. It can be used for properties in the Preprocessor step, but not for fields in the Data Model. Boolean Booleans are a simple true/false data type often used in conditions and comparisons.
-
Boolean expressions Boolean values can also be set using an expression of which the result is true or false. This is done using operators and comparisons. Example: record.fields["isCanadian"] = (extract("Country") == "CA"); For more information on JavaScript comparison and logical operators, please see w3schools.com or developer.mozilla.org. Currency The Currency data type is a signed, numeric, fixed-point 64-bit number with 4 decimals. Values range from -922 337 203 685 477.5808 to 922 337 203 685 477.
-
Building Currency values Currency values can be the result of direct attribution or mathematical operations just like Integer values (see "Integer" on page 148). Date Dates are values that represent a specific point in time, precise up to the second. They can also be referred to as datetime values. While dates are displayed using the system's regional settings, in reality they are stored unformatted.
-
For the letters and patterns that you can use in a date format, see "Defining a date/time format" below. Data format settings tell the DataMapper how certain types of data are formatted in the data source. They don't determine how these data are formatted in the Data Model or in a template. In the Data Model, data are converted to the native data type.
-
Note The markers that can be used when extracting dates are different from those that are used to display dates in a template (see the Designer's "Date and time patterns" on page 792). Examples of masks Value in raw data Mask to use June 25, 2013 MM dd, YYYY 06/25/13 mm/dd/yy 2013.06.25 yyyy.mm.dd 2013-06-25 07:31 PM yyyy-mm-dd hh:nn ap 2013-06-25 19:31:14.1206 yyyy-mm-dd hh:nn:ss.ms Tuesday, June 25, 2013 @ 7h31PM DD, MM dd, yyyy @ hh\hnnap Entering a date using JavaScript In several pl
-
Example The following script creates a date that is the current date + 30 days: function addDays(date, days) { var result = new Date(date); result.setDate(result.getDate() + days); return result; } addDays(new Date(), 30); Float Floats are signed, numeric, floating-point numbers whose value has 15-16 significant digits. Floats are routinely used for calculations. Note that Float values can only have up to 3 decimals.
-
HTMLString HTMLStrings contain textual data that includes HTML markup. They are essentially the same as String values except in cases where the HTML markup can be interpreted. Example: Assume that a field has the value He said WOW!. If the data type is String and the value is placed in a template, it will display exactly as "He said WOW!" (without the quotes). If the data type is HTMLString, it will display as "He said WOW!" (again, without the quotes).
-
l Mathematical operations: Assign the result of any mathematical operation. For example: 22+51, 3*6, 10/5 or sourceRecord.property.SubTotal. For more information on mathematics in JavaScript , see w3Schools - Mathematical Operators. For more advanced mathematical functions, see w3schools - Math Object. Note When adding numbers that are not integers, for instance 4.5 + 1.2 , a round towards zero rounding is applied after the operation was made. In the previous example, the result, 5.7, is rounded to 5.
-
l Extraction: l In the Data Model, select a field. On the Step properties pane, under Field Definition set the Type to String. The field value will be extracted and treated as a string. l l JavaScript Expression: Set the desired value to any string between quotes. Example: record.fields["countryOfOrigin"] = "Canada"; Building String values String values can be made up of more than just a series of characters between quotes.
-
xsi:schemaLocation="http://www.objectiflune.com/connectschemas/Data ModelConfig http://www.objectiflune.com/connectschemas/DataModelConfig/1_0_0_ 3.xsd" xmlns:xsi="http://www.w3.
-
Example: transactional details, in a simple invoice format PAGE 153
Example: nested tables (one table into another) PAGE 154
Page 154
-
See: l "Menus" on page 160 l "Toolbar" on page 225 l "Steps pane" on page 187 l "Step properties pane" on page 189 l "Data Model pane" on page 164 l "The Data Viewer" on page 174 l "Messages pane" on page 176 l "Settings pane" on page 177 Keyboard shortcuts This topic gives an overview of keyboard shortcuts that can be used in the DataMapper.
-
Key combination Function Ctrl + N New Ctrl + O Open file Ctrl + Shift + O Open configuration file Ctrl + S Save file Ctrl + V or Shift + Insert Paste Ctrl + X Cut Ctrl + W or Ctrl + F4 Close file Ctrl + Y or Ctrl + Shift +Y Redo Ctrl + Z or Ctrl + Shift + Z Undo Ctrl + Shift + S Save all Ctrl + Shift + W or Ctrl + Shift + F4 Close all Page 156
-
Key combination Function Ctrl + F5 Revert Ctrl + F7 Next view Ctrl + Shift + F7 Previous view Ctrl + F8 Next perspective Ctrl + Shift + F8 Previous perspective Ctrl + F10 Save as Ctrl + F12 Send to Workflow / Package files F4 Ignore step F6 Add an Extract step F7 Add a Goto step F8 Add a Condition step F9 Add a Repeat step F10 Add an Extract field F11 Add an Action step F12 Add a Multiple Conditions step Alt + F12 Add a Case step (under a Multiple Conditions step) Home Go
-
Key combination Function End Go to the last step in the workflow Alt + V Validate records Shift + F10 or Ctrl + Shift + F10 Open context menu Viewer pane The following key combinations activate a function in the Viewer.
-
Key combination Function PageDown Go to next record Alt + CR Property page Alt + PageDown Scroll down to the last field Alt + PageUp Scroll up to the first field Steps tab Key combination Function Ctrl + - Zoom out Ctrl + + Zoom in Edit Script and Expression windows The following key combinations have a special function in the Expression and in the Edit Script windows (expanded view).
-
Key combination Function Ctrl + Q Comment/uncomment; this adds or deletes // before the line. Ctrl + Shift + D Delete line Shift + Tab Shift selected lines left Tab Shift selected lines right Menus The following menu items are shown in the DataMapper Module's menu: File Menu l l l l l l l l New...: Opens the Creating a New Data Mapping Configuration dialog. Open: Opens a standard File Open dialog. This dialog can be used to open Templates and data mapping configurations.
-
l l Revert: Appears only in the Designer module. Reverts all changes to the state in which the file was opened or created. Add Data: Adds data either to the current data mapping configuration or to the open template. In data mapping configuration l l l l From File...: Opens the dialog to add a new data file to the currently loaded data mapping configuration. Not available if the currently loaded data mapping configuration connects to a database source. From Database...
-
Data Menu l l l Hide/Show datamap: Click to show or hide the icons to the left of the Data Viewer that displays how the steps affect the line. Hide/Show extracted data: Click to show or hide the extraction selections indicating that data is extracted. This simplifies making data selections in the same areas and is useful to display the original data. Validate All Records: Runs the Steps on all records and verifies that no errors are present in any of the records.
-
View Menu l Zoom In: Click to zoom in the Steps Pane. l Zoom Out: Click to zoom out the Steps Pane. Window Menu l Show View l Messages: Shows the Messages Pane. l Steps: Shows the Steps Pane. l Settings: Shows the Settings Pane. l Record: Shows the Record Pane. l l l l Detail tables : Each detail table and nested table is listed here. Click on one to show it in the Data Model Pane. Step Properties: Shows the Step Properties Pane.
-
l l "The Data Viewer" on page 174. The Data Viewer shows one record in the data source. "Step properties pane" on page 189. The Step properties pane contains all settings for the step that is currently selected on the Steps pane. l "Data Model pane" below. The Data Model pane shows one extracted record. l "Messages pane" on page 176. Data Model pane The Data Model pane displays the result of all the preparations and extractions of the extraction workflow.
-
l l l Default Value: Click to set the default value for a field. This value is used if no extraction is present, or if an extraction attached to this field returns no value. Collapse Fields: Collapse the fields in the selected level. Expand Fields: Clicking the icon that represents collapsed fields (for example: enables this menu item. It is used to expand the fields on one level. l Collapse All Fields: Collapse the fields on the record level and in all detail tables.
-
l l l l A field name with an asterisk to the right indicates that this field is part of an imported Data Model file. A field with a grey background indicates this Data Model field does not have any attached extracted data. A field with a white background indicates that the field has attached extracted data but the step extracting the data is not currently selected. A field with a blue background indicates that the field has attached extracted data and the step extracting the data is currently selected.
-
Detail tables A detail table is a field in the Data Model that contains a record set instead of a single value. Detail tables contain transactional data. They are created when an Extract step is added within a Repeat step; see "Extracting transactional data" on page 101. In the most basic of transactional communications, a single detail table is sufficient. However, it is possible to create multiple detail tables, as well as nested tables.
-
To create more than one detail table, simply extract transactional data in different Repeat steps (see "Extracting transactional data" on page 101). The best way to do this is to add an empty detail table (right-click the Data Model, select Add a table and give the detail table a name) and drop the data on the name of that detail table.
-
Page 169
-
Nested detail tables Nested detail tables are used to extract transactional data that are relative to other data. They are created just like multiple detail tables, with two differences: l l For the tables to be actually nested, the Repeat step and its Extract step that extract the nested transactional data must be located within the Repeat step that extracts data to a detail table. In their name, the dot notation (record.services) must contain one extra level (record.services.charges).
-
a number of "details" such as movie rentals or long distance calls.
-
The services can be extracted to a detail table called record.services. The "charges" and "details" can be extracted to two nested detail tables.
-
The nested tables can be called record.services.charges and record.services.details.
-
Now one "charges" table and one "details" table are created for each row in the "services" table. The Data Viewer The Data Viewer is located in the middle on the upper half of the DataMapper screen. It displays the data source that is currently loaded in the DataMapper, specifically one record in that data. Where one record ends and the next starts, is set in the Data Source settings (see "Record boundaries" on page 94).
-
l l l l Hide/Show line numbers the left of the Data Viewer. (Text file only): Click to show or hide the line numbers on Hide/Show datamap : Click to show or hide the icons to the left of the Data Viewer which displays how the steps affect the line. Hide/Show extracted data : Click to show or hide the extraction selections indicating that data is extracted. This simplifies making data selections in the same areas and is useful to display the original data.
-
Messages pane The Messages pane is shared between the DataMapper and Designer modules and displays any warnings and errors from the data mapping configuration or template. At the top of the Message pane are control buttons: l Export Log: Click to open a Save As dialog where the log file (.log) can be saved on disk. l Clear Log Viewer: Click to remove all entries in the log viewer. l Filters: Displays the Log filter (see "Log filter" below).
-
Settings pane Settings for the data source and a list of Data Samples and JavaScript files used in the current data mapping configuration, can be found on the Settings tab at the left. The available options depend on the type of data sample that is loaded. The Input Data settings (especially Delimiters) and Boundaries are essential to obtain the data and eventually, the output that you need. For more explanation, see "Data source settings" on page 92.
-
l Ignore unparseable lines: Ignores any line that does not correspond to the settings above. PDF file Input Data settings PDF Files have a natural, static delimiter in the form of pages, so the options here are interpretation settings for text in the PDF file. The Input Data settings for PDF files determine how words, lines and paragraphs are detected in the PDF when creating data selections. Each value represents a fraction of the average font size of text in a data selection, meaning "0.
-
l l l l l Connection String: Displays the connection string used to access the Data Source. Table: Displays the tables and stored procedures available in the database. The selected table is the one the data is extracted from. Clicking on any of the tables shows the first line of the data in that table. Encoding: Defines what encoding is used to read the Data Source ( US-ASCII, ISO8859-1, UTF-8, UTF-16, UTF-16BE or UTF-16LE ).
-
l On lines: Triggers a new page in the Data Sample after a number of lines. l l l Cut on number of lines: Triggers a new page after the given number of lines. With this number set to 1, and the Boundaries set to On delimiter, it is possible to create a record for each and every line in the file. Cut on FF: Triggers a new page after a Form Feed character. On text: Triggers a new page in the Data Sample when a specific string is found in a certain location.
-
instance of that node. For example, if a client node contains multiple invoice nodes, the information for the client node can be duplicated for each invoice. The DataMapper only extracts elements for which at least one value or attribute value is defined in the file. Boundaries Boundaries are the division between records: they define where one record ends and the next record begins; for an explanation see "Record boundaries" on page 94.
-
l On field value: Sets a boundary on a specific field value. l l l Field name: Displays the fields in the top line. The value of the selected field is compared with the Expression below to create a new boundary. Expression: Enter the value or Regular Expression to compare the field value to. Use Regular Expression: Treats the Expression as a regular expression instead of static text. For more information on using Regular Expressions (regex), see the Regular-Expressions.info Tutorial.
-
boundary can be effectively defined. For example, if a string is always found on the first and on the last page of a document, you could specify a number of occurrences of 2. This way, there is no need to inspect other items for whether it is on the first page or the last page. Having found the string two times is enough to set the boundary. l Pages before/after: Defines the boundary a certain number of pages before or after the current page.
-
l l l l l l l Top/Bottom: Defines the start and end row of the data selection to compare with the text value. Entire width: Ignores the column values and compares using the whole line. Entire height: Ignores the row values and compares using the whole column. Entire page: Compares the text value on the whole page. Only available with contains, not contains, is empty and is not empty operators.
-
l l Record limit: Defines how many records are displayed in the Data Viewer. This does not affect output production; when generating output, this option is ignored. To disable the limit, use the value 0 (zero). Trigger: Defines the type of rule that controls when a boundary is set, creating a new record. l On Element: Defines a new record on each new instance of the XML element selected in the Input Data settings.
-
l Set as Active : Activates the selected Data Sample. The active data sample is shown in the Data Viewer after it has gone through the Preprocessor step as well as the Input Data and Boundary settings. External JS Libraries Right-clicking in the box brings up a control menu, with the same options as are available through the buttons on the right. l Add : Add a new external library. Use the standard Open dialog to browse and open the .js file. l Delete l Replace l Reload to it.
-
Note Default data formats tell the DataMapper how certain types of data are formatted in the data source. They don't determine how these data are formatted in the Data Model or in a template. In the Data Model, data are converted to the native data type. Dates, for example, are converted to a DateTime object in the Data Model, and will always be shown as "year-month-day" plus the time stamp, for example: 2012-04-11 12.00 AM.
-
Viewing step details Hovering over the task shows a tooltip that displays some of the details of that step. To see all details for a step, click on the step and take a look at the Step properties pane ("Step properties pane" on the next page. Clicking on any Extract step in the Steps pane highlights any area in the Data Viewer from which it extracts data. You can also click on the Preprocessor step to select all the steps in the workflow to show a complete map of all the extracted data.
-
placed in the clipboard. To paste the copied step at its destination, right-click the step in the position before the desired location and select Paste Step, or use the button in the Toolbar. Step properties pane The Step Properties pane is used to adjust the properties of each step in the process. The pane is divided in a few subsections depending on the step and the data type. It always contains a subsection to name and document the selected step.
-
Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane. Fixed Automation Properties The Fixed automation properties subsection lists all the fixed properties available from the PlanetPress Workflow automation module. These properties are equivalent to data available within the PlanetPress Workflow process.
-
PlanetPress Workflow. To access this property inside of any JavaScript code within the Data Mapping Configuration, use automation.properties.ProcessName. Properties The Properties subsection is used to create specific properties that are used throughout the workflow. Properties can be accessed through some of the interface elements such as the Condition and Repeat step properties, or in scripts, through the "DataMapper Scripts API" on page 228.
-
Note Entire Data Properties are evaluated before anything else, such as Preprocessors, Delimiters and Boundaries in the Settings pane (see "Data source settings" on page 92). This means these properties cannot read information from the data sample or from any records. They are mostly useful for static information such as folder locations or server addresses.
-
Extraction Definition l l Data Table: Defines where the data will be placed in the extracted record. The root table is record, any other table inside the record is a detail table. For more information see "Extracting transactional data" on page 101. Append values to current record: When the Extract step is inside a loop, check this to ensure that the extraction will be done in the same detail table as any previous extractions within the same loop.
-
Note If the selection contains multiple lines, only the first line is extracted. l Post Function: Enter a JavaScript expression to be run after the extraction. A Post function script operates directly on the extracted data, and its results replace the extracted data. For example, the Post function script replace("-", ""); would replace the first dash character that occurs inside the extracted string. l l Trim: Select to trim empty characters at the beginning or the end of the field.
-
l Mode: Determines the origin of the data. l Location: The contents of the data selection set below will be the value of the extracted field. The data selection settings are different depending on the data sample type. l Left: Defines the start of the data selection to extract. l Right: Defines the end of the data selection to extract. l l l Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer). Height: The height of the selection box.
-
l JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See DataMapper API. l l l Use JavaScript Editor: Click to display the Script Editor dialog. Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used.
-
l l Column: Drop-down listing all fields in the Data Sample, of which the value will be used. Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer). l Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l Post Function: Enter a JavaScript expression to be run after the extraction.
-
Note If the selection contains multiple lines, only the first line is selected. l Type: The data type of the selected data; see "Data types" on page 141. Make sure that the data format that the DataMapper expects matches the actual format of the data in the data source; see "Data Format" on the next page. XML File l Field List: The Field List displays each of the single fields that are being extracted in a drop-down. Fields can be re-ordered and re-named within the Ordering and Renaming Fields dialog.
-
l Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string. l l l l Use JavaScript Editor: Click to display the Script Editor dialog. Trim: Select to trim empty characters at the beginning or the end of the field. Type: The data type of the selected data; see "Data types" on page 141.
-
Note Data format settings tell the DataMapper how certain types of data are formatted in the data source. They don't determine how these data are formatted in the Data Model or in a template. In the Data Model, data are converted to the native data type. Dates, for example, are converted to a DateTime object in the Data Model, and will always be shown as "year-month-day" plus the time stamp, for example: 2012-04-11 12.00 AM.
-
l Name: The name of the field. Click the field name and enter a new name to rename the field. Note If you intend to use the field names as metadata in a PlanetPress Workflow process, do not add spaces to field names, as they are not permitted in metadata field names. l Value: Displays the value of the extract field in the current Record. l Remove button : Click to remove the currently selected field. l Move Up button : Click to move the selected field up one position.
-
l Name: A name by which to refer to the action. This name has no impact on functionality. l Type: l l l Set property: Sets the value of a record property which was created in the Preprocessor step (see "Preprocessor step" on page 116). Run JavaScript : Runs a JavaScript expression, giving much more flexibility over the extraction process. Stop Processing Record: When this option is selected, the extraction workflow stops processing the current record and moves on to the next one.
-
Note If the selection contains multiple lines, only the first line is selected. l l Trim: Select to trim empty characters at the beginning or the end of the field JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See "DataMapper Scripts API" on page 228. l l l l Expression: The JavaScript expression to run.
-
l l Date Language : Set the date language for a date value (ex: If English is selected, the term May will be identified as the month of May). Treat empty as 0 : A numerical empty value is treated as a 0 value. CSV and Database Files l Property: Displays a list of record properties set in the Preprocessor step (see "Preprocessor step" on page 116). l Type: Displays the type of the property. Read only field. l Based on: Determines the origin of the data.
-
l l Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used. Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l Data Format: Data format settings tell the DataMapper how certain types of data are formatted in the data source.
-
l XPath: The path to the XML field that is extracted. l Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l l Trim: Select to trim empty characters at the beginning or the end of the field JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field.
-
l Data Format: Data format settings tell the DataMapper how certain types of data are formatted in the data source. Make sure that this format matches the actual format of the data in the data source. l Negative Sign Before : A negative sign will be displayed before any negative value. l Decimal Separator : Set the decimal separator for a numerical value. l Thousand Separator : Set the thousand separator for a numerical value. l Currency Sign : Set the currency sign for a currency value.
-
The properties described below become visible in the Step properties pane when the Repeat step is selected in the Steps pane. Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane.
-
Rule Tree The Rule tree subsection displays the full combination rules (defined below under Condition) as a tree, which gives an overview of how the conditions work together as well as the result for each of these conditions for the current record or iteration. Condition First, the Condition List displays the conditions in list form, instead of the tree form above. Three buttons are available next to the list: l Add condition: Click to create a new condition in the list.
-
extraction. l l Value: A specified static text value. l l l l l l l l Field: The Extracted Record field to use in the comparison. Expression: The JavaScript line that is evaluated. Note that the last value attribution to a variable is the one used as a result of the expression. Use JavaScript Editor: Click to display the Edit Script dialog. Use selected text: Inserts the text in the current data selection in the JavaScript Expression.
-
l l l l is less than: The first specified value is smaller, numerically, than the second value for the condition to be True. is greater than: The first specified value is larger, numerically, than the second value for the condition to be True. is empty: The first specified value is empty. With this operator, there is no second value. Invert condition: Inverts the result of the condition. For instance, is empty becomes is not empty.
-
l l l l l Data Property: The value of a data-level property set in the Preprocessor step. Record Property: One of the local variables that you can create and that are reset for each document as opposed to data variables that are global because they are initialized only once at the beginning of each job. Automation Property: The current value of a Document-level property set in the Preprocessor step.
-
XML Files l Based On: l Position: The data in the specified position for the comparison. l l l l l l l l l l Value: The text value to use in the comparison. Use selected text: Uses the text in the current data selection as the Value. If multiple lines or elements are selected, only the first one is used. Field: The Extracted Record field to use in the comparison. JavaScript : The result of a JavaScript Expression.
-
l Operators: l l l l l l is equal to: The two specified value are identical for the condition to be True. contains: The first specified value contains the second one for the condition to be True. is less than: The first specified value is smaller, numerically, than the second value for the condition to be True. is greater than: The first specified value is larger, numerically, than the second value for the condition to be True. is empty: The first specified value is empty.
-
l l To rename a rule, double click on its name from the Rule tree subsection. To change the way rules are combined, right-click "AND". Select OR or XOR instead. XOR means one or the other, but not both. Condition First, the Condition List displays the conditions in list form, instead of the tree form above. Three buttons are available next to the list: l l Add condition: Click to add a new rule. This will always branch the current condition as an "AND" operator.
-
l Value: A specified static text value. l l l l l l l l Expression: The JavaScript line that is evaluated. Note that the last value attribution to a variable is the one used as a result of the expression. Use JavaScript Editor: Click to display the Edit Script dialog (see "Using scripts in the DataMapper" on page 230). Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used.
-
l is greater than: The first specified value is larger, numerically, than the second value for the condition to be True. is empty: The first specified value is empty. With this operator, there is no second value. Invert condition: Inverts the result of the condition. For instance, is empty becomes is not empty. l Multiple Conditions step properties The Multiple Conditons step contains a number of Case conditions (one to start with) and a Default, to be executed when none of the other cases apply.
-
l l l l l Trim: Select to trim empty characters at the beginning or the end of the field. Value: A specified static text value. Use selected text: Uses the text in the current data selection as the Value. If multiple lines or elements are selected, only the first one is used. Field: The Extracted Record field to use in the comparison. JavaScript : The result of a JavaScript Expression. l l l Value: The text value to use in the comparison.
-
l Extractor Property: The value of an internal extractor variable: l l Counter: The value of the current counter iteration in a Repeat step. Vertical Position: The current vertical position on the page, either in Measure (PDF) or Line (Text and CSV). Condition The Condition drop-down displays the cases in list form. Three buttons are available next to the list: l l l Add case: Click to add a new case to the step. It will be placed next to any existing cases.
-
The properties of the Goto step described in this topic become visible in the Step properties pane when you select the Goto step on the Steps pane. Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane.
-
options appear below to specify in which area of each line the Gotostep checks in: l Left: The starting column, inclusively. l Right: The end column, inclusively. l l Use selection: Click while a selection is made in the Data Viewer to automatically set the left and right values to the left and right edges of the selection. Next occurrence of: Jumps to the next occurrence of specific text or a text pattern, either anywhere on the line or in specific columns.
-
l Page: Jumps between pages or to a specific page. l l l From: Defines where the jump begins: l Current Position: The Gotobegins at the current cursor position. l Top of record: The Gotobegins at line 1 of the source record. Move by: Enter the number pages to jump. Next line with content: Jumps to the next line that has contents, either anywhere on the line or in specific columns.
-
l Use regular expression: Check so that the Expression box is treated as a regular expression instead of static text. For more information on using Regular Expressions (regex), see the Regular-Expressions.info Tutorial. CSV File l From (CSV files): Defines where the jump begins: l Current Position: The Goto begins at the current cursor position. l l Move by: Enter the number of lines or pages to jump. Top of record: The Gotobegins at line 1 of the source record.
-
The properties described below become visible in the Step properties pane when the Postprocessor step is selected in the Steps pane. Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane.
-
Postprocessor definition JavaScript l l l Expression: The JavaScript expression that will run on the Data Sample. See "DataMapper Scripts API" on page 228. Use JavaScript Editor: Click to display the Script Editor dialog. Use selected text: Uses the text in the current data selection as the Value. If multiple lines or elements are selected, only the first one is used. Toolbar In the DataMapper module, the following buttons are available in the top toolbar.
-
l l l l l l l l l l l l Add Condition Step : Adds a condition based on the current data selection. The "True" branch gets run when the text is found on the page. Other conditions are available in the step properties once it has been added. Add Repeat Step : Adds a loop that is based on the current data selection, and depending on the type of data. XML data will loop on the currently selected node, CSV loops for all rows in the record.
-
Welcome Screen The Welcome Screen appears when first starting up PlanetPress Connect. It offers some useful shortcuts to resources and to recent documents and data mapping configurations. The Welcome Screen can be brought back in two ways: l The Welcome Screen button in the "Toolbars" on page 692. l From the Menus in Help, Welcome Screen. Contents l Activation: Click to open the Objectif Lune Web Activation Manager. l Release Notes: Opens the current Release Notes for PlanetPress Connect.
-
l Documentation: Opens this documentation. l Courses (OL Learn): Opens the Objectif Lune e-Learning Center. l User Forums: Opens the Questions & Answer forums. DataMapper Scripts API This page describes the different features available in scripts created inside DataMapper. See "Using scripts in the DataMapper" on page 230.
-
Name Description Available in scripts of type except Goto "record" on page 259 The current record in the main data set. Extract, Condition, Repeat and Multiple Conditions steps "region" on page 260 An object that defines a subsection of the input data. Boundaries "sourceRecord" on page 262 An object containing properties specific to the current source record being processed.
-
Name Description createHTTPRequest () Creates a new HTTP Request Object. createTmpFile() Creates a file with a unique name in the temporary work folder and returns a file object. deleteFile() Deletes a file. execute() Calls an external program and waits for it to end. newByteArray() Returns a new byte array. newCharArray() Returns a character array. newDoubleArray() Returns a double array. newFloatArray() Returns a float array. newIntArray() Returns an integer array.
-
A script can be used to set boundaries for a data source (see "Setting boundaries using JavaScript" on page 233). The script determines where a new record starts. Scripts can also be used in different steps in the extraction workflow. You can: l l l l l l Modify the incoming data prior to executing the rest of the extraction workflow, via a Preprocessor (see "Preprocessor step" on page 116).
-
Syntax rules In the DataMapper, all scripts must be written in JavaScript, following JavaScript syntax rules. For example, each statement should end with ; and the keywords that can be used, such as var to declare a variable, are JavaScript keywords. There are countless tutorials available on the Internet to familiarize yourself with the JavaScript syntax. For a simple script all that you need to know can be found on the following web pages: http://www.w3schools.com/js/js_syntax.asp and http://www.
-
Setting boundaries using JavaScript As soon as you select the On Script option as the trigger for establishing record boundaries (see "Record boundaries" on page 94), you are instructing the DataMapper to read the source file sequentially and to trigger an event each and every time it hits a delimiter. (What a delimiter is, depends on the source data and the settings for that data; see "Input data settings (Delimiters)" on page 93).
-
l Compare the contents of one region with another. l Etc. To access this data in the script, use the get() function of the boundaries object. This function expects different parameters depending on the type of source file; see "Example" on page 242. Getting access to other data Data that is not passed with the event, but that is necessary to define the record boundaries, can be stored in the boundaries object using the setVariable function (see "boundaries" on page 240 and "Example" on page 244).
-
Note The first line is just the header with the names of the CSV columns. The data is already sorted per year, per artist, and per album. Your goal is to examine two values in each CSV record and to act when either changes. The DataMapper GUI allows you to specify a On Change trigger, but you can only specify a single field. So for instance, if you were to set the record boundary when the "Released" field changes, you'd get the first four lines together inside a single record.
-
simply the column name. The region is passed as a parameter to the get() method, which reads its contents and converts it into an array of strings (because any region, even a CSV field, may contain several lines). l l l To "remember" the values that were processed the last time the event was triggered, we use variables that remain available in between events. Note that these variables are specific to the Boundary context and not available in any other scripting context in the DataMapper.
-
The purpose of the script, again, is to set the record boundary when EITHER the year OR the artist changes. The script would look like this: /* Read the values of both columns we want to check */ var zeBand = boundaries.get(region.createRegion(1,1,30,1)); var zeYear = boundaries.get(region.createRegion(61,1,65,1)); /* Check that at least one of our variables holding previous values have been initialized already, before attempting to compare the values */ if (boundaries.
-
pages do not have a grid concept of lines and columns, the above parameters would instead be specified in millimeters relative to the upper left corner of each page. So for instance, to create a region for the Year, the code might look like this: region.createRegion(190,20,210,25) which would create a region located near the upper right corner of the page.
-
Property Description properties Returns a ScriptableAutomation object containing additional information (file name, process name and task ID) from PlanetPress Workflow. variables Returns a ScriptableAutomation object containing the list of local and global variables defined by the user in PlanetPress Workflow. Note that there is no way to distinguish local variables from global ones (local variables take precedence over global variables).
-
automation.properties.OriginalFilename; To access Workflow variables (declared in the Preprocessor properties): automation.variables.Same_as_workflow; boundaries Returns a boundaries object encapsulating properties and methods allowing to define the boundaries of each document in the job. This object is available when triggering document boundaries On script. Properties The following table lists the properties of the boundaries object.
-
Method Description Script type getVariable () Retrieves a value of a variable stored in the boundaries object. Boundaries set() Sets a new record boundary. (See: "Record boundaries" on page 94.) Boundaries setVariable () Sets a boundaries variable to the specified value, automatically creating the variable if it doesn't exist yet. Boundaries find() Method of the boundaries object that finds a string in a region of the data source file.
-
get() The get() method reads the contents of a region object and converts it into an array of strings (because any region may contain several lines). How the region is defined, depends on the type of source data; see "region" on page 260 and "Example" on page 261. get(in_Region) in_Region A region object. What type of object this is depends on the type of source data, however in any case the region object can be created with a call to region.createRegion(); see "Example" on page 261.
-
set(delimiters) delimiters Sets a new record boundary. The delimiters parameter is an offset from the current delimiter, expressed in an integer that represents a number of delimiters. If this parameter is not specified, then a value of 0 is assumed. A value of 0 indicates the record boundary occurs on the current delimiter. A negative value of -n indicates that the record boundary occurred -n delimiters before the current delimiter.
-
set the Boundary accordingly */ if((boundaries.currentDelim % 2) !=0 ) { /* Total is on odd page, let's set the document Boundary on delimiter further, thereby skipping the next blank page */ boundaries.set(1); } else { /* Total is on an even page, set the document Boundary to t current delimiter */ boundaries.set(); } } } setVariable() This method sets a variable in the boundaries to the specified value, automatically creating the variable if it doesn't exist yet.
-
data Returns a data object encapsulating properties and methods pertaining to the original data stream. Properties The following table lists the properties of the data object. Property Description Return type filename The path of the input file. Returns the fully qualified file name of the temporary work file being processed. properties Contains properties declared in the preprocessor step (see Preprocessor Step Properties for details).
-
Method Description Script type File type and Postprocessor steps "Examples" on page 255 Finds the first occurrence of a string starting from the current position. Boundaries "Examples" on page 258 Finds the first match for a regular expression pattern starting from the current position.
-
separator String inserted between all lines returned from the region. If you don't want anything to be inserted between the lines, specify an empty string (""). Tip "
" is a very handy string to use as a separator. When the extracted data is inserted in a Designer template, "
" will be interpreted as a line break, because
is a line break in HTML and Designer templates are actually HTML files. Examples Example 1: The script command data.
-
Example 2: The script command data.extract(1,22,9,6,"
"); means that the left position of the extracted information is located at 1, the right position at 22, the offset position is 9 (since the first line number is 10) and the regionHeight is 6 (6 lines are selected). Finally, the "
" string is used for concatenation.
-
extract(xPath) Extracts the text value of the specified node in an XML file. xPath String that can be relative to the current location or absolute from the start of the record. Example The script command data.extract('./CUSTOMER/FirstName'); means that the extraction is made on the FirstName node under Customer.
-
extract(columnName, rowOffset) Extracts the text value from the specified column and row. columnName String that represents the column name. rowOffset Number that represents the row index (zero-based), relative to the first row in the record. To extract the first row, specify 0 as the rowOffset. Example The script command data.extract('ID',0); means that the extraction is made on the ID column in the first row.
-
extract(left, right, verticalOffset, lineHeight, separator) Extracts the text value from a rectangular region in a PDF file. All coordinates are expressed in millimeters. left Double that represents the distance from the left edge of the page to the left edge of the rectangular region. right Double that represents the distance from the left edge of the page to the right edge of the rectangular region. verticalOffset Double that represents the distance from the current vertical position.
-
lineHeight Double that represents the total height of the region. separator String inserted between all lines returned from the region. If you don't want anything to be inserted between the lines, specify an empty string (""). Tip "
" is a very handy string to use as a separator. When the extracted data is inserted in a Designer template, it will be interpreted as a line break, because
is a line break in HTML and Designer templates are actually HTML files. Example The script command data.
-
extractMeta() Method that extracts the value of a metadata field on a certain level in a PDF/VT. This method always return a String. extractMeta(levelName String, propertyName String) levelName String, specifying the PDF/VT's level. Case-sensitive. propertyName String, specifying the metadata field. fieldExists() Method of the data object that returns true if a certain metadata field, column or node exists. (See "data" on page 245.
-
fieldExists(levelName, propertyName) This method returns true if the given metadata field exists at the given level in a PDF file. levelName String that specifies the metadata field. propertyName String that specifies the level. fieldExists(fieldName) This method returns true if the specified column exists in the current record in a CSV file. fieldName String that represents a field name (column) in a CSV file.
-
Partial matches are not allowed. The entire string must be found between the two constraint parameters. The data.find() function only works on the current page. If the record contains several pages, you must create a loop that will perform a jump from one page to another to do a find() on each page. Note Calling this method does not move the current position to the location where the string was found.
-
Left=26,76, Top=149.77, Right=40,700001, Bottom=154.840302 These values represent the size of the rectangle that encloses the string in full, in millimeters relative to the upper left corner of the current page. findRegExp() Finds the first occurrence of a string that matches the given regular expression pattern, starting from the current position.
-
matching can be enabled by specifying the UNICODE_CASE flag (u) in conjunction with this flag. s: Enables dotall mode. In dotall mode, the expression . matches any character, including a line terminator. By default this expression does not match line terminators. L: Enables literal parsing of the pattern. When this flag is specified, then the input string that specifies the pattern is treated as a sequence of literal characters.
-
Examples data.findRegExp(/\d{3}-[A-Z]{3}/,"gi",50,100); or data.findRegExp("\\d{3}-[A-Z]{3}","gi",50,100);}} Both expressions would match the following strings: 001-ABC, 678-xYz. Note how in the second version, where the regular expression is specified as a string, some characters have to be escaped with an additional backslash, which is standard in JavaScript. db Object that allows to connect to a database. Methods The following table describes the methods of the db object.
-
user String that represents the user name for authentication. password String that represents the password for authentication. logger Global object that allows logging messages such as error, warning or informational messages. Methods The following table describes the methods of the logger object.
-
region The region object defines a sub-section of the input data. Its properties vary according to the type of data. This object is available when triggering document boundaries On script; see "Setting boundaries using JavaScript" on page 233. Methods The following table describes the methods of the region object. This object is available in Boundaries scripts, with all file types. Method Description Return Type found Field that contains a boolean value indicating if the last call to boundaries.
-
createRegion() This method sets the physical coordinates of the region object. The region is available when setting document boundaries using a script (see "region" on the previous page). PDF and Text: createRegion(x1, y1, x2, y2) Creates a region from the data, using the specified left (x1), top (y1), right (x2) and bottom (y2) parameters, expressed in characters for a text file or in millimeters for a PDF file. x1 Double that represents the left edge of the region.
-
CSV or database: createRegion(columnName) Creates a region from the data in a CSV file, using the specified columnName parameter. columnName String containing the name of the column where the region is to be created. Example This script checks the first value in a certain column. If it is not the same value as in the previous record(s), a document boundary is set. if(!(boundaries.Eof || boundaries.Bof)){ var recordValue = boundaries.get(region.createRegion('ID'))[0]; if(!(recordValue==boundaries.
-
1. Enter the property Name. 2. Select Each record from the Scope drop-down list. 3. Select a Type for the Property. steps Returns a steps object encapsulating properties and methods pertaining to the current DataMapper process. This object is available in an Extract, Condition, Repeat or Multiple Conditions step script. Methods and properties The following table lists the methods and properties of the steps object.
-
Method Description File type currentPosition Returns the current position of the pointer in the data. Depending on the type of data being processed, the return value may be a string (e.g. XPath value in XML), an integer (e.g. line numbers in text ot tabular data), or a measure in millimeters(e.g. PDF data). All currentLoopCounter An integer value representing the current iteration of the containing loop.
-
Example if(steps.currentPage > curPage) { steps.moveTo(0, steps.currentPosition+14); /* Moves the current position to 14 lines below the current position of the pointer in the data */ curPage++; } else if(curLine.startsWith("LOAD FACTOR")) { /* Extracts data to the curLine variable until the string "LOAD FACTOR" is encountered */ break; } else { lineArray.push(curLine); /* Adds the current line value (extraction) to the array */ } moveTo() Moves the position of the pointer in the source data file.
-
With the scope set to 1 or steps.MOVEDELIMITERS, verticalPosition represents the index of the delimiter (as defined in the Input Data settings) to move to from the top of the record. With the scope set to 2, verticalPosition is not used. The position is moved to the next line after the current position that contains any text. Example The following line of code moves the current position in a text file 14 lines down from the current vertical position (steps.
-
moveTo(xPath) Moves the current position in a XML file to the first instance of the given node, relative to the top of the record. xPath String that defines a node in the XML file. Tip The XML elements drop-down (on the Settings pane, under Input Data) lists xPaths defining nodes in the current XML file. moveTo(row) Moves the current position in a CSV file to the given row number. row Number that represents the index of the row, relative to the top of the record.
-
l l l 0 or steps.MOVELINES: the current position is set to the next line. 1 or steps.MOVEDELIMITERS: the current position is set to the next delimiter (as defined in the Input Data settings). 2 (next line with content): the current position is set to the next line that contains any text. Example The following line of code moves the current position to the next line that contains any text. steps.moveToNext(2); XML scope Number that may be set to: l l 0 or steps.
-
copyFile(source, target) source String that specifies the source file path and name. target String that specifies the target file path and name. Example This script copies the file test.txt from c:\Content into the c:\out folder. copyFile("c:\Content\test.txt","c:\out\") createTmpFile() Function that creates a file with a unique name in the temporary work folder and returns a file object. This file stores data temporarily in memory or in a buffer.
-
writer.newLine(); } } finally{ // Close the writer of the temporary file writer.close(); } } finally{ // Close the reader reader.close(); } deleteFile(data.filename); tmpFile.move(data.filename); createHTTPRequest() Function that creates a new ScriptableHTTPRequest object, in order to issue REST/AJAX calls to external servers.
-
deleteFile(filename) filename String that specifies the path and file name of the file to be deleted. Examples 1. Deleting a file in a local folder: deleteFile("c:\Content\test.txt"); 2. Deleting the sample data file used in the DataMapper: deleteFile(data.filename); execute() Function that calls an external program and waits for it to end. execute(command) Calls an external program and waits for it to end. command String that specifies the path and file name of the program to execute.
-
size Integer that represents the number of elements in the new array. newDoubleArray() Function that returns a new double array. newDoubleArray(size) Returns a new Double array of the specified number of elements. size Integer that represents the number of elements in the new array. newFloatArray() Function that returns a new float array. newFloatArray(size) Returns a new Float array of the specified number of elements. size Integer that represents the number of elements in the new array.
-
newLongArray(size) Returns a new Long array of the specified number of elements. size Integer that represents the number of elements in the new array. newStringArray() Function that returns a new string array. newStringArray(size) Returns a new String array of the specified number of elements. size Integer that represents the number of elements in the new array. openBinaryReader() Function that opens a file as a binary file for reading purposes. The function returns a BinaryReader object.
-
openTextReader() Function that opens a file as a text file for reading purposes. The function returns a TextReader object. Please note that the temporary file must be closed at the end. openTextReader(filename,encoding) filename String that represents the name of the file to open. encoding String that specifies the encoding of the file to read (UTF-8, ISO-8859-1, etc.). Example In the following example, the openTextReader() function is used to open the actual data sample file in the Data Mapper for reading.
-
encoding String specifying the encoding to use (UTF-8, ISO-8859-1, etc.).. append Boolean parameter that specifies whether the file pointer should initially be positioned at the end of the existing file (append mode) or at the beginning of the file (overwrite mode). Example In the following example, the openTextWriter function is used to open the newly created temporary file for writing: var var var var fileIn = openTextReader(data.filename); tmp = createTmpFile(); fileOut = openTextWriter(tmp.
-
The Designer The Designer is a WYSIWYG (what you see is what you get) editor that lets you create templates for various output channels: Print, Email and Web. A template may contain designs for multiple output channels: a letter intended for print and an e-mail variant of the same message, for example. Content, like the body of the message or letter, can be shared across these contexts. Templates are personalized using scripts and variable data extracted via the DataMapper.
-
2. Fill the template Add text, images and other elements to the template and style them. See "Content elements" on page 407 and "Styling and formatting" on page 488. 3. Personalize the content Personalize the content using variable data. See "Personalizing Content" on page 522. 4. Generate output Adjust the settings, test the template and generate output: letters, emails, and/or web pages. See "Generating output" on page 858. 5. What's next Use Workflow to automate your customer communications.
-
"Snippets" on page 486. Snippets help share content between contexts, or insert content conditionally. "Styling and formatting" on page 488. Make your Designer templates look pretty and give them the same look and feel with style sheets. "Personalizing Content" on page 522. Personalize your customer communications using variable data. "Writing your own scripts" on page 552. Scripting can take personalization much further. Learn how to script via this topic. "Generating output" on page 858.
-
After creating a template you can add the other contexts (see "Contexts" on page 293), as well as extra sections (see "Sections" on page 294), to the template. It is, however, not possible to use a Template Wizard when adding a context or section to an existing template. Tip If an Email context is going to be part of the template, it is recommended to start with an Email Template Wizard; see "Creating an Email template with a Wizard" on page 335.
-
Select a file to put its name in the File name field. Then set Save as type to Template files (*.OLtemplate) and save the template. When more than one resource (template or data mapping configuration) is open and the Designer software is closed, the Save Resources dialog appears. This dialog displays a list of all open resources with their names and file location. Selected resources will be saved, deselected resources will have all their changes since they were last saved dismissed.
-
File properties On the menu, select File > Properties to view and complement the file properties. See File Properties. The file properties can also be used in scripts; see "template" on page 853. If you are not familiar with writing scripts, refer to "Writing your own scripts" on page 552.
-
l A data mapping configuration that provides the variable data. You could use the data mapping configuration made for the standard template report, or create another one in the DataMapper module, using the standard XML template report as data sample. Data mapping configurations have the extension .OL-DATAMAPPER. The following zip file contains both the template and data mapping configuration that are used to generate the standard template report: http://help.objectiflune.com/en/archive/reporttemplate.zip.
-
configuration file in the Browse dialog, and each of them is sent to Workflow (or added to a package file). A Data Mapping Configuration file has the extension .OL-datamapper. 4. Use the drop-down to select a Job Creation Preset to send. Click Browse to select a preset that is not in the default location for presets. A Job Creation Preset file has the extension .OL-jobpreset. 5. Use the drop-down to select an Output Creation Preset.
-
1. l l In the Welcome screen that appears after startup, choose Browse Template Wizards. Scroll down until you see the Foundation Web Page Starter Template Wizards. Alternatively, on the File menu, click New, expand the Template folder, and then expand the Foundation Web Page Starter folder. 2. Select a template.
-
l Primary: links on the page. l Secondary: secondary links on the page. l Text: text on the page contained in paragraphs (
). l Headings: all headings (
through ) including the heading section's subhead. 4. Click Finish to create the template. The Wizard creates: l l l l A Web context with one web page template (also called a section) in it.
-
Use the Styles pane next to the Attributes pane to see which styles are applied to the currently selected element. Tip Click the Edges button on the toolbar to make borders of elements visible on the Design tab. The borders will not be visible on the Preview tab. Web Template Wizards Foundation All Web Template Wizards in Connect Designer make use of the Zurb Foundation front-end framework. A front-end framework is a collection of HTML, CSS, and JavaScript files to build upon.
-
Blank web page The Blank Web Page template is a very simple Foundation template that contains a top bar menu and some basic contents to get you started. Capture OnTheGo template wizards With the Designer you can create Capture OnTheGo (COTG) templates. COTG templates are used to generate forms for the Capture OnTheGo mobile application. For more information about this application, see the website: Capture OnTheGo.
-
Creating a COTG template using a Wizard To create a COTG template with a Template Wizard: 1. l l In the Welcome screen that appears after startup and when you click the Home icon at the top right, choose Browse Template Wizards. Scroll down until you see the Capture OnTheGo Starter Template Wizards. Alternatively, on the File menu, click New, expand the Template folder, and then expand the Capture OnTheGo Starter folder. 2. Select a template.
-
l l l Submit URL: enter the URL where the form data should be sent. The URL should be a server-side script that can accept COTG Form data. The Title and the Logo that you choose will be displayed at the top of the Form. Colors: Click the colored square to open the Color Picker dialog (see "Color Picker" on page 593) and pick a color, or enter a valid hexadecimal color code (see w3school's color picker) for the page background color.
-
The method of a Capture OnTheGo form should be POST to ensure that it doesn't hit a data limit when submitting the form. The GET method adds the data to the URL, and the length of a URL is limited to 2048 characters. Especially forms containing one or more Camera inputs may produce a voluminous data stream that doesn't fit in the URL. GET also leaves data trails in log files, which raises privacy concerns. Therefore POST is the preferred method to use.
-
Tip Click the Edges button on the toolbar to make borders of elements visible on the Design tab. The borders will not be visible on the Preview tab. Resources This page clarifies the difference between Internal, External and Web resources that may be used in a template, and explains how to refer to them in HTML and in scripts. Internal resources Internal resources are files that are added to and saved with the template.
-
Note When referring to images or fonts from a CSS file, you need to remember that the current path is css/, meaning you can't just call images/image.jpg. Use a relative path, for example: #header { background-image: url('../images/image.jpg'); } External resources External resources are not stored in the template, but on the local hard drive or on a network drive. They are accessed using a path. The path must have forward slashes, for example
PAGE 293
l l "Static Resources", as set in the preferences, are accessed using the resource path, by default something like http://servername:8080/_iRes/images/image.jpg. (For guidance on setting the preferences, search for 'HTTP Server Input 2' in the PlanetPress Workflow help files on OL Help). Resources can also be served by processes: http://servername:8080/my_ process?filename=image.jpg (assuming "my_process" is the action in the HTTP Server Input).
-
If present in the same template, a Print context and a Web context can be attached to an Email context. Outputting other combinations of contexts, and selecting sections based on a value in the data, can be done via a Control Script; see "Control Scripts" on page 570. Adding a context To add a context, right-click the Contexts folder on the Resources pane and click New print context, New email context or New web context. Only one context of each type can be present in a template.
-
Tip If an Email context is going to be part of the template, it is recommended to start with an Email Template Wizard; see "Creating an Email template with a Wizard" on page 335. After creating a template, contexts can be added to it, but that can not be done with a wizard. Editing a section To open a section, expand the Contexts folder on the Resources pane, expand the respective context (Print, Email or Web) and double-click a section to open it.
-
Warning No backup files are maintained in the template. The only way to recover a deleted section, is to click Undo on the Edit menu, until the deleted section is restored. After closing and reopening the template it is no longer possible to restore the deleted context this way. Renaming a section To rename a section: l On the Resources pane, expand the Contexts folder, expand the folder of the respective context, right-click the name of the section, and then click Rename.
-
1. Click and hold the mouse button on the style sheet on the Resources pane. 2. Move the mouse cursor within the Resources pane to the section to which the style sheet should be applied. 3. Release the mouse button. Using the Includes dialog 1. On the Resources pane, right-click the section, then click Includes. 2. From the File types dropdown, select Stylesheets. 3. Choose which CSS files should be applied to this section. The available files are listed at the left.
-
In email and web output, only one section can be executed at a time. The section that will be output is the section that has been set as the 'default'. See "Generating Web output" on page 884 and "Web pages" on page 357 and "Generating Email output" on page 875 and "Email templates" on page 340. The 'default' section is always executed when the template is run using the Create Email Content task in Workflow (see Workflow Help: Create Email Content).
-
Pages Unlike emails and web pages, Print sections can contain multiple pages. Pages are naturally limited by their size and margins. If the content of a section doesn't fit on one page, the overflow goes to the next page. This happens automatically, based on the section's page size and margins; see "Page settings: size, margins and bleed" on page 315.
-
section on top. To open the Preview tab, click it at the bottom of the Workspace or select View > Preview View on the menu. The Media will not be printed, unless this is specifically requested through the printer settings in the Print Wizard; see "Generating Print output" on page 861. See "Media" on page 325 for further explanation about how to add Media and how to apply them to different pages.
-
Tip Use the Outline pane at the left to see which elements are present in the template and to select an element. Use the Attributes pane at the right to see the current element's ID, class and some other properties. Use the Styles pane next to the Attributes pane to see which styles are applied to the currently selected element. Print Template Wizards There are three Print Template wizards: one for a formal letter, one for a postcard and one for a Print template based on a PDF that you provide.
-
The Wizard opens the Print section, so that you can fill it with text and other elements; see "Content elements" on page 407. It already has two Positoned Boxes on it: one on the front, for text, and one on the back, for the address. See "Print context" on page 304 and "Print sections" on page 307 for more information about Print templates. Formal letter The Formal Letter Wizard first lets you select the page settings, see "Page settings: size, margins and bleed" on page 315.
-
l l One Media. You can see this on the Resources pane: expand the Media folder. Media 1 is the Virtual Stationery that you have selected in the Wizard. It is applied to all pages in the Print section, as can be seen in the Sheet Configuration dialog. (To open this dialog, expand the Contexts folder on the Resources pane; expand the Print folder and rightclick "Section 1"; then select Sheet Configuration.) See "Media" on page 325. Selectors for variable data, for example: @Recipient@.
-
When you click Finish, the Wizard creates: l l l A Print context with one section in it; see "Print context" below and "Print sections" on page 307. The selected PDF is used as the background of the Print section; see "Using a PDF file as background image" on page 311. For each page in the PDF one page is created in the Print section. One empty Master Page.
-
l l The Print context is created and one Print section is added to it. You can see this on the Resources pane: expand the Contexts folder, and then expand the Print folder. The Print context can contain multiple sections: a covering letter and a policy, for example, or one section that is meant to be attached to an email as a PDF file and another one that is going to be printed out on paper.
-
Print settings in the Print context and sections The following settings in the Print context and Print sections have an impact on how the Print context is printed. Arranging and selecting sections The Print context can contain one or more Print sections. When generating output from the Print context, each of the Print sections is added to the output document, one after the other in sequence, for each record. The sections are added to the output in the order in which they appear on the Resources pane.
-
To set the binding style of a Print section, see "Setting the binding style for a Print section" on page 313. Overriding binding styles in a job creation preset A Job Creation Preset can override the binding styles set for the Print sections and for the Print context as a whole. To bind output in another way than defined in the template’s settings: 1.
-
Using headers, footers, tear-offs and repeated elements In Print sections, there are often elements that need to be repeated across pages, like headers, footers and logos. In addition, some elements should appear on each first page, or only on pages in between the first and the last page, or only on the last page. Examples are a different header on the first page, and a tear-off slip that should show up on the last page. This is what Master Pages are used for.
-
to be printed out on paper. When a Print template is created (see "Creating a Print template with a Wizard" on page 300 and "Print context" on page 304), only one Print section is added to it, but you can add as many print sections as you need. To add a section to a context: l On the Resources pane, expand the Contexts folder, right-click the Print context , and then click New section.
-
Warning No backup files are maintained in the template. The only way to recover a deleted section, is to click Undo on the Edit menu, until the deleted section is restored. After closing and reopening the template it is no longer possible to restore the deleted context this way. Arranging Print sections When generating output from the Print context, each of the Print sections is added to the output document, one after the other in sequence, for each record.
-
1. On the Resources pane, right-click the section, then click Includes. 2. From the File types dropdown, select Stylesheets. 3. Choose which CSS files should be applied to this section. The available files are listed at the left. Use the arrow buttons to move the files that should be included to the list at the right. You can also change the order in which the CSS files are read. Note that moving a style sheet up in the list gives it less weight.
-
is: file:///. Note: if the host is "localhost", it can be omitted, resulting in file:///, for example: file:///c:/resources/images/image.jpg. Check the option Save with template to insert the image into the Images folder on the Resources pane. l Url allows you to choose an image from a specific web address. Select the protocol (http or https), and then enter the web address (for example, http://www.mysite.com/images/image.jpg).
-
Note To set the background of a section in script, you need a Control Script; see "Control Scripts" on page 570 and "Control Script API" on page 841. Setting the binding style for a Print section In printing, Finishing is the binding style, or the way pages are bound together. Each Print section can have its own Finishing settings, as well as the Print context as a whole; see "Setting the binding style for the Print context" on page 306. To set the binding style of a Print section: 1.
-
Note Your printer must support duplex for this option to work. To enable duplex printing: 1. On the Resources pane, expand the Print context, right-click the print section and click Sheet configuration. 2. Check Duplex to enable content to be printed on the back of each sheet. 3. When duplex printing is enabled, further options become available. l l l Check Tumble to duplex pages as in a calendar.
-
Each page in a print section has a natural position: it is the first page, the last page, a 'middle' page (a page between the first and the last page) or a single page. For each of those positions, a different Master Page and Media can be set. A Master Page functions as a page's background, with for example a header and footer. A Media represents preprinted paper that a page can be printed on. See "Master Pages" on page 322 and "Media" on page 325.
-
Margins define where your text flow will go. Static elements can go everywhere on a page, that is to say, within the printable space on a page that depends on the printer. The bleed is the printable space around a page. It can be used on some printers to ensure that no unprinted edges occur in the final trimmed document. Note: Printers that can’t print a bleed, will misinterpret this setting. Set the bleed to zero to avoid this. Tip By default, measurements settings are in inches (in).
-
l Do not place the promotional image or snippet inside an absolute positioned box. Whitespacing only works for elements that are part of the text flow, not for absolute-positioned boxes. 3. Select the image or the element that holds the promotional content: click it, or use the breadcrumbs, or select it on the Outline tab; see "Selecting an element" on page 411. 4. On the Attributes pane, check the option Whitespace element. 5. (Optional.
-
l l Sheet number: The current sheet number in the document. A sheet is a physical piece of paper, with two sides (or pages). This is equivalent to half the page number, for example if there are 10 pages, there will be 5 sheets. Sheet count: This marker is replaced by the total number of sheets in the document, whether or not they have contents. Note When a marker is inserted, a class is added to the element in which the marker is inserted. Do not delete that class.
-
3. Use the Format drop-down to select uppercase or lowercase letters or Roman numerals instead of Arabic numerals. 4. In Leading Zeros, type zeros to indicate how many digits the page numbers should have. Any page number that has fewer digits will be preceded by leading zeros. 5. Type the Number prefix. Optionally, check Add Prefix to Page Counts, to add the prefix to the total number of pages, too. 6. Close the dialog.
-
1. Open the style sheet for the Print context: on the Resources pane, expand the Styles folder and double-click context_print_styles.css. 2. Add a CSS rule, like the following: p { widows: 4; orphans: 3 } Per paragraph To change the widow or orphan setting for one paragraph only: 1. Select the paragraph, using the breadcrumbs or the Outline pane (next to the Resources pane). 2. Select Format > Paragraph, on the menu. 3.
-
Inserting a page break To insert a page break before or after a certain element, set the page-break-before property or the page-break-after property of that element (a paragraph for example; see also "Styling text and paragraphs" on page 498): 1. Select the element (see "Selecting an element" on page 411). 2. On the Format menu select the respective element to open the Formatting dialog. 3. In the Breaks group, set the before or after property.
-
Master Pages In Print sections, there are often elements that need to be repeated across pages, like headers, footers and logos. In addition, some elements should appear only on specific pages, such as only the first page, or the last page, or only on pages in-between. Examples are a different header on the first page, and a tear-off slip that shows up on the last page. This is what Master Pages are used for. Master Pages can only be used in the Print context (see "Print context" on page 304).
-
the next page. l Click OK. Initially, the master page that has been created together with the Print context will be applied to all pages in the Print section. After adding more Master Pages, different Master Pages can be applied to different pages; see "Applying a Master Page to a page in a Print section" on the facing page. Editing a Master Page Master Pages are edited just like sections, in the workspace.
-
the Master Page itself; in Master Pages, elements can go everywhere on the page. Instead, the header and footer of the Master Page limit the text flow on pages in the Print sections to which this Master Page is applied. Pages in a Print section that use this Master Page cannot display content in the space that is reserved by the Master Page for the header and footer, so that content in the Print section does not collide with the content of the header and footer.
-
Page on the last backside of a section if that page is empty and to skip that page from the page count. 5. Optionally, decide which Media should be linked to each sheet. 6. Click OK to save the settings and close the dialog. Deleting a Master Page To delete a Master Page, expand the Master pages folder on the Resources pane, right-click the master page, and click Delete. Note that one Master Page as well as one Media must always exist in a Print template. Just leave it empty if you don't need it.
-
Specifying and positioning Media Specifying a PDF for the front: the fast way To quickly select a PDF file for the front of a Media, import the PDF file by dragging it from the Windows Explorer to the Images folder on the Resources pane. Then drag that the PDF file from the Images folder and drop it on one of the Media in the Media folder. With this method you can not set any options.
-
l Url allows you to choose an image from a specific web address. Select the protocol (http or https), and then enter the web address (for example, http://www.mysite.com/images/image.jpg). Note It is not possible to use a remotely stored PDF file as virtual stationery, because the number of pages in a PDF file can not be determined via the http and http protocols. Therefor, with an external image, the option Save with template is always checked. 2. Select a PDF file. 3.
-
l l l l l Front Coating: The pre-process coating applied to the front surface of the media, such as Glossy, High Gloss, Matte, Satin, etc. Back Coating: The pre-process coating applied to the back surface of the media. Texture: The intended texture of the media, such as Antique, Calenared, Linen, Stipple or Vellum. Grade: The intended grade of the media, such as Gloss-coated paper, Uncoated white paper, etc.
-
4. Decide which Media should be linked to each sheet position: click the downward pointing arrow after Media and select a Media. 5. Optionally, decide which Master Page should be linked to each sheet; see "Master Pages" on page 322. Note When both Media and a Master Page are used on a certain page, they will both be displayed on the Preview tab of the workspace, the Master Page being 'in front' of the Media and the Print section on top.
-
This script changes the media to Media 2 for male customers. See "Writing your own scripts" on page 552 if you are not familiar with how scripts are written. 5. Click Apply, open the tab Preview and browse through the records to see if the script functions as expected. 6. When you click OK, the script will be added to the Scripts pane. Printing virtual stationery Media are not printed, unless you want them to. Printing the virtual stationery is one of the settings in a Job Creation Preset.
-
Only one Email section is created at the start, but you can add as many Email sections as you need; see "Email templates" on page 340. However, when the Designer merges a data set to generate output from the Email context, it can merge only one of the templates with each record; see "Generating Email output" on page 875. Email templates are personalized just like any other template; see "Variable Data" on page 534.
-
HTML email challenges Creating HTML email isn't like designing for the Web. That's because email clients aren't like web browsers. Email clients pass HTML email through a preprocessor to remove anything that could be dangerous, introduce privacy concerns or cause the email client to behave unexpectedly. This includes removing javascript, object and embed tags, and unrecognized tags.
-
Emmet Emmet is a plugin that enables the lightning-fast creation of HTML code though the use of a simple and effective shortcut language. The Emmet functionality is available in the HTML and CSS source editors of Connect Designer. Emmet transforms abbreviations for HTML elements and CSS properties to the respective source code. The expansion of abbreviations is invoked with the Tab key. In the Source tab of the Workspace, you could for example type div.row.
-
Designer. When generating output from the Email context, the Designer converts all CSS rules that apply to the content of the email to inline style tags, as if local formatting was applied. Using images in email campaigns: tips Host images on a public server In the Designer you can add images as resource to the template document. When used in email messages these images are automatically embedded on sending the email. These embedded images appear instantly when viewing the message in your email client.
-
Creating an Email template with a Wizard With the Designer you can design Email templates as well as PDF attachments. PDF attachments are designed in the Print context; see "Print context" on page 304. It is strongly recommended to start creating an Email template with a Wizard, because designing HTML email that displays properly on a variety of devices and screen sizes is challenging.
-
2. Select a template and click Next. If you don't know what template to choose, see below; the characteristics of each kind of template are described further down in this topic. 3. Make adjustments to the initial settings (the options for each type of template are listed below). Click Next to go to the next settings page if there is one. 4. Click Finish to create the template. The Wizard creates: l l l An Email context with one section in it.
-
Note that the contents of the email are arranged in tables. The many tables in an Email template ensure that the email looks good on virtually any email client, device and screen size. As the tables have no borders, they are initially invisible. Tip Click the Edges button on the toolbar to make borders of elements visible on the Design tab. The borders will not be visible on the Preview tab.
-
Banded emails do. The Banded Email Action Template is a simple call-to-action email with a message, header and a button linking to a website, such as an informational or landing page. The Banded Email Invoice Template is an invoice with an optional Welcome message and Pay Now button. Settings For a Blank email you can not specify any settings in the Wizard. For an Action or Invoice email, the Email Template Wizard lets you choose: l l l l The subject.
-
When an Email template is created (see "Creating an Email template with a Wizard" on page 335) or when an Email context is added to a template (see "Adding a context" on page 294) the following happens: l l The Email context is created and one Email section is added to it. You can see this on the Resources pane: expand the Contexts folder, and then expand the Email folder. See "Email templates" on the facing page to learn how to fill an Email section.
-
See "Email attachments" on page 350. Email output settings The following settings in an Email context influence how the Email output is generated. Compressing PDF attachments For PDF attachments, generated from the Print context, you can set the Print Context Image Compression to determine the quality of the files, and with that, the size of the files. To set the Print Context Image Compression: 1. On the Resources pane, expand the Contexts folder, and right-click the Email context. 2. Click Properties. 3.
-
In Email templates, many content elements can be used; see "Content elements" on page 407. However, special attention must be paid to the way elements are positioned. In Email sections, it is advisable to position elements using Tables and to put text in table cells. Email templates are personalized just like any other template; see "Variable Data" on page 534.
-
l On the Resources pane, expand the Contexts folder, expand the Email context, rightclick the name of the section, and then click Delete. Warning No backup files are maintained in the template. The only way to recover a deleted section, is to click Undo on the Edit menu, until the deleted section is restored. After closing and reopening the template it is no longer possible to restore the deleted context this way.
-
1. On the Resources pane, right-click the section, then click Includes. 2. From the File types dropdown, select Stylesheets. 3. Choose which CSS files should be applied to this section. The available files are listed at the left. Use the arrow buttons to move the files that should be included to the list at the right. You can also change the order in which the CSS files are read. Note that moving a style sheet up in the list gives it less weight.
-
The default Email SMTP settings and the sender's name and address are defined in the Connect Designer preferences. They can be adjusted per run in the Send Email and Send Test Email dialogs. The subject, the recipients (To, Cc and Bcc), the sender and the Reply to address can be entered in the Email Fields at the top of the workspace. If the fields are not visible, click the words 'Email Fields' (or the small plus before them) to expand the Email Fields area.
-
The language in which the script has to be written is JavaScript. For more information on writing scripts, see "Writing your own scripts" on page 552. Other header fields At some point you may need to define a header field that isn't available in the Preferences or in the Email Fields. This can be done in a Control Script. For a few examples of such scripts, see "Adding custom ESP handling instructions" on page 880. To get started with Control Scripts, refer to "Control Scripts" on page 570.
-
Note When updating the software from a version prior to version 1.5, pre-existing presets will be maintained in the new version. In the "Send Email" on page 644 and "Send Test Email" on page 646 dialogs you will be able to choose one of the presets and adjust the settings to your needs. Subject To specify a subject for an email template: 1. Open the email section and expand the Email Fields by clicking Email Fields at the top of the section. 2. Type the subject in the Subject field.
-
Subject scripts made with earlier versions of the software are not specific to one email section. Writing a custom Subject script The default script replaces all @field@ placeholders in the subject line with field values. This script can be modified, for example to create a subject that depends on the value of a data field. Open the Script Wizard (see "Using the Email Script Wizard" on page 344), click the Expand button and modify the script.
-
Sender From address A default From name and email address can be specified in the Preferences dialog: select Window > Preferences, expand the Email preferences and click General. This name and email address will appear as the default in the "Send Email" on page 644 and "Send Test Email" on page 646 dialogs. The default can be overwritten by typing an email address directly in the From field (as long as no script is present for this field).
-
Alternatively, you can drag and drop one data field into the field, or use the Email Script wizard (see "Using the Email Script Wizard" on page 344), to specify the Reply To address in a script. Email PDF password The Email PDF Password Script Wizard defines a password with which to protect the PDF generated when using the Print context as PDF Attachment option in the Send Email or Send Test Email dialogs (see "Generating Email output" on page 875).
-
Email attachments Output, generated from an Email template, can have the following attachments: l The contents of the Print context, in the form of a single PDF attachment. l The output of the Web context, as an integral HTML file. l Other files, an image or a PDF leaflet for example. Attaching the Print context and/or the Web context is one of the options in the Send (Test) Email dialog.
-
5. Write a script that appends a element to the results (the selector is head, so the results contain the
of the email). l l Make sure to set the rel attribute to related. The href attribute determines where the file comes from. For resources inside of the template, use 'images/file.extension' , or 'fonts/myfont.otf', etc. For external resources, you need the full path to the file, such as 'file:///c:/resources/attachments/instructions.pdf'.
-
The Web context outputs one HTML web page that contains the HTML text and all the resources necessary to display it. JavaScript files are added to the
in the generated HTML file. They are useful to add special features such as those offered by jQuery and its plugins, or MooTools. Style sheets are also added to the and are used just as they would be used in a regular web page.
-
Foundation All Web Template Wizards in Connect Designer make use of the Zurb Foundation front-end framework. A front-end framework is a collection of HTML, CSS, and JavaScript files to build upon. Foundation is a responsive framework: it uses CSS media queries and a mobile-first approach, so that websites built upon Foundation look good and function well on multiple devices including desktop and laptop computers, tablets, and mobile phones.
-
l l l l Set width to Grid: Check this option to limit the width of the top bar contents to the Foundation Grid, instead of using the full width of the page. Stick to the top of the browser window: Check to lock the top menu bar to the top of the page, even if the page has scroll bars. This means the menu bar will always be visible in the browser.
-
The Wizard opens the Web section, so that you can fill it with text and other elements; see "Content elements" on page 407, "Web Context" on the facing page and "Web pages" on page 357. Web pages can be personalized just like any other type of template; see "Variable Data" on page 534 and "Personalizing Content" on page 522. Tip Use the Outline pane at the left to see which elements are present in the template and to select an element.
-
important text and its "call to action" button invites a visitor to click on to more information or an order form. Contact Us The Contact Us template is a contact form that can be used on a website to receive user feedback or requests. It's great to use in conjunction with the Thank You template, which can recap the form information and thank the user for feedback. Thank You The Thank You template displays a thank you message with some text and media links.
-
are meant to be used for styles that are only applied to elements in the Web context; see "Styling and formatting" on page 488. When the template is ready, you can: l l Output the web page as an as an integral HTML file attached to an Email context in the same template. Output the Web context in an automated Workflow using the Create Web Content task (see Workflow Help: Create Web Content).
-
template, to guarantee just that; see "Creating a Web template with a Wizard" on page 352. Other approaches are described below, in "Adding a Web page" on the facing page. Adding a Web page When a Web template is created (see "Creating a Web template with a Wizard" on page 352), only one Web section is added to it. A Web context may contain various templates, but per record only one of those can be used to generate output.
-
Warning No backup files are maintained in the template. The only way to recover a deleted section, is to click Undo on the Edit menu, until the deleted section is restored. After closing and reopening the template it is no longer possible to restore the deleted context this way. Filling a Web page Many of the content elements that are available for all three contexts are particularly suitable for web pages; see "Content elements" on page 407.
-
Styling and formatting a Web page The contents of a Web section can be formatted directly, or styled with Cascading Style Sheets (CSS). See "Styling and formatting" on page 488. In order for a style sheet to be applied to a specific section, it needs to be included in that section. There are two ways to do this. Drag & drop a style sheet 1. Click and hold the mouse button on the style sheet on the Resources pane. 2.
-
l On the Resources pane, expand the Web context, right-click a section and click Set as Default. Tip Use a Control Script to dynamically select a Web section for output depending on the value of a data field. See "Control Scripts" on page 570. Including JavaScript files Which JavaScript files are included in the a Web section, depends on a setting for that section. To change this: 1. On the Resources pane, right-click a section in the Web context and click Includes. 2.
-
Tip If a valid favicon image is dragged to the Web section, it will automatically be set as a shortcut icon. 4. The Meta Information Group lists all tags that will be added to the header of the HTML file generated in the output. Click the Add button to add a new tag to the list. Then you can select the type of tag, which is either name or http-equiv, and enter the value (for a name-type meta tag) or the content (for a .
-
Tip To create a Capture OnTheGo template, preferably use a Template Wizard (see "Capture OnTheGo template wizards" on page 385). The Wizard doesn't just add the form, it also adds the necessary Capture OnTheGo form elements (see ), style sheets and JavaScript files, and extra pre-made elements. Adding a Form This procedure describes how to add a Form element to an existing Web context. 1. On the Resources pane, expand the Web context and double-click a Web page to open it. 2.
-
6. Using the next drop-down, select the form's Encryption Type (enctype): l l l application/x-www-form-urlencoded: Default. All characters are encoded before they are sent. Spaces are converted to "+" symbols, and special characters are converted to ASCII HEX values. multipart/form-data: No characters are encoded. This value is required when you are using forms that have a file upload control. text/plain: Spaces are converted to "+" symbols, but no special characters are encoded. 7.
-
11. Use the Location drop-down to select where to insert the element. l l l l l At cursor position inserts it where the cursor is located in the template. Before element inserts it before the HTML element in which the cursor is currently located. For example if the cursor is within a paragraph, the insertion point will be before the
tag.* After start tag inserts it within the current HTML element, at the beginning, just after the start tag.
-
l An Encryption Type (enctype): l l l application/x-www-form-urlencoded: Default. All characters are encoded before they are sent. Spaces are converted to "+" symbols, and special characters are converted to ASCII HEX values. multipart/form-data: No characters are encoded. This value is required when you are using forms that have a file upload control. text/plain: Spaces are converted to "+" symbols, but no special characters are encoded.
-
Browser validation you can only make a field required and set a maximum length. Changing a Form's validation in HTML In HTML, the validation method is stored in the data-validation-method attribute of the
-
Adding elements to a Form To add an element to a Form or Fieldset, click inside the Form or Fieldset, select Insert > Form elements, and choose the respective element on the menu. (When the element isn't available via the menu, see the tip below.) Now you can change the element's settings: 1. Add an ID (required) and, optionally, a class. Note The ID will be copied to the name attribute of the element. The name attribute is what identifies the field to the receiving server-side script.
-
4. The following options are only available for specific elements: l l l For a Text Area you can specify a number of rows. For a Radio Button, the submit name indicates to which Radio Button Group the Radio Button belongs. For a Button, Checkbox, Hidden Field, and Radio Button you can set the value. The value is associated with the input and will be sent on submitting the Form.
-
The name attribute of Form elements is sent to the server (together with the input value) after the form has been submitted. When adding an element to a Form or Fieldset, you cannot specify a name; the ID will be copied to the element's name attribute. After adding the element to the Form or Fieldset you can change the name on the Attributes pane. Adding new HTML5 elements HTML5 added several new input element types that can't be found in the Designer menu.
-
Grouping data using arrays A Job Data File is an XML file created by a Workflow process on submitting a Web Form or COTG Form. Grouping data in a Job Data File greatly simplifies both the Data Mapping workflow and looping over data in Designer scripts. A simple method to create arrays in that data file is to use two pairs of square brackets in the name of the form inputs. Put the name of the array between the first pair of square brackets.
-
Note To enable submitting arrays, you need to check this option in the HTTP Server user preferences in (PlanetPress or PreS) Watch. In case multiple fields with the same name are encountered the previous value is overwritten. This way only a single occurrence of that field name will we available in the data containing the value of the last encountered occurrence of that field. This behaviour is also seen in the PHP language.
-
Adding JavaScript files to the resources To add a JavaScript file to the resources: l l Right-click the Javascript folder on the Resources pane, and click New Javascript. Double-click it to open and edit it. Alternatively, drag and drop the JavaScript file from the Windows Explorer to the JavaScript folder on the Resources pane. Next, include it in a Web page; see below.
-
When async is checked, the script executes asynchronously with the rest of the page (while the page continues the parsing). When neither option is checked, the script is fetched and executed immediately, while the parsing of the page is paused. 6. Optionally, for a Capture OnTheGo Form, you can check Use cached Capture OnTheGo resource, to prevent downloading a remote JavaScript file again if it has been downloaded before.
-
Using JavaScript in other Contexts Email clients do not support JavaScript. Therefore, Email contexts cannot include JavaScript resources. When a JavaScript file is included in a Print section, the Designer itself acts as the browser. When generating Print output, it runs the JavaScript after generating the main page flow contents and the pagination. So, it is possible to change the Print output by a JavaScript; you could, for example, add a barcode that includes the page number to each document.
-
CaptureOnTheGo). A reusable COTG Form is not deleted from the app's form library when it is submitted, so it can be used again. Creating a COTG Form A Capture OnTheGo Form is actually just a Web Form, so you could add a Form element to a Web page in the Web context without the use of a Template Wizard. It is strongly recommended however, to start the COTG Template using one of the COTG Template Wizards.
-
Note For testing purposes, it is possible to use another URL for the Form's action or not to specify an action at all; see "Testing a Capture OnTheGo Template" on page 401. Filling a COTG template Before inserting elements in a COTG Form, have the design ready; see "Designing a COTG Template" on page 382. In a Capture OnTheGo form, you can use special Capture OnTheGo Form elements, such as a Signature and a Barcode Scanner element; see "COTG Elements" on page 460 and "Using COTG Elements" on page 397.
-
Tip Click the Edges button on the toolbar to make borders of elements visible on the Design tab. The borders will not be visible on the Preview tab. Using JavaScript JavaScript files, libraries and frameworks can be added to a template, to add widgets and other functionality to your Capture OnTheGo Forms; see "Using JavaScript" on page 372. For COTG templates created with a COTG Template wizard, lots of features are already available through the Foundation framework; see "Using Foundation" on page 389.
-
var value = event.detail.state["mywidget"]; value = value + $("#camera1 img").attr("src"); $("form p").html(value); }, false); With jQuery you must use event.originalEvent in the handler functions, for example: $(window).on("olcotgsavestate", function(event) { event.originalEvent.detail.state["mywidget"] = "test: "; }); Note that you should register for the event directly in the JavaScript file (a separate JavaScript file, preferably, not cotg-1.2.1.js). You should not do this on the document ready event.
-
Using COTG data in a template When a user submits a COTG Form, a Workflow configuration may store the information in a database and/or push it into other Workflows, for example to send a letter or an email receipt. To be able to use the submitted data in a template for that letter or email receipt, follow these steps: 1. Get the data First create a Data Mapping Configuration for the data that is submitted from a certain COTG Form. This means you have to get access to a sample of that data.
-
1. Choose File > New > Data mapping Wizards > From XML file. 2. Select the XML data file as its source and click Next. 3. Set the XML Elements option to /request/values. This will automatically add an extraction step for the submitted form fields. 4. Click Finish. The file is opened in the DataMapper and the form fields are automatically extracted including the data for the signature and camera object. 5. Save the Data Mapping Configuration. 3.
-
5. Right-click the empty rectangle and choose New Script... in the contextual menu. The Edit Script dialog appears. The selector of the script is automatically set to the ID of the selected element (#camera). Alternatively, you could add a new script on the Scripts pane and make sure that the Selector field is set to #camera. 6. Enter the following script code: results.attr("src", record.fields.photo); The name of the data field (in this case: photo) must be that of the Camera data in your data model.
-
l After creating a Capture OnTheGo template using a wizard, you can find more ready-made elements in the Snippets folder on the Resources pane. 3. Creating mockups. A mockup or wire frame will help you to layout the form and allows your customer to provide feedback early in the project. This will save you a lot of time: typically it is easier to change the sketch than to rework the code. In addition, mockups provide a way to do usability testing before actually creating the form.
-
Responsive design Responsive Design is "an approach to web design aimed at crafting sites to provide an optimal viewing and interaction experience - easy reading and navigation with a minimum of resizing, panning, and scrolling — across a wide range of devices". (Source: Wikipedia.). With the COTG app for Android or iOS, COTG forms can be viewed on a wide variety of mobile devices, with different screen sizes.
-
Provide touch areas that are large enough. COTG forms are used on a mobile device (in the COTG app). Make sure that the user can easily tap the form elements, hyperlinks and buttons. The index finger of most adults covers an area that is between 45 and 55 pixels wide. There should be enough white space between the form inputs so the user won't accidentally put focus on the wrong element. Visually group related information. Use headers to mark a section. This makes it easier to navigate the form.
-
Foundation All Web Template Wizards in Connect Designer make use of the Zurb Foundation front-end framework. A front-end framework is a collection of HTML, CSS, and JavaScript files to build upon. Foundation is a responsive framework: it uses CSS media queries and a mobile-first approach, so that websites built upon Foundation look good and function well on multiple devices including desktop and laptop computers, tablets, and mobile phones.
-
l l l l l l Event Registration. The Event Registration Template is a generic registration form asking for name, phone, email, etc. Event Feedback. The Event Feedback Template is a questionnaire containing different questions used to rate an experience. Membership Application. The Membership Application Template is a signed generic request form that can be used for memberships such as gyms, clubs, etc. Patient Intake.
-
l l Style sheets and JavaScript files related to the COTG form itself and others related to the Foundation framework (see above). The style sheets can be found in the Stylesheets folder on the Resources pane. The JavaScript files are located in the JavaScript folder on the Resources pane. A collection of snippets in the Snippets folder on the Resources pane. The snippets contain ready-to-use parts to build the web form. Double-click to open them.
-
Naturally, Web Form elements can also be used on COTG Forms (see "Forms" on page 466 and "Form Elements" on page 470) as well as text, images and other elements (see "Content elements" on page 407). Capture OnTheGo templates can be personalized just like any other type of template; see "Variable Data" on page 534 and "Personalizing Content" on page 522. Tip Use the Outline pane at the left to see which elements are present in the template and to select an element.
-
Capture OnTheGo and Jumbotron template wizards automatically add the Foundation files v. 5.5.1 to the resources of the template. In a future version of PlanetPress Connect, Foundation 6 will be included. If you'd rather start using the newest Foundation files right away, you have two options: l l Download the Foundation files (from http://foundation.zurb.com/sites/download.html/) and add them to the template manually. Use remote Foundation files from a CDN, such as https://cdnjs.
-
These classes can be combined, so that depending on the screen size, a Div can take more or less space in a row. Separate the class names with a space. Tip Start with the class for small screens. For example:
. Larger devices will inherit those styles (thanks to the mobile-first approach of Foundation's style sheet). Customize for larger screens as necessary.
-
To add Grid rows and columns quickly, you could also use the Grid snippets or Row snippets, found in the Snippets folder on the Resources pane after using a wizard to create a Foundation web page or a Capture OnTheGo template. For more information about Snippets, see "Snippets" on page 486. For more information about template wizards, see "Creating a Web template with a Wizard" on page 352 and "Capture OnTheGo template wizards" on page 385.
-
OnTheGo form elements. For more information about the application refer to these websites: Capture OnTheGo and Capture OnTheGo in the Resource Center. Capture OnTheGo (COTG) elements can only be added within a Form element in a Web context; see "COTG Forms" on page 375. For information about how to add and use COTG Elements, see "Using COTG Elements" on page 397. Barcode Scanner The Barcode Scanner element adds a button to trigger the device to scan a barcode.
-
device itself. l Clear: Removes any existing image data from the Camera element. To omit the Take now or Library button, edit the Camera element's properties: right-click the Camera element after adding it to the form, select Camera properties and then use the Source drop-down to select which buttons will be available: Take, Pick from library, or both.
-
How to use the captured or selected image in a template When the user has submitted the form, you may want to use the captured or selected image in a Designer template, for example in a letter or on a web page. To do this, insert a dummy image in the template, right-click it and select Dynamic Image. The Text Script Wizard appears. Under Field select the field that contains the base64-encoded string. The script puts the given string in the source (src) attribute of the image (
).
-
Geolocation The Geolocation Element adds a button to read the device's current GPS coordinates and save them in a form field. When the button is pressed, the GPS coordinates are requested and saved. When the form is submitted, the Geolocation data is sent in plain text. Image & Annotation The Image & Annotation element is meant to be used with an image that needs input from the user. When inserting an Image & Annotation element you have to select the image.
-
the locale of the device on which the user is viewing the form. A Time Element displays dates in the ISO 8601 format: HH:MM. When the form is submitted, the time data is sent as plain text. A Formatted Time element submits the time in both the ISO format mentioned above and in the format that depends on the device's regional and language settings. A Time element sends the time in the ISO format only.
-
2. Type a label, or choose No label under Style, to omit the label. (For Label elements there are no other options to be set.) 3. If applicable, choose a style for the label (for the label of a Checkbox, for example, you can't set a style). l l l l Wrap input with label places the input element inside the Label element. Attach label to input ties the label to the input element using the for attribute of the Label element.
-
All COTG elements have a role attribute. This attribute is not supposed to be edited: without the correct role attribute, the element won't function. As noted, the name attribute is what identifies the element after submitting the form. Tip Use the Outline pane at the left to see which elements are present in the template and to select an element. Use the Attributes pane at the right to see the current element's ID, class and some other properties.
-
name="company" value="Objectif Lune"> name="pinElm1[pin_0][left]" value="122"> name="pinElm1[pin_0][top]" value="253"> name="pinElm1[pin_0][type]" value="dent"> name="pinElm1[pin_1][left]" value="361"> name="pinElm1[pin_1][top]" value="341"> name="pinElm1[pin_1][type]" value="dent"> The above HTML results in the following
-
Getting the status of unchecked checkboxes and radio buttons Unchecked checkboxes and radio buttons are not submitted (as per standard HTML behavior), so how to get the state of those checkboxes and radio buttons? A common approach to get the state of unchecked checkboxes and radio buttons is to add a hidden field to the Form with the same name as the checkbox or radio button, for example: Whe
-
Tip In the Designer, you can test the responsiveness of a form using the Responsive Design button at the top right of the workspace. Some browsers also let you test the responsiveness of a form. In Firefox, for example, select Developer > Responsive Design to view a form in different sizes. Previewing a COTG Template in the app A COTG Template cannot only be previewed on a PC; it can also be previewed on a mobile device.
-
Submitting and previewing data When you hit the Submit button in a template in the Designer (on the Live tab), the submitted data can be sent back to the Designer in the form of an XML file (see below). The advantage of this is that you can immediately start creating a Data Mapping Configuration and use the data in a template. Data submitted from the Capture OnTheGo app can be sent to you in the form of an email or saved via a Workflow configuration. Both options are explained below.
-
2. Click the Get Job Data File on submit toolbar button. This replaces the default form submit action and will send the form data to the Workflow's HTTP Service (which needs to be running in the background). Note Workflow's HTTP Service must be running, but not necessarily the Workflow Service itself. 3. Hit the Submit button. Now the data file will be sent directly to the Designer. Once the Job Data File is received by the Connect server, a dialog appears asking where to store it. 4.
-
Input Dummy Value Password 1234567890 URL "http://www.localhost.com" Checkbox Checkboxes in detail tables and in the Fields Table control (time sheet) are checked. Radio button Selects the first radio button that is not disabled in each radio group. The radio group will be left untouched when there is a selected radio button. Capture On The Go input dummy data values Input Dummy Value Signat ure Receives SVG signature data and the onscreen presentation of that data.
-
Input Dummy Value cker (format ted and standa rd) Device Info widget " {"available":true,"platform":"Android","version":"9.9.9","uuid":"17206724b807749 1","cordova":"3.6.4","model":"Connect Designer"}" User Accou nt widget "user@localhost.com" Locale widget en-US * Note that the formatted date and time can be different from the values that the COTG app provides.
-
1. Select the Form (see "Selecting an element" on page 411). 2. On the Attributes pane, paste the following URL in the action field: http://learn.objectiflune.com/services/cotg-debug?__ol__auth_key={{APIKEY}}. 3. Replace {{APIKEY}} by your API Key. When you submit the form in the COTG app (see "Previewing a COTG Template in the app" on page 402), the debug service will compose an HTML email that contains the form element names and the submitted values.
-
When you add elements, such as text, images or a table, to the content of a template, you are actually constructing an HTML file. It is possible to edit the source of the HTML file directly in the Designer; see "Editing HTML" on page 409.
-
Most elements are suitable for use in all contexts. There are a few exceptions, however. Forms and Form elements can be used on web pages only, whereas Whitespace elements and Page numbers can only be used in a Print context. Positioned boxes are well suited for Print sections, but are to be avoided in the Email and Web context.
-
Attributes ID and class Every element in the content of a template can have an ID and a class. ID's and classes are particularly useful with regard to variable data (see "Personalizing Content" on page 522) and styling (see "Styling templates with CSS files" on page 490). You can specify an ID and/or class when you add the element to the content.
-
1. Click the respective toolbar button. Alternatively, click the element on the Insert menu. 2. Add an ID and/or a class. ID's and classes are particularly useful with regard to variable data (see "Personalizing Content" on page 522) and styling (see "Styling templates with CSS files" on page 490). 3. Use the Location drop-down (if available) to select where to insert the element. l l l l l At cursor position inserts it where the cursor is located in the template.
-
l Using the Breadcrumbs at the top of the workspace. Breadcrumbs show the HTML tag of the clicked element, as well as the HTML tags of 'parent elements': elements inside of which the clicked element is located. The clicked element is at the end of the line. Elements with classes or IDs show these details next to them, for instance div #contents > ol.salesitems > li. Click any of the elements in the Breadcrumbs to select that element.
-
l l Right-click the element and select the type of element on the shortcut menu. Select the element (see "Selecting an element" on page 411) and select the type of element on the Format menu. See "Styling and formatting" on page 488 for more information about the formatting options. Format elements via Cascading Style Sheets (CSS) It is highly recommended to use style sheets in templates right from the start.
-
1. Select Insert > Barcode on the menu or click the Barcode toolbar button 2. Choose the desired barcode type. The list is divided between 1d and 2d barcodes. 3. An ID is required. You can change the given ID and, optionally, add a class. 4. Check the option Absolute to insert the barcode in an absolute-positioned box inside the
of the HTML, but outside other elements. Alternatively, use the Location dropdown to select where to insert the Barcode.
-
value minus the Checksum. To include a calculated Checksum in the barcode value, edit the barcode properties after adding the barcode to the template; see below. 6. Click OK to close the dialog. In the template the barcode shows up as a gray box. The associated barcode script is added to the Scripts pane. To see the barcode script working, toggle to the Preview tab in the Workspace.
-
The barcode properties set via the properties dialog are written to the data-params attribute on the barcode element in JSON format. (To see this, select the barcode and open the document in the Source view.) Click the barcode type below for information about its properties.
-
Barcode properties This topic lists the properties of the barcode types OneCode, KIX Code, Royal Mail and Australia Post. For the properties of other barcode types, see "Barcode type and properties" on page 415. Height, width and spacing The height, width and spacing of the barcode are all measured in pixels (38 dpi).
-
Aztec Code Aztec is one of the types of barcodes that can be added to a template; see "Barcode" on page 413. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties.
-
Error Correction Level This option reserves a percentage of the symbol capacity for error correction. The recommended percentage for this type of barcode is 23. Rune When set to a value between 0 and 255, an Aztec Rune corresponding to the selected value is created. Set the Rune to -1 to disable this feature. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width.
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the barcode type on the shortcut menu. Barcode properties This topic lists the properties of the Codabar barcode. For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters.
-
Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output.
-
Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
Code 39, Code 39 extended Code 39 and Code 39 extended are two of the barcode types that can be added to a template. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties.
-
Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt). Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
l Industrial 2 of 5 l Interleaved 2 of 5 l Matrix 2 of 5 For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width.
-
l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output. Code 128 Code 128 is one of the types of barcodes that can be added to a template; see "Barcode" on page 413. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching.
-
The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the barcode type on the shortcut menu. Barcode properties This topic lists the properties of the QR barcode.
-
Preferred format Use the drop-down to select the size of the Data Matrix. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching.
-
Barcode properties This topic lists the properties of the barcode types UPC-A, UPC-E, EAN-8 and EAN-13. For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Show guardbars Checking this option adds guardbars to the barcode.
-
Note When the chosen supplement type doesn't match the data, the supplement data will be skipped and the additional barcode will not be rendered. l l Height Factor: This is the relative height of the supplement's bars compared to the normal bars. Space Before : Defines the space between the main symbol and the supplement, in cm.
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the barcode type on the shortcut menu. Barcode properties This topic lists the properties of the barcode type GS1-128. For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters.
-
Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output. OneCode, KIX Code, Royal Mail, Australia Post OneCode, KIX Code, Royal Mail and Australia Post are some of the types of barcodes that can be added to a template; see "Barcode" on page 413.
-
l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching. Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
w3school's color picker). Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching.
-
The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the barcode type on the shortcut menu.
-
character will be calculated. Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt). Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
l Code 93 extended l Industrial 2 of 5 l Interleaved 2 of 5 l Matrix 2 of 5 For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width.
-
Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output. MaxiCode MaxiCode is one of the barcode types that can be added to a template; see "Barcode" on page 413.
-
MSI MSI is one of the types of barcodes that can be added to a template; see "Barcode" on page 413. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties.
-
Checksum Type The Checksum type can be MSI10, MSI11, MSI1010 or MSI1110; see https://en.wikipedia.org/wiki/MSI_Barcode. Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt).
-
Barcode properties This topic lists the properties of the barcode types OneCode, KIX Code, Royal Mail and Australia Post. For the properties of other barcode types, see "Barcode type and properties" on page 415. Height, width and spacing The height, width and spacing of the barcode are all measured in pixels (38 dpi).
-
PDF417 PDF417 is one of the types of barcodes that can be added to a template; see "Barcode" on page 413. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties.
-
Bar height Defines the height of the bars for a single row measured in pixels drawn. Compact Check this option to use Compact PDF417 instead of the PDF417 barcode. This shortened form of the PDF417 barcode is useful where the space for the symbol is restricted. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the barcode type on the shortcut menu. Barcode properties This topic lists the properties of the barcode type Postnet. For the properties of other barcode types, see "Barcode type and properties" on page 415. Module width Specifies the width of the narrow bars in centimeters.
-
Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output. QR Code A QR Code is one of the types of barcodes that can be added to a template; see "Barcode" on page 413.
-
Encoding This option defines the encoding of the barcode. When Auto is selected, the barcode generator determines the encoding based on the supplied string. The other options are: l l Numeric: 10 bits per 3 digits, with a maximum of 7089 numerical characters. Alphanumeric: 11 bits per 2 characters, with a maximum of 4296 alphanumerical characters. l Byte: 8 bits per character, with a maximum of 2953 characters. l Kanji: 13 bits per character, with a maximum of 1817 characters.
-
l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching. Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Barcode properties This topic lists the properties of the barcode types OneCode, KIX Code, Royal Mail and Australia Post. For the properties of other barcode types, see "Barcode type and properties" on page 415. Height, width and spacing The height, width and spacing of the barcode are all measured in pixels (38 dpi).
-
Royal Mail Mailmark Royal Mail Mailmark is one of the types of barcodes that can be added to a template; see "Barcode" on page 413. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 413. Initially the barcode will have the barcode type's default properties.
-
Color The Color property allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. l Proportionally: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching. Supplement UPC-A, UPC-E, EAN-13, and EAN-8 may all include an additional barcode to the right of the main barcode.
-
w3school's color picker). Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is smaller in size, but not compatible with Email output. PNG: Binary rasterized format. This is slightly larger than SVG but will display properly in Email output. Boxes Boxes are elements that are used to surround other elements, either to style them, to find them, or to place them in specific locations.
-
Moving and resizing a Positioned Box Positioned Boxes can be moved by dragging the borders, and resized using the handles on the sides and the corners. Alternatively the size and position can be set on the Attributes pane. Note that the size and offset values will be displayed in the default print units as defined in the preferences.
-
Inline Box An Inline Box is one that is placed within the text flow, where other elements (including text) can wrap around it. An inline box is actually a
element that is floating; in other words, it has its CSS property float set to left, right or no float. Inline Boxes can be used in Print context and in Web pages. It is common to do entire web layouts using the float property. In Email templates, it is best to use Tables to position elements.
-
To wrap content in a span, select the text and other inline elements and click Insert > Wrap in Span on the menu. Give the span an ID, if you are going to add a style rule or script for it that is unique to this span; or give the span a class, if this span can be targeted by a style or script along with other pieces of content. Now you can use the wrapper's ID or class as a script's or style's selector; see "Using the Text Script Wizard" on page 537 and "Styling and formatting" on page 488.
-
1. Place the cursor where the graphic should be added. 2. Click the toolbar button of the type of chart you want to add, or select Insert > Business graphic and choose the chart type. 3. An ID is required. You can change the given ID and, optionally, add a class. 4. Use the Location drop-down to select where to insert the graphic: l l l l l At cursor position inserts it where the cursor is located in the template.
-
With the options to fill a chart dynamically you also have to select a detail table and a (row) label: a data field of which the value appears near the parts in a pie chart or under the bars or points of the line in a bar chart or line chart. The label is also used for the legend. Note that initially the legend is not visible. To make it visible, check the option Show legend in the chart's properties (see "Business graphic properties" below). 6.
-
COTG Elements With the Designer you can create Capture OnTheGo templates. COTG templates are used to generate forms for the Capture OnTheGo mobile application. This topic is about Capture OnTheGo form elements. For more information about the application refer to these websites: Capture OnTheGo and Capture OnTheGo in the Resource Center. Capture OnTheGo (COTG) elements can only be added within a Form element in a Web context; see "COTG Forms" on page 375.
-
l l Library: Opens the device's default library or gallery application to select a single image that is then saved in the form data. The accessible images and navigation depend on the device itself. Clear: Removes any existing image data from the Camera element.
-
l Scale Image: Check this option to enable image scaling. Then set the maximum width and height of images before they are sent to the server. Note that only the smallest of these is applied and the size ratio is always maintained. How to use the captured or selected image in a template When the user has submitted the form, you may want to use the captured or selected image in a Designer template, for example in a letter or on a web page.
-
you need. The user can click (or rather, touch) the Add button to add a row to the table. The new row will contain the same elements as the first row. The names of all elements in the first row will be extended with __0, while the names of the elements in the second row will be extended with __1, etc. Geolocation The Geolocation Element adds a button to read the device's current GPS coordinates and save them in a form field. When the button is pressed, the GPS coordinates are requested and saved.
-
Time and Formatted Time The Time element and the Formatted Time element display the current time on the device when the form is first opened. When the element is touched, a time selector appears so the user can modify this time. The Formatted Time element displays times in a format that depends on the locale of the device on which the user is viewing the form. A Time Element displays dates in the ISO 8601 format: HH:MM. When the form is submitted, the time data is sent as plain text.
-
Tip If you are looking to add a date, originating from a record set, to a template, see: "Variable Data" on page 534. To insert a date you could use either the drag and drop method or the Text Script Wizard, however the latter lets you set the date/time format. Changing the date Once inserted, a date can be modified directly in the template (if it does not update automatically) or through the date script (if it does update automatically). To modify the date in the script: 1.
-
Forms Web templates can contain Forms. Capture OnTheGo templates always contain a Form. Tip To create a Capture OnTheGo template, preferably use a Template Wizard (see "Capture OnTheGo template wizards" on page 385). The Wizard doesn't just add the form, it also adds the necessary Capture OnTheGo form elements (see ), style sheets and JavaScript files, and extra pre-made elements. Adding a Form This procedure describes how to add a Form element to an existing Web context. 1.
-
5. Using the the Method drop-down, select whether the form should be sent using the GET or POST method. 6. Using the next drop-down, select the form's Encryption Type (enctype): l l l application/x-www-form-urlencoded: Default. All characters are encoded before they are sent. Spaces are converted to "+" symbols, and special characters are converted to ASCII HEX values. multipart/form-data: No characters are encoded. This value is required when you are using forms that have a file upload control.
-
11. Use the Location drop-down to select where to insert the element. l l l l l At cursor position inserts it where the cursor is located in the template. Before element inserts it before the HTML element in which the cursor is currently located. For example if the cursor is within a paragraph, the insertion point will be before the
tag.* After start tag inserts it within the current HTML element, at the beginning, just after the start tag.
-
l An Encryption Type (enctype): l l l application/x-www-form-urlencoded: Default. All characters are encoded before they are sent. Spaces are converted to "+" symbols, and special characters are converted to ASCII HEX values. multipart/form-data: No characters are encoded. This value is required when you are using forms that have a file upload control. text/plain: Spaces are converted to "+" symbols, but no special characters are encoded.
-
Browser validation you can only make a field required and set a maximum length. Changing a Form's validation in HTML In HTML, the validation method is stored in the data-validation-method attribute of the
-
Fieldset A fieldset is a group of related elements in a form. The elements don't have to be of the same type. After inserting and selecting the Fieldset (see "Selecting an element" on page 411) you can add elements to it in the same way you add elements to a Form; see "Adding elements to a Form" on page 367. Text The Text element is a simple element with the type text. It accepts any alphanumerical characters, including special characters.
-
Hidden field A hidden field can contain specific data used by the server-side script. It is not visible to the user. When adding a Hidden Field you can set the value that will be sent on submit. Label A Label element is a text displaying informative text within the form. Labels are non-interactive. Note that this type of label is not tied to an input element. At the same time you add an input element, you can add a label to that element; see "Adding elements to a Form" on page 367.
-
If a Radio Button is not checked, no information is sent when the form is submitted. Fortunately, there is a workaround to submit the status of the unchecked radio button, see "Using Form Elements" on page 367. The submit name of a Radio Button indicates to which Radio Button Group the Radio Button belongs. Select A Select element is a drop-down list with multiple entries from which the user can select only one option.
-
Hyperlink and mailto link Links can be added to any template but they only work in electronic output (web pages, email and PDF files). They can be a regular hyperlink pointing to a web page or a mailto link that will open the default email client when clicked. HTML element: a When you add elements, such as text, images or a table, to the content of a template, you are actually constructing an HTML file.
-
Target: use the drop-down or type in the target for the link.When the target is _ blank the link will open in a new browser window or tab. For a mailto link: l l l Email: enter a valid email address that appears by default in the To: field of the email client. Subject: type a default subject that appears in the Subject: field of the email client. Message: type a message that appears by default in the Message field of the email client.
-
Tip Using images in an Email template? See "Using images in email campaigns: tips" on page 334. Dynamic images Images can be switched dynamically, so that a letter, email or web page can include one image or another, depending on a value in the data set. Read "Dynamic Images" on page 545 to find out how to add such switching images. Background images Several parts of templates, such as sections and media, and elements such as positioned boxes, can have a background image.
-
In the section's source file, images are
elements. The
tag has at least four attributes: src, alt, width and height. src specifies the URL of the image. alt contains the alternate text; see "Setting an alternate text" on page 479. The value of the attributes can be changed via a script; see "Attributes" on page 409. Adding images Imported or external images In templates, both imported images and external images can be used. Imported images are images that are saved within the template file.
-
Via the Select Image dialog To either import an image into a template or use an external image in a template, the Select Image dialog can be used: 1. Position the cursor in the content where you want the image to be inserted. 2. On the Insert menu, click Image. Or, click the Insert Image button on the toolbar. The Select Image dialog appears. 3. Click Resources, Disk or Url, depending on where the image is located.
-
For an explanation of how to do this, see "Optimizing a template" on page 859. Styling an image Images can be resized using the handles on the sides and the corners, or via the Image Formatting dialog, which opens when you right-click the image and select Image..., or select the Format > Image menu item. Images can be styled using the same dialog, or through the CSS files; see "Styling templates with CSS files" on page 490.
-
Note When CSS repeating gradients are displayed in a PDF reader, artifacts, like very thin lines may occur. When this happens, try setting the gradient's position a little bit different. Table Tables serve two different purposes: they are a way to display data in a tabular format, and they are also a way to position elements on a page. In HTML email, Tables are the most reliable way to position text and images; see "Designing an Email template" on page 331.
-
Inserting a Table 1. On the toolbar, click the Insert table button, or on the menu select Insert > Table > Standard. 2. Enter the table's desired attributes: l l ID: a unique identifier for the table. IDs are used to access the Table from scripts and as CSS selectors for style rules. Class: A class identifier for the table. Classes can be shared between elements and are used to access the table from scripts and as CSS selectors for style rules.
-
Note Tables on a Master Page have to have an absolute position, unless they are located inside another element with an absolute position. 4. Click Next and select which fields should show up in the Dynamic Table. The order of the fields indicates in which order columns are displayed in the dynamic table, from left to right. Select a line and then use the Up and Down buttons to change the order of the columns. You could change the placeholder for each data field as well; just click a placeholder to edit it.
-
Rows and columns Adding a row or column To add a row or column to an existing table, click in a cell. Then click the black triangle next to the Insert Row Above button on the toolbar, and click one of the Insert buttons, or select one of the options in the Insert > Table Elements menu. Alternatively, right-click the table and on the shortcut menu, select Row > Insert Above or Insert Below, or select Column > Insert Before or Insert After.
-
l Select the Table and select Format > Table, on the menu. On the Table tab, change the width and height of the Table. Moving a Table l l l Click in the table and then drag the border to move the Table. Select the Table (see "Selecting an element" on page 411) and type the desired Y-offset and X-offset in the respective fields on the Attributes pane. Select the Table and select Format > Table, on the menu. On the Table tab, change the Y-offset and X-offset of the image.
-
ConnectDesigner. Formatting options like bold, italic and formats like Heading 1, Heading 2 are maintained. Extra spaces In HTML, extra spaces are generally removed. In Designer templates this is the same, because they are HTML files. In some cases however, you want extra spaces to be shown in your output. Read this how-to to learn how to maintain extra spaces in the text: Maintain extra spaces in text. Adding special characters To add special characters: 1.
-
Snippets A snippet is a small, ready-to-use piece of content in a file. Snippets can be re-used within the same template, in all contexts and sections. They can contain any contents that a section can have, such as text, images, variable data, dynamic tables, etc. Normally, a snippet is an HTML file, but it can also be a JSON file. When a snippet is added to different sections or contexts, it is displayed according to the section's or context's style sheet.
-
1. Right-click the Snippets folder on the Resources pane, and click New Remote Snippet. 2. Enter a name for the file as it appears in the Snippets folder. This name is shown in the Snippets folder with the .rhtml file extension. 3. Enter the URL for the remote resource. This must be a full URL, including the http:// or https:// prefix, domain name, path and file name. Note Remote snippets may contain other resources, such as images.
-
Tip To export a snippet from your template, drag or copy/paste it out of the Snippets folder to a folder on the local hard drive. Creating a snippet To turn a parts of a letter, email or web page into a snippet for reuse in the content of a template: 1. Select the part that should be saved in a snippet. 2. Right-click the selection, point to Snippet and click Create. 3. Right-click the new snippet on the Resources pane in the Snippets folder and rename it.
-
l l Using local formatting. Local formatting means styling an element directly, using a toolbar button or one of the formatting dialogs. Using Cascading Style Sheets (CSS). Style sheets can determine the appearance of individual elements, as well as the appearance of elements that have the same class or HTML tag. Whether applied through style sheets or through local formatting, behind the scenes all layout properties in the Designer are CSS properties.
-
Spacing (padding and margin) helps to position elements relative to other elements in the template; see "Spacing" on page 521. The best way to position elements depends on the output channel for which the template is intended; see "How to position elements" on page 502. The locale setting influences how dates, numbers and amounts of money are displayed; see "Locale" on page 520.
-
the clicked element, as well as the HTML tags of other elements to which the clicked element belongs. The clicked element is at the end of the line. To edit the HTML text directly: l In the workspace, toggle to the Source tab. On this tab you can view and edit the content of the template in the form of plain text with HTML tags (note the angle brackets: <>). You may add and edit the text and the HTML tags, classes, ID’s and other attributes. To learn more about HTML, see for example https://developer.
-
Adding CSS files To add a CSS file of your own, open an Explorer window, drag the file to the Resources pane and drop it on the Stylesheets folder. To create a new CSS file, right-click the Stylesheet folder on the Resources pane and select New Stylesheet. Note The order in which style sheets are executed, can affect the actual output. This sequence can be set per section; see "Determining the order in which style sheets are read" on page 497.
-
4. Optionally, for a Capture OnTheGo Form, you can check Use cached Capture OnTheGo resource, to prevent downloading a remote style sheet again if it has been downloaded before. The file should be available on a publicly accessible location, for example: a folder location on a corporate website, hosted by a CDN (Content Delivery Network) or shared via a Workflow process.
-
l An ID: #id. An ID is always preceded by #, e.g. #sender. When you create an ID, choose a name that indicates what the ID is used for, e.g. #sender would refer to the HTML element with information about the sender. Note Each ID should be unique and can only be used once in each section. l l l l An HTML element: p, h1, table, etc. Type the tag name without the angle brackets. A combination of HTML elements, separated by a comma.
-
Step 2: apply CSS to the content After editing the CSS file(s), make sure that the CSS rules actually apply to one or more elements in the template. CSS rules for HTML elements, such as paragraphs, are automatically applied to all elements with the corresponding HTML tag. To make a CSS rule for a certain class or ID work for an element in your document, you have to add the class or ID to that HTML element.
-
How to determine which styles are applied To see which styles are applied to an element, select the element (see "Selecting an element" on page 411) and take a look at the Styles pane that sits next to the Attributes pane. The Styles pane shows which CSS style rules apply to the currently selected element. A link next to a style rule will open the file where that particular style is defined.
-
Rules for HTML elements (p, table, li etc.) are general rules. Rules for classes, pseudo classes, and elements with a certain attribute (.class, :hover, [target]) are more specific. Rules for elements with a certain ID are even more specific. The most specific are inline styles.
-
1. On the Resources pane, expand the Contexts folder, expand the folder of the corresponding context and then right-click the section (or right-click the Web context). 2. Click the tab Includes. 3. From the File types dropdown, select Stylesheets. 4. The list at the left displays the style sheets that are present in the template's resources. The list at the right shows the style sheets that will be included in the output of the current section (or Web sections, if you have selected the Web context).
-
l The font, font size, color and background color: l l l l l Font size. Enter the size in a measure, named size or percentage. This is equivalent to setting the font-size property in CSS. Color: this the color of the text. Select a named font color as defined in the Edit Colors dialog (see "Colors" on page 514) or click the colored square to create a new color or to enter a color manually. The color value must be a valid HTML color name or hexadecimal color code.
-
l Lowercase: Sets thetext-transform to lowercase. l Small-caps: Sets the font-variant to small-caps. Note All settings in the Text Formatting dialog are in fact CSS style rules. When you change one or more settings, the selected text gets wrapped in a Span element that has an inline style tag containing the selected setting(s). Click the Advanced button to add CSS properties and values to the inline style tag of the Span directly. For more information about CSS, see "Styling and formatting" on page 488.
-
l (Page) breaks: these settings are only useful in Print sections, as only Print sections have pages. l l l l Before: Sets whether a page break should occur before the paragraph. This is equivalent to the page-break-before property in CSS; see CSS page-breakbefore property for an explanation of the available options. Inside: Sets whether a page break is allowed inside the paragraph.
-
l Alternatively, click the Source tab at the bottom of the workspace (or select View > Source View) to manually remove style tags. Tip When you select an element in the template, the Styles pane will show which styles are applied to that element. The link behind the style will take you to the place (the Source tab, or a CSS file) where that style is defined.
-
element in relation to the other elements, by putting more space between the element and its surrounding elements. The padding is the space between an element's content and its border. It is used to position the content of the element inside the border. To learn how to set an element's spacing properties, see "Spacing" on page 521. Tip Use a negative left margin to create a hanging paragraph or image.
-
properties position the element inside its parent with exact values: pixels (px), centimeters (cm), etc. Negative values are allowed. For an explanation of all values that the position property can possibly have, see http://www.w3schools.com/css/css_positioning.asp. Where to use it In Print sections, setting the position property to absolute can be very useful. It takes the element out of the text flow, so that the element stays where it is on the page.
-
Rotating elements In any type of template, boxes, images, tables, text and other elements can be rotated. The toolbar buttons Rotate Clockwise and Rotate Counter Clockwise rotate the element in which the cursor is located 90 degrees at a time. To rotate an element into another angle position, use the 'angle' CSS property of the element. In most cases, this can be done in the element's Formatting dialog. In other cases, such as with text, you have to enter the CSS property and value manually.
-
l l With local formatting. This means styling the table directly, using the Formatting dialog. Via Cascading Style Sheets (CSS). In a style sheet, style rules are declared for elements with different HTML tags, ID's and classes. These two methods are described below. See "Styling and formatting" on page 488 for background information about these two methods. Selecting a table, row or cell There are several ways to select a table or row: l l l Click in the table or row.
-
To style all cells in a table or row at the same time via the Formatting dialog, you have to select the table or row first; see "Selecting a table, row or cell" on the previous page Next, to open the Formatting dialog, choose Format > Table Cell. The settings that you make now will be applied to all cells in the selected row or table. Via a style sheet Cascading Style Sheets (CSS) offer more ways to style a table and its contents, than the Formatting dialog does. This is especially true for Dynamic Tables.
-
In CSS, refer to the table, row or cell with #ID (where ID should be replaced with the actual ID) or with .class (where class should be replaced with the actual class). Styling the first, last and nth rows The CSS pseudo-classes :first-child, :last-child and :nth-child() are very useful for styling table rows (especially in Dynamic Tables). A CSS pseudo-class follows a selector to specify a special state of that selector. It always starts with a colon.
-
:nth-child(3n+1) matches child elements 1, 4, 7, 10 etc., so every third element, starting at 1. Via script (based on a data field value) To style a table, row or cell based on a data field value, you have to write a script (see "Writing your own scripts" on page 552). First add an ID or class to the table, row or cell that needs to be styled: select the element (see "Selecting a table, row or cell" on page 506) and add an ID on the Attributes pane.
-
To keep all CSS style rules together you could add the style rules to a class in the CSS file (see "Styling templates with CSS files" on page 490) and assign that class to the a row or cell using addClass (see "Examples" on page 815). For another example, see this how-to: Change detail line formatting based upon a data field value. Background color and/or image In any type of template, boxes, tables and table cells can have a background color and/or a background image.
-
l l l Resources lists the images that are present in the Images folder on the Resources pane. Disk lists image files that reside in a folder on a hard drive that is accessible from your computer. Click the Browse button to select a folder (or an image in a folder). As an alternative it is possible to enter the path manually. The complete syntax is: file:///. Note: if the host is "localhost", it can be omitted, resulting in file:///, for example: file:///c:/resources/images/image.jpg.
-
Border In any type of template, boxes, tables and table cells, paragraphs, images and other elements can have a border. Elements have a rectangular shape, so their border has four sides. Each side of the border can have a different layout. Adding a border 1. Right-click the element and click the respective element on the shortcut menu. Alternatively, select the element (see "Selecting an element" on page 411) and on the Format menu click the respective element. 2. Click the Border tab. 3.
-
Boxes, images and tables To round the corners of a box, image or table: 1. Select a Box, Image or Table element (see "Selecting an element" on page 411) and on the Format menu click the respective element. Alternatively, right-click the element and click the respective element on the shortcut menu. 2. On the first tab in the Formatting dialog (the Box, Image or Table tab respectively) specify the corner radius in a measure (10mm, 5px, 0.5in) or percentage (0 - 90%). 3.
-
1. Select the paragraph (see "Selecting an element" on page 411) and then select Format > Paragraph on the menu, or right-click the paragraph and select Paragraph on the shortcut menu. 2. Click the Advanced button at the bottom of the Formatting dialog. 3. Under Property, type border-radius. 4. Under Value, type the value of the corner radius in a measure (10mm, 5px, 0.5in) or percentage (0 - 90%). 5. Click OK, and click OK again to close the Formatting dialog.
-
1. Select Edit > Colors on the menu. 2. Add a color. There are two ways to do this: l l Click the New button (the green plus). Select an existing color from the list and copy it using the Duplicate button . (The Filter drop-down limits the list to colors of a certain type.) Select the new color and click the Edit button . 3. In the Edit color dialog, type a name for the color (or let the Designer create a name based on the values that you select). The color’s name can be used in style sheets.
-
Defining a tint A tint is a transparent color, based on another color in the template. To define a tint: 1. Select Edit > Colors on the menu. 2. Click the New button (the green plus) to add the tint. 3. Click the Type drop-down and select Tint. 4. In the Edit color dialog, type a name for the color (or let the Designer create a name based on the values that you select). The color’s name can be used in style sheets. This name should not contain spaces or special characters. 5.
-
p { color: MyColor; } CMYK colors You may use the custom cmyk() CSS function to assign a CMYK color to any element, or a series of elements. The following example assigns a steel blue color as a background for all H1 elements: h1 { background-color: cmyk(33%, 17%, 0%, 20%); } Coloring text Instead of using a style sheet (see above), you can color text locally: 1. Select text or an HTML element that contains text (see "Selecting an element" on page 411). 2.
-
see "Color Picker" on page 593. You could also type a name or value in the Color field directly. It must be a valid color name (see color names on w3schools), a hexadecimal color code (see w3school's color picker), RGB color value, for example rgb(216,255,170) or CMYK color value, for example cmyk(15%, 0%, 33%, 0%). 5. Click OK or Apply. Color management Color profiles can keep colors consistent across different outputs.
-
l Drag the appropriate font files into the Fonts folder on the Resources pane. When text is displayed in an imported font, the Designer can mimic the bold and italic versions of that font. If you have separate files for the bold, italic and possibly other versions of a font, you can make the Designer use the appropriate files to style text. To do this: 1. Import the files for the bold, italic and/other versions of the font into the Fonts folder. 2. On the Edit menu, click Fonts, to open the Font Manager.
-
Applying an imported font Once a font is imported, it is automatically added to the Fonts drop-down on the toolbar. It can also be used in the style sheets, even in combination with other fonts, for example: body { font-family: 'MyWebFont', Arial, sans-serif; } Locale The locale is a setting that can affect date, time and currency output, and other formatting that depends on location and language. This setting is specific to each template, so changing it for one template will not affect other templates.
-
letter country code (de-DE, zh-CN, fr-CA, fr-FR, etc), as defined by the international standards ISO-639-1 and ISO 3166. l Select Data Field to use a data field from the record. The locale will be recordspecific in this case. Use the drop-down to select a field within the current Data Model that contains the locale. This field must be a string and contain the exact locale to be used, such as "en" or "fr-CA". It cannot be an alias such as "english" or "french".
-
2. Click the Spacing tab. Note All settings in the Formatting dialog are in fact CSS style rules. Click the Advanced button to manually add CSS properties (at the left) and values (at the right). For more information about CSS, see "Styling and formatting" on page 488. It is also possible to change an element's formatting via a style sheet; see "Styling templates with CSS files" on page 490. 3. Set the value for the padding in measure or percentage.
-
Variable data Variable data are data from a database or data file that are used to personalize documents for each customer. Variable data fields can be inserted in the text directly. For example, if a person's last name can be found in your data, the field that holds the last name can be used in the text of a web page, letter or email. Scripts in PlanetPress Connect Designer are the basis of Variable Data Printing.
-
Snippets Snippets are pieces of content that can be re-used within the same template, in all contexts and sections. Snippets can contain any contents that a section can have, such as text, images, variable data, dynamic tables, etc. They are often very useful to personalize content, especially in combination with variable data and scripts. See "Snippets" on page 486 and "Loading a snippet via a script" on page 568.
-
l a Data Mapping Configuration, see "Loading a Data Mapping Configuration" on the facing page l a data file, see "Adding data from a data file" on page 527 l a database, see "Adding data from a database" on page 529. A Data Model and sample data are part of a Data Mapping Configuration.
-
Tip If you have no data at hand, download a demo from http://demo.objectiflune.com and open a dummy data file to test with. Loading a Data Mapping Configuration If you have used the DataMapper first, you probably already have an open Data Mapping Configuration. Its Data Model and sample data will automatically be used when you start creating a template. You might have to click the Synchronize Model button on the Data Model pane, to update the fields. To open a Data Mapping Configuration: 1.
-
complete sample data file that is part of the Data Mapping Configuration. The output is not limited to the number of records shown in the Data Model pane (which is one of the settings in the DataMapper). Adding data from a data file 1. Click File, select Add Data and then click From file data source. Browse to the location of the file and select it. The Designer can open the following types of data files: l CSV files (.csv) l Microsoft Access Database (.mdb, .accddb) l XML files (.
-
MDB file options o File: Include the full path to the file. o Password: If the file isn't password protected, you can click Next without filling out this field. o Table name: Use the drop-down to select the appropriate table or stored query to retrieve the appropriate data set. o Encoding: Use the drop-down to select the encoding with which to read the data in the table. XML File options Select what level of XML elements defines a record. The Trigger is what triggers the creation of a new record.
-
AFP file options After selecting a file, use the drop-down to select what level in the AFP file defines a record in your data. The levels are defined in the AFP file itself. (See "About AFP files" below.) All metadata fields that belong to the chosen level and higher levels in the tree structure will be listed. The lower the chosen level is in the tree structure, the more records you will get and the more metadata fields will appear in the list. Select metadata fields to add them to your data.
-
MySQL 1. Enter the appropriate information to connect to the database: l l l l l Server: Enter the server address for the MySQL database. Port: Enter the port to communicate with the MySQL server. The default port is 3306. Database name: Enter the exact name of the database from where the data should be extracted. User name: Enter a user name that has access to the MySQL server and specified database. The user only requires Read access to the database.
-
SQL Server 1. Enter the appropriate information to connect to the database: l Server: Enter the server address for the SQLServer database. l Port: Enter the port to communicate with the SQLServer. The default port is 1433. l l l Database name: Enter the exact name of the database from where the data should be extracted. User name: Enter a username that has access to the SQLServer and specified database. The user only requires Read access to the database.
-
JDBC 1. Enter the appropriate information to connect to the database: l l JDBC Driver: Use the drop-down to select which JDBC Driver to use for the database connection. JAR file path: Enter a path to the JAR file that contains the appropriate driver for the database below. l Server: Enter the server address for the database server. l Port: Enter the port to communicate with the server. l l l l l Database name: Enter the exact name of the database from where the data should be extracted.
-
l l User name: Enter a username that has access to the Oracle server and specified database. The user only requires Read access to the database. Password: Enter the password that matches the username above. 2. Click Next and enter the information for the source table. l l l Connection string: Displays the full path to the database. Table: Use the drop-down to select the appropriate table or stored query to retrieve the appropriate data set.
-
l l l l Padding character: Which character to add if the counter's value is smaller than the width. Width: The number of digits the counter will have (prefix and suffix not included). If the width is larger than the current counter value, the padding character will be used on the left of the counter value, until the width is equal to the set value. For example for a counter value of "15", a width of "4" and padding character of "0", the value will become "0015".
-
You can use the drag-and-drop method for simple fields that do not need to be preceded or followed by a space, line break or text. Note Web templates are personalized just like any other template. There are a few extra possibilities, though; see "Using variable data on a Web page" on page 359. Inserting variable data directly (drag-and-drop) An easy, quick and direct way to insert variable data in the content is via drag and drop: 1. Open the section you want to add the data field to. 2.
-
The drag-and-drop method automatically generates a script that is named after the data field (see the first column of the Scripts pane). The selector (in the second column in the Scripts pane) is the text that the script will replace. The selector that the drag-and-drop method generates for a script, is the same as the placeholder that is placed in the text. When you drag the same field to the content again, a second placeholder appears in the text, but no new script is added.
-
Using the Text Script Wizard The Text Script Wizard can insert one or more data fields into your template, each with an optional prefix and suffix. It is recommended to use the Text Script Wizard for blocks of data, such as address blocks, and when data fields can be empty or need to be formatted differently. 1. Create a new text script and open the Text Script Wizard.
-
l An HTML/CSS selector: n HTML elements, such as a paragraph. In the Text Script Wizard, click Selector and type the HTML tag without the angle brackets, for example: p. n HTML elements with a specific class. In the Text Script Wizard, click Selector and type the class name, including the preceding dot, for example: p.green for all paragraphs with the class 'green' or .green for all kinds of HTML elements that have the class 'green'.
-
pointing arrow and select one of the formats. See "Formatting variable data" on the facing page. 7. Add as many data fields as you need, following the same procedure. 8. Optionally, you can click Options to specify where and how the script inserts its results: l l l As HTML. HTML elements in the results are processed and displayed as HTML elements. For instance, this is bold will be displayed as this is bold. This is the default setting. As text.
-
of the content to move up or down. If, in a Print context, you don't want the result of the script to be part of the text flow (for example, when a letter is going to be sent in an envelope with a window), put the placeholder for the script in a positioned box (see "Boxes" on page 454 and "How to position elements" on page 502). Tip An example of how to create an address block using the Text Script Wizard is described in a howto; see How to create an Address Block.
-
3. Under Format you can choose one of the following options: l l l l l l l l l Short Date displays the day, month and year in two digits each, for example 01.04.16. Medium Date displays the day and month in two digits each and the year in four digits, for example 01.04.2016. (This is also the value of the Default Date.) Long Date displays the day as a number, the month's full name and the year in four digits, for example 1. April 2016.
-
Font style Text originating from variable data can be displayed in uppercase, lowercase or proper case. 1. Open the Text Script Wizard: double-click to open an existing script in the Scripts pane or create a new Text Script using the Text Script Wizard; see "Using the Text Script Wizard" on page 537. 2. Click a data field that contains text, or add such a data field to the script with the Add field button on the right. 3.
-
data file or database without a Data Mapping Configuration, all fields are of the type string. l ∑ (Sum) and ∑↑ (Sum Up) are used in Dynamic Tables in a Print context. ∑ is for transport rules at the end of a page and ∑↑ shows the subtotal of the previous page. Alternatively, you can enter a custom format mask: click in the Format column for the corresponding field and start typing a pattern.
-
automatically. The new ID functions as the selector of the script. You can change the selector after closing and reopening the script (double-click the name of the script in the Scripts pane). 4. Set the Action: use the drop-down to select whether to Show or Hide the element when the condition below is true. 5. Click the downward pointing arrow next to Field, to select the data field that should be evaluated. 6.
-
2. Change the selector to a CSS class (for example, .male) or to an HTML element with a certain CSS class (for example, p.male). See "Using the Text Script Wizard" on page 537 for further explanation on selectors. 3. Apply the same CSS class to all elements that should be shown or hidden under the condition that you have set in the conditional script. Click each element and type the class (without the preceding dot) in the Class field.
-
an external folder). It is important that they are named after the various possible values of the related data field. Adding dynamic images that are not named after a data field value requires a self-made script. To use the Dynamic Image Script Wizard: 1. Add one image to the template. See "Adding images" on page 477. 2. Right-click the image and click Dynamic Image. Or select the image and click Source (not the field, but the label before the field) in the Attributes pane.
-
How to insert dynamic images if there are no data fields with the actual names of the images is described in another how-to: Dynamic image that doesn't contain the data field value. Editing a Dynamic Image To edit dynamic images added to the template earlier, right-click the image, or the space reserved for the dynamic images. Then click Dynamic Image to open the Dynamic Image Script Wizard again. Dynamic table In invoice templates, a Dynamic Table is an essential element.
-
l l Detail Table: Use the drop-down to select which detail table to display within the dynamic table. Width: Enter the width of the table. A Dynamic Table is always inserted at the cursor position. 3. Click Next and select which fields should show up in the Dynamic Table. The order of the fields indicates in which order columns are displayed in the dynamic table, from left to right. Select a line and then use the Up and Down buttons to change the order of the columns.
-
1. In the workspace, open the Design tab. Right-click the first line of the table if you want to add a header row, or the last line if you want to add a footer row. 2. On the shortcut menu select Row > Insert below or Insert above. The new row will be added to either the header or footer. 3. Right-click the row and choose Row > Show.
-
Change detail line formatting based upon a data field value An example of how to change the formatting of a line in a Dynamic Table, based upon a data field value, is given in the following how-to: Change detail line formatting based upon a data field value. Resizing a Dynamic Table To change the width of a Dynamic Table or of a column in a Dynamic Table, select it (see "Selecting an element" on page 411) and type the desired width as a percentage in the respective field on the Attributes pane.
-
l data-showin: This attribute determines the visibility of the row in different situations, if the table gets split over multiple pages: l header will make the row show up at the top of the table on the first page only. l footer will make the row show up in the footer of the table on the last page only. break used in a row in the section of a table indicates that the row should not be displayed at the top of the table on the first page, but only on following pages.
-
In addition to the pURL, to generate a personalized landing page the Connect Server needs a template with a Web context and a Workflow process with the following tasks: l l l A HTTP Server Input task to capture incoming web requests (see Workflow Help: HTTP Server Input). An Execute Data Mapping task to create the record set appropriate for the template (see Workflow Help: Execute DataMapping Task). A Create Web Content task that generates the HTML files (see Workflow Help: Create Web Content).
-
However, when you want to do something that goes beyond what you can do with a Wizard, like creating a conditional paragraph with a condition that is based on a combination of data fields, you have to write the script yourself. This topic explains how scripts work and how you can create and write a script. Script types There are generally two types of scripts: Control Scripts and template scripts.
-
Creating a new script Writing a template script starts with this procedure: 1. On the Scripts pane at the bottom left, click New. A new script appears in the list. Doubleclick on it to open it. 2. Change the name of the script, so that it reflects what the script does. 3. Choose which kind of selector you want to use. Running a script starts with searching the template for pieces of content that match the script's selector.
-
CSS selectors. See also: "Testing scripts" on page 560. There is a shorter route to create a script for an element with a specific ID: 1. In the template, click the element for which you want to create a script. 2. On the Attributes pane at the top right, type an ID. (In HTML, IDs start with #, but in this field you should type it without the preceding #). 3. Click the label to the left of the ID input field (ID)to make a new script with the ID that you typed as a selector. Writing a script 1.
-
Tip In the editor window, press Ctrl + Space to see the available features and their descriptions. Use the arrow keys to select a function or object and press Enter to insert it in the script. Type a dot after the name of the function or object and press Ctrl + space again to see which features are subsequently available. For more keyboard shortcuts, see "Keyboard shortcuts" on page 659.
-
When this script executes, it stores the value of the AMOUNT field from the current record in a variable and evaluates it. If the value is zero or higher, the color of text in the results the table cells in this case - will be set to green; if the value is below zero, the text color will be set to red. Tip For more examples of using conditions, see this how-to: Combining record-based conditions. Designer API Features like results and record do not exist in the native JavaScript library.
-
They can not be excluded from execution for a specific context or section, using the execution scope of a folder; see "Execution scope" on the next page. What you can do is disable the script or the containing folder; see "Enable/disable scripts" on the next page. Script folders Scripts can be organized in folders. Why would you do that? For three reasons: l l l Folders have an execution scope. You can specify for which contexts and sections the scripts in a folder have to run.
-
execution scope of a folder; see "Execution scope" below. What you can do is disable the script or the containing folder; see "Enable/disable scripts" below. Execution scope A particular script may be used in one context or section, but not in other contexts or sections.
-
To enable or disable a script or a folder: l On the Scripts pane, right-click the script or the folder and click Disable (if the script or folder was enabled) or Enable (if the script or folder was disabled). Tip For more ways to optimize scripts, see "Optimizing scripts" on page 564. Import/export scripts Scripts can be exported - one at a time - for use in other templates. To do this: 1. On the Scriptspane, click on a script, and then click theExportbutton, or right-click a script and selectExport. 2.
-
Note that scripts that use values of data fields can only be effective when a data file or Data Mapping Configuration is open. See "Loading data" on page 524. Test for errors Another way to 'test' a script is to take a look at the Scripts pane. Tip Hover over the name of a script in the Scripts pane to highlight parts of the template that are affected by the script. Icons on the name of scripts in the Scripts pane can show a warning, information or error icon.
-
Tip Be aware that scripts run in a specific order (see "The script flow: when scripts run" on page 585). When one script unintentionally influences the results of another script, changing the order of the scripts in the Scripts pane may help (see "Changing the order of execution" on page 557). Test for speed issues To measure the time that the execution of scripts will take: l On the Context menu, click Profile scripts.
-
scripts" on page 564. Execution: the time it takes to execute the script. If you are an experienced JavaScript coder you may be able to optimize the code to speed up the execution of the script. Tip Functions that actually change the content of the template (for example,append()) are comparatively time consuming. Avoid using such functions in a loop. For more tips, see "Optimizing scripts" on the facing page. Note that the times vary slightly per run of the Script Profiler.
-
after a set time. You can adapt this timeout to your needs, as follows: 1. On the menu, select Window > Preferences. 2. Click Scripting. 3. Set a timeout in seconds (for example: 2s) and click OK. The minimum timeout is 1 second. Note The script timeout is not active when generating output. Optimizing scripts In the process of output generation, the execution of scripts may take up more time than necessary.
-
Tip When using the drag-and-drop method to insert data fields in a template: l l Press the Alt key while dragging, to wrap the placeholder in a span, give the span an ID and have that ID used as the script's selector. Press the Ctrl key while dragging, to wrap the placeholder in an absolute positioned box (a div) at the cursor position. A unique ID is assigned to the box and used as the script's selector.
-
var labelElm = loadhtml('snippets/label.html'); var labelStr = ""; for( var i = 0; i < record.tables.products.length); i++) { var label = labelElm.clone(); label.find('@ProductLabel@').text(record.tables.products [i].ProductDescription); labelStr += label; } results.after(labelStr); Use replace() When personalizing HTML fragments retrieved from a snippet or from the template itself, JavaScript's replace() method shows the best performance.
-
label = label.replace('@netweight@', record.tables.detail [i].fields['netweight']); labelStr += label; } results.after(labelStr); Tip The replace() method as used in the above example replaces only the first occurrence of the search string. To replace every occurrence of a search string in a given string, use a regular expression. In the following line of code, the regular expression /@product@/g makes replace() search for all occurrences of the string @product@ in the label string: label = label.
-
Example The following script replaces all of the placeholders on a postcard. It takes advantage of the JavaScript replace() command. Assuming that the ID of the block that requires personalization is promoblock, the script has to have its selector set to #promoblock. var block = results.html(); var data = record.fields; block = block.replace('@name@',data.first + ' ' + data.last); block = block.replace('@address@',data.address); block = block.replace('@zip@',data.zip); block = block.replace('@city@',data.
-
Note Make sure that the file name is exactly the same as the file in the Snippets folder. If the file name isn’t correct, the snippet will not appear in the template. Loading part of a snippet When a snippet contains a part that can be identified by a selector, that selector can be used to load that part of the snippet into a template. In script, use the following code: results.loadhtml(‘snippets/nameofthesnippet.html’, ‘selector’) See "loadhtml()" on page 799 for more information about this function.
-
Example The following script reads the value of the LANGUAGE field in the record and uses that value as the selector in the function loadhtml(). If the snippet contains an HTML element with this ID (for example,
), that HTML element will be added to the content: var language = record.fields.LANGUAGE; results.loadhtml(‘snippets/nameofthesnippet.html’, ‘#’+ language) Another example is given in the following how-to: Using a selector to load part of a snippet.
-
Some knowledge of JavaScript is needed to edit Control Scripts, just as for any other self-made scripts, because there is no Control Script Wizard; see "Writing your own scripts" on page 552. This topic explains how to add a Control Script and it gives an overview of what Control Scripts can do. It will also tell you where you will find information about each feature, including examples. What Control Scripts are Control Scripts are a special kind of Designer script.
-
Tip New Control Scripts added to the template contain code to continue the page numbering over all print sections, and two examples: one to select different sections of a Print context for email and print output, and one to select a web section. What to use a Control Script for Control Scripts let you change the way a template is merged, by giving access to the template with all its contexts and sections in a script.
-
Task See topic Field/function of section object page 578 Split Email attachments and rename them "Parts: splitting and renaming email attachments" on page 576 part Dynamically set a password on PDF attachments "Control Script: Securing PDF attachments" on page 583 password, ownerPassword Include/exclude sections: "section" on page 846, take a look at the examples. enabled Add sections dynamically "Dynamically adding sections (cloning)" on page 580.
-
Control Script: Page numbering This topic explains how to write a Control Script that changes the page numbering in Print sections. Note that when you add a Control Script, it already contains a script to make the page numbering continue over all Print sections. For information about Control Scripts in general, see "Control Scripts" on page 570 and "Control Script API" on page 841. If you don't know how to write scripts, see "Writing your own scripts" on page 552.
-
1. Section A (1 page) restartPageNumber = true 2. Section B (1 page) restartPageNumber = true 3. Section C (1 page) restartPageNumber = false 4. Section D (1 page) restartPageNumber = true The code would look like this: if (merge.context.type == ContextType.PRINT) { merge.context.sections['Section A'].restartPageNumber merge.context.sections['Section B'].restartPageNumber merge.context.sections['Section C'].restartPageNumber merge.context.sections['Section D'].
-
merge.context.sections['Section D'].restartPageNumber = false; } The page numbering in the output will be: 1. Section A page 1 2. Section B page 2 3. Section D page 1 (page numbering is restarted due to section C's restartPageNumber = true) Parts: splitting and renaming email attachments In a Control Script, parts can be defined to determine which sections should be output to the same file. This way it is possible to split the Print context or the Web context into multiple email attachments.
-
Examples No parts defined Assume there are three Print sections: sections A, B and C. When generating Email output with the Print context as attachment, all three Print sections will be put together in one file and attached to the email. If the email's subject is 'Take action', the name of the attached file will be 'Take action.PDF'. Splitting and renaming a Print attachment Assume there are three Print sections: sections A, B and C.
-
merge.context.sections['Section 1'].enabled = false; merge.context.sections['Section 2'].enabled = false; merge.context.sections['Section 3'].enabled = true; merge.context.sections['Section 3'].part = "PDFAttach1"; merge.context.sections['Section 4'].enabled = true; merge.context.sections['Section 4'].restartPageNumber = false; merge.context.sections['Section 5'].enabled = false; merge.context.sections['Section 6'].enabled = true; merge.context.sections['Section 6'].part = "PDFAttach2"; } else if (merge.
-
background of the section to either DataMapper PDF or Resource PDF (see "BackgroundResource" on page 854). For example: merge.template.contexts.PRINT.sections['Policy'].background.source = BackgroundResource.RESOURCE_PDF; A DataMapper PDF is, as you would expect, a PDF generated by the DataMapper. A Resource PDF is a PDF from another source. For a DataMapper PDF, nothing else has to be done to set the background.
-
Example This scripts sets a background on a Print section using absolute positioning. var activeSection = merge.template.contexts.PRINT.sections['Section 1']; activeSection.background.source = BackgroundResource.RESOURCE_PDF; activeSection.background.url = "images/somepage.pdf"; activeSection.background.position = MediaPosition.ABSOLUTE; activeSection.background.left = "10mm"; activeSection.background.
-
Note Due to resource constraints, the number of unique clones that can be created throughout a job is limited to around 20. A clone is considered unique if it has a different name. This is a rough estimate; if the template is simple, up to 60 clones may be created. The limit only applies to the amount of unique clones. There is no limit to the amount of clone() function calls.
-
[section="my_section_clone_0"] h1 { color: red; } [section="my_section_clone_1"] h1 { color: green; } [section="my_section_clone_2"] h1 { color: blue; } The same selectors could be used in personalization scripts: Selector: [section="my_section_clone_0"] h1 Script: results.css('color','red'); In a template script, cloned sections can be found using merge.section: if (merge.section == "my_section_clone_0") { results.html("Clone!"); } else { results.html("Original."); } Note that in a Control Script, merge.
-
if(record.fields.policy_a == 1) { addPolicy('a'); } if(record.fields.policy_b == 1) { addPolicy('b'); } function addPolicy(policy){ var resourceUrl = 'images/policy-' + policy + '.pdf'; var clone = printSections["Policy"].clone(); clone.name = "policy_" + policy; clone.background.url = resourceUrl; clone.enabled = true; printSections["Policy"].addAfter(clone); } Control Script: Securing PDF attachments The Print context can be attached to an email in the form of a PDF file and secured with a password.
-
When producing a single attachment, the password(s) should be set on the first Print section. When producing multiple attachments, it should be set on the first section of each part. Password types PDF allows for two types of passwords to be set on a secured PDF file: a user password and owner password. The user password allows a limited access to the file (e.g. printing or copying text from the PDF is not allowed). The owner password allows normal access to the file.
-
} } The script flow: when scripts run When Connect generates the actual output – letters, web pages or emails -, it opens a record set and merges it with the template. It takes each record, one by one, and runs all scripts for it, in a specific order, as explained below. First all Control Scripts are executed, in the order in which they appear in the Scripts pane.
-
See: l "Menus" on page 665 l "Toolbars" on page 692 l "Resources Pane" on page 682 l "Outline Pane" on page 682 l "Attributes Pane" on page 677 l "Styles pane" on page 689 l "Workspace" on page 689 l "Data Model Pane" on page 679 l "Scripts pane" on page 687 l "Problems and messages" on page 680 Page 586
-
Dialogs Dialogs can allow you to perform a command or make settings. They can also ask you a question or provide you with information or progress feedback. Here is a list of all panes: Bar Chart Properties dialog The Bar Chart dialog appears when a Bar Chart object is right-clicked and the Bar Chart... option is clicked. It determines how the Bar Chart is displayed when generating output and in Preview mode.
-
l l l Show Line: Adds a line around each bar (or fills the bar if the bar has no fill color). Color: Enter a color for the line. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Opacity: Enter the percentage for the opacity of the line. Value Axis Tab l Title group: l Label: Enter a label for the Y axis (X axis if the graph is rotated). l Bold: Check if you want the label to be in bold style. l l l Font Size: Enter a font size for the label, in pt.
-
Category Axis Tab l Title group: l Label: Enter a label for the X axis (Y axis if the graph is rotated). l Bold: Check if you want the label to be in bold style. l l l Font Size: Enter a font size for the label, in pt. Grid group: l Color: Enter a color for the grid that is displays in the graph. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. l Opacity: Enter the opacity percentage of the grid. Default is 15%. l Thickness: Enter a thickness for the grid, in pixels.
-
Legend tab l Show Legend: Check to show the legends in the chart object. l Legend Group: Defines how the legends are shown. l l l l l l l Equal label widths: Check so that all labels are of equal width in the Legends box. The Legend's width will accommodate the largest value. Position: Use the drop-down to select where the labels are shown: Right, Left, Top or Bottom. Align: Use the drop-down to select how to align the text in the labels: Left, Middle or Right.
-
l l Border Color: Enter a valid HTML Hex Color for the border's color. Border Opacity: Enter a numerical value between 0 and 100 to define the opacity (in percentage) of the border. Box Formatting dialog The Text Formatting dialog is accessible by clicking inside a positioned box in the template and then selecting Format > Box in the menu.
-
l l Clear: Use the drop-down or type in the value for clearing pre-existing alignments. Equivalent to the CSS clear property. Positioning: l l l l l l Position: Use the drop-down or type in the value for the type of positioning for the box. Equivalent to the CSS position property. Top: Set the vertical offset between this box and its parent's top position. Equivalent to the CSS top property. Left: Set the horizontal offset between this box and its parent's left position.
-
Spacing Tab l Padding group: Defines padding (spacing inside the element) in measure or percentage: l l l All sides: Check to set all padding to use the Top value. Equivalent to the CSS padding property. Top, Left, Bottom, Right: Set padding for each side. Equivalent to the CSS padding-left, padding-top, padding-right and padding-bottom properties. Margin group: Defines margins (spacing outside the element) in measure or percentage: l l All sides: Check to set all margins to use the Top value.
-
displays the currently selected color, while the Original shows the color currently attributed to the element. The rest of the dialog has various options for choosing colors: l Color Mode: Use the drop-down to select whether the color is set as RGB, CMYK or HEX. The color mode determines how the color is saved in the formatting properties, and how they are printed or output; see "Colors" on page 514. l RGB group: Enter the Red, Green and Blue color values from 0 to 255.
-
l Delete: Delete the currently selected color. l Duplicate: Duplicate the currently selected color using the name [color]CopyX. Edit color You can edit the following color properties. l l l l Name: Enter the name of the color. This name should not contain spaces or special characters. Create name based on values: Check so that the name is automatically based on the color slider values below. Type: Use the drop-down to specify which type of color this should be: either a Tint or a Color.
-
Color Settings Color Management can keep colors consistent across different outputs by using Color Profiles. When producing output to a new device, color adjustments are made to present the color as accurately as possible on this new device. l l Enable Color Management: Check to disable color management and ignore embedded color profiles when importing images (with the exception of imported PDF files as it might contain a multiple tagged sub images).
-
Email Context Properties For the Email context, the Context Properties dialog defines options that are used when generating email output (see "Generating Email output" on page 875). l Print Context Image Compression: Defines the properties of the PDF when attaching the Print context to email output. l l l Lossless: Enables maximum quality in the PDF. Note that this will produce a larger PDF. Quality: Disabled when Lossless is checked. Determines the quality (aka compression) of the attached PDF.
-
Edit Label Properties The Edit Label Properties defines how a Pie Chart Label displays its title and data. It contains two options: l l Label: Enter a title for Labels and Legends when they are shown (see "Pie Chart Properties dialog" on page 611). Value: Use the drop-down to select which Value to use as data within the Pie Chart as well as for Label and Legend values. Find/Replace Dialog The Find/Replace dialog can replace text within the current template.
-
l Options l l l l l Case sensitive: Use a case-sensitive search, which differentiates TEXT from text or TexT. Wrap search: Loop back from the end of the template or selection to its beginning, when the Search is at the end of the template or the selection. Whole word: Searches for the source string as a whole word. Incremental: With this option selected, each letter you type in the Find field causes the editor focus to move to the first complete occurrence of the text you are typing.
-
The following buttons appear to the right of the list of fonts: l New: Click to open the Edit Font dialog to add a new font. l Edit: Click to open the Edit Font dialog to edit the currently selected font. l Remove: Click to delete the currently selected font entry. l Duplicate: Click to create a copy of the currently selected font entry. Edit Font The Edit Font dialog appears when clicking New or Edit from the Fonts Dialog. l l l Name: Enter the name that should be used to refer to the font.
-
Image Tab l General group: l l l l l l l l l Height: Set the height of the image in measure or percentage. Equivalent to the CSS height property. Angle: Set the rotation angle of the image in clockwise degrees. Equivalent to the CSS transform:rotate property. Corner radius: Set the radius of rounded border corners in measure or percentage. Equivalent to the CSS border-radius property. Display: Use the drop-down or type in the value for how to display the image.
-
l l l Bottom: Set the vertical offset between this image and its parent's bottom position. Equivalent to the CSS bottom property. Right: Set the horizontal offset between this image and its parent's left position. Equivalent to the CSS right property. Z-index: Set the z-index of the image. The z-index defines in which order elements appear. Equivalent to the CSS z-index property.
-
Line Chart Properties dialog The Line Chart dialog appears when a Line Chart object is right-clicked and the Line Chart... option is clicked. It determines how the chart is displayed when generating output and in Preview mode. General Tab l General Group: l l l l l l Stack Series: Stack the lines so that lines representing the same value do not overlap. Font: Type in the font-face to use to display text. The font must be installed on the system and defaults to Verdana if the font is not found.
-
Value Axis Tab l Title group: l Label: Enter a label for the Y axis (X axis if the graph is rotated). l Bold: Check if you want the label to be in bold style. l l l Font Size: Enter a font size for the label, in pt. Grid group: l l Color: Enter a custom color for the label (Default is Black). The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Color: Enter a color for the grid that is displays in the graph.
-
l l Opacity: Enter the opacity percentage of the grid. Default is 15%. l Thickness: Enter a thickness for the grid, in pixels. Default is 1px. l l l Color: Enter a color for the grid that is displays in the graph. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Position: Choose Middle to centre the grid over the graph, or choose Start to make the first vertical grid lign match the value axis. Tick Length: The distance between each vertical line in the grid.
-
l Values Group: Defines if and how values are shown in the Legends box. l l Show Values: Check to show values besides the Legend's label. Text: Enter the text used to display the values. Variables can be used to display specific data,
can be used to create a new line: l [[percents]] : Contains the percentage of the chart the value represents. l [[value]] : Contains the numerical value of the field.
-
l l Locale: Use the drop-down to select a specific locale. Only enabled when Explicit Locale is selected above. Data Field: Use the drop-down to select a field within the current data model that contains the locale. This field must be a string and contain the exact locale to be used, such as "en" or "fr-CA". It cannot be an alias such as "english" or "french".
-
l Page Size: The named page size. l Width: The width of the page. l Height: The height of the page. l Orientation: Whether the page is portrait or landscape. Virtual Stationery Tab l Front/Back group: Defines the preprinted media used for the front and back of the Virtual Stationery. l l PDF: Click the Select Image button to open the "Select Image dialog" on page 648 and select which PDF (and optionally, which page of the PDF) to display as a background for the page.
-
l Back Coating: The pre-process coating applied to the front surface of the media. l Texture: The texture of the media, such as Antique, Calenared, Linen, Stipple or Vellum. l Grade: The grade of the media, such as Gloss-coated paper, Uncoated white paper, etc. l Hole Name: Pre-defined hole pattern that specifies the pre-punched holes in the media, such as R2-generic, R2m-MIB, R4i-US, etc. Paragraph Formatting dialog The Paragraph formatting controls how the selected paragraph is formatted.
-
l l Widows: Specifies how to handle widows within the paragraph (lines appearing alone on the next page if the paragraph does not fit on the current one). Equivalent to the widows property. Widows and orphans are ignored if the page-breakinside property is set to avoid. Orphans: Specifies how to handle orphans within the paragraph (lines appearing alone at the end of a page if the paragraph does not fit on the current one). Equivalent to the orphans property.
-
l l Style: Specify the style of the border such as solid, dashed or dotted. Equivalent to the border-style property. Color: Specify the color of the border. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Equivalent to the border-color property. Pie Chart Properties dialog The Pie Chart dialog appears when a Pie Chart object is right-clicked and the Pie Chart... option is clicked.
-
l Slice Outline Group: Determines whether an outline should be added to each slice of the chart. l Width: Use the drop-down to select the width of the outline for each pie slice. Values are 0pt, 0.5pt, 1pt, 1.5pt, 2pt or 3pt. l Color: Enter a valid HTML Hex Color for the outline to appear. l Opacity: Enter the opacity of the outline. 100 is fully opaque, 0 is transparent. Pie tab l Pie Group: Defines how the pie chart is displayed in the template.
-
l Text: Enter the text to use to display labels. Variables can be used to display specific data,
can be used to create a new line: l l [[percents]] : Contains the percentage of the Pie Chart the value represents. l [[value]] : Contains the numerical value of the field. l l l Any Text: Adding text (such as a dollar sign or column, etc) will make it appear in each label.
-
l l l l l Align: Use the drop-down to select how to align the text in the labels: Left, Middle or Right. Horizontal Space: When multiple columns appear, enter a numerical value (in pixels) to define horizontal spacing between the columns. Vertical Space: Enter a numerical value (in pixels) to define vertical spacing between legends. Max Columns: Enter a numerical value to define the maximum number of columns allowed in the Legends box.
-
The Preferences dialog is separated into individual tabs, where each tab controls certain aspects of the software. To open the Preferences dialog, select Window > Preferences. General preferences The General Preferences are as follows: l Always run in background: This option correlates with the "Always run in background" option selectable in the "Document Boundaries Refresh" dialog and "Print via Print Server" dialog.
-
and processing power (CPU) that will be required for cleaning them up. Thus a regular Clean-up of the database (as often as possible) is recommended. This is especially the case if items are not going to be retrieved from the database at a later date. i.e. If the Connect job is not going to be re-run. The clean-up can always be set to run outside of business hours (see the Run according to the cron schedule option below), to reduce impact upon Production systems.
-
l Product managing the service: Select which of the applications will run the service. Note The Server Engine is set as the default as it is generally considered the best option. This is particularly the case when using a scheduled cron job, as the Sever Engine is always running, whilst the Designer might well not be at the scheduled time (in which case the clean-up will fail to run).
-
i.e. a selection of 1,000 would delete 1,000 data records within a Data Set, 1,000 content items within a Content Set, and so on. l l l l l l Minimum time to retain Content Sets: The minimum time a Content Set (and all the content items it contains) is retained within the database before being set for deletion. Minimum time to retain Job Sets: The minimum time a Job Set (and all the jobs information it contains) is retained within the database before being set for deletion.
-
Note This is not a migration tool. It is a connection tool, that enables swapping between backend databases. Any existing data will not be transferred/ migrated between the databases, and any existing Filestores will be cleansed by the Clean-up Service after the swap. Note When a different back-end database is selected, the changes won't apply until after PlanetPress Connect is restarted, including the Connect services. A full machine restart would be recommended, as this provides the cleanest restart.
-
l Port: Enter Port number. The defaults are those which the vendors use by default. l Schema: The individual database schema, within the vendor database. Note If a previously non-existent schema were chosen here, then a new schema of that name will be created within the database when the back-end database swap is applied. The tables within that schema will not be created until Connect is restarted. l Username: Enter the database login username.
-
l Property: These are free field text fields. Note These fields and their associated values get appended to the JDBC connection and therefore must follow all rules regarding acceptable URL addresses for such. l l l l Value: The value applied to the associated Property. l Add: Used to add extra Property values to the table. l Delete: Used to remove existing Property values from the table. Test Connection: Use to test if current connection settings will connect to the specified database.
-
l Negative Sign Before : A negative sign will be displayed before any negative value. l Decimal Separator : Set the decimal separator for a numerical value. l Thousand Separator : Set the thousand separator for a numerical value. l Currency Sign : Set the currency sign for a currency value. l Date Format : Set the date format for a date value. l l Date Language : Set the date language for a date value (ex: If English is selected, the term May will be identified as the month of May).
-
l l l l l Guides: This is the color for rulers that can help position content correctly; see "Guides" on page 503. Margins: This color delineates the content area on a page; see "Pages" on page 314. Bleed box: This color delineates the printable area on a page; see "Page settings: size, margins and bleed" on page 315. Master pages: These edges are only visible on Master pages; see "Master Pages" on page 322.
-
l Litmus account Group: l Email Test address: If you have a Litmus account, enter the test address to use when using the "Send Test Email" on page 646 dialog. For more information on Litmus, please see http://litmus.com/ Email (SMTP) Preferences SMTP server presets can be selected when sending emails using either the "Send Email" on page 644 or "Send Test Email" on page 646 dialogs. See also: "Email header settings" on page 343.
-
This is, for example, the abbreviation for a
element with the class row: div.row On pressing the Tab key, this abbreviation is transformed to:
To learn more about Emmet itself, please see their website Emmet.io and the Emmet.io documentation. Note Emmet is a plugin. All options listed below are Emmet's default options. They are not specifically adjusted for Connect.
-
l New: Add a new abbreviation. l Name: The name of the abbreviation is also its trigger. l Context: The context in which the abbreviation is enabled (HTML, CSS, etc.). l Description: A short description of the abbreviation . l l l l l l Pattern: This defines what an abbreviation expands to. Since Emmet is mostly used for writing HTML/XML tags, abbreviation definition uses XML format to describe elements; see Abbreviation types.
-
l New: Click to create a new snippet. l Name: The name of the abbreviation is also its trigger. l Context: The context in which the snippet is enabled (HTML, CSS, etc.). l Description: A short description of the snippet. l Pattern: The pattern defines what a snippet expands to. l Automatically insert: This option doesn't affect how Emmet works in Connect Designer. l Edit: Modify the currently selected snippet. l Remove: Remove the currently selected snippet from the list.
-
Language Setting Preferences The Language Setting preferences are used for selecting the language used in the User Interface. l Language: Select a language from the options available in the drop down list. Print Preferences Available Printers Preferences The Available Printers preferences control which printer definitions are available when generating print output or creating Output Presets.
-
l l l l l Port: Enter the port through which to communicate with the Print Server. Default is 9340. Username: Enter the username to authenticate to the Print Server. Default is oladmin. This is set on the server's "Server Security Settings" on page 75. Password: Enter the password to authenticate to the Print Server. Default is secret. Confirm Password: Re-enter the password above.
-
Auto Backup Connect Designer can automatically create a backup file when you manually save a template or data mapping configuration. The Auto Save function does not cause backup files to be created. l l l Enable: activate the Auto Backup function. Revisions to keep: Enter the maximum number of backup files. When the maximum is reached, Auto Backup will overwrite the oldest file. Destination: Select the directory in which the backups should be stored.
-
Scripting Preferences The Scripting preferences define different options related to scripting within PlanetPress Connect . l General: l l Script timeout at design time (sec): In Preview mode or when running the Script Profiler (see the Profile Scripts dialog), a long running script is stopped after the amount of time set here. The default is 2 seconds, the minimum is 1 second.
-
l l l l l Before element: The element is inserted before the current element where the cursor is located. For example if the cursor is within a paragraph, insertion occurs before the
tag. After start tag: The element is inserted within the current element, at the beginning, just after the start tag. Before end tag: The element is inserted within the current element, at the end, just before the end tag. After element: The element is inserted after the current element where the cursor is located.
-
l l l l Name: The name of the script being executed. Count: As the profiler runs, Count shows the current number of iterations that have been run. This goes up to the total number of set instances and then stops. Hover with your mouse to display a tooltip indicating in which sections the scripts has run (and in which contexts). Elapsed: Displays the total elapsed time since the start of the session. The table entries are initially sorted based on the values in this column, from high to low.
-
Options Here are the options visible in Script wizards: l Name: The name of the script, making it easier to identify it. l Find: The Selector or Text to apply the result of the script to. l Selector: Uses CSS selectors to find the element to which the script applies l l Text: Uses text as a trigger for the script. The script applies to all instances of the text found in the template.
-
l l l l l l l As text. This inserts the results as-is, meaning HTML tags and elements are displayed as text in the output. In this scenario, "
" shows up in the text and does not insert a line break. As the value of an attribute of an HTML element. The selector of the script should be an HTML element. Which attributes are available depends on the selected HTML element.
-
l l Selector and Text: Uses text as a trigger for the script but only applies to text within the specified Selector. Input Type: Use the drop-down to select the source of the data to add to the Chart. The selection changes the options below: l Static Labels: Select to use a static number of data lines below. The chart will always have the same number of items. l Data List: Lists the data lines that are part of the Chart. Each line represents a segment of the pie as well as a label if they are shown.
-
l Name: The name of the script, making it easier to identify it. l Selector: The Selector or Text to apply the result of the script to. l l l Selector: Uses CSS selectors to find the element to which the script applies. Text: Uses text as a trigger for the script. The script applies to all instances of the text found in the template. Selector and Text: Uses text as a trigger for the script but only applies to text within the specified Selector.
-
Print Section Properties The Section Properties dialog is separated in a few separate tabs depending on the Context in which it resides: General tab (all Contexts) l Section group: l l l l Show PDF data mapping input as background image: Check this option to display each page of a PDF data source when using a PDF data mapping configuration. Each page of the PDF is shown, separated by the appropriate records. Note that as many pages as there are in the PDF will be created in the section.
-
l Bottom: The bleed at the bottom of the page. l Right: The bleed at the right of the page. Includes Tab This tab defines what other resources are included in the output l File types: l l Stylesheets: What CSS stylesheets to use in producing the output. Stylesheets are loaded in the order shown, and styles in later Stylesheets overwrites earlier ones when the same selector is used. JavaScript: Which JavaScript resources are included in the HTML header of the web output.
-
l Pattern Catalog ID: When the Number of Holes is not the default in the option above, use the drop-down to select the Pattern Catalog ID for the hole making. Sheet Configuration Tab This tab defines how different Print Context Sections output on different Media and using different Master Pages. There are multiple groups, each defining the settings for individual position within the section as it outputs: First, Middle and Last sheet, as well as a group for Single sheets.
-
l Master Page Back: Defines the Master Page used for the front of the selected sheet's position. Disabled if "Back Only" is selected under Allow content on, or if Duplex is unchecked. Background Tab This tab defines the background for the current Print Context Section. It contains the following options: l Generalgroup: l l l PDF: Select the PDF to use as the section's background: a PDF Datamapper Input or a PDF Resource. Path: The path to a PDF Resource.
-
Properties Tab l Section Group: l l l l Name: Enter the name of the Section in the Web Context. This has no effect on output. Page Title: Enter the title for the page. This is the contents of the
HTML tag. Shortcut Icon: Enter the path to the favicon.ico file, for instance images/favicon.ico. If a valid favicon image is dragged to the Web Section, it will automatically be set as a shortcut icon.
-
Arrange Sections The Arrange dialog is used to change the order of sections within a context. To access the Arrange dialog, right-click on any section or the context containing them, and click Arrange. l Name: Displays the name of each section within the context. l Move Up: Click to move the currently selected section up one position. l Move Down: Click to move the currently selected section down one position.
-
Note The dialog is only available on templates containing a Web context. It does not, however, verify whether any Capture OnTheGo form elements have been added to the page. The dialog contains the following options: l General group: l l l l l Store ID: The Nu-Book Store ID. If you don't have one, you can get a trial account for this purpose; please see this page for more details: http://www.captureonthego.com/en/promotion/. Password: The password to the above Nu-Book Store.
-
l From group: l l l l Email: Enter the email address that will appear as a Sender to the email recipient. A single email address should be written. Records group: l All: Select to send to all records in the Record Set. l Selection: Select this open and enter a range of records that should be sent. Attachments: l l l Name: Enter the name that should appear when sending emails. The name is optional.
-
l User: Enter the username used to connect to the SMTP server. l Password: Enter the password for the above username. Send Test Email The Send Test Email dialog is used to generate mail output of a certain number of records and send them to one recipient. To open this dialog, select File > Send Test Email, on the menu. For more information about the process of sending out email and the possible settings, see "Generating Email output" on page 875.
-
l l Web Page context as ZIP archive: If a Web context exists in the template, its output will be generated as an HTML file. A ZIP archive, containing the HTML file and all required resources, will be attached to the outgoing email. Outgoing mail settings: l l l Host: The SMTP server through which the emails are to be sent. Can be a host (mail.domain.com) or an IP address. You can specify a port number as part of the host name, for example: smtp.mandrillapp.com:465.
-
l Destination group: l Send files to: Use the drop-down to select where to send the files. l l Workflow machines: Send the files to a PlanetPress Workflow installation. This lists all the detected PlanetPress Workflow installations detected on the network. File...: Click to save the files as a package. This package can be loaded within the Workflow tool. Select Image dialog The Select Image dialog lets you select an image, depending on where the image is located.
-
produced. External images are updated (retrieved) at the time the output is generated. Sheet Configuration dialog The Sheet Configuration dialog defines how different Print context sections output on different Media (see "Media" on page 325) and using different Master Pages (see "Master Pages" on page 322). There are multiple groups, each defining the settings for pages grouped by their position within the section as it outputs: First, Middle, Last and Single sheets.
-
Style sheets dialog The Stylesheet editor dialog is used to edit CSS style sheet resources. For information on the use of style sheets, see "Styling and formatting" on page 488 and "Styling templates with CSS files" on page 490. This dialog lets you edit the Global style sheet (context_all_styles.css, which by default applies to all contexts), and the style sheet that applies to the context that is currently being edited in the workspace: Print (context_print_style.css),Email (context_email_style.
-
At any point you can click on the Advanced button to see the Advanced Stylesheet Rule. See "Advanced Stylesheet Rule" on page 653. l Name: The CSS Selector to which this rule applies. Since CSS selectors are not specific to PlanetPress Connect, any selector used in regular CSS can also be used here. See CSS Selectors on W3Schools for a simple reference page. Type Tab l General group: l l l l l Size: Enter the size in measure, named size or percentage.
-
l Subscript: Sets vertical-align to super. l Superscript: Sets vertical-align to sub. l Capitalize: Sets text-transform to capitalize. l Uppercase: Sets text-transform to uppercase. l Lowercase: Sets text-transform to lowercase. l Small-caps: Sets font-variant to small-caps. Formats Tab l General group: l l l l l Line-height: Specify the height of each line in the element's text, in measure or percentage.
-
Spacing Tab l Padding group: Defines padding (spacing inside the element) in measure or percentage: l l l All sides: Check to set all padding to use the Top value. Equivalent to the border property. Top, Left, Bottom, Right: Set padding for each side. Equivalent to the borderleft, border-top, border-right and border-bottom properties. Margin group: Defines margins (spacing outside the element) in measure or percentage: l l All sides: Check to set all margins to use the Top value.
-
l Value: The value for the given property. The values must be valid for that property, see the CSS Reference link above and check the property for valid values. l New: Click to create a new line and type in the property. l Delete: Click to delete the currently selected property in the Property List. l l Move Up: Move the currently selected property in the Property List up one position in the list. Move Down: Move the currently selected property in the Property List down one position in the list.
-
l Positioning: l l l l l l l Position: Use the drop-down or type in the value for the type of positioning for the table. Equivalent to the CSS position property. Top: Set the vertical offset between this table and its parent's top position. Equivalent to the CSS top property. Left: Set the horizontal offset between this table and its parent's left position. Equivalent to the CSS left property. Bottom: Set the vertical offset between this table and its parent's bottom position.
-
l l Top, Left, Bottom, Right: Set padding for each side. Equivalent to the CSS padding-left, padding-top, padding-right and padding-bottom properties. Margin group: Defines margins (spacing outside the element) in measure or percentage: l l All sides: Check to set all margins to use the Top value. Equivalent to the CSS margin property. Top, Left, Bottom, Right: Set the margin for each side. Equivalent to the CSS margin-left, margin-top, margin-right and margin-bottom properties.
-
percentage of the parent element's size (e.g. 50% 50%). Equivalent to the CSS background-size property. l Position: select the position for the background-image. Equivalent to the CSS background-position property. Table Cell Formatting dialog Cell Tab l l l Width: Set the width of the table in measure or percentage. Equivalent to the CSS width property. Height: Set the height of the table in measure or percentage. Equivalent to the CSS height property.
-
l l Whitespace: Specify how to handle white spaces inside of an element. Equivalent to the CSS white-space property. See CSS White-Space for details. Style group: Check any option to apply the selected style to text within the element: l Bold: Sets the font-weight to 700. l Italic: Sets the font-style to italic. l Underline: Sets the text-decoration to underline. l Strikethrough: Sets the text-decoration to line-through. l Subscript: Sets the vertical-align to super.
-
l Color: Specify the color of the border. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Equivalent to the CSS border-color property. Background Tab l General group: l l Color: Specify the color of the table cell background. The color value must be a valid HTML Color Name, or a valid HTML Hex Color. Equivalent to the CSS background-color property.
-
Key combination Function can then be browsed using the Enter key, arrow up and arrow down buttons.
-
Key combination Function Ctrl + X or: Shift + Delete Cut Ctrl + W Close file Ctrl + Y or: Ctrl + Shift + Z Redo Ctrl + Z Undo Ctrl + Alt + ; Lock guides Ctrl + Shif + R Clear preview cache Ctrl + Shift + S Save all Ctrl + Shift + W Close all Ctrl + Shift + ; Snap to guides Ctrl + ; Show guides Ctrl + ' Show/hide virtual stationery Ctrl + \ Highlight master page items Ctrl + F5 Revert Ctrl + F10 Save as Ctrl + F11 Send COTG test Ctrl + F12 Send to Workflow / Package files Pa
-
Workspace The following key combinations activate a function in the Workspace.
-
Key combination Function Ctrl + B Bold (works on a text selection) Ctrl + E Open Paragraph formatting dialog Ctrl + I Italic (works on a text selection) Ctrl + H Show Edges Ctrl + K Delete browser element Ctrl + M Open Box formatting dialog Ctrl + T Open Text formatting dialog Ctrl + U Underline ( (works on a text selection) Ctrl + + or: Ctrl + Shift + + or: Ctrl + = or: Ctrl + Shift + = Zoom in Ctrl + or: Ctrl + Shift + - Zoom out Ctrl + 0 Zoom to page width Ctrl + 1 Zoom to page c
-
Text editors: Source tab, JavaScript, CSS, Script Editor The following key combinations have a special function in the Source tab of the Workspace (see also: "Source Tab" on page 691), and when editing a JavaScript or CSS file in the Workspace, and in the Script Editor (expanded view).
-
Key combination Function Ctrl + J Line break Ctrl + Q Comment/uncomment; this adds or deletes // before the line. Scripts pane and Resources pane The following keys or key combinations have a special function when a file is selected in the Resources pane and when a script is selected in the Scripts pane.
-
File Menu l l l l l l l l l l l New...: Opens the New (Select a Wizard) dialog. You can choose from the Email, Print or Web Template Wizards. See "Templates" on page 278. Open: Opens a standard File Open dialog. This dialog can be used to open Templates and Data Mapping Configurations. See "Templates" on page 278 and "Data mapping configurations" on page 79. Open Recent: List the most recently opened Templates and configurations.
-
l Export report: opens the wizard to save a template report. See "Exporting a template report" on page 281. l Properties: opens the File Properties dialog. l Print: Opens the "Print Options" on page 766 dialog. l Print Presets: Selecting this option allows you to create or modify Printing Presets, which can be saved and used in print runs thereafter. l l l l l l l Job Creation Presets: Click to open the"Job Creation Presets" on page 756 dialog.
-
l Colors...: Opens the Colors Editor dialog. See "Colors" on page 514. l Fonts...: opens the "Font Manager" on page 599. See "Fonts" on page 518. l Locale...: Opens the Locale Settings dialog. See "Locale" on page 520. l Color Settings...: Opens the Color Settings dialog. See "Colors" on page 514. Insert Menu l l Image: Inserts an image using a resource that is local to the template, a resource on disk or a URL. See "Images" on page 475.
-
l l l l l Sheet Count: This marker is replaced by the total number of sheets in the document, whether or not they have contents. Dashes and Spaces: Use the list to insert special dashes, such as an em-dash, and spaces, such as non-breaking spaces or an en-space. (The HTML code inserted for the dash or space is visible on the Source tab of the workspace.) Arrows: Use the list to insert directional arrows (in one of four directions).
-
l l Address...: Click to open a dialog to add an
element. l Preformatted...: Click to open a dialog to add a element. Structural Elements: l Div...: Click to open a dialog to add a element; see "Boxes" on page 454 l Span...: Click to open a dialog to add a
element; see "Boxes" on page 454 l Article...: Click to open a dialog to add an element l Section...: Click to open a dialog to add a element (the HTML element, not a section in a context).
-
l l l l l l l l Date Field...: Click to open a dialog to add a Date Field; see "Date" on page 471. Number Field...: Click to open a dialog to add a Number Field; see "Number" on page 471. Hidden Field...: Click to open a dialog to add a Hidden Field; see "Hidden field" on page 472. Label...: Click to open a dialog to add a Label; see "Label" on page 472. Checkbox Field...: Click to open a dialog to add a Checkbox; see "Checkbox" on page 472. Radio Button...
-
l l l l l l l Barcode Scanner...: Click to open a dialog to add a Barcode Scanner Element, see "Barcode Scanner" on page 460. User Account...: Click to open a dialog to add a User Account Element, see "User Account" on page 464. Device Info...: Click to open a dialog to add a Device Info Element, see "Device Info" on page 462.
-
l l l l l l Color: When text is selected, sets the text color by applying the color attribute to the text. The color submenu lists all the colors in the Colors Editor. Text...: Opens the Text Formatting dialog to modify the current text selection. See "Styling text and paragraphs" on page 498. Align: When an element is selected, determines how its contents is aligned inside the element. Options are Align Left, Align Right, Align Center and Justify. Paragraph...
-
Context Menu l Add: l l l l l l l l l Print Context: Click to add a new Print context to the template if one does not exist. HTML Email Context: Click to add a new Email context to the template if one does not exist. Web Page Context: Click to add a new Web context to the template if one does not exist. Delete: Click to delete the currently selected context. The last remaining context cannot be deleted. Go to: Click to open the first section in the selected context.
-
l l l Sheet Configuration... (Print Sections Only): Click to open the "Sheet Configuration dialog" on page 649. Master Pages: Click to list the available Master Pages in the template, and open one by clicking it (see "Master Pages" on page 322). Master Page Properties...: Click to open the currently selected Master Page's properties dialog; see "Master Pages" on page 322. View Menu l l l l l l l 50/75/100/150/200%: Click to zoom the Workspace at the selected level.
-
Window Menu l Show View>: Use the options in this menu to show or hide different panes of the UI. l l l l Properties > Attributes: Shows the Attributes pane Messages: Shows the Messages pane, see "Problems and messages" on page 680. l Problems: Shows the Problems pane, see "Problems and messages" on page 680.
-
Attributes Pane The Properties Pane displays all of the properties of the currently selected object in the Workspace. These properties vary greatly depending on the object that has been selected. General These attributes are common to all elements in the template and will always appear. l l ID: A unique identifier for the selected element. Used for CSS selections as well as JavaScript expressions affecting single elements. Class: One or more classes that can be common to more than one elements.
-
l l l l l Title (table only): Defines the title of the table. This has no impact on the table's displays, only on accessibility of HTML pages and screen readers. Repeat (table row not in
or only): Defines if the row is affected by the detail table calculation. This row is the one repeated in a Dynamic Table. Show Row (table row only): Use the drop-down to determine when the selected row appears when a dynamic table overflows.
-
Page These attributes appear when selecting the Page node in the Outline Pane. l Master Page: Which of the "Master Pages" on page 322 to use for the template. Data Model Pane The Data Model Pane displays a Data Model used to help design the template, along with (optional) extracted data. When executing a data mapping configuration or directly loading data (see "Loading data" on page 524), the resulting record set is loaded in the Data Model Pane.
-
l Home: first record l End: last record. Problems and messages Messages Pane The Messages pane is shared between the DataMapper and Designer modules and displays any warnings and errors from the data mapping configuration or template. To open it in the Designer module, click the Messages button at the bottom right of the window (see "Designer User Interface" on page 585). Buttons l Export Log disk. : Click to open a Save As dialog where the log file (.
-
l l Event Types group: l OK: Uncheck to hide OK-level entries. l Information: Uncheck to hide information-level entries. l Warning: Uncheck to hide any warnings. l Error: Uncheck to hide any critical errors. Limit visible events to: Enter the maximum number of events to show in the Messages Pane. Default is 50. Moving and merging panes The PlanetPress Connect interface for both the Designer and DataMapper module is highly configurable.
-
l Click the Restore button next to the panel's display icon. The restored panel will return to its original docked location. To temporarily display a minimized panel: l Click the panel's display icon. When another panel, menu or toolbar is clicked, the panel will be minimized again. To maximize a panel: l Click the Maximize button at the top-right corner of the panel. A maximized panel takes the full available size for the panels. All other panels are minimized.
-
Tip Images, fonts, stylesheets and snippets can be dragged or copied and pasted into the Resources Pane to add them to your template. Media Media resources define paper handling configurations for Print output (see "Generating Print output" on page 861 and "Print Options" on page 766) including page size and paper type. See "Media" on page 325 for more information. Contextual menu l l l l New Media: Click to create a new media and open its properties. Delete: Click to delete the resource.
-
Contexts Contexts hold the actual content of the template that is used to generate output. See "Contexts" on page 293 for more information. Contextual menu (Context folder or individual contexts) l New Print Context: Click to create a new Print Context with a single section. l New Web Page Context: Click to create a new Web Page Context with a single section. l l New HTML Email Context: Click to create a new HTML Email context with a single section. Properties...
-
Images Images are graphical elements that can be added to the page for display, either statically or dynamically. See "Images" on page 475 for more information. Contextual menu l l l New Folder: Click to create a new folder to organize resources more easily. Rename: Click to open the resource's Rename. This is the same as pressing the F2 key while the resource is selected. Delete: Click to delete the resource. This is the same as pressing the Delete key while the resource is selected.
-
l Delete: Click to delete the resource. This is the same as pressing the Delete key while the resource is selected. Stylesheets Stylesheets control how contents appears on the page. It defines spacing, color, size and other properties of elements on the page. See "Styling templates with CSS files" on page 490 for more information. Contextual menu l l l l l New Stylesheet: Click to create a new Stylesheet resource. Adding a new stylesheet will automatically include it in the currently active section.
-
Scripts pane The Scripts pane contains all of the scripts that are used to replace data in a template, or to modify its look; see "Personalizing Content" on page 522. Scripts can be exported and imported via the buttons or through drag & drop between the Scripts pane and any location on the computer. Note Scripts included on the Scripts pane are completely distinct from the JavaScript resources found in the "Resources Pane" on page 682 (see "Using JavaScript" on page 372).
-
l l l l l l Dynamic Image script: Provided that its selector refers to an image, this script dynamically changes the image for each record. See "Dynamic Images" on page 545. Email scripts: Email scripts define the sender, recipients, subject etc. of the email that is sent, and the PDF password. See "Email header settings" on page 343. Control script: A Control script affects the output of a template per record as a whole, instead of parts of the content.
-
l Enable/Disable: Click to trigger the script to be enabled or disabled. Disabled scripts are greyed out and italic and will not be executed. See "Enable/disable scripts" on page 559 l Import: load a script from a Scripts file (*.OL-script). l Export: save the script to a Scripts file (*.OL-script). l Properties (Script folders only): edit the name and execution scope of the folder. See "Execution scope" on page 559.
-
Design Tab The design tab show the template including all styles, text and images as well as the placeholders used for variable data. In this tab, the template's scripts are not executed and only placeholders are shown. The top of the Design tab contains an area with the following options: l l l l Breadcrumbs: Displays the element type where the cursor is located and any of its parent elements. Elements with classes or IDs show these details next to them, for instance div #contents > ol.salesitems > li.
-
Source Tab The source tab displays the HTML source for the template, including HTML Headers, CSS and HTML code. The source is displayed in a color-coded text editor, to quickly visualize the code. In this tab changes and adjustments can be made to the code. To the left of the Source tab, a bar helps visually identify the start and stop of an element. For example when clicking on the opening
element, this bar marks the whole and all its contents, until the ending
tag.
-
Live tab The Live tab shows the result of the template as rendered by the Gecko rendering engine. It is a good indication of how an HTML template would display in a visitor's browser, especially if they are using FireFox (which uses the Gecko engine). Toolbars In the Designer module, the following buttons are available in the top toolbar: l File Manipulation l l l l l l Open: Displays the Open dialog to open an existing template. Save: Saves the current template.
-
l Insert Text Field: Inserts a element. A drop-down is available to insert other fields, such as a URL, Password etc. l Insert Text Area Field: Inserts a
-
l Table Manipulation l l l Insert Standard Table...: Inserts a table with a specific number of columns and rows through the "Table" on page 480 Wizard. Insert Dynamic Table...: Inserts a dynamic table where the number of rows is determined by a Details table, through the "Dynamic table" on page 547 Wizard. Select l l l l Select Row: Selects the innermost row where the cursor is located. l Select Cell: Selects the innermost cell where the cursor is located.
-
l l l l l l l Insert Pie Chart: Click to insert a new Pie Chart object and open the Chart Script wizard. Insert Bar Chart: Click to insert a new Bar Chart object and open the Chart Script wizard. Insert Line Chart: Click to insert a new Line Chart object and open the Chart Script wizard. Insert Hyperlink...: Creates a Hyperlink or mailto link on the currently selected text or element and opens its properties. See "Hyperlink and mailto link" on page 474.
-
l l l l l l Font Face: Displays the font face of the selected text or element where the cursor is located and drops down to show other available font faces which can be applied to it. Fonts added to the Fonts folder of the Resources pane are shown automatically in the Fonts drop-down. Font Size: Displays the font size of the selected text or element where the cursor is located and drops down to show other available sizes which can be applied to it.
-
l l l l Outdent: Decreases indentation of the selected text element. If the element is wrapped in a blockquote element, one blockquote is removed. If the element is a list item, it is removed from one surrounding list. Position l Superscript: Makes the currently selected text a superscript. l Subscript: Makes the currently selected text a subscript. Remove Formatting: Remove any and all styles, text decorations and other formatting from the selected text. Indentation is not affected.
-
l l l l l Create a New Template: Lets you choose a Context to create a new template without a Wizard. Browse Template Wizards: Displays a list of available Template Wizards, producing premade templates with existing demo content; see "Creating a template" on page 278. Open an Existing Template: Click to open the standard Browse dialog to open an existing template. Recent Templates: Lists recently used templates. Click any template to open it in the Designer module.
-
types can be added to the Printer Model drop down list via the Settings button For more information on how to do this, see "Adding print output models to the Print Wizard" on page 865. l Output Options group: l l Output Local checkbox: Select to have the output created using the local Print Server. Output Type choices: l l Prompt for file name: Select to output to a local file on the hard drive. When this option is selected, no other configuration is necessary.
-
l l Windows Printer: Select to send the Print Job to a Printer Queue. The job is rendered as a PDF before being printed through the Windows driver. l l l l Job Name: The name of the output file. You can use ${template} as a variable for the name of the Designer Template used to generate the output. Windows Printer: Use the drop-down to select the windows printer queue where the job will be sent. Job Owner Name: Optional entry for adding the name of the job owner.
-
l l l l l l l l Print virtual stationery checkbox: Check to enable virtual stationery in the output. Use grouping checkbox: Check to configure grouping of output into jobs, job segments or document sets. See "Grouping Options" on page 763. Include meta data checkbox: Check to add meta data to the output. This can be done at Job, Job Segment, Document, Document Set and Page level. See "Metadata Options " on page 765.
-
Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections. Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard.
-
Booklet Options The Booklet Options page defines how to generate booklets in the output. It is used in conjunction with Imposition settings, which will appear after the Booklet entries have been made. This page includes a handy illustration that displays how the final binding would look, based upon the current selections.
-
l l Blank: Select to add no data to the back cover. Last two pages on inside and outside: Select to use the final 2 pages as the inside and outside of the back cover. Imposition Options Imposition refers to the printing of multiple pages on a single sheet. This is also known as N-Up printing. The options on this page allow for the setting of imposition repetition, order, margins and markings. The display box shows a representation of the current Imposition selections.
-
l Position: Select from following options: Note If "Booklet Options" on page 772 were selected, then the Position settings are pre-set and cannot be altered here. l l l Auto-positioned: This option creates unscaled imposition-ed pages. Scale to fit: Scales the imposition-ed pages so they fit on the N-Up stock. The scaled pages are then auto-positioned as usual. Offset: Allows for the selection of an offset position.
-
options made within the "Booklet Options" on page 772 Page and they cannot be altered here. l Gap group: Allows selection of the amount of blank space (either Horizontal and/or Vertical) to add between each page. Note If Booklet Binding were selected, some of these settings will be determined by the options made within the "Booklet Options" on page 772 Page and they cannot be altered here.
-
l Force simplex: Select this option to make the output Simplex, rather than the Imposition default of Duplex. Note If Booklet Binding were selected, some of these settings will be determined by the options made within the "Booklet Options" on page 772 Page and they cannot be altered here. l CropMarks group: l Type: Use the drop-down to select the type of Crop Marks to add to the page. l Page side: What side(s) of the page to put the Crop Marks. l Width: Select the width of the crop mark lines.
-
Inserter Options The Inserter Options page allows the selection of a High Capacity Feeder (HCF) model. These machines are also commonly referred to as Inserters or Folder-Inserters. The options available on this page are dependent upon the model selected. The options selected on this page influence the position of the markings set on the next page: "Mark Position Options" on page 779.
-
l Margins: l l l Same for all sides: Check so that the Left margin selection is used to set all sides identically. Left, top, right, bottom: Enter measurements for the margins on each side of the OMR Marks. Custom OMR mark sizing Tab: If supported by the currently chosen Mark Configuration you can select a Custom OMR size by checking the Custom OMR mark sizing checkbox. Select from any of the following, or leave the entries blank to use default values: l Line length: Enter a value between 10.
-
l l The pink area displays the areas of the page where inserter marks can be positioned. The small checkered box displays the current location of the inserter marks. This box is selectable and can be dragged to the desired location within the printable (pink) areas. If the box is placed outside the printable areas the page will display an error and prevent attempts at leaving the page. Below the Preview box are buttons which allow control of the Preview box.
-
l l l l Reload All: Restores all Section properties to the default values set in the template for each Section. Apply finishing from: Displays a list of available Sections. Clicking on a Section name loads that Section's properties into the current Section to edit. Apply current finishing to all sections: Applies the current properties to all Sections. Binding group: l l l l l Style: What type of Binding to request on the printer.
-
Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections. Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard.
-
Documents of 1 to 5 pages length, the second will contain any document of 6 or more pages. Note Page Break Grouping works only on Document page counts. l l Grouping Level: Use the drop-down to select which grouping level to use, between Job, Job Segment or Document Set. Only one grouping level can be selected. Grouping list: Add (or remove ) entries to this list to create new groups based upon the number of pages in the level selected above.
-
through the wizard to return to the main selection page (the "Print Options" on page 766 page) and add or remove printing options from the print run. l l Print button: Click to produce print output according to the current settings. This can be done at any point within the Wizard, whether or not the options selected in the the "Print Options" on page 766 page have been completed or not. Cancel button: Cancels the Print Wizard, without creating any printout.
-
Separation Options This page defines how to separate the jobs using subsets, slip sheets, or jogging. l Sheet Count Splitting group. This group allows for the splitting of output based upon a pre-determined number of pages l l l None: Select to ignore sheet count splitting entirely. l At exactly: Select to create a split at a specific sheet number. Every: Enter the number of sheets at which to split the output.
-
Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections. Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard.
-
will be displayed here. You might consider this a text entry preview of the text, rather than the complete text entry. l Condition: Displays the condition which is used to determine if text element is to be included or not. l Add: Click to open the Additional Text Settings dialog to add a new text entry. l Delete: Click to delete the currently selected entry. l Edit: Click to edit the currently selected entry using the Additional Text Settings dialog.
-
l Left: Displays the distance between the left margin of the page and the Barcode . l Bottom: Displays the distance between the bottom margin of the page and the Barcode . l Orientation: Displays the orientation of the Barcode . l Type: Displays the type of Barcode that's added. l Text: Displays the data used for generating the barcode content. l l l l l Condition: Displays the condition which is used to determine if the barcode is to be included or not. Add: Click to add a Barcode.
-
Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections. Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard.
-
l l Font group: l l Font Name: Use the drop-down to select which font type to apply to the Text. The drop-down displays all the fonts installed on the system. l Font Size: Enter the font size in points (pt). l Bold: Check to make the Text bold. l Italic: Check to make the Text italic. l Color: Select what color the Text will be. Text: Enter the actual Text to appear on the page in the selected location.
-
Note If Imposition options such as auto-positioning and scaling were selected, these options won't apply to the Additional Content added to the physical NUp sheet. l l l Left: Enter the distance between the left margin of the page and the image, in either metric (cm/mm), inch (in), pixel (px) or point (pt) values. Bottom: Enter the distance between the bottom margin of the page and the image, in either metric (cm/mm), inch (in), pixel (px) or point (pt) values.
-
Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l l l Default start symbol: Use the drop-down to select the optional Barcode start character, which defines the encoding mode. Default stop symbol: Use the drop-down to select the Barcode stop character, which defines the encoding mode. Print human readable text: Check to add a textual version of the Barcode data. l l l l l Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l l l l Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text. Text: Enter the text used to generate the Barcode. l l Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode. Add button: Click to display a list of variable data that could be used for generating the Barcode.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
This adds support for lower case letters (a-z) and the full range of ASCII punctuation and special characters. l Module Width: Specifies the width of the narrow bars. Changing this value to higher value will generally make the Barcode bigger. The smallest Module Width is 0.19mm (high density). l Bar width ratio: Set the Barcode bar width. l Checksum: Use the drop-down to select how to deal with the Barcode checksum: l l l l l l l Check: Verify the Barcode has a valid checksum.
-
Data Matrix Settings A Data Matrix barcode is a high-density, two-dimensional (2D) matrix barcode which supports encoded text, numbers, files and digital data. Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode.
-
l Datamatrix Properties g: l l Module Width: Specifies the width of the narrow bars. Changing this value to higher value will generally make the Barcode bigger. Encoding: The data represented in the symbol can be compressed using one of the following algorithms: l l l l l l l l ASCII: is used to encode data that mainly contains ASCII alphanumeric characters (ASCII 0-127). Use where Barcode size is a concern and where the data is alphanumeric. Base 256: used to encode 8-bit values.
-
GS1-128 entry for more information. Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page.
-
l l l l l Module Width: Specifies the width of the narrow bars. Changing this value to higher value will generally make the Barcode bigger. Check Digit marker: This character is used as a placeholder for the check digit, which we be calculated at runtime. The character must be expressed in Hex. Group separator: This character is used to define group separation points. The character must be expressed in Hex. Template: Specify an optional Barcode "template".
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l Checksum: Use the drop-down to select how to deal with the Barcode checksum: l l l l l l l Check: Verify the Barcode has a valid checksum. Add: Calculate and add a checksum character to Barcode, regardless of current value. Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode. Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l Checksum: Use the drop-down to select how to deal with the Barcode checksum: l l l l l l l Check: Verify the Barcode has a valid checksum. Add: Calculate and add a checksum character to Barcode, regardless of current value. Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode. Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l Print human readable text: Check to add a textual version of the Barcode data. l l l l Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text. Text: Enter the text used to generate the Barcode. l l Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode.
-
l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing. Select this box to have the Barcode printed once per sheet rather than once per document page. Note If Imposition options such as auto-positioning and scaling were selected, these options won't apply to the Additional Content added to the physical NUp sheet.
-
(maximum error correction). Recommended error correction levels are between level 2 and 5, but the optimal value depends on the amount of data, printing quality of the PDF417 symbol and decoding capabilities. l l Rows: A PDF417 bar code can have anywhere from 3 to 90 rows. l Columns: The number of data columns can vary from 1 to 30. Text: Enter the text used to generate the Barcode. l l Add button: Click to display a list of variable data that could be used for generating the Barcode.
-
l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing. Select this box to have the Barcode printed once per sheet rather than once per document page. Note If Imposition options such as auto-positioning and scaling were selected, these options won't apply to the Additional Content added to the physical NUp sheet.
-
l l Byte: 2953 characters. l Kanji: 1817 Japanese/Chinese characters. Version: Select the preferred QR code version (which sets the data length field) from the 40 available. Note The Encoding and Version fields work together to determine how many characters are encoded within a length field. The following table shows the number of bits in a length field, based upon the selections made: Encoding l l l Ver. 1-9 Ver. 10-23 Ver.
-
Note The Structured Append symbols Part number can never exceed the sum total of Structured Append symbols available (the "of" value). Thus selecting a Part number beyond the existing sum total will increase the sum total to the same value. l Use FNC1: Check to enable Application Identifiers. These are often used to encode links to websites, or to encode production/batch details.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l l l l l l l Check: Verify the Barcode has a valid checksum. Add: Calculate and add a checksum character to Barcode, regardless of current value. Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode. Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text. Text: Enter the text used to generate the Barcode.
-
Note Note To create dynamic barcodes, "Metadata Options " on page 765 must first have been set. Metadata fields are required to create the association between the dynamic data used in the print run and the barcode. Use the following options to configure the output Barcode settings: l Position group: l l Orientation: Use the drop-down to select the orientation of the Barcode added to the page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing.
-
l l l l l l l Check: Verify the Barcode has a valid checksum. Add: Calculate and add a checksum character to Barcode, regardless of current value. Placement: Use the drop-down to select whether to place the human readable text above or below the Barcode. Font name: Use the drop-down to select the font with which to display the human readable text. Font size: Enter a font size for the human readable text. Text: Enter the text used to generate the Barcode.
-
l Position group: l l l Orientation: Use the drop-down to select the orientation of the OMR Mark added to the page. Page Side: Select whether the OMR Mark will print on the front or back of page. Output once per sheet: Option relates to Imposition (also known as N-Up) printing. Select this box to have the OMR Mark printed once per sheet rather than once per document page.
-
enabled, based upon this selection. l l l l Line Per Inch: If Line Spacing is set to Lines Per Inch this option will be enabled. It defines how many lines will print per inch. Gap Distance: If Line Spacing is set to Gap Distance this option will be enabled. It defines the size of the gap between lines. i.e. the distance from the bottom of one OMR mark line to the top of the next. Line Distance: If Line Spacing is set to Line Distance this option will be enabled.
-
l l l Start: Start number l Stop: Stop number Condition: Enter the condition which determines whether or not the OMR Mark will be added to the document at print time. For details on how to create a conditional, see the Conditionals page. OMR Marks Tab: l #: OMR Mark number (display only). l Type: Type of OMR Mark (display only). l l Value: OMR Mark Value. These can be selected and altered for Sequence, Match and Parity marks, as described below. Add: Add an OMR Mark entry to the table.
-
Note The match number is the same for all pages in a group l l Parity: This mark prints in order to maintain the parity of the number of lines printed on the page. If set to Even then it will print if the total count of the other printed marks in the printed is odd. For example, by printing the parity mark it will create an even number of marks on the page.
-
l Embed standard fonts: Click to embed the 14 standard system fonts within the PDF output. This increases the output filesize but makes the PDF output truly portable. Such PDFs print as displayed on screen, regardless of whether the 14 standard fonts are present on the target printing system or not. Note This box is ignored for PDFA and PDF-X4 output, as fonts are always embedded in those output types. l Add Digital Signature Group: Check to enable the integration of a digital signature into the PDF.
-
l l l New: Click to open the PDF Signature dialog to add a new signature to the list. Duplicate: Click to make a copy of the currently selected signature. Edit: Click to edit the currently selected signature in the PDF Signature dialog. l Delete: Click to delete the currently selected signature. l Move Up: Click to move the currently selected signature up. l Move Down: Click to move the currently selected signature down.
-
l PKCS#11 Note PKCS#11 requires an extra plug-in not included in the PlanetPress Connect installation. These are the options available in this dialog: l Name: Enter a name for the keystore to describe it within Connect. l File: Enter the path to the keystore file, or use the Browse button to locate the file. l Keystore properties group: l l l l l Type: Use the drop-down to select the appropriate type of the keystore format the file is: JKS, PKCS11, PKCS12.
-
l l l Name: Enter a name that describes the signature entry. Keystore: Use the drop-down to select which keystore the signature is pulled from. These keystores are set in the "Keystore" on page 783 dialog, called from the "PDF Options" on page 780 page. Signature Properties group: These are optional Metadata fields associated with the signature, which can be omitted. l Location: The CPU host name or physical location of the signing. l Reason: Records the reason for the signing.
-
l l X: Enter the horizontal distance between the left side of the page and the left side of the signature, in points (pt). Y: Enter the vertical distance between the top of the page and the top of the signature, in points (pt). l Width: Enter the desired width of the signature, in points (pt). l Height: Enter the desired height of the signature, in points (pt). Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset.
-
l Properties: Displays a summary of the settings for this Job Creation Preset. l Has Custom Job Creation Options: Indicates if any job creation settings have been added. Becomes Yes if any setting in any of the below windows have been added: l Has Data Selection Filter: Becomes Yes if Data Filtering Options are set. l Has Sorting: Becomes Yes if any Sorting Options are set.
-
l l Ignore section level finishing: Check to override finishing options at the document level only. Section to edit: Use the drop-down to select which Section to apply the options below. The Document level is also listed to edit document-level finishing.
-
l l Area: The area where the binding can be applied. Hole making group: Hole making options are available only to Ring, Comb (wire and plastic) and Coil Binding Styles. The selections will need to be made at run-time based upon the types of binding options available that the printer supports. l Number of holes: The number of holes to punch for the selected Binding option. l StyleThe style of hole punches for the selected Binding option.
-
l Operator: Use the drop-down to select the comparison operator for the condition. l Value: Type in a value for the comparison. l l l l l Add: Click to add a new line to list. Different options are available in this menu, such as filtering by field, media and finishing properties, or document length. Add a new nested rule group: Click to add a new grouping at the current level. Delete: Click to delete the currently selected rule or group.
-
Warning External Sort commands must return a non-zero error code if an error occurs. An external sort command could easily fail part way through processing and generate only a partial output file. Without receiving a return code from the external sort process, PlanetPress Connect cannot know if the sort has successfully completed or not. Thus the sort program must generate a return code, with a code of zero ('0') indicating success, and all non-zero results indicating failure.
-
characters, is relatively compact (in terms of Unicode character sets) and is compatible with standard ASCII. l Exported sort data group: l l First row of sort data has field names checkbox: select to have field names placed on the first line of the exported CSV file. Fields to export: Lists the fields to export in the CSV file. The buttons to the right of the table provide the following functionality: l Click to select from available datatfields.
-
l l Record ID Field selection box: Select which return field is to be the Record ID field. Sorting by selection box: Select whether the sorting will be by the returned sort order or whether it is to be sorted on a selected datafield. l Sequence Field selection box: Select the datafield to be sorted on, if such was chosen in the Sorting by entry. Grouping Options The Grouping options separates the job output into multiple blocks that can then be physically separated using split sheets in the printer.
-
l l Grouping Level: Use the drop-down to select which grouping level to use, between Job, Job Segment or Document Set. Only one grouping level can be selected. Grouping list: Add (or remove ) entries to this list to create new groups based upon the number of pages in the level selected above. All groups must be contiguous from 1-to-Largest and they must not contain any gaps. l l l l l Range Name: Enter a name identifying the range.
-
Metadata Options The Metadata Option page defines metadata tags that will be added to the output file when producing PDF and AFP output in the Output Creation Presets. Metadata tags are ignored in all other output types, except when they are associated with "Additional Content" on page 716 in the Print Wizard. The tags can be added to any of these levels, as indicated by the tabs on top: Job, Job Segment, Document, Document Set, and Page Tags.
-
l Configuration Name: Use the drop-down to select the presets saved in the default location. Click the Settings button for more options: Click the Reload option to look for new presets. l l l Click the Import Configuration... option to import one or more Output Presets using a Browse dialog. Properties: Displays a summary of the settings for this Output Creation Preset.
-
The choices can be broken down as follows: l Printer group: l Model: Use the drop-down to select the printer language / output type that will be generated. Connect output options cover a range of industry standard print output types. These include PCL, PDF and PostScript (including PPML, VIPP and VPS variants), with a range of quality settings available.
-
l LPR Queue: Select to send the print job to an LPR queue. It is assumed that the print technology is supported by the system receiving the LPR job. l l l l l Queue Name: The queue name that will accept the job on the LPD. Default is generally "auto". Job Owner Name: Optional entry for adding the name of the job owner. Job Name: The name of the output file. You can use ${template} as a variable for the name of the Designer Template used to generate the output.
-
l Production Options: l l l l l l l l l l Add Inserter marks checkbox: Check to enable inserter mark functionality, which is set in the "Inserter Options" on page 777 page. Override Finishing options checkbox: Check to configure custom "Finishing Options" on page 757, such as binding. Print virtual stationery checkbox: Check to enable virtual stationery in the output. Use grouping checkbox: Check to configure grouping of output into jobs, job segments or document sets.
-
of gray, rather than black or white. l l Black Threshold Percentage: The percentage of shading at which the element will appear as full black, rather than dark gray. White Threshold Percentage: The percentage at which the element will appear as full white, rather than light gray. Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset.
-
l Weight: Enter a weight for the paper. l Type: Use the drop-down to select which type of stock to use on the printer. l Color: Use the drop-down to select which color the paper should be on the printer. Separation Options This page defines how to separate the jobs using subsets, slip sheets, or jogging. l Sheet Count Splitting group. This group allows for the splitting of output based upon a pre-determined number of pages l l l None: Select to ignore sheet count splitting entirely.
-
None (no forced jogging) or at the Job, Job Segment, Document or Document Set level. Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections.
-
l Booklet Binding Edge: Use the drop-down to select the side on which to bind the booklet. Optional Cover Page selections are available to Saddle Binding only. l Cover Page checkbox: Check to enable cover pages to be created with the options below: l Media selections: l l Front Cover selections: l l l Cover Media Size: Use the drop-down to select the media size for the cover page, or use a Custom size and select Width and Height values. Blank: Select to add no data to the front cover.
-
size multiplied by the number of repetitions, added with the margins and spaces between the repetitions. If Custom media size is selected, enter the custom Width and Height values. Note The Sheet Size cannot be altered if a Cover Page was selected in the "Booklet Options" on page 772 Page. l l Orientation: Select orientation (aspect ratio) of media (Landscape or Portrait), or allow Connect to automatically determine the proper aspect ratio (Auto-Rotate).
-
stock to be rotated to fit the imposition-ed pages) then the measurement becomes the top left position of the rotated stock. i.e. The top left corner does not rotate with the stock. l l Rotate final output Sheet 180 degrees (upside down): Select to flip the output upside down. Repetition group: Allows selection of how many Sections are to be placed, both Horizontally and Vertically. This is the total number of items, not the number of additional items being placed.
-
options made within the "Booklet Options" on page 772 Page and they cannot be altered here. l l l l Page Order: Select in which direction to go when adding sections to the output: l Left to right, then top to bottom l Right to left, then top to bottom l Top to bottom, then left to right l Top to bottom, then right to left Stack Depth: Enter a stack depth or use the arrows to increment or decrement. Reverse Pages: Select this option to reverse the order of pages.
-
Advanced Print Wizard navigation options l l l l l Load button: Click to select a previously created Output Creation Preset. This will change the Advanced Print Options to match the entries contained within the Preset. Preview button: Click to launch a Proof Preview window, which displays how the printed output would look based upon the currently chosen selections. Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard.
-
printed page. l l l l l Fold Type: Use the drop-down to select the type of fold to apply to the paper. This will impact upon where on the page the markings will be placed. Collation level: Select whether the markings will be made at Document level, or Document Set level. Print marks on back: Check to place the Inserter Marks on the rear of the page.
-
l l l Back and Next buttons: Used to navigate back and forth through all the selected options within the Wizard. Up until the Print button is pressed, one can reverse all the way through the wizard to return to the main selection page (the "Print Options" on page 766 page) and add or remove printing options from the print run. Print button: Click to produce print output according to the current settings.
-
l Zoom Level: Use the drop-down to select a predefined level or enter a zooming percentage. PDF Options The PDF Options page is shown only when a PDF Print output type is selected in the Print Options dialog. l PDF Options Group l l PDF Type: Use the drop-down to specify which format the PDF should be generated in. These options are standard PDF, archive format PDF (PDFA-1b), graphics format PDF (PDF-X4 ) and variable data printing format PDF (PDF-VT).
-
l l Edit: Click to edit the currently selected keystore in the Key Store dialog. l Delete: Click to delete the currently selected keystore. l Move Up: Click to move the currently selected keystore up. l Move Down: Click to move the currently selected keystore down. All Signatures: Displays a list of signatures to add to the PDF output. l Name: The user-defined name of the signature. l File: The file path and name to the signature file. l Alias: The user-defined alias for the signature.
-
PDF Digital Signature Options PDF Signature The PDF Signature dialog appears when adding or editing a signature from the "PDF Options" on page 780 page. l l l Name: Enter a name that describes the signature entry. Keystore: Use the drop-down to select which keystore the signature is pulled from. These keystores are set in the "Keystore" on the next page dialog, called from the "PDF Options" on page 780 page.
-
l l Password: Password specific to the TSA server chosen. l Repeat Password: Repeat of password. Visible Signature group: Check to add a visible signature to the PDF file. l l X: Enter the horizontal distance between the left side of the page and the left side of the signature, in points (pt). Y: Enter the vertical distance between the top of the page and the top of the signature, in points (pt). l Width: Enter the desired width of the signature, in points (pt).
-
l PKCS#11 Note PKCS#11 requires an extra plug-in not included in the PlanetPress Connect installation. These are the options available in this dialog: l Name: Enter a name for the keystore to describe it within Connect. l File: Enter the path to the keystore file, or use the Browse button to locate the file. l Keystore properties group: l l l l l Type: Use the drop-down to select the appropriate type of the keystore format the file is: JKS, PKCS11, PKCS12.
-
Most scripts can be made using one of the Script Wizards (see "Personalizing Content" on page 522). However, when you want to do more than what you can do with a Wizard, you may write a script yourself. If you are not familiar with writing scripts, please read "Writing your own scripts" on page 552 first. All scripts in the Designer have to be written in JavaScript. If you don't know JavaScript, the many examples given in this API will help you get started.
-
Designer Scripts API This page lists the global objects and functions that are available in scripts, created inside the Scripts pane. Click through to an object or function to get a description and examples. If you are not familiar with writing scripts, see "Writing your own scripts" on page 552. Control Scripts Control Scripts are a special kind of Designer Scripts.
-
Object Description on page 842 triggered the current operation. Not available in PrintShopMail Connect. "merge" on page 844 The merge object is mainly used in Control Scripts. It gives access to the template with all of its contexts and sections. It doesn't give access to the content of the sections. To change the content of a section, you would create a script with a selector and use the results object in the script (see "results" on page 810).
-
Date, date/time and time functions l date() l dateLong() l dateMedium() l dateShort() l dateTime() l dateTimeLong() l dateTimeMedium() l dateTimeShort() l time() l timeLong() l timeMedium() l timeShort() Note The locale also influences the output of the different Date functions; see "Locale" on page 520.
-
String. The custom pattern may consist of pattern letters, separating symbols and quoted text, for example: "MMMM dd, yyyy"; see "Date and time patterns" on page 792. Note that the repetition of pattern letters determines the exact presentation. dateLong(value) Formats a date as long string representation, for example April 1, 2016. value A Date object. A Date can contain a date and time. dateMedium(value) Formats a date as medium string representation, for example 01/04/16. value A Date object.
-
dateTimeLong(value) Formats a date and time as long string representation, for example April 1, 2016 12:00:00 EDT AM. value A Date object. A Date can contain a date and time. dateTimeMedium(value) Formats a date and time as medium string representation, for example 1-Apr-2016 12:00:00 AM. value A Date object. A Date can contain a date and time. dateTimeShort(value) Formats a date and time as short string representation, for example 01/04/16 12:00 AM. value A Date object. A Date can contain a date and time.
-
A Date object. A Date can contain a date and time. timeMedium(value) Formats a time as medium string representation, for example 12:00:00 AM. value A Date object. A Date can contain a date and time. timeShort(value) Formats a time as short string representation, for example 12:00 AM. value A Date object. A Date can contain a date and time. Examples The following script passes the value of a field in the record set to the date() function.
-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date.) When the time is omitted, it defaults to 12:00:00 AM. /* Convert var var var [0]); the string 21-12-1997 into a valid JavaScript date */ strDate = record.fields["date"]; dateParts = strDate.split("-"); date = new Date(dateParts[2], (dateParts[1] - 1), dateParts Note JavaScript counts months from 0 to 11. January is 0. December is 11. Another way to put a string in a Date is to use the Date.
-
Note The pattern letters and patterns on this page are only suitable for displaying dates and times in templates, not for extracting dates in the DataMapper module. For pattern letters and patterns available in the DataMapper, see "Date" on page 144.
-
zone Note These date and time pattern letters and patterns conform to standard Java notation. For more information, see http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html. Each A generic iterator function, to iterate over the elements in the result set. each(callback) Iterates over the elements in a set, such as the enumerable properties of an object, in arbitrary order. For each distinct property, statements can be executed. callback A function.
-
Selector Matched element Matched element after script execution p
3
1
7
This script gets the row index (of the current element in the set) and puts it in a paragraph. results.each(function(index){ this.
-
Selector Matched element Matched element after script execution p
primero
último
dirección de correo electrónico
For...in Can be used to iterate over fields in a data set or rows in detail table. Also see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...in. for(variable in object) { ...
-
Selector Matched element Matched element after script execution #test
Fields
Fields
Peter
Parker
pparker@localhost.com
This script iterates over rows in a detail table and adds the contents of the 'country' field to a paragraph. for(var i in record.tables['countries']) { results.after("" + record.tables['countries'][i].
-
Note The TextFormatter object is now deprecated and will eventually be removed. Functions Function l l currency() currencyNoSymbol () l grouped() l integer() l l l Description The currency(), grouped(), integer() and number() functions allow you to format a number, possibly with a custom pattern. See "Number functions" on page 803.
-
Function l properCase() Description first character of each word to uppercase and all other characters to lowercase. loadhtml() Global function that replaces the content (inner html) of each matched element in the result set, alternatively load the data into a variable. The location should be an URL or a relative file path. Note Loadhtml() is cached per batch run (based on the URL) in print/email. loadhtml(location) Loads all HTML from the specified HTML file.
-
The following script loads a snippet into a variable and finds/replaces text in the variable before inserting the content into the page. The second find command also adds formatting to the replacing text. var mysnippet = loadhtml('snippets/snippet.html'); mysnippet.find('@var1@').text('OL Connect 1'); mysnippet.find('@var2@').html('OL Connect 2').css('textdecoration','underline'); results.
-
var snippet = loadhtml('snippets/snippet.html','foobar').children (); results.replaceWith(snippet); The next script loads a remote snippet, looks for an H1 heading and uses that text. var post = loadhtml('snippets/post.rhtml'); var h1 = query('h1', post).text(); results.text(h1); Another example is given in the following how-to: Using a selector to load part of a snippet. loadjson() Creates a JSON object based on the text retrieved from the supplied location.
-
This script retrieves a post from a WordPress site. var wpPost = loadjson('http://192.168.101.58/2013/06/leave-thethird-dimension-behind-and-focus-on-real-printinginnovation/?json=1'); if(wpPost.post){ results.html("
" + wpPost.post.title + "
" + wpPost.post.content); } This script retrieves multiple posts from a WordPress site. var numPosts = 3; var wpPost = ''; var wpRecentPosts = loadjson('http://192.168.101.58/?json=get_ recent_posts&count=' + numPosts); if(wpRecentPosts.
-
Method Parameters Description warn() message: string Logs a warning message Number functions Note The locale also influences the output of some Number functions; see "Locale" on page 520. Tip For fields that contain a number, you can also enter a formatting pattern directly in the Text Script Wizard; see "Using the Text Script Wizard" on page 537, "Formatting variable data" on page 540 and "Number patterns" on the facing page). currency(value) Formats a number as an amount of money.
-
A custom pattern that may consist of symbols; see "Number patterns" below. Note that the repetition of pattern letters plays a part in determining the exact presentation. currencyNoSymbol(value) Formats a number as a currency whilst omitting the currency symbol. value A number. This can be a value from a field that contains a SmallInteger, BigInteger, Float, SmallCurrency or LargeCurrency. grouped(value) Formats a number using a thousands separator.
-
Pattern characters Symbol Location Localized? Meaning 0 Number Text Digit # Number Year Digit, zero shows as absent . Number Year Decimal separator or monetary decimal separator - Number Month Minus sign , Number Number Grouping separator E Number Number Separates mantissa and exponent in scientific notation. Need not be quoted in prefix or suffix.
-
query() This function creates a new result set, containing the HTML elements in the current section that match the supplied CSS selector. The context (optional) allows you to restrict the search to descendants of one or more context elements. The new result set is of the type QueryResults, just like the results object which is also the result of a (hidden) query. All functions that can be used with the results object can also be used with this result set; see "results" on page 810.
-
query(selector, context) Creates a new result set containing the HTML elements that match the supplied CSS selector. The context (optional) allows you to restrict the search to descendants of one or more context elements. selector A String containing a CSS selector. See http://www.w3schools.com/cssref/css_selectors.asp for CSS selectors and combinations of CSS selectors. context A result set (the result of another query) or an HTML string.
-
Field Type Description id Number The id of this record. index Number The one-based index of this record, or zero if no data is available. tables Array The detail tables that belong to this record. You can access a specific table using either a numeric index or the table name, followed by a numeric index for a record inside that detail table. For example, to access the value of the field prod_id in the first record of a detail table called detail, use: record.tables["detail"][0].fields["prod_id"].
-
The next script looks up a value in the first record in a detail table and shows or hides the results depending on that value. if (record.tables["detail"][0].fields["prod_id"] == "10") { results.show; } else { results.hide; } Note that indexes start counting at 0, so tables["detail"][0] refers to the first record in the detail table. resource() The resource() function returns information about an image resource. It can also be used to check if a file exists.
-
Examples This script retrieves the second page of a PDF that is present in the template's resources. var var var var pdf = resource("images/stamp.pdf", 2); height = pdf.height; width = pdf.width; numberOfPages = pdf.pages; In this script, the function is used to check if a file exists. if(resource("C:/paw.pdf")){ //exists } else { //oops } results The results object (type: QueryResults) is the result of the query for HTML elements that match the selector of the script.
-
Property Field Type Description length Number Number of elements in this result set. Equivalent to calling size(). Functions The functions below can be called by the results object and by any other result set that is returned by a query, see "query()" on page 806. Function Description "Examples" on page 814 Adds elements to a set of HTML elements. "Examples" on page 815 Adds the specified class to each element in a set of HTML elements. Has no effect if the class is already present.
-
Function Description "Examples" on page 826 For each element in a set, this function gets the first parent element that matches a selector, by testing the element itself and traversing up through its ancestors in the DOM tree. "Examples" on page 827 Gets the value of a style property for the first element in set of HTML elements or sets one or more CSS properties for every element in a set of HTML elements.
-
Function Description page 834 "Examples" on page 834 Inserts content at the beginning of an HTML element or of each element in a set of HTML elements. "Examples" on page 837 Removes an HTML element or a set of HTML elements from the document. "Examples" on page 838 Removes the specified attribute from each element in this result set. "Examples" on page 838 Removes the specified class from an element or from each element in a set of HTML elements. Has no effect if the class is not present.
-
content A query result. This can be an HTML string or a result set. Examples Add one result set to another This script adds one query result to another and sets the background color to yellow. query("#test1").add(query("#test2")).css("background", "yellow"); Note: the way the functions add() and css() are used in this script is called 'chaining'. Chaining is optional; the same could be achieved by storing the results of the queries in a variable: var myResult = query("#test1"); myResult.
-
addClass() Adds the specified class(es) to each element in a set of HTML elements that match the selector of the script or of another query in the template (see "query()" on page 806). This has no effect if the class is already present. addClass(classname) Adds the specified class(es) to each element in a result set. Has no effect if the class is already present. classname String, space separated list of class names. Examples This script adds a class name to a paragraph. results.
-
after(content) Insert content after each element in the set of HTML elements that match the selector of the script, or of another query in the template (see "query()" on page 806). After creates a new result set. content String, HTML string or result set to insert after the matched elements. In case a plain text string is provided, it is automatically wrapped in a element to avoid orphan text nodes to appear in the element.
-
The following script inserts a paragraph after the elements in the results (the set of HTML elements that match the selector of the script). results.after("
Lorem Ipsum
"); Matched element Matched element after script execution Peter Parker
Peter Parker
Lorem ipsum
This script looks for the string "Lorem " in the results (the set of HTML elements that match the selector of the script).and inserts the string "ipsum" right after that text.
-
page 806). See also: "Examples" on page 834. append(content) Insert content as the last element to each element in the set of HTML elements that match the selector of the script or of another query in the template (see "query()" on page 806). Append creates a new result set. content String, HTML string or result set to insert after the elements. In case a plain text string is provided, it is automatically wrapped in a element to avoid orphan text nodes to appear in the element.
-
Selector Matched element Matched element after script execution class="name">Name:
This script's selector is , so the script appends a paragraph to all Div elements in the template. results.
-
Matched element Matched element after script execution
Personal information
Personal information
Peter Parker
This script looks for an element with the ID box, appends a paragraph to it and colors all text inside the box red. query("#box").append("Peter Parker
").
-
Examples This script - with the selector img - stores the source of the first image in a variable. var src = results.attr("src"); The following script looks up an image with the ID #image1 and stores its background color in a variable. var imgURL = query("#image1").attr("src"); attr(attributeName, value) Sets the value of the specified attribute of each element in a result set. attributeName String; the name of the attribute. value String; value for the attribute.
-
before(content) Before(content) inserts content before each element in the set of elements that match the script's selector. Before() creates a new result set. content String, HTML string or result set to insert after the elements. In case a plain text string is provided, it is automatically wrapped in a element to avoid orphan text nodes to appear in the element. Examples This script looks for an element with the ID salesrepand inserts a paragraph before that element. results.
-
Matched element Matched element after script execution
Peter Parker
Lorem ipsum
Peter Parker
Note: the way the functions before() and css() are used in this script is called 'chaining'. Chaining is optional; the same could be achieved by storing the result of the query in a variable: var salesrep = query("#salesrep"); salesrep.before("Lorem ipsum
"); salesrep.
-
Examples This script retrieves the inner HTML of an element selected from a snippet. var snippet = loadhtml('snippets/snippet.html','#foobar').children (); results.append(snippet); The following script retrieves the inner HTML of the elements and then performs a find/replace. var snippet = loadhtml('snippets/snippet.html','#foobar').children (); snippet.find('@firstname@').text('foobar'); results.
-
The following script clones an existing table row to match the number of rows in a detail table. Afterwards it iterates over the rows to populate the fields. // Create the number of rows based on the records in the detail table // We start at 1 so the boilerplate row is used too and there is no need to delete that row for(var r = 1; r < record.tables['detail'].length; r++) { results.parent().append(results.
-
} // Hide our boilerplate row (note that this doesn't really delete the row). results.hide(); closest() For each element in a set, this function gets the first parent element that matches a selector, by testing the element itself and traversing up through its ancestors in the DOM tree. (In HTML, a parent is an element that contains another element.) To get a child element or all child elements, use children() (see "Examples" on page 824).
-
css() Gets the value of a style property for the first element in the set of HTML elements that match the selector of the script or of another query in the template (see "query()" on page 806), or sets one or more CSS properties for every element in the set. css(styleName) : String Returns the value of the specified CSS property. propertyName String; the name of the CSS property.
-
query("#callout p").css('color' , 'red'); The following script does the same, but it only sets the text color to red if in the current record the value of the field 'accounttype' is 'PRO'. if(record.fields.accounttype == "PRO") { query("#callout p").css("color","red"); } This script sets the text color of the results to a hexadecimal color code. results.css('color' , '#669900'); This script loads a snippet into a variable.
-
Example This script empties all Span elements found in the template. results.empty(); Selector Paragraph before script execution Paragraph after script execution span
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Lorem ipsum amet, consectetuer adipiscing elit.
filter() filter(callback) Returns a subset of a set. All elements for which the callback function returns true will be included in the result.
-
results.filter(function(index) { return index % 3 === 2; }).css( "background-color", "red" ); filter(selector) Returns a subset of a set. All elements matching the selector will be included in the result. The difference between results.filter(selector) and query(selector, results) is that query() searches throughout the entire results while filter() only takes the top-level elements into account. selector A String containing a CSS selector. See http://www.w3schools.com/cssref/css_selectors.
-
decoration','underline'); results.replaceWith(mysnippet); hasClass() hasClass(classname) : Boolean Returns true if the first element in this result set has the specified class. classname String containing one class name. Example This script checks if the first of the results (the set of elements matching the selector of the script) has the class 'green'. If so, it colors the text of all the elements in the results green. if (results.hasClass('green')) { results.
-
html() html() : String Returns the inner HTML of the first element in this result set. html(value) Replaces the inner HTML of each element in this result set by the supplied value. value A String that may contain HTML tags. Examples The following script loads part of a snippet based on the value of a field, and then inserts the content into the document using html(). var promoTxt = loadhtml('snippets/promo-en.html', '#' + record.fields['YOGA']); results.html(promoTxt); The following script loads a snippet.
-
var toc = '
'; query('h1.title').each(function() {toc += '- ' + this.text() + ' ' + this.pageref() + '
'; }); toc += '
'; results.after(toc); The first line creates a variable for the table of contents, which will be a list (a element with the ID toc). The start tag of the list is added to the variable. The next line does a query for all level 1 headings ( elements) with the class title in the current section.
-
Example Assume that there are three paragraphs in a Box and that one of those paragraphs matches the selector of this script. The paragraph is stored in the results object (see "results" on page 810). The script retrieves the Box (which is the parent of the paragraph) using results.parent(), and then changes its background color to red. results.parent().
-
results.prepend("Name: "); Selector Matched element Matched element after script execution .name
Personal information
Peter Parker
Personal information
Name: Peter Parker
This script inserts content in multiple elements at the same time. results.
-
This script uses the function query() to find a box. Then it inserts a heading as the first element in that box. query("#box").prepend("
Personal information
"); Matched element Matched element after script execution
Personal information
Peter Parker
This script uses the function query() to find a box, prepends a heading and sets the text color of the entire box to red. query("#box").
-
Examples This script removes all Span elements found in the template. results.remove(); Selector Paragraph before script execution Paragraph after script execution span
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Lorem ipsum amet, consectetuer adipiscing elit.
The selector of the following sample script is tbody. Before this script runs, the table body consists of a single placeholder row with three cells. After running the script, it contains thirty rows.
-
// Attach all copies to the DOM as children of tbody results.append(rows); removeAttr() Removes the specified HTML attribute from an element or from each element in a set of elements. To add or change an attribute, use attr() (see "Examples" on page 821). removeAttr(attributeName) attributeName String; the name of the attribute. Examples This script looks up an email field in a form (which is an with the ID #email1) and removes its readonly attribute. query("#email1").
-
replaceWith() Replaces each element in a set of HTML elements. replaceWith(content) Replaces each element in a set of HTML elements. Returns the result set. content A query result. This can be an HTML string or a result set. Examples Replace elements with a snippet The following script loads a snippet and then replaces the elements matched by the script's selector with the snippet. var snippet = loadhtml('snippets/mysnippet.html'); results.
-
Example This script hides or shows the elements matched by the selector of the script (which are stored in the results object), depending on the value of the data field Country in the current record. if (record.fields["Country"] == "CANADA") { results.show(); } else { results.hide(); } text() text() : String Returns the text content of the first element in a result set. Example This script loads a snippet into a variable and retrieves an element from the snippet using query () and text().
-
Control Script API The table below lists the objects that are the most important in Control Scripts. Click through to the object to find a description and sample scripts. See "Control Scripts" on page 570 for information about this kind of scripts, how to insert them and what you can do with them. Object Usage "section" on page 846 Much of the Control Script magic is performed by setting one of the fields of the section object.
-
Object Usage page 807 record, use record.fields['fieldname'] or record.fields.fieldname. Other objects that are available to Control Scripts The list above isn't exhaustive: most of the objects listed in the Designer API (see "Designer Scripts API" on page 786) are also available in Control Scripts. Not all of those objects can be used in Control Scripts, however.
-
Properties The following table lists the properties of the Automation object. Property Description jobInfos Returns an object containing JobInfo 1 to 9 values from PlanetPress Workflow. Properties Returns an object containing additional information (file name, process name and task ID) from PlanetPress Workflow. Accessing automation properties To access JobInfo 1 to 9 (defined in Workflow): automation.jobInfos.
-
Which contexts are available in the template can be queried using merge.template.contexts. The context being merged can be queried using merge.context. Field Type Description sections Array Array of sections (see "section" on page 846) inside a particular context defined in the template. Note: When using merge.context.sections keep in mind that for example 'Section X' might only exist in your Print context, so using merge.context.
-
contexts and sections. For sample scripts, follow the links to the respective objects. For more information about Control Scripts, see "Control Scripts" on page 570 and "Control Script API" on page 841. Field Type Description channel "Channel" on page 855 The final output channel: EMAIL, PRINT or WEB. The channel doesn't change when the output consists of different contexts. When generating an email, for example, the channel is EMAIL, even when merging the Print context to attach it to the email.
-
section The section object can be used to query and modify how the section (and the related context) will be outputted. It is one of the most important objects in Control Scripts (see "Control Scripts" on page 570 and "Control Script API" on page 841). Retrieving a section A section can be retrieved using merge.template.contexts.ContextType.sections["section name"], for example: merge.template.contexts.PRINT.sections["Section EN"]. A section can also be retrieved via merge.context.sections['section name'].
-
Field Type Description For Email channel requests on the Web context, only the default section is enabled by default. It is possible to enable different or multiple sections, to control which sections will be attached to the email. For Email channel requests on the Print context all Print sections are enabled by default. It is possible to enable different or multiple sections to control which sections will be attached to the email.
-
Field Type Description attachment. See "Parts: splitting and renaming email attachments" on page 576. password String Print sections only. Used to set the user password and owner password for a PDF attachment to the same value. See "Control Script: Securing PDF attachments" on page 583.* restartPageNumber boolean Print sections only. Enables or disables a restart of the page numbering. When generating Print output this can be used to let page numbering continue over multiple sections.
-
Function Description page 580. addAfter() Add a cloned section after this section. addBefore() Add a cloned section before this section. Examples Conditionally skipping or printing Print sections This script disables all Print sections and then re-enables one of them, depending on a value in the current record. var printSections = merge.template.contexts.PRINT.sections; printSections['Section EN'].enabled = false; printSections['Section FR'].enabled = false; if(record.fields.
-
printSections['Section 2'].enabled = false; } Setting the name of Email PDF attachments This script renames the file name of an attachment by setting the part name of a section (see "Parts: splitting and renaming email attachments" on page 576). var section = merge.template.contexts.PRINT.sections['Section 1']; section.part = 'Invoice ' + record.
-
Note For another example, see this how-to: Output sections conditionally. Note If the Email PDF Password Script Wizard defines a password, and a template has a Control Script that creates multiple PDF attachments, all the attachments are secured by the same password by default. Using a Control Script, you can set set different passwords for attachments; see "Control Script: Securing PDF attachments" on page 583.
-
Cloning Print sections For background information on cloning Print sections, see: "Dynamically adding sections (cloning)" on page 580. Cloning a section based on the number of records in a detail table This script creates as many clones of a section as there are records in a detail table. It assigns the new sections a unique name. var printSections = merge.template.contexts.PRINT.sections; var numClones = record.tables['detail'].
-
template The template object represents the template with all its contexts and sections. It is used frequently in Control Scripts (see "Control Scripts" on page 570 and "Control Script API" on page 841). It is retrieved via the merge object: merge.template (see "merge" on page 844). Which contexts are available in the template can be queried using merge.template.contexts. To get access to a specific context, you have to specify the ContextType (see "ContextType" on page 856).
-
} else { printSections['Section EN'].enabled = true; } BackgroundResource BackgroundResource is an enumeration for the types of background resources for a Print section (see "section" on page 846). A Print section can be retrieved in script using merge.template.contexts.ContextType.sections["section name"], for example merge.template.contexts.PRINT.sections["Section EN"]. Field Description DATAMAPPER_ PDF A PDF file retrieved via the active Data Mapping Configuration.
-
Note To learn how to set a PDF file as a background image on a Print section without a Control Script, see "Using a PDF file as background image" on page 311. Channel Channel is an enumeration for the output channels. The active output channel is registered in merge.channel. The channel doesn't change when the output consists of different contexts. When generating email, for example, the channel is EMAIL, even when merging the Print context to attach it to the email.
-
printSections['Section 2'].enabled = false; } ContextType ContextType is an enumeration for the context types. The type of the context that is going to be merged next can be retrieved via type: merge.context.type. The context type needs to be specified when retrieving a section with merge.template.contexts.ContextType.sections["section name"], for example merge.template.contexts.PRINT.sections["Section EN"]. Value Description HTML_EMAIL The context is the Email context.
-
MediaPosition In a Control Script, the position is an enumeration for the position of background resources for a Print section. It is retrieved and set via background.position. Field Description ABSOLUTE Places the PDF at a specific location on the page. Set the background's top (background.top) and left (background.left) measured from the top and left side of the section. CENTERED Centers the PDF on the page, vertically and horizontally. FIT_TO_ MEDIA Stretches the PDF to fit the page size.
-
Generating output When merged with a record set, the templates made in the Designer can generate three types of output: Print, Email and Web. Print output Print templates, also called Print sections, are part of the Print context. They are meant to be printed to a printer or printer stream, or to a PDF file (see "Generating Print output" on page 861). The Print context can also be added to Email output as a PDF attachment; see "Generating Email output" on page 875.
-
To test a template, you can test the scripts (see "Testing scripts" on page 560) and send a test email first (see "Send Test Email" on page 646), before actually sending the email (see "Generating Email output" on page 875). Attachments Output, generated from an Email template, can have the following attachments: l The contents of the Print context, in the form of a single PDF attachment. l The output of the Web context, as an integral HTML file. l Other files, an image or a PDF leaflet for example.
-
Other ways to speed up script execution are described in another topic: "Optimizing scripts" on page 564. Images When a template that contains lots of images is merged with a large record set, the many file requests may slow down the process of output generation. The solution is simple: combine the images into a single image file and display the part that holds the image. This reduces the number of file requests and can improve the output speed significantly. Step 1.
-
in a script, add the page parameter to the file path and set that as the source of the image. Here is an example (assuming that the page number is stored in a variable pageNumber): var imageStr = ""; var imagePath = "file:///C:/image-collection.pdf?page=" + pageNumber; imageStr += '
'; results.after(imageStr); Generating Print output Print output can only be generated from the Designer when a data set is available (see Loading_Data).
-
l l Using previously saved Printing Preset options. See "Job Creation Presets" on page 756 and Output Creation Presets for more details. File > Proof Print... allows either the default output settings; the last used output settings or previously saved output Presets. For more information on this option see "Print Using Standard Print Output Settings" on the next page. for more details. Saving Printing options in Printing Presets.
-
l l Finishing. The Print context , as well as each of the Print sections, can have its own Finishing settings. In printing, Finishing is the way pages are bound together after they are printed. See "Setting the binding style for the Print context" on page 306 and "Setting the binding style for a Print section" on page 313. Also see "Finishing Options" on page 757 for an explanation of the Finishing options. Bleed. The margins around a page are called the Bleed.
-
l l l l All: Outputs all records in the active dataset. Selection: Allows selection of a range of records or a custom selection. You can specific individual records separated by semi-colons (;) or ranges using dashes. For example: 2;4;6-10 would print pages 2, 4, 6, 7, 8, 9 and 10. Apply filtering and sorting to record selection checkbox: Check o filter and/or sort records. Selecting this will open both the "Data Filtering Options" on page 759 and "Sorting Options" on page 760 pages.
-
Note: These print runs cannot be saved as presets and can only be replicated in the following print run, using the Last Used option. The output settings are determined by selections made throughout the Wizard. For example, if you want to add Inserter Marks to the output, you select the Add Inserter Marks option on the first page of the Wizard, and the Inserter Options page will then appear later in the Wizard. The first page of the Advanced Printer Wizard is the "Print Options" on page 766 page.
-
1. Select Window > Preferences... from the menu. Preference dialog is launched. 2. Select Print > Available Printers from the options. 3. In the Available Printers area, select the print output options to be added to the Print Wizard, then click OK. Splitting printing into more than one file By default, when Connect saves the print output spool file to a directory, it creates one spool file that contains all the generated documents.
-
The Template object Contains information about the template. The default use of ${template} expands to a name based on the template name. A four digit sequence number is added at the end of the basename. The file extension is determined by the selected output technology. ${template} is basically a short hand for ${template.base}_ ${template.nr,0000}.${template.ext} ${template} The 0000 in ${template.
-
It is possible to format the number using a pattern and locale. See "Formatting date and number values " on page 872, below. The extension that corresponds to the chosen output technology. ${template.ext} For example, for PDF output, ${template.ext} would be PDF, for PostScript output, ${template.ext} would return PS Note, that ${template.ext} does not include a leading dot. The File object ${file} is basically a short hand for ${file.base}_ ${file.nr,0000}.${file.ext} where 0000 in ${file.
-
Example (Designer context) If the template file is C:\Data\my-invoices.OL-template, then ${file.base} returns my-invoices The extension that corresponds to the chosen output technology. ${file.ext} For example, for PDF output, ${file.ext} would be PDF, for PostScript output, ${file.ext} would return PS Note, that ${file.ext} does not include a leading dot. The name of the template (designer context) or the name of the job (server context) ${file.name} Example ${file.nr} If the template file is C:\Data\
-
The 0000 in ${job.nr,0000} is a format pattern that takes care of formatting the number with at least four digits including leading zero's. See "Formatting date and number values " on page 872, below. Example If the job name My-Invoices-Reprint.XY2016 gets printed to PDF, then ${job} expands to My-Invoices-Reprint_0001.pdf Returns the base name of the job without any extension. ${job.base} Example If the job name is My-Invoices-Reprint.XY2016, then ${job.
-
${job.count.pages} based on Job has been selected on the Separation page in the Advanced Print Wizard. The total number of pages in the Job. Other available properties These are various properties available to the Output module that are not part of a larger object: ${system.time} ${page.nr} ${page.sequence.job} Displays the current system data and/or time. Can be formatted using the "Formatting date and number values " on the facing page, as seen below. Page number, within Document.
-
Value of a meta data property of the job segment. The propertyname must have been defined as a Tag Name on the Job Segment Tags tab of the Metadata Options page in the Advanced Print Wizard. ${segment.metadata. propertyname} ${segment.count.pages} Note: this is only available if Separation based on Job Segment or Split At Exactly n Sheets has been selected on the Separation page in the Advanced Print Wizard. Total pages within Job Segment.
-
Generating Fax output It is possible to generate Fax output from PlanetPress Connect through the use of PDF/VT output. Here are the details on how to implement such a process. Required Components The following components are required in order to output to Fax: l A PlanetPress Image license which includes PlanetPress Fax. l A Job Preset adding the appropriate metadata fields l An Output preset generating a PDF/VT file. l A PlanetPress Workflow process outputting to the PlanetPress Fax task.
-
l l Create Output using the above Output Preset. The task's Output Management must be set to be Through Workflow. The PlanetPress Fax connector task set to Passthrough (the first "Document" on the list). Generating Tags for Image Output It is possible, even easy, to generate specific tags and indexes for PlanetPress Image. This can be used to send email, archive with Search or output to image formats.
-
PlanetPress Search Indexing For PlanetPress Search indexing, you can add your own custom fields. Each field that is not included in the above or in Generating Fax output is added as an index for PlanetPress Search. For example you could add CustomerID and this would appear as the CustomerID index in Search. Yes, it's that easy! Output Preset Configuration The following settings must be used in the Output Preset: l In the Print Options, a PDF type should be selected, such as Generic PDF.
-
To test a template, you can send a test email first. Output, generated from an Email template, can have the following attachments: l The contents of the Print context, in the form of a single PDF attachment. l The output of the Web context, as an integral HTML file. l Other files, an image or a PDF leaflet for example. Attaching the Print context and/or the Web context is one of the options in the Send (Test) Email dialog. To learn how to attach other files, see "Email attachments" on page 350.
-
Note When you send a test email, the Email To Script will not be used; instead, the email will be sent to the address that you specify in the Send Test Email dialog. l l l l The sender(s), recipient(s) and the subject can be set using Script Wizards; see "Email header settings" on page 343. Default SMTP settings can be set in the preferences; see "Email header settings" on page 343. If there are multiple Email sections, only one of them can be merged with each record.
-
3. On the File menu, click Send Email or Send Test Email. In the dialog that appears you can, among other things, attach the Print context or the Web context to the email. See "Send Email" on page 644 or "Send Test Email" on page 646 for a description of all the options. Finally, click OK. Note About testing emails When you send a test email, the Email To Script will not be used; instead, the email will be sent to the address that you specify in the Send Test Email dialog.
-
l A Create Email Content task with the appropriate settings (see Workflow Help: Create Email Content). Using an ESP with PlanetPress Connect An email service provider (ESP) is a company that offers email marketing or bulk email services.
-
Adding an SMTP Preset for an ESP After creating an account, add a SMTP settings preset in PlanetPress Connect for the chosen ESP, via the Preferences dialog of the Designer (see "Email SMTP settings" on page 345). Make sure Use authentication is checked, and put in your SMTP Username in the box below. Note Presets for different ESPs are already available in the list of default presets.
-
view statistics per email type in the dashboard of the ESP. Note that each ESP has its own notation and instructions. In a Connect template, adding these custom headers is handled through a Control Script (see "Control Scripts" on page 570, "Control Script API" on page 841 and "section" on page 846). The following samples show how to assign a tag or category to a message (e.g. ‘invoice’, ‘confirmation’, ’newsletter-jan-2017’) for various ESPs. SendGrid Dashboard: https://app.sendgrid.
-
MailGun Dashboard: https://mailgun.com/cp/stats Documentation: https://documentation.mailgun.com/api-sending.html#sending Sample Control Script to assign a tag: merge.context.sections["Content"].headers = { "X-Mailgun-Tag": "invoices" }; Note The Mailgun tag allows you to view the stats per tag. Mailgun has a quick refresh and stats are available almost instantly.
-
MailJet Dashboard: https://app.mailjet.com/dashboard Documentation: https://app.mailjet.com/docs/emails_headers Sample Control Script to assign a campaign: merge.context.sections["Content"].headers = { "X-Mailjet-Campaign": "invoices" }; Note Mailjet strips out their own mailheaders like X-Mailjet-Campaign. The results can only be verified via the respective campaign stats page in the Mailjet dashboard.
-
Generating Web output The Web context outputs one HTML web page that contains the HTML text and all the resources necessary to display it. JavaScript files are added to the
in the generated HTML file. They are useful to add special features such as those offered by jQuery and its plugins, or MooTools. Style sheets are also added to the and are used just as they would be used in a regular web page.
-
Note When generating output with just an open Data Mapping Configuration, the template is merged with the complete sample data file that is part of the Data Mapping Configuration. The output is not limited to the number of records shown in the Data Model pane (which is one of the settings in the DataMapper). Before generating Web output Before actually generating the Web output, you may want to rasterize certain elements, such as
elements, business graphics, or headings with a special font type.
-
4. On the File menu, click Send Email or Send Test Email. In the dialog that appears, check the option to attach the Web context to the email. See "Send Email" on page 644 or "Send Test Email" on page 646 for a description of all options. Note When you send a test email, the Email To Script will not be used; instead, the email will be sent to the address that you specify in the Send Test Email dialog. 5. Fill in the dialog and send the emails. Generating Web output from Workflow 1.
-
l The title, shortcut icon and meta tags appearing in the web page's header.
-
General Information Connect File Types This article describes the different File Types that are related to PlanetPress Connect and its different modules. These are files that are generally transferable between machines, can be sent via email or other means. l l l l l l l l l .OL-template : A Designer Template file, including up to 3 contexts. Is linked to a data mapping configuration by default, but not necessarily. .
-
Additional Information You can find additional information that complement the user manuals about PlanetPress Connect Workflow in the knowledge base.
-
Release Notes Overview This document provides an overview of the new features and enhancements in PlanetPress Connect 1.7.1 and PlanetPress Workflow 8.7. Installing PlanetPress Connect1.7.1 and PlanetPress Workflow 8.7 l l l PlanetPress Connect is released as a 64 Bit version only (with the exception of the Workflow, Fax, Search and Imaging modules). Full details on installing and licensing PlanetPress Connect and PlanetPress Workflow can be found in the online help in the installer.
-
Print Only Version A Print Only license is available with version 1.7.1 of PlanetPress Connect which allows legacy PlanetPress Suite 7 customers on OL Care to upgrade to Connect for a minimal fee. The license allows regular printing via the Print Wizard but runs Email and Web output in demo mode. For more information, please contact your local OL Customer Care or Sales team.
-
Connect 1.7.1 General Enhancements and Fixes Template Reports added to Connect Generate a report in PDF format containing the most important information about your template. The report lists contexts, sections, master pages, scripts, the data model, graphic files, and any other resources used, along with their properties. This report can be added as part of your project documentation.
-
Document Properties Document Properties can now be added to both Templates and Data Mapper Configurations. This allows you to specify properties such as the document author, the customer name and other important references. You can also add custom key/value pairs. The respective properties can be retrieved in scripting and are thus available as content in your documents. The information is also included in the Template Report feature.
-
"Enhance with Connect" option added for PDF files in Windows Explorer A Windows Explorer context menu entry "Enhance with Connect" has been added for PDF files. When a user selects this context menu entry, PlanetPress Connect Designer opens with a prefabricated template, that uses the selected PDF file as the background. (SHARED15350/47156) Support added for Remote HTML and JSON Snippets In PlanetPress Connect 1.7.1 we introduce the concept of remote snippet resources.
-
Handling Nested Detail Data Simplifying the handling nested detail data has been on our agenda for some time. As part of our research into this we have looked at an approach that repeats table rows for nested detail data. This doesn’t create HTML tables in HTML tables but rather clones a base row specified for each level. Consider the following image: At this stage there is no user interface to configure this type of dynamic table but in a separate Technical article.
-
Installer improvements l l The PlanetPress Connect 1.7.0 installation did not work on machines running Windows 10 build 1703 (i.e. the "Creators Update", released March 2017). This has been fixed for PlanetPress Connect 1.7.1. (SHARED-56800) The silent installation process has been enhanced, and now supports the following: l l l l l l Setting the repository. This can be configured via the "product.repository" entry in "install.properties".
-
Connect 1.7.1 Designer Enhancements and Fixes Edit and Save CSS, HTML, JavaScript and JSON files within the Designer Ever needed to quickly edit an external CSS, HTML, JavaScript or JSON file? The PlanetPress Connect 1.7.1 Designer now allows you to open and save these file types via the File menu. (SHARED-42094) Data Model Panel Enhancements Various enhancements have been made to the Data Model panel.
-
string to make a personalized email subject without any scripting. (SHARED-51475) Improved Customization of the Designer interface Customize your interface by selecting your own colours for object edges, margins, guidelines, etc.
-
Guideline behaviour improved Along with visible/invisible settings, Guidelines can now be locked in place or set to snap to objects, using the new Guides option in the View menu. (SHARED-47159). Warning now displayed when opening templates created in an older version When PlanetPress Connect opens an older template file it is automatically migrated to the template structure of the current version.
-
These Warnings can be switched on again at any time thereafter, via the "Reset All Warning Dialogs" button in the General Preferences dialog. (SHARED-16962) Option to automatically Delete a dynamic table when the table is empty An option has been added to allow you to automatically delete a dynamic table when the data table is empty. To do so, select the entire table, and then tick the "Hide when empty" checkbox in the Attributes panel.
-
Replace elements with data-insert-location when inserting HTML elements When inserting an element from an Insert dialog, Connect now checks the data-insertplaceholder attribute. The value of the attribute is then used to set the default value for the Insert Location option within the Insert dialog. If the attribute is not found, things behave as in previous versions. This ticket also introduces the Replace option for the Insert Location drop down.
-
Scripting improvements l Context menu added to the Edit Script dialog. (SHARED-45381) . l l l l Find and Replace functionality has been added to Script editors. (SHARED-48424) New menu option to rename Scripts or Folders has been added to the Context Menu within the Script panel. (SHARED-48607) Support added for copy and paste of folders and scripts within the Scripts panel.
-
General Designer improvements l l l l l l l Duplicate and Delete line(s) using shortcuts in the Stylesheet, JavaScript and HTML editors. Use Ctrl+D to duplicate and Ctrl+Shift+D to delete the currently selected lines. (SHARED-46928) Entering geometry values without stating a specific unit type will now automatically assign the default unit type to the entry. (SHARED-50656) When deleting an element (such as a Barcode or a Chart) on a page, a check will now be made for associated scripts.
-
Capture OnTheGo (COTG) improvements l l l l l Two new form inputs have been introduced to facilitate the retrieval of the document ID and the store ID. (SHARED-53987/54054) Improvements made to updating the COTG library within existing templates. The user will now be prompted as to whether they wish to switch to the new version or not.
-
Connect 1.7.1 DataMapping Enhancements and Fixes DataMapper can now fetch or update data from remote sources New in PlanetPress Connect 1.7.1 is the ability to create an XMLHTTPRequest object (aka XHR) in DataMapper scripts in order to issue REST/AJAX calls to external servers. This feature allows the datamapping process to complement the extraction process with external data, including data that could be provided by a HTTP process in Workflow.
-
add an Action Step and specify the new “Stop processing record” action type. This basically discards this data record and instructs the DataMapper to immediately skip to the next source record. This yields two immediate and major benefits: l l Data Extraction is much faster since you are only extracting the records you actually want The database will not be cluttered with useless records (potentially numbering in the thousands) that you were not going to use anyway.
-
Note If you stop processing any record after you’ve already extracted some data from it, then the record will still be stored in the database, with un-extracted fields being assigned whatever default value (if any) you defined for them. So if your goal is to completely prevent unwanted records from being stored in the database, you should make sure to implement your filtering conditions early in the data mapping process.
-
General DataMapper Enhancements and Fixes l l l l l XML Wizard: option added to extract Attributes and to set boundaries on Attribute changes. (SHARED-42251) Improved support for UNC paths to image files. (SHARED-44316) The Extradata fields are now available in the DataMapper to more easily allow setting of field default values. The display of the Extradata fields can be toggled on or off directly from the Data Model panel. (SHARED-51426) New data.findRegExp() function added.
-
This means that, apart from straightforward cases where we are grouping with or without sorting, it is also possible to create combinations where some fields do alter the sort order and others have no effect. Please note that grouping without sorting also means that any documents that have the same value for the same grouping field (i.e., customer number in the example above), but which are not consecutive in the input data, will not end up in the same group.
-
Additionally, some settings on the Imposition Options page affect the way that booklets are created. These settings are now editable, so settings such as the gap between pages can now also be set for booklets.
-
Additional Postal Services Barcodes added to Output Creation Barcodes for postal services are excellent candidates for adding during the Output Creation steps, rather than during Content Creation. Reasons for this include: l l l They often cannot be added during Content Creation because they depend on document size (or weight) and on a sort order that is determined during Job Creation. They need to go in a fixed position, dependent upon the envelope window, rather than document design.
-
The new barcodes include: l Australia Post 4 State l KIX Code (Dutch postal service - Post.NL) l Royal Mail (UK) l Royal Mail 2D (UK) l USPS IMB (US) l USPS IMPB (US) Some of these barcodes have specific requirements in order for them to be usable. The respective postal services provide specifications and sometimes also the tools for generating the content of these barcodes. The checksums needed for Australia Post 4 State and IMPB are calculated automatically.
-
Job Output Mask improvements, to simplify working with output file names We have improved the way that output file names can be specified. A new dialog box has been added to the Print Wizard, to simplify the creation of Job Output Masks. While it is still possible to directly type a file name with placeholders in the Output File Mask box, it is now also possible to use the dialog to pick the metadata fields and other variables that can be used to create dynamic file names.
-
For the Output Preset to know what metadata is available, you can select a Job Preset when creating or modifying an Output Preset: In the Advanced mode of the Print Wizard this new dialog works a bit different, because the metadata can be directly edited in the same wizard instead of having to refer to a Job Preset. Tray Mapping for Multiple Templates For printing to a cutsheet printer, the Output Preset allows mapping of media defined in a template to trays and media known by the printer.
-
such a way that no conflicting tray mappings can occur within a job, as Job Presets allow filtering by media type. Print Output l Improvements made to the Print Wizard These include: l Improved usability in Inserter dialog. (SHARED-38279) l Data Filtering dialog usability improved.
-
Workflow 8.7 Enhancements and Fixes Custom Task descriptions The Comments section of each Workflow Task can now be used as the task's description in the Workflow Configuration tool, allowing users to better document the process without having to resort to numerous Comment Tasks. (SHARED-39120) Workflow processes can sometimes become rather complex and thus they require some documentation in order to allow subsequent users to know why they were implemented in one fashion or another.
-
reason (reprints, produce additional jobs, etc.), you will have to perform the data mapping configuration from scratch. So make sure you only tick the box for true one-off jobs. (SHARED48956/56420) Retrieve Items task now has a JSON Output option The Retrieve Items task can now output the results of its query as a JSON string instead of storing them within the metadata. This allows easy handling of the results either through Workflow Scripting or directly in the Designer.
-
Note The "Test SMTP Settings" does not work when using TLS. This limitation will be addressed in a later release. General Workflow fixes and enhancements l l l l l l l l l l Improved datamapping speed when outputting records in metadata. (SHARED-38455) Improved performance when creating metadata after Content Creation. (SHARED47150) Processing a Secure PDF as passthrough through CreatePDF will retain the Security options.
-
Known Issues Issues with Microsoft Edge browser The Microsoft Edge browser fails to display web pages when the Workflow's CORS option (in the HTTP Server Input 2 section) is set to "*". This issue will be resolved in a future release.
-
correctly. For this reason those users should activate Place all certificates in the following store and then select the Trusted Root Certification Authorities as the target certificate store. MySQL Compatibility After installing Connect 1.7.1 a downgrade to a Connect version earlier than Connect 1.3 or to a MySQL version earlier than 5.6.25 is not seamlessly possible. This is because the database model used in Connect 1.3 and later (MySQL 5.6) is different to that used in earlier versions.
-
External Resources in Connect There are certain limitations on how external resources can be used in Connect. For example if you want to link a file (e.g., CSS, image, JavaScript etc.) from a location on the network but you do not want to have a copy of the file saved with the template you need to do the following: 1. The resource must be located where it can be accessed by all Servers/Slaves run as users.
-
Colour Model in Stylesheets The colour model of colours defined in a stylesheet can sometimes change after editing the stylesheet. This is a known issue and will be addressed in a subsequent release. Online Help Links Point to Introductory Page Context sensitivity for the online help is not yet enabled in Connect. All links and F1 calls point to the introductory page, where you can Search on keywords to bring up Help pages relating to the topic.
-
Print Content and Email Content in PlanetPress Workflow In PlanetPress Workflow’s Print Content and Email Content tasks, the option to Update Records from Metadata will only work for fields whose data type is set to String in the data model. Fields of other types will not be updated in the database and no error will be raised. This will be fixed in a later release.
-
Installing PlanetPress Connect 1.6.1 and PlanetPress Workflow 8.6 l l l PlanetPress Connect is released as a 64 Bit version only (with the exception of the Workflow, Fax, Search and Imaging modules). Full details on installing and licensing PlanetPress Connect and PlanetPress Workflow can be found in the online help in the installer. Note that both PlanetPress and PlanetPress Connect Workflow come with a 30 day trial licenses by default. Upgrading from PlanetPress Connect 1.
-
Print Only Version A Print Only license is available with version 1.6.1 of PlanetPress Connect which allows legacy PlanetPress Suite 7 customers on OL Care to upgrade to Connect for a minimal fee. The license allows regular printing via the Print Wizard but runs Email and Web output in demo mode. For more information, please contact your local OL Customer Care or Sales team. Reduced Memory Version Note This is not recommended for production.
-
OL Connect Send OL Connect Send is an application of two components. The first is a Windows printer driver and the second is a set of Workflow plug-ins. In its most basic form, OL Connect Send allows the transmission of print files over the Internet from any Windows Desktop application. OL Connect Send flavors OL Connect Send comes in three flavors. These are: l l l Free of charge: No license required; any user; any domain; no usage limits; no web interaction.
-
l Supply Chain: Inbound document processing, such as capturing inbound invoices or POs for publication in an ECM. Print to EDI for outbound documents such as invoices. For further information on Connect Send, please refer to the OL Connect Send website and standalone User Guide.
-
Connect 1.6.1 General Enhancements and Fixes Performance improvements l Changes to the handling of transparency in PDF backgrounds has not only cured some job failures, but has also led to substantial improvements to both output speeds and filesizes. (49680) l Improved processing speed for multiple large detail table documents. (47252/48537) l Improvements made to the clean-up processes, improving overall production speed. l Some memory leaks plugged, improving overall production speed.
-
Connect 1.6.1 Designer Enhancements and Fixes General Designer improvements l Interface improvements such as inclusion of icons for different types of files (js and CSS). l Provided option to configure the script timeout period. (48639) l Minor issues with non-English language translations fixed. l l l l l l Display issues that were sometimes encountered when changing section background images have been fixed.
-
Connect 1.6.1 DataMapping Enhancements and Fixes l Support for Regular Expressions added to database searches. (51694) l Improved Datamapping process reliability. l Improved data record reliability when handling large jobs (those in excess of 50,000 records). l Improved PDF extraction avoids character duplication. l Improved marking of data fields in extraction steps. l l l l l New option added to support multibyte (variable length) encoded data such as Big5, GBK, UTF-8 and Shift-JIS.
-
Email Output l l l Fixed issue with the email Subject field not being encoded properly when using characters other than Latin characters. (48781) To improve privacy certain Meta tags that were embedded in the output email HTML have been removed. These include "email-reply-to", "email-from", "sender-name" and "sender-address". (49864) The Date field was not always included in the email header. This has been fixed and the Date field should now be present in all email headers.
-
Connect Workflow 8.6 Enhancements and Fixes General improvements l l l l l l l l A multitude of changes and enhancements made to support new OL Connect Send functionality within Workflow. Support for password protection added to "Create PDF" task. (48380) Generic Data Repository field length extended beyond previous limit of 32 characters. (47734) Added new "Create PDF Preview" task for lightning fast creation of single record PDF. (49497) Minor issues with some language translations fixed.
-
l l Fixed potential out-of-memory error with very large Workflow configuration files. (51621) Fixed crashes encountered when large numbers of data selection calls were issued in highly threaded processes. (50569) HTTP and SMTP Server improvements l Support added for cross-origin HTTP (CORS HTTP) requests, to facilitate the development and testing of web templates. (47014) l Added option to specify SMTP port number in "Create Email Content" task.
-
Known Issues Installing OL Connect Send on a machine with Connect installed. When OL Connect Send Plug-Ins are installed (either standalone or via a Workflow installation) on the same machine as Connect, an interference between OL Connect Send's internal Database and that of Connect may occur, which will block a browser popup on that same machine. This issue can be fixed by applying a startup wait to the Connect Server Service.
-
1. Go to the .ini files for the Designer and Server Config: l l C:\Program Files\Objectif Lune\OL Connect\Connect Designer\Designer.ini C:\Program Files\Objectif Lune\OL Connect\Connect Server Configuration\ServerConfig.ini 2. Change the language parameter to the required one under Duser.language=en | es | de | fr | it | ja | pt | tw | zh Only one of the above language tags should be selected. Once saved, Connect will appear in the selected language at next start-up.
-
Available Printer Models Note that only the single Printer Model (Generic PDF) will appear on the Advanced page of the Print Wizard by default. To add additional printer models click on the settings entry box. button next to the Model selection Note that the descriptions of some of the printers were updated in version 1.2 meaning that if you had version 1.n installed, you may find that the same printer style appears twice in the list, but with slightly different descriptions.
-
impression that the resources are correct. Using Capture After Installing Workflow 8 If PlanetPress Connect Workflow 8 is installed alongside PlanetPress Suite Workflow 7, Capture can no longer be used within Workflow 7. The plugins are now registered uniquely to Workflow 8 and the messenger for Workflow 7 is taken offline. It is only possible to use Capture from PlanetPress Connect Workflow 8 thereafter.
-
To fix the issue you must check the "Bypass proxy settings for local addresses" option. Merge\Weaver Engines when Printing The print operation in the Designer will automatically detect whether the Merge\Weaver engines are available and display a message for the user to retry or cancel if not. Once the Merge\Weaver engine becomes available and the user presses retry the print operation will proceed as normal.
-
l l The Windows printer must be installed on both the Server and Designer machines. When printing via the Server from a remote Designer, the output file remains on the Server machine. This is remedied by selecting “Output Local” in the Output Creation configuration. Overview This document provides an overview of the new features and enhancements in PlanetPress Connect 1.4.n and PlanetPress Workflow 8.4. Installing PlanetPress Connect 1.4.n and PlanetPress Workflow 8.
-
Templates Used in Workflow For improved performance we recommend resaving Workflow templates set up in the previous versions to run with PlanetPress Connect 1.4.n\Workflow 8.4. Reduced Memory Version Note This is not recommended for production. It is now possible to install PlanetPress Connect on a machine with a minimum of 2 GB of RAM.
-
Connect 1.4.1 New Features and Enhancements New Languages Added The Connect user interface is now supported in Spanish, Italian, Portuguese and Chinese (Simplified) as well as English, French, German, Japanese and Chinese (Traditional). The default language remains English. Further languages will be introduced in later releases.
-
At present only the Connect user interface has been translated. Error messages and warnings will be translated for a later release. Welcome Screen Extended l l The Printer Definition Configs and HCF files available on the OL Connect website are now grouped by manufacturer, to simplify selection. Connect 1.4.1 also introduces Responsive Email Templates.
-
Modifying Connect Installations l Connect 1.4.1 introduces the ability to Modify Connect installations, once Connect 1.4.1 has been installed. Connect 1.4.1 Designer Enhancements and Fixes Capture OnTheGo l l l Remote CSS and Javascript resources can now be pre-fetched and shared between documents to avoid having to embed them in every template. (SHARED-39095) Signature widgets can now be marked as required. (SHARED-39833) Annotations can now be added to static images (not the picture widget).
-
l l Page range can be specified via scripting when setting PDF as background. (SHARED36998) Matched elements are highlighted when hovering over scripts. (SHARED-38293) General l l l l l l Numerous improvements to Designer GUI and user-experience. These include: l A new "Styles" pane that displays the styles applied to the selected object. l Image Selection Dialog now inserts from resources, files or URL. l Line number option now available from any source view.
-
l Ability to add Metadata to any output type (previously only PDF and AFP), for use within output Presets. l Static strings can now be added to Metadata in job Presets. l The Output Path in the Output Preset can now be set dynamically. l New Color setting for the Add Text option. (SHARED-40830) l Monochrome and Dithering support added to PCL output. (SHARED-39937) l l Dithering and B&W threshold values now supported in the Print Wizard.
-
Switching Languages Changing the language using the Window>Preferences>Language Setting menu option does not currently change all of the strings in the application to the selected language. This is a known issue and will be fixed in a later release. In the meantime we offer the following workaround for anyone who needs to change the language: 1. Go to the .ini files for the Designer and Server Config: l l C:\Program Files\Objectif Lune\OL Connect\Connect Designer\Designer.ini C:\Program Files\Objectif Lune
-
Any PostScript print preset from Version 1.0 that contains the following will not work in Version 1.4: *.all[0].* Any preset containing this code will need to be recreated in Version 1.4. Available Printer Models Note that only the single Printer Model (Generic PDF) will appear on the Advanced page of the Print Wizard by default. To add additional printer models click on the settings entry box. button next to the Model selection Note that the descriptions of some of the printers were updated in version 1.
-
Warning Important Note: The Designer itself and Proof Print do not use processes that run as services and they may find local files with non-UNC paths which can lead to the false impression that the resources are correct. Using Capture After Installing Workflow 8 If PlanetPress Connect Workflow 8 is installed alongside PlanetPress Suite Workflow 7, Capture can no longer be used within Workflow 7. The plugins are now registered uniquely to Workflow 8 and the messenger for Workflow 7 is taken offline.
-
l Images will be shows as 0 size boxes (no red 'X' is displayed) l Live preview does not progress, and when re-activated reports "browsers is busy" To fix the issue you must check the "Bypass proxy settings for local addresses" option. Merge\Weaver Engines when Printing The print operation in the Designer will automatically detect whether the Merge\Weaver engines are available and display a message for the user to retry or cancel if not. Once the Merge\Weaver engine becomes available and the user presse
-
l l l The file path for the prompt and directory output modes is evaluated on both the client AND server side. When printing to a network share it must be available to BOTH the Designer and Server for the job to terminate successfully. The Windows printer must be installed on both the Server and Designer machines. When printing via the Server from a remote Designer, the output file remains on the Server machine. This is remedied by selecting “Output Local” in the Output Creation configuration.
-
Legal Notices and Acknowledgments PlanetPress Connect, Copyright © 2017, Objectif Lune Inc.. All rights reserved. The license agreements for the associated open source third party components can be downloaded here. This application uses the following third party components: l l l l l l Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or other countries. Adobe XMP Core Copyright © 1999 - 2010, Adobe Systems Incorporated.
-
l l l l l l l l l l l l JavaCraft JSch Copyright © 2002 - 2012 Atsuhiko Yamanaka, JCraft Inc. All rights reserved. JavaSysMon Copyright © 2009 ThoughtWorks, Inc. All rights reserved. JavaX Mail which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. The source code for this can be obtained from the following location: https://java.
-
l l l l l l l l l l Rhino 1.7R4 and 1.7.7.1 which are licensed under the terms of the Mozilla License Version 2.0. The source code for these can be obtained from the following location: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Download_Rhino Saxon which is distributed under the terms of the Mozilla Public License Version 2.0. The source code for this can be obtained from the following location: http://sourceforge.net/projects/saxon/files/Saxon-HE/9.
-
This application also uses the following components which are distributed under the terms of the Apache Software License Version 2.
-
l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l Jetty l LMAX Disruptor l OPS4J Pax Web l org.json.simple l Spring Dynamic Modules l StAX l XMLBeans Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org.
-
l freemarker/ext/jsp/web-app_2_5.xsd l freemarker/ext/jsp/web-jsptaglibrary_1_1.dtd l freemarker/ext/jsp/web-jsptaglibrary_1_2.dtd l freemarker/ext/jsp/web-jsptaglibrary_2_0.xsd l freemarker/ext/jsp/web-jsptaglibrary_2_1.xsd Java SE framework and platform: This application uses the Java SE framework and platform which is distributed under the terms of the Oracle Binary Code License Agreement for the Java SE Platform Products and Java FX. Copyright 2013, Oracle America ,Inc. All rights reserved.
-
form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.disclaims all warranties as to this software, whether expressed or implied, including without limitation any implied warranties of merchantability, fitness for a particular purpose, functionality, data integrity or protection. PlanetPress, PReS and PrintShop Mail are registered trademarks of Objectif Lune Inc.
-