Scriptura Engage Document Flow Steps User Guide
This user guide describes Scriptura Engage Document Flow Steps.
1. Add Email Analytics Step
The Add Email Analytics step allows the user to add email analytics in HTML output. This is usually done in combination with email HTML output to detect if an email was read and/or if certain links were visited.
1.1. Input/output types
-
Input: The Add Email Analytics step accepts flow objects of type Stream. The stream must contain valid HTML.
-
Output: The Add Email Analytics step outputs flow objects of type Stream. The stream is HTML.
1.3. Properties
-
Add Tracking Iframe: Whether or not an iframe element should be added to the HTML to track if the document was loaded.
-
Add Tracking Image: Whether or not an image element should be added to the HTML to track if the document was loaded.
-
Additional URL Parameters: Additional parameters that should be added to the original link that when rewritten.
-
Secret Key: The base 64 encoded key used to encrypt the metadata passed to the link tracking service.
-
Key ID: The ID of the encryption key.
-
Metadata: Additional data to be passed to the link tracking service. This will be encrypted.
-
Name property
-
Log context property
-
Order Information property
1.4. Configuration Properties
Additionally there are two configuration properties that can be used to change the base URL used to rewrite links and serve as the source for the tracking elements:
-
/config/server/link-tracking/url-rewrite-prefix: The prefix URL when rewriting links.
-
/config/server/link-tracking/url-static-prefix: The prefix URL to use for the tracking image or iframe that can be added to the HTML. By default, the name of the tracking image is clear.gif under this prefix, and the iframe will be iframe.html.