System tools for Personalization

9 min

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Optimizely Personalization includes a set of system tools designed to support changes in Personalization and with using the Visual EditorVisual Editor. These Opal system tools are grouped by functionality to make it easier to find the right tool for your workflow.

Note

Ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts for calling the tool. If you do not provide a required parameter, Opal prompts you for it.

Context

Performance results for Personalization campaigns and experiences are not available. Opal is limited to campaign creation and setup details. For full campaign results, use the Optimizely Personalization Campaign Results pageOptimizely Personalization Campaign Results page.

The feature is not connected to the Optimizely Analytics product. Opal does not have access to Analytics explorations or custom analyses.

Results data support is still evolving. While Opal can surface high-level performance information, deeper results integration is still in progress.

Visual Editor

Note

If you use Opti ID, administrators can turn off generative AI in the Opti ID Admin Center. See Turn generative AI off across Optimizely applicationsTurn generative AI off across Optimizely applications.

System tools for Personalization

Context

exp_get_schemas – Retrieves detailed schemas for various Optimizely entities relevant to Personalization. This is a mandatory first step before using the exp_execute_query tool to retrieve actual data about these entities.

exp_execute_query – Executes a template-based query to fetch specific data from your Optimizely Personalization instance. It lets you retrieve detailed information about various entities.

Visual Editor

exp_ve_apply_change – Applies a pending change to the Visual Editor.

exp_ve_element_glob – Finds elements in the Visual Editor DOM that match a glob pattern.

exp_ve_element_grep – Searches for elements in the Visual Editor DOM whose content or attributes match a regular expression.

exp_ve_element_read – Reads the content or attributes of a specific element in the Visual Editor.

exp_ve_element_tree – Retrieves a partial DOM tree for a specified element and its descendants in the Visual Editor.

exp_ve_get_change_schema– Retrieves the JSON schema for a specific type of Visual Editor change.

exp_ve_get_selector – Generates a robust CSS selector for a given element in the Visual Editor.

exp_ve_list_pending_changes – Lists all pending Visual Editor changes for the current experiment or personalization.

exp_ve_revert_change – Reverts a specific pending Visual Editor change, undoing its effects.

exp_ve_validate_change – Validates a Visual Editor change object against its schema to ensure it is well-formed.