Standard Script API
This page lists the global objects and functions that are available in Standard Scripts, created inside the Scripts pane. Click through to an object or function to get a description and examples.
Most of these objects and functions are also available in Control Scripts (Control Scripts) and Post Pagination Scripts (Post Pagination Scripts).
For objects and functions restricted to Control Scripts see Control Script API, and for the Post Pagination Script API see Post Pagination Script API.
The basics of script-writing in the Designer are explained in the following topic: Writing your own scripts.
Objects
| Object | Description |
|---|---|
| results | This object is used to manipulate the content of the template. It contains the HTML element or set of HTML elements that match the selector of the script, specified
in the script editor. This object is not available in Control Scripts, because that type of script doesn't have a selector (see Control Scripts). |
| record | The record in the main data set that is currently being merged. To get the value of a field in the record, use record.fields['fieldname'] or record.fields.fieldname. |
| logger | Global object that allows you to log messages. |
| locale | Defines which locale to use. See Locale. |
| formatter | Global object that allows you to format values (such as a date or number). |
| automation | This object encapsulates the properties of the Workflow process that triggered the current operation. Not available in PrintShopMail Connect. |
| merge | 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). |
(Print output only.) The contentitem object holds the Print Content Item that is written to the Connect database when generating Print output. It allows you to add custom properties to the Print Content Item, in the form of key-value pairs (a JSON string).Note: The contentitem object is not available in PrintShopMail Connect, due to the absence of a Connect database. |
Global functions
| Function | Description |
|---|---|
| fatalError(message) |
Triggers a fatal error that aborts content creation. |
| loadhtml() | Loads HTML data from a HTML (snippet). The returned HTML can be placed into a variable or into a set of HTML elements. |
| loadjson() | Loads json data from a URL. This is a simple way to retrieve content from external systems. |
| query() | Performs a query in the template's contents and creates a new result set containing the HTML elements that match the given CSS selector. |
| This function returns information about an image resource. It can also be used to check if a file exists. |
Examples of iterator functions
| Function | Description |
|---|---|
|
A generic iterator function, to iterate over the elements in the result set |
|
| for(... in ...) | Iterates over the enumerable properties of an object, in arbitrary order. For each distinct property, statements can be executed. |