Rich Text is a dashboard component in the Wyn Enterprise application that enables you to add rich text content to your dashboard. Rich Text makes your dashboard informative by adding textual information with various editing properties such as formatting, listing, positioning, dynamic data options, and navigation. The mentioned properties are listed and explained in the Editor Toolbar Properties section.

Using the Rich Text Component

You can access the Rich Text component when you create or edit the dashboard. Follow the below instructions to access and use the Rich Text component in Wyn Enterprises,

1. Navigate to the Dashboard Designer page by either creating a new dashboard or editing an existing one.

   
   

2. On the Dashboard Designer page, click the Components icon from the Dashboard Toolbox, and drag and drop the Rich Text component icon to the Design Area.

   
   

3. Rich Text component appears on the Design Area. Hover on the rich text component and click the edit icon from the Action Menu to edit. You can also save the rich text component as a template using the Save As Component Template icon from the Action Menu as shown in the image below.

   
   

   Note: The Action Menu will appear in the top-right corner of the component and in case the Rich Text component is at the top of the Dashboard, the Action Menu will appear at the bottom of the rich text component.

4. In the edit mode, enter the text in the Rich Text component and use the Editor Toolbar to enhance the appearance of the text with formatting, listing, positioning, dynamic data, and navigation options. The properties of the Editor Toolbar are listed and explained in the Editor Toolbar Properties section.

   
   

5. Inspector Panel on the right side of the Dashboard Design Area can be used to further enhance the text for interaction, blank and null data content, layout, and appearance. The properties of the Inspector Toolbar are listed and explained in the Inspector Panel Properties section of this topic.

   
   

Attributes of Rich Text

Rich Text Component

Rich Text component is an advanced text editor with special features to add textual information on dashboards. Following properties are available in the Rich Text component.

1. Edit – Use the Edit icon to access the Editor Toolbar used to edit the text in the Rich Text component. Editor Toolbar Properties section lists and describes the properties available in the Rich Text component.

2. Add Annotation – Use the Add Annotation icon on the Rich Text component to add comments or explanations to the text.

3. Share Scenario – Use the Share Scenario icon to embed a particular scenario of the Wyn Dashboard in your application. Embed the scenario using iFrame or Div containers.

4. Delete – Use the Delete icon to remove the Rich Text component from the Dashboard.

Editor Toolbar Properties

Dynamic Data Options

Dynamic Data Options are used to display dynamic data by adding expressions to bind the data fields of a dataset. The following Dynamic Data Options are available in the edit mode of the Rich Text component;

• Insert Data Aggregation - To insert a summarized value by aggregating multiple data attribute values in a dataset, click the Σ icon from the Editor Toolbar. Select a Dataset, Field, Aggregation Method, Display Unit, Format, and click Apply to add. You can also add filters and conditional formatting to the data aggregates.

  
  

  
  

• Insert Parameter - To insert parameters to the dashboard, click the Insert Parameter icon from the Editor Toolbar and select the parameters to add to the Rich Text component. See this help topic for more information on using parameters in Wyn Enterprise application.

  
  

• Insert Variable - To insert user-defined variables used in a particular context, click the {} icon from the Editor Toolbar and input a single context variable such as, user["name"], datasets["datasetName"].lastUpdated.

  Note: Variables in the referenced document are contained within #{}. However, in the Rich Text variable, this is not required.

  
  

Navigation

Navigation option (Jump To) is used to add navigation to other documents (reports or dashboard), and internal or external URLs for adding more details of the metrics to the visualization. To insert jump, select the text from the Rich Text component, click the Jump To icon from the Editor Toolbar, and then click Ok button. When using the Jump To feature in a Rich Text, Images or Annotation, you can set the color of the Jump To hyperlink text by changing the font color of the text from the Editor Toolbar.

See Jump To help article for more information on how to add and manage settings of the Jump To scenario.

Formatting

Listing

Positioning

Inspector Panel

On selecting the Rich Text component, the following Inspector Panel Properties of the Rich Text component will appear on the right side of your screen;

1. Interaction – includes the Scenario Name, Cross Filter option, Visible Menu Items, Pin Annotation option, and Hyperlink Underline for visibility.

2. Blank Data content – includes customization options for the blank data which is an output of the data binding from datasets in the Rich Text component.

3. Null Data content – includes customization options for the null data which is an output of the data binding from datasets in the Rich Text component.

4. Layout – includes options for the positioning of the Rich Text component. Layout options include X Position, Y Position, Width, and Height.

5. Appearance – includes options to modify the appearance of the Rich Text component including Style Template, Background Color, Padding, Visibility, Background Image, etc.

Inspector Panel Properties

RichText Style

Animation

Interaction

Blank Data Content

Null Data Content

Layout

Note: Minimum Height and Width supported is 8X8“.

Appearance

Set Auto Refresh

From Wyn version 8.0 onwards, you can refresh the content of the rich text expression by using the dataset/data model management panel at the dashboard level. You can use the Set Auto Refresh option in the dataset/data model management panel to set the refresh mode of the dataset or data model.

Steps to Auto Refresh Rich Text

In this example, the auto refresh in the Rich Text will be handled by the Set Auto Refresh property for the dataset at the dashboard level.

1. Create a new dashboard. Drag and drop a Rich Text scenario. Click the Edit icon and select Insert Data Aggregation. Click the Choose Data dropdown list, the list will be empty.

   
   

   
   

2. Click the [+] next to the dataset, the Choose Data dialog box is displayed. Select the desired dataset and click Ok.

   
   

   
   

3. A dataset is selected in the dashboard. Add the aggregation details and apply them.

   
   

4. Click the Data Binding tab. The selected dataset will be displayed.

   
   

   
   

5. Click the icon , the Set Auto Refresh option is displayed.

   
   

   
   

   
   

6. Click the Set Auto Refresh option, the Auto Refresh Setting dialog box is displayed.

   
   

   
   

7. Select the desired option and click the Ok button.

   
   

   
   

   In this example, we have selected the option Real Time. So, when the cache of the dataset changes, refresh is triggered, and the content of the rich text in the dashboard will be updated accordingly.

   
   

   If you select the Polling option then you need to set the refresh interval as required. By default, the None option is selected.