Categories

System Admin
Activity Tracking
DXM
Data
Approval Groups
Studio for Office

Links

Commentary App

Table of Contents

Description

The Commentary app is used to display text-type data stored as commentaries or disclaimers in the Data product. This can be general text or entity-related text related to a fund, class, account or benchmark.

Add a new App

Click the Studio tab, then click + to add a new application.

Studio Wizard

  1. Click Next to start the Studio Wizard.
  2. Provide a name and description for your app. Once these items have been filled, the Next button will become active. Click Next.
  1. Use the dropdown arrow to select a template to base your application on. Enter a few letters of the application name to make the search easier.
  2. Select Kurtosys App Commentary v1.4.0 (or the latest version available), then click Next.
  1. There is a default preset for the Commentary App, Title and Commentary, click Next.
  2. Connect your data – commentaries relate to both cultures and the entity identifier e.g. ISINs so it is necessary to reference the inputs required for a particular commentary to display.
  1. Culture: List the cultures created for the client, for example, en-GB, de-DE, fr-FR. These must be typed out as they appear under Cultures in your Data Dictionary. Press Enter after typing each one.
  2. ISIN: Instead of using Custom Values where each value would have to be typed out, click the dropdown arrow and type a few letters to filter to Class Properties > ISIN. This will allow any ISIN value from your data set to be used instead of custom inputs. Make sure you select the correct entity identifier used by the system for your data set e.g. CUSIP or Fund Code
  3. Click Next.
  1. No Parent Client Configuration is required for this app, click Next.
  2. The token (each client instance has a unique identifier) will be added automatically, click Next.
  1. Select a commentary type from the dropdown list, for example, Fund Objective, click Next.
Note: The commentary types are provided by the Data Dictionary.
  1. Click Finish.

Configuration

Preview

Click the Configuration tab, and make sure the Preview button is selected.

The Commentary Type that was selected while building the app using the Wizard will be displayed.

Note: Some commentaries are linked to specific ISIN codes, input values may need to be updated to see the selected commentary.

Inputs

Click the Inputs button, select the appropriate Culture and ISIN to ensure the commentary displays correctly.

You may need to check Data | Commentaries for this information.

You may also need to confirm that the commentary you are testing has published text.

In Configuration | Inputs Use the dropdown arrow next Culture and ISIN to change your selection to match the information in Data.

JSON

Click the JSON button to make any amendments to the input key or other values using the JSON code.

Styles

Click the Styles tab to add some styling to the app.

Note: It is only necessary to add styles to an app if it is not using the client's general styling Theme.

Styles can be added either by clicking the <> JSON icon and then copying and pasting a JSON file into the editor or using the UI and adding Style elements.

Using the UI:

  1. Click Add Element+.

  1. Check the checkbox next to Components.
  2. Click Save.

  1. Click Components.

  1. Click Add Element+.

  1. Check the checkbox next to App.
  2. Click Save.

  1. Click App.

  1. Click Add Element+.

  1. Only check the checkbox next to Children.
  2. Click Save.

  1. Click Add Element+.

  1. Check the checkbox next to Component Style.
  2. Click Save.

  1. Click Component Style.

  1. Click Add Element+.

In the next menu, you can make changes font style, color, size, etc.

  1. For example, scroll down to select Background, Border, and Color.
  2. Click Save.

  1. Click Background.

  1. Click Add Element+.

  1. Check the Checkbox next to Color.
  2. Click Save.

  1. Type in a color name or code, e.g. yellow, in the Color field. The background immediately updates to the selected color.

  1. Click Component Style in the left navigation pane.
  2. Click Border.

  1. Click Add Element+.

  1. Check the checkboxes next to Color and Style.
  2. Click Save.

  1. Type in a color name or code, e.g. black, in the Color field.
  2. Click Style, a dropdown list of options will display.

  1. Click to select, the border will be added immediately.

  1. Click Component Style in the left navigation pane.
  2. Type a color name or code in the Color field. The commentary text color will update immediately.

  1. Click Add Element+ under Component Style.
  2. Check the checkbox next to Font.
  3. Click Save.

  1. Click Font.

  1. Click Add Element+.

  1. Check the checkboxes next to Family and Size.
  2. Click Save.

  1. Type in a font style in the Family field.
  2. Type in a font size in the Size field.

The text will update immediately.

  1. When all styling is complete, click Save.

  1. Add a comment, then click Confirm.

A green Saved! pop up bar will display across the bottom of the screen.

Adding a  JSON Style file:

  1. Click the Styles tab.
  2. Click the <> JSON icon.
  3. Then Copy and Paste the file below into the editor. Make sure to remove the empty curly brackets.
{
  "components": {
    "app": {
      "children": {
        "wrapper": {
          "border": {
            "color": "#4B0082",
            "radius": "4",
            "style": "double",
            "width": "10"
          },
          "font": {
            "family": "arial",
            "size": "18"
          }
        }
      }
    }
  }
}
  1. Click Save.

  1. Add a comment, then click Confirm.

A green Saved! pop up bar will display across the bottom of the screen.

  1. Click the Configuration tab again and make sure the Preview icon is selected. The commentary styles will be updated.