Script mode for browser monitor configuration
- Classic
- How-to guide
- 2-min read
- Published Sep 19, 2018
In addition to the usual configuration in the UI, you can use Script mode to configure your clickpath or single-URL monitors. In this mode, you can access the underlying JSON script of your monitor. If you're a synthetic power user, this will make your life a lot easier and allow you to speed up clickpath creation and management. Use the script editor to quickly find specific events (steps), adapt locators across the whole script, or edit parts of the clickpath without rerecording.
You aren't limited to just one mode—you can switch back and forth between the UI and script modes by clicking the Clickpath/Script switch.
Access the clickpath script
To edit your clickpath browser monitor in script mode:
- Go to Synthetic Classic.
- Select the clickpath monitor you want to edit.
- Click the Browse button (…) and select Edit.
- Click the Recorded clickpath tab in the Monitor settings menu on the left.
- Click Script at the top.
Access the single-URL script
To edit your single-URL browser monitor in the script mode:
- Go to Synthetic Classic.
- Select the single-URL monitor you want to edit.
- Click the Browse button (…) and select Edit.
- Click the Monitor script tab in the in the Monitor settings menu on the left.
Edit the script
You can download the script (Download script as .json) or just copy it from the editor and edit it in a text editor of your choice. However, you can also edit the script directly in the browser. This provides the following benefits:
- Autocomplete—just press Ctrl+Spacebar to see a list of suggestions.
- Syntax highlighting makes it easier for you to write script code.
- Instant error validation—the editor instantly shows a warning for any error in the script. Hover over the error to see what's wrong and a suggestion for how to fix it. You cannot save changes until the code is error free.
Note that you need to escape all special characters and break lines with a backslash (for example, a new line is \n, double quotes is \", and tab is \t).
You can play your changes back for clickpath scripts without saving them—just click Play back clickpath.
Script structure
Main script object
Contains the monitor script.
The ScriptConfig object
Contains the setup of the monitor.
The customDevice object
Contains the emulated device of the monitor.
The predefinedDevice object
Contains one of the preconfigured device emulations.
The bandwidthOptions object
Contains the emulated network conditions of the monitor.
The predefinedBandwidth object
Contains the pre-configured network emulations.
The requestHeader object
Contains the list of HTTP headers to be sent with requests of the monitor.
The following headers are not allowed:
- user-agent
- cookie
The requestCookie object
Contains the list of cookies to be created for the monitor.
Every cookie must be unique within the list. However, you can use the same cookie again in other event.
The navigateEvent object
Contains a Navigate event.
The interactionEvent object
Contains a Click or a Tap event.
The javaScriptEvent object
Contains a JavaScript event.
The selectOptionEvent object
Contains a Select option event.
The cookieEvent object
Contains a Cookie event.
The keystrokesEvent object
Contains a Keystroke event.
The waitCondition object
Contains the wait condition for an event.
The validationType object
Contains the validation rule for an event or waiting rule.
The plainAuthenticationType object
Plain login credentials to bypass the browser login mask during a Navigate event
The secureAuthenticationType object
The login credentials to bypass the browser login mask during a Navigate event.
The credentialType object
The credentials from the credential vault.
The listOptions object
Contains the options to be selected in the Select option event.
The targetType object
Contains the target tab or element of the event.
The locatorType object
Contains an element of a page to look for.
Synthetic Classic