Skip to main content
Previous section   Next section

Configuring Settings

This chapter describes how to configure options that affect the appearance and behavior of DeepSee. It discusses the following topics:

Accessing the DeepSee Settings

To access the DeepSee settings:

  1. Click the InterSystems Launcher and then click Management Portal.

    Depending on your security, you may be prompted to log in with a Caché username and password.

  2. Switch to the appropriate namespace as follows:

    1. Click Switch.

    2. Click the namespace.

    3. Click OK.

  3. Click DeepSee > Admin > Settings.

The system displays the following page:

images/d2imp_settings.png

Specifying Basic Settings

On the General tab, you can specify the following settings:

  • Color Scheme — Select a color scheme for the User Portal.

  • Chart Series Color Scheme — Select a color scheme for chart series. This is used as the default color scheme. Via the Dashboard Editor, users can apply a different color scheme to a given chart.

  • Home Page Title — Specify the title for the browser page or tab.

  • Company Name — Select a title to display in the upper right area of the User Portal.

    If you specify this, do not specify Company Logo.

  • Company Logo — Specify the URL of an image to display to the right of the company name.

    Specify either a complete URL, starting with http:// or a URL relative to the web application defined for this namespace.

    If you specify this, Company Name is ignored.

  • Company Link — Specify the URL to open when a user clicks the company logo or name in the upper right.

    Specify either a complete URL, starting with http:// or a URL relative to the web application defined for this namespace.

  • Google Maps API Key — Specify a key to use for the Google Maps API. Google has changed their policy regarding the use of the Google Maps libraries so that all new installations require an API key to function. See the Google Maps API Documentation for more information.

  • Dashboard email — See the next topic.

  • Default Resource — Default resource to use to secure pivot tables and dashboards.

    See “Adding Security for DeepSee Elements,” later in this book.

  • No Dashboard Titles — If this option is selected, DeepSee hides the title area in the User Portal and in all dashboards. The title area is this area:

    images/d2imp_settings_dashboard_title_area.png

    This option is equivalent to the NOTITLE URL parameter; see “Available URL Parameters,” later in this book.

  • No Dashboard Borders — If this option is selected, DeepSee hides the border in the User Portal and in all dashboards. This option is equivalent to the NOBORDER URL parameter; see “Available URL Parameters,” later in this book.

  • Show Calculated Members in Filters — If this option is selected, calculated members that are part of existing cube dimensions will appear in filters. This setting does not affect calculated members that are part of special dimensions created by the definition of a calculated member.

  • Autosave — These options enable or disable the autosave feature in this namespace. If the Analyzer check box is selected, DeepSee automatically saves the state of the Analyzer for each user, for each pivot table. This means that when a given user opens a pivot table in the Analyzer, DeepSee displays that pivot table as the user last saw it.

    Similarly, if the User Portal Settings check box is selected, DeepSee automatically saves the state of the User Portal for each user, for each dashboard.

    In both the Analyzer and the User Portal, there is an option to clear the autosave state. (You can also remove all autosave data programmatically. See the %KillAutosaveFolders() method of %DeepSee.UserLibrary.Utils.)

Click Save after making any changes on this tab.

Configuring DeepSee to Support Email

On the General tab, you can configure DeepSee so that users can send email from within dashboards. To do so, use the Dashboard email setting. Select one of the following:

  • Use client-side email — Enables email in DeepSee. When a user sends email, DeepSee accesses the default client-side email system, which the user then uses to send a message. The message contains a link to the dashboard, and the user can edit the message.

  • Use server-side email — Enables email in DeepSee. When a user sends email, DeepSee displays a dialog box where the user types the email address and enters an optional comment, which DeepSee adds to the message that it generates; this default message contains a link to the dashboard. The system then sends the email via an SMTP server.

    If you select this, you must also configure Caché to use an SMTP server. See “Configuring Task Manager Email Settings” in the chapter “Configuring Caché” in the Caché System Administration Guide.

  • Disabled — Disables support for email within DeepSee.

    This is the default.

Customizing Worklists

On the Worklists tab, you can customize how DeepSee displays worklists. To do so, click Customized worklists and then select options in the following groups:

  • The Home Page Top Panel and Home Page Bottom Panel options specify the worklists that are available in the User Portal, which always has two worklist areas on the left.

  • The Dashboard Page Top Panel and Dashboard Page Bottom Panel options specify the worklists that are available in dashboards, which can have zero, one, or two worklist areas on the left, depending on their configuration.

