Editor

Content Script objects can be edited with the dedicated web-based IDE selecting the 'Editor' function in the object function menu. The function is also available as a promoted function.

The web-based IDE (Integrated Development Environment) for Content Script appears as follows:

Shortcuts¶

The following keyboard shortcuts are available while using the editor:

Top Bar controls (DEVELOPER)¶

Command	Description
Versions
	Save the script (adds a new version)
	Save the content script properties (i.e. the icon) as well as the static variables (does not add a new version)
	Open the object’s Versions tab
	Close the Content Script Editor
Edit
	Erases the last change done
	Opposite of Undo
	Change the script’s associated icon
	Display the last 200 lines of the ModuleSuite’smaster log file
	Disable the script's real-time validation
Execution
	Run the script in the current window (CTRL + J)
	Save the script and run it, showing the result in the editor’s bottom panel
Comparison
	Toggle comparison: toggles the comparison of the current version of the script with the selected.
Editor
	Theme:Changes the theme applied to all the RPA embedded editors
Help
	Access the module’s online guide and the support portal
Validation
	Red label: The script failed the validation and most likely will fail to compile
	Green label: The script is well-formed
	Smart Completion: Activate smart completion to enhance code suggestions
	Predictive Completions: When enabled, the editor automatically computes a code suggestion at the current cursor position, even without an explicit request from the user, in order to speed up completion generation. (default: disabled)

Top Bar controls (ADMINISTRATOR)¶

Command	Description
Versions
	Save the content script properties (i.e. the icon) as well as the static variables (does not add a new version)
Scheduling
	Toggle script scheduling
	Toggle script advance scheduling mode
	Toggle re-scheduling abortion on script’s execution error
Impersonation
	Select the user that will be always used to run the script
	Clear impersonation setting
Manage Log
	Trigger ModuleSuite’s master log rotation
	Trigger ModuleSuite’s master log download

Auto-completion¶

The Content Script Editor features a code completion assistant functionality. While typing use the ctrl + space key combination to retrieve the suggested values.

In some cases the Content Script’s inference engine might not be capable of determining the actual type of the expression you are trying to auto-complete. In these cases the auto-complete feature will prompt you to firstly specify the type against which the auto-completion should be performed and then will switch to the standard behaviour.

If the actual type (class) of your expression is not listed among the results you can still specify the fully qualified class name to autocomplete against that class: e.g. (java.lang.String)

AI Autocompletion¶

The AI Autocompletion feature provides intelligent, context-aware code suggestions directly within the Script Editor. When enabled, it calculates a variable number of potential code completions for the code immediately to the left of the cursor.

To generate relevant completions, the system analyzes both the full set of available Content Script APIs and the current context of the script being edited. This is considered an experimental feature, and must be explicitly enabled via the Smart Completion switch in the editor options. As a prerequisite, the C.A.R.L. integration must be properly configured and enabled on your system.

In addition to manual suggestions, there is a Predictive Completion switch. If this is enabled, the editor will automatically compute possible code completions based on the cursor's current position, even if the user hasn't explicitly requested them. This allows the system to keep a background "cache" of likely completions ready for the user, making the experience more seamless and responsive.

These options can be toggled in the Script Editor UI, giving you control over the level of AI assistance you want to use during script development.

Code Validation¶

Every time a change is made to the script, a code validator attempts to check the formal correctness of the code. A validation status icon placed on the bottom right side of the working area will show the result of the validation. Code that fails the validation status check will most likely contain formal errors and will fail to compile correctly, if executed.

Versions tab¶

Content Script objects are subject to versioning on Content Server, just like any other document-class object. Every time the Content Script is saved in the IDE, a new version is created.

Older versions of the Script can be opened in the Script Editor for editing. If saved, a new (latest) version will be created.

Code Snippet library¶

In order to simplify the creation of new scripts, a library of pre-configured ready-to-use code snippets is available in the Script Editor.

Snippets are grouped in families of objects with similar features. In order to use a snippet in Content Script:

1. Navigate the library until you find the suitable snippet

2. Place the cursor in the Working Area location where you wish to place the code

3. Click on the snippet to open the Configuration Panel

4. The code snippet could contain place-holders for some configuration variables (for example, in case of a “create document” snippet, a configurable option could be the target container where to create the document.) In this case, configuring the variables as required.

5. Click Save. The resulting code will be placed at the location of the cursor in the working area.

Online Help¶

The Content Script IDE features two different online help guides:

• The complete API Reference (accessible with the Ctrl + H shortcut)

• The Content Script Module Help (accessible through the standard Content Server Help, or through the “Help” button in the Top Bar of the IDE)

The Content Script API Reference can be toggled in a navigable panel on the right side of the screen and describes the programming interfaces of all objects and services that are available in the Content Script context. A more thorough description of the available APIs is presented in the following sections.