UI Editor/Overlays

Overlays are a feature of the UI and scripting systems that allow for Service Providers to modify or extend script packages provided by another Service Provider.

Overlay packages are packages which add and/or replace files in an underlying package. Overlays can additionally add a ".overlay" file to be loaded alongside any ".ui" files which provide sets of changes to modify the loaded ".ui" files. These features allow for more robust handling of updates to the underlying package.

Workflow

Creating an Overlay File

1. Load the original UI file you want to modify
2. Expand the arrow next to the definition name in the Definition panel
3. Click "Load" beside the Overlay option
4. Select the folder you want the ".overlay" file to write to
5. Make changes to the UI as desired
6. Saving will write out the ".overlay" file to the folder you selected

Editing an Overlay File

1. Load the original UI file you want to modify
2. Expand the arrow next to the definition name in the Definition panel
3. Click "Load" beside the Overlay option
4. Select the folder which has the ".overlay" file to modify
5. Make changes to the UI as desired
6. Saving will update the ".overlay" file to the folder you selected

Once you have finished creating or editing an Overlay, remember to upload it to the server.

Server-side Configuration

Overlays may be used with any registered Client Scripts. You can find the list of registered Client Scripts on your admin site under "Misc > Client Scripts"

Adding an Overlay

1. Navigate to the Client Scripts admin page
2. Locate the Script you want the Overlay added to and click the name
3. Click the "Add Overlay" button
4. Provide a name for the Overlay and choose a script package you have created.
5. Click "Create" to add the Overlay

The Overlay will now be added to any future deliveries of that Client Script.