Build a data dictionary

Web Dashboard stores data structures in the object called the data dictionary. The data dictionary represents the data structure where Reports, Metrics, Alerts, and Dashboards are based.

You can build data dictionaries using SQL queries or a wizard. You can also combine multiple data dictionaries into a single data dictionary. The procedure to create a data dictionary is essentially the same whether you are creating a standard (or star schema) data structure, SQL data structure or multi-dictionary.

In general, perform the following steps to create a data dictionary:

  1. On the Main menu, select Data management > Data dictionary. A list of existing data dictionaries are displayed.
  2. Select the Add button icon green plus sign to create a new data dictionary. A new document opens and the Description tab displays.
  3. On the Description tab, enter values for the following:
    FieldDescription
    NameEnter a unique identifier for the data dictionary object.
    Description

    Enter a label for your data dictionary. This label provides additional information about the object and is displayed across the GUI. This field can be internationalized.

    Type

    A list of data dictionary types from which you can select.

    WorldA previously defined database connection used for accessing data.
    EntityThe entity with which the data dictionary is associated. See User access managment.
  4. Optionally, select More Details to display advanced settings for data dictionary set up.
  5. Field Description
    Max lines in memory

    Limits the number of lines retrieved from the database. Specify -1 for unlimited lines.

    Note   Please set this field to a value close to the actual number of records that you intend to monitor. Specifying a very high number or -1 (unlimited) will have a negative impact on the report's loading time. In order to avoid performance issues caused by overlooking this field, starting with Service Pack 7, the default value for a newly created Data Dictionary was set to 10000.

    Comment Add a comment to the data dictionary.
    Available for multi-dictionaries Specify whether this dictionary can be used to compose a multi-dictionary. This is only available for type standard.
    Available for forms

    Specify whether this dictionary can be used by forms. This is only available for type standard.

    Available for tasks Specify whether this dictionary can be used in associate with tasks.
    Version Version number of the object. The version of the object is automatically incremented each time you modify it. You can also manually set a custom version using the following format: dd.dd.ddd (where d represents a digit.) This version number is used during XML export/import. See Import and export objects
  6. If you select Standard or Multi-dictionary in the Type list, the Data structure tab is made available. If you select SQL in the Type field, the SQL tab is made available.
  7. Select the Data structure tab or SQL tab to continue creating your data dictionary. See the following for more information about creating data structures for each type of data dictionary:

Related Links