Customizing the Insight Narrative

After you add a suggested or a custom insight to an analysis, you can customize the narrative displayed in the insight according to your needs. For example, you can edit the insight computation or add more computations, use parameters, and add functions. You can also configure the text formatting and alignment and add images or hyperlinks.
To edit the narrative included in an insight:
  1. Click Dashboards tab, the Dashboards tab.
  2. Click Dashboard Designer, in the bottom-left corner.
  3. On the Analyses dialog, click New analysis or click Options button, the Options button, next to an existing analysis and select Edit.
  4. On the analysis page, add a suggested insight or a custom insight.
    For more information, see Adding Suggested Insights or Adding Custom Insights.
  5. To customize the content of the insight, click Menu options button, the Menu options button, in the corner of the insight and select Customize narrative.
  6. In the Edit narrative dialog, configure the computations, add parameters and functions, add custom text, configure the text formatting and alignment, or add images and hyperlinks.
    1. To add a computation, click the Add computation button, then select a type of computation, configure the computation properties in the Configure dialog, and click Add.
      The available configuration options depend on the type of the computation.
      Note: The computation names that you specify are unique within the insight. You can reference multiple computations of the same type in your narrative template. For example, if you have two metrics, you can create growth rate computations for each metric, each with a different name.

      The computation that you configured is added to the narrative. You can see the list of output parameters available for the computation in the Computations section. Click a parameter to add it to the narrative.

      For more information on computations, see Supported Computations for Insights.

    2. To edit a computation, expand the Computations section and click Edit icon, the Edit icon, next to a computation.
      Edit the computation properties in the Configure dialog and click Save. The available options depend on the type of the computation.
    3. To remove a computation, expand the Computations section, click Edit icon, the Edit icon, next to a computation, and click Delete in the Configure dialog.
    4. To add the current value of an analysis parameter, expand the Parameters section and click one of the available parameters.
      For more information on parameters, see Creating Parameters.
    5. To add a function, expand the Functions section and click the function that you want to use.
      For more information on the supported functions, see Supported Functions.
    6. To add a code expression, expand the Insert code menu from the toolbar, select one of the options from the list, enter the code in the code box, and click Save.
      You can use these code expressions in the narrative:
      • Expression: Lets you create your own code expression.
      • Inline IF: Adds an IF statement that includes an expression after evaluating a condition. The statement displays inline, in a sentence.
      • Inline FOR: Adds a FOR statement that loops through values. The statement displays inline, in a sentence.
      • Block IF: Adds an IF statement that includes an expression after evaluating a condition. The statement displays in a separate block of text.
      • Block FOR: Adds a FOR statement that loops through values. The statement displays in a separate block of text.
    7. To modify the text that is displayed in the narrative, enter or edit text directly in the workspace.
    8. To customize the text alignment, size, style, and color, select the text in the workspace and use the formatting options available on the toolbar.
    9. To add an image, click the Image icon on the toolbar and enter a valid URL that links directly to an image.
      You can resize the image. You can also display an image based on a condition by adding the image inside an IF block.
    10. To add a static or dynamic URL, click the URL icon on the toolbar and enter a valid URL.
      You can also set the display text, add computation parameters, analysis parameters, or functions to the URL, and specify whether the link opens in the same browser tab or in a different tab.

      A static URL is a link that does not change. For example, you can add a link to another sheet in the same analysis.

      A dynamic URL is a link that changes based on the expressions or parameters that you provide when you set it up. It is built with dynamically evaluated expressions or parameters. For example, you can use a dynamic link to search a website with a query or to update a parameter.

      • To search a website with a query, create a URL with this link:
         https://google.com?q=<<formatDate(now(),'yyyy-MM-dd')>>
        The link sends a query to Google with search text that is evaluated as: 
        formatDate(now(), 'yyyy-MM-dd')
        If the value of now() is 02/02/2024, then the link in your narrative contains https://google.com?q=2024-02-02.
      • To create a link that updates a parameter, enter the URL to the current dashboard or analysis and add the expression that sets the parameter value at the end, for example dashboardURL#p.myParameter=12345.

    You can see a preview of the narrative at the bottom of the Edit narrative dialog. If there are errors in your narrative, the preview displays an error message. Check the narrative for alerts and use the provided information to fix the errors.

    To see a preview of insights that use machine learning, such as anomaly detection or forecasting, run the insight calculation at least once before customizing the narrative.

  7. Click Save.
Parent topic: Using Insights