In each section of this page, select the worklists to be available in the corresponding area. The available worklists are as follows:

  • The Details worklist displays details for the pivot table or dashboard that the user has selected. For example:

    images/d2imp_worklist_details.png

  • The Favorites worklist displays any items that the user has marked as favorites. For example:

    images/d2imp_worklist_favorites.png

  • The Recent items worklist displays items that the user has recently accessed. For example:

    images/d2imp_worklist_recent.png

  • The Alerts worklist displays recent alerts for the user. For example:

    images/d2imp_worklist_alerts.png

  • The Filters worklist displays filters and other controls in the dashboard. For example:

    images/d2imp_worklist_filters.png

Creating Runtime Variables for Use as Default Values for Filters

On the Run-time Variables tab, you can define variables that have a logical name and a value that is an ObjectScript expression that is evaluated at runtime. You use these within dashboards for the default values of filters.

To add a setting:

  1. Click New.

    The page then displays the following:

    images/d2imp_runtime_variable_new.png

  2. Specify the following details:

    • Name — Specify the name of the variable.

    • Value — Specify an ObjectScript expression.

      The value can be any valid ObjectScript expression. For example, it can be an invocation of a class method or routine; that method or routine can use special variables such as $USERNAME and $ROLES.

      For details on the allowed values, see the section “Allowed Default Values for Filters.”

    • Context — Select DefaultFilterValue to specify the context in which you will use this expression. Then the Widget Editor lists this setting as a possible default value for a filter, when you add a control to a widget.

      The value Other is currently not used.

    • Description — Optionally specify a comment.

  3. Click Apply.

    The variable is added to the table, which also shows its current value:

    images/d2imp_runtime_variable_example.png

Editing Runtime Variables

To edit a runtime variable:

  1. Click the variable in the table.

  2. Edit the details in the area below the table.

  3. Click Apply.

Removing Runtime Variables

To remove a runtime variable, click the X in the row for that variable.

The system immediately removes the variable.

Allowed Default Values for Filters

The following table lists the possible default values for filters, when used with an MDX-based data source. Use this information when you define runtime variables to use as filter defaults, or when you specify filters in other ways described in this book.

Scenario Expression That Returns This Value
A single member "&[keyval]" where keyval is the key for the member. See “Key Values” in the DeepSee MDX Reference.
A range of members "&[keyval1]:&[keyval2]"
A set of members "{&[keyval1],&[keyval2],&[keyval3]}"
All members of the level except for a specified single member "%NOT &[keyval]"
All members of the level except for a specified subset "%NOT{&[keyval1],&[keyval2],&[keyval3]}"

Note that for an MDX-based data source, the filter name and filter value are not case-sensitive (except for the optional %NOT string).

Creating Icons

On the User-defined Icons tab, you can define reusable icons with logical names. You can use these icons within pivot tables that have conditional formatting and within widget controls on dashboards.

To add an icon:

  1. Click New.

    The bottom area of the page then displays the following:

    images/d2imp_icon_new.png

  2. For Name, specify the name you will use to refer to this icon.

  3. For Path, specify the location of the icon file. Do one of the following:

    • Specify a relative path that is relative to install-dir/CSP/broker/

    • Specify a complete URL.

  4. Click Apply.

    The icon is added to the table, which also shows a preview:

    images/d2imp_icon_example.png

You can edit or remove icons in the same way that you do with runtime variables. See the previous section for details.

For information on using icons in pivot tables with conditional formatting, see “Applying Conditional Formatting” in Using the DeepSee Analyzer. For information on configuring widget controls, see “Adding a Control” in Creating DeepSee Dashboards.

Creating Custom Color Palettes

You can also create custom color palettes, for use in the dashboard editor, which provides a color picker. The following shows this color picker with one of the default color palettes:

images/d2imp_color_palette_example.png

To add a custom color palette, add nodes to the ^DeepSee.UserPortalColorSets global, as follows:

Node Value
^DeepSee.UserPortalColorSets(n) where n is an integer, incremented from the previous node in the global. A $LISTBUILD list that consists of the following items, in order:
  1. Logical name of the color palette
  2. Display name of the color palette. Optionally use $$$Text() to make this name localizable.
  3. A list of CSS color names, separated by semicolons.

For example:

 set colorlist = "darkturquoise;greenyellow;hotpink;floralwhite;palevioletred;plum;"
 set colorlist = colorlist _"powderblue;palegreen;plum;mediumaquamarine;linen;"
 set colorlist = colorlist _"lightsteelblue;lightpink;oldlace;lightsalmon;gold;"
 set mycolors=$LB("My Custom Colors","My Custom Colors",colorlist)
 set ^DeepSee.UserPortalColorSets($I(^DeepSee.UserPortalColorSets)) = mycolors
Copy code to clipboard

When a user selects a color palette, DeepSee displays a sample of each color in the grid. You can specify up to 64 colors.