Skip to content
Browse help
Getting started
Model fundamentals
Build and maintain models
Import and export
Publish and share
Account and troubleshooting

Publish a model

Last updated 2026-10-10

Publish a model

Publishing creates a read-only view of your OnyxJar model so people can explore it without editing the underlying model. Depending on the options available to your account, you may be able to view the published model in OnyxJar, download a portable HTML output, or both.

Publishing is different from exporting model data. A published view is designed for people to explore the model; a data export is intended for working with supported model data outside OnyxJar.

Before you publish

Check that the model is ready for its intended audience:

  • Review the model name and description. These can appear in the published view.
  • Check the objects, attributes and relationships that readers will be able to inspect.
  • Make sure the model does not contain information you do not intend to share. Treat a portable output as a copy of the model data made available to anyone who receives the file.
  • Consider whether the current model revision is the one you want readers to see.

Create a publication

  1. Open the model you want to share.
  2. Open the publishing option available in the current OnyxJar interface.
  3. Follow the options shown by OnyxJar. Availability of downloadable output can depend on your account's plan or entitlements.
  4. Once publication has completed, open the published view and check it as a reader would.
  5. If a portable HTML download is offered and you need a file to distribute independently, download it and keep track of which model revision it represents.

The exact controls may change as the product evolves, so follow the labels and options presented in your current interface rather than relying on an assumed button name.

What readers can do

The published view is read-only. Readers can explore the graph, find items, and inspect available details and connections, but they do not edit the underlying model through the publication.

A publication represents the model at the time it was created. Changes you make to the model later do not automatically update an already downloaded portable file. Publish again when you need a newer snapshot; see Refresh a published output after model changes.

Choose the right workflow

  • Publish when people need to explore a read-only view of the model.
  • Use a portable published output when you need a standalone HTML file that can be shared and opened independently.
  • Export model data when you need the supported structured data rather than an interactive view. See Export model data.

For help using the published interface, see Explore a published model.

On this page