Create a world

A Web Dashboard stores database connection information in a world object. Once defined, you can use the world objects to setup data structures called data sets, which are the basis of Reports and Dashboards.

To create a world:

  1. On the Main menu, select Data management > World. For example:

    Screen to show how to add a World
  2. Click the Add button icon green plus sign to create a new world. A new document opens and the Description tab displays.
  3. On the Description tab, enter values for the following:
    FieldDescription
    NameThis value must be unique for your world.
    DescriptionEnter additional information about the world's content. This field can be internationalized.
    JDBC Driver

    Select the driver from the drop down that corresponds to the database you want to use. You will not be able to establish a valid database connection until you have a driver that corresponds to your database.

    In this drop down, driver names are prefixed with a dot (.), which indicates a driver is ready to use, or a question mark (?), which indicates the driver is unavailable.

    Note  Web Dashboard comes with four prepackaged drivers: H2, MS Excel, MySQL, and ODBC. Other drivers not prepackaged will need to be configured. See Driver management.
    JNDI

    Select the radio button and enter the name of the Java Naming and Directory Interface (JNDI) connection you want to use for your database.

    Tip  You must choose either JNDI or URL to specify your database connection. You cannot choose both.
    URL

    Select the radio button and enter the URL for your Sentinel database. For example:

    • Oracle™: jdbc:oracle:thin:@<server name>:<port>:<database name>
    • SQL Server™ : jdbc:mssqlserver:jtds://<server name>/<database name>
    • MySQL: jdbc:mysql://<server name>/<database name>

    For in-memory databases, see In-memory database.

    This field supports personalized fields. See Personalized fields.

    Tip  You must choose either JNDI or URL to specify your database connection. You cannot choose both.

    User name

    If you choose URL, you must enter user name to log in to the database.

    This field supports personalized fields. See Personalized fields.

    Standard password

    The password for the specified database user.

    This field supports personalized fields. See Personalized fields.

    Contextualized passwordThe password for the specified database user. This field can be personalized; it is displayed in clear text.
    Read only

    Select if you want your database connection to be read-only.

    If you plan to exclusively read from the database, select read only. However, if you are setting up an in-memory database, do not select read only. See In-memory database

    Limit to Catalog/Schema

    Select to restrict access to certain catalogs or schemas in your database.

    If you do not select this, you can still make this restriction at the data dictionary level. By clicking the Connection test button under the Description tab, your database connection is tested using the specified data. The output information may contain information about available database catalog or schema objects.

    These fields support personalized fields. See Personalized fields.

  4. (Optional) Select More Details to reveal the following fields:
    FieldDescription
    Transaction isolationControls concurrent access to the database. Depending on this setting, Web Dashboard will activate transaction-related mechanisms that constrain database data access timing to assure some level of transaction isolation. The higher the isolation level, the greater the performance loss. The highest isolation level is Serializable, and the lowest is Read uncommitted. Not all databases support transaction isolation.
    Default settings

    Select if you want to disable editing for the Resultset type, Resultset concurrency, and Fetch size fields.

    Unselect to enable editing.

    Resultset type SQL statements that read data from the database return the data in a resultset. Choose from the following types of resultsets: Forward only, Scroll insensitive and Scroll sensitive. The default value for a result set type is Forward only. See your JDBC documentation for more information.
    Resultset concurrency Choose from the following options: Read only (default) and Updatable.
    Fetch size

    Enter the number of rows to be retrieved in any subsequent trips to the database for a resultset. Most JDBC drivers have a default value of 10.

    Override pool configurationSelect to override the current, default connection pool configuration for Web Dashboard.
    Use pooled connection Select to use one single connection between the World object and the database. This option has a negative impact on performance. If selected, you can customize parameters related to the database connection pool.
    Max active connectionsSpecify the maximum number of active connections that can be allocated from this pool at the same time. Specify a negative number for no limit.
    Max idle connectionsSpecify the maximum number of connections that can remain idle in the pool without releasing the extra ones being released. Specify a negative number for no limit.
    Max wait time in millisSpecify the maximum time (in milliseconds) that the pool should wait (when there are no available connections) for a connection to be returned before throwing an exception. Specify -1 to wait indefinitely.
    Min evictable idle time in millis Specify the minimum time (in milliseconds) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any).
    Min idle connectionsSpecify the minimum number of connections that can remain idle in the pool, without extra ones being created. Specify zero to create none.
    Time between eviction runs in millisThe time (in milliseconds) to sleep between runs of the idle object evictor thread. Specify a negative value if you do not want the idle object evictor thread run.
    Validation query

    Enter the SQL query used to validate connections from this pool before returning them to the caller. If specified, this query must be an SQL SELECT statement that returns at least one row.

  5. On the Properties tab, you can configure database connection properties provided directly by the JDBC driver you chose. These are for advanced use. See you JDBC driver documentation for information about configuring these properties.
  6. On the Internationalization tab, you can define labels to be displayed in different languages supported by your Web Dashboard installation. In the case of the World object, you can do so with the Description field from the Description tab.
  7. Click the Save icon.
  8. Your world is now ready to be used.

Related Links