Skip to main content

Use reporting artifacts in dashboards

Beta feature. Reporting artifacts are currently in beta and may still evolve. They are available by opt-in only. To join the beta or ask questions, contact support@azumuta.com.

What is a reporting artifact?

A reporting artifact is a self-contained HTML dashboard. You can add the artifact to an Azumuta dashboard as a widget.

An artifact can contain HTML, CSS, JavaScript, and image files. One artifact can have multiple versions. New widgets use the default version.

Azumuta runs each artifact in a sandbox. A sandbox separates the artifact from the main Azumuta interface. The artifact cannot make direct database or network requests.

Azumuta supplies a client to the artifact. This client can make permitted read-only reporting queries and GET requests to the Azumuta REST API. The access rights of the current user still apply.

Before you start

Make sure that these conditions apply:

  • Azumuta enabled the Reporting artifacts beta for your workspace.
  • Your role can configure dashboards and manage reporting artifacts for the applicable module.
  • The artifact folder contains an HTML entry document and all required local files.

Create a reporting artifact

  1. Open Reporting.
  2. Open the Artifacts tab.
  3. Click Add artifact.
  4. Enter a name.
  5. Optional: Enter a description.
  6. Under Bundle files, select the artifact HTML and its CSS, JavaScript, and image files.
  7. Select the Entry document. Usually, this file is index.html.
  8. Optional: Select a Configuration UI document.
  9. Select the required built-in controls.
  10. Save the artifact.

The built-in controls can supply a date and time value, one or more work instructions, or one or more zones to the artifact.

Add an artifact widget

  1. Open the applicable dashboard.
  2. Add a widget.
  3. Under General, select Artifact.
  4. Select the reporting artifact.
  5. Select the required version and configuration.
  6. Save the widget.

You can add the same artifact to multiple dashboards. Each widget can use its own configuration.

Add a new artifact version

  1. Open Reporting > Artifacts.
  2. Click the ⋮ (three-dot) icon for the artifact.
  3. Click Add version.
  4. Upload the new bundle files.
  5. Check the entry document, configuration document, and built-in controls.
  6. Save the version.
  7. To use this version for new widgets, click its ⋮ icon and click Mark as default for new widgets.

Existing widgets keep their selected version until you change their configuration.