Use Custom Add-Ons on Your Widgets (Optimized Story Experience)

You can use custom add-ons, which extend the predefined set of widget add-ons in Optimized Story Experience.

You can upload custom add-ons to SAP Analytics Cloud and add them to widgets in stories to customize parts of the built-in widgets, such as adding visual elements to a chart, modifying tooltip contents and overriding the existing styling.

As a developer, you can build your own widget add-ons. For more how to develop, restrictions, hosting considerations and more, refer to SAP Analytics Cloud Widget Add-On Developer Guide.

Supported Add-On Types and Chart Types

Currently, the following add-on types and corresponding chart types are supported:

  • Tooltip

    Supported chart types exclude numeric point.

  • Plot area (general)

    Supported chart types are bar/column, stacked bar/column, stacked area and line

  • Plot area (numeric point)

    Supported chart type is numeric point.

Permissions

There’re the following permissions for Widget Add-On:

  • Create: Lets you upload widget add-ons to SAP Analytics Cloud.

  • Read: Lets you add widget add-ons to the widgets in your story.

  • Update: Lets you update widget add-ons.

  • Delete: Lets you delete widget add-ons from SAP Analytics Cloud.

Upload Your Widget Add-On to SAP Analytics Cloud (Optimized Story Experience)

Upload your widget add-on to SAP Analytics Cloud so that you can add it to the widgets in your story.

Prerequisites

To upload custom add-ons, ensure that you have the permission Create for the object type Widget Add-On.

Procedure

  1. On the Stories start page, choose the Widget Add-Ons tab.
  2. Choose (Create).
  3. In the Upload File dialog, select the add-on from your device, which is a JSON file.

Results

After uploading the add-on, you can find it listed under Widget Add-Ons and manage the uploaded add-ons there.

Next Steps

Every custom add-on has a version number in the format majorVersion.minorVersion.patchVersion defined in its original file, for example, 1.0.0.

You can upload different major versions of an add-on at the same time, for example, versions 1.0.0 and 2.0.0.

However, when you upload an add-on that differs in minor version from an existing one on your tenant, the former replaces the latter. For example, if a widget add-on of version 1.5.0 already exists on the tenant, then adding either version 1.4.0 or 1.6.0 replaces it.

Add a Custom Add-On to Your Widget (Optimized Story Experience)

You can add a custom add-on to the widget in your story to customize its behavior.

Prerequisites

To add custom add-ons, ensure that you have the permission Read for the object type Widget Add-On.

Procedure

  1. In the story edit time, go to the widget's Builder panel.
  2. Scroll down in the Builder panel, and expand Custom Add-Ons.
  3. Make sure that Enable Custom Add-Ons is switched on so that you can add add-ons to the widget.
  4. Choose + Add Add-On.
  5. In the dialog, select an add-on uploaded on your tenant:
    1. Select an add-on type, for example, Tooltip.

      All the existing add-ons of this type appears under Add-On.

    2. Select the add-on from the dropdown list.

      The add-on is listed in the Custom Add-Ons section.

  6. Choose (Add-On Settings) next to the added add-on.
  7. In the Add-On Settings panel, you can edit the properties, such as color.
  8. Choose Done to finish the settings.

Results

You've added the custom add-on to the widget. The widget displays your own add-on instead of the SAP Analytics Cloud built-in one.

To change to another add-on of this type, in the Builder panel, remove the existing one first, and add another one in the same way.