Using the Component Editor

Vault Toolbox includes a Component Editor that allows you to view the Metadata Definition Language (MDL) of components in your Vault. In sandbox Vaults, you can also execute MDL commands directly from the Component Editor to Vault, allowing you to quickly test configuration changes. See the MDL Overview to learn more about MDL commands.

This guide explains how to use the Component Editor to search, browse, and modify components.

Searching & Browsing Components

Section link for Searching & Browsing Components

To search for a component, type it into the search bar in the format Componenttypename.Componentname. For example, Picklist.language__v. Then click Get. The component MDL appears in the Component Editor.

Vault Toolbox retrieves all MDL-based components from your Vault, displaying them in the right-hand-side Component Directory. To browse components, scroll to a component type in the Component Directory, then click the icon to expand the list of components. Click on a component to see its MDL in the editor.

Click Reload () to refresh the Component Directory to include any new configuration changes.

Toggle the icon to hide or show the Component Directory.

Tip

The Component Editor uses the open-source Monaco Editor, customized with Syntax Highlighting for MDL and Sticky Scroll. You can use Ctrl/Command + Mouse Scroll or the Pinch Zoom on touchpads to zoom in or out, setting the desired display size. To access the Monaco Editor Command Palette, press the F1 key while focused on the editor.

Modifying Components

Section link for Modifying Components

The Component Editor allows you to modify existing components in your sandbox Vault by executing MDL commands. By default, the Component Editor sends a synchronous request to Vault API, and the execution results appear in the bottom half of the editor.

Some large operations may require an asynchronous request, which the Component Editor supports. Learn which kinds of operations require an asynchronous request in the API Reference.

Note

Modifying components is only supported for sandbox Vaults. If you are authenticated to Vault Toolbox with a production Vault, the Send button is disabled.

To modify a component:

1. Search or browse a component to load its MDL into the Component Editor.
2. Edit the MDL command in the editor, then click Send.
3. Optional: To execute the MDL command asynchronously, click the down chevron on the Send button and then click Send MDL Script Asynchronously.
4. Optional: To retrieve asynchronous MDL operation results, click the down chevron on the Send button and then click Retrieve Asynchronous MDL Script Results.