Overlay Package

The Overlay Package allows any overlay creator to distribute overlays to the clients or community, without hosting them on a server.

It is a ovpak file that contains the following files:

tip

The ovpak file is simply a zip file with a modified extension.

• config.json: A JSON file that follows the Overlay Provider schema.

  caution

  The basePath should not contain any host or protocol information. In most cases, it should be /.

• static: A folder that contains a static website.

  caution

  Thet static website must have a base path which is the same as the productId in the config.json file. For example, if the productId is my.overlay, any absolute URLs must start with /my.overlay/.

  For more information about how to configure the base path, see the documentation for the framework you are using.