Skip to main content

Getting Started

The SAMPLES namespace includes two DeepSee samples. One is the DeepSee.Study.PatientOpens in a new tab class and related classes. This sample is meant for use as the basis of a DeepSee model. It does not initially contain any data. The DeepSee.Model package includes sample cubes, subject areas, KPIs, pivot tables, and dashboards, for use as reference during this tutorial.

This sample is intended as a flexible starting point for working with DeepSee. You use this sample to generate as much data or as little data as needed, and then you use the DeepSee Architect to create a DeepSee model that explores this data. You can then create DeepSee pivot tables, KPIs, and dashboards based on this model. The sample contains enough complexity to enable you to use the central DeepSee features and to test many typical real-life scenarios. This book presents hands-on exercises that use this sample.


DeepSee uses SQL to access data while building the cube, and also when executing detail listings. If your model refers to any class properties that are SQL reserved words, you must enable support for delimited identifiers so that DeepSee can escape the property names. For a list of reserved words, see the “Reserved Words” section in the Caché SQL Reference. For information on enabling support for delimited identifiers, see the chapter “Identifiers” in Using Caché SQL.

Be sure to consult the online InterSystems Supported PlatformsOpens in a new tab document for this release for information on system requirements for DeepSee.

Getting Started

Most of the tools that you will use are contained in the Management Portal.

To log on:

  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 SAMPLES namespace as follows:

    1. Click Switch.

    2. Click SAMPLES.

    3. Click OK.

Regenerating Data

The tutorial uses a larger, slightly more complex set of data than is initially provided in SAMPLES.

To generate data for this tutorial:

  1. In the Terminal, switch to the SAMPLES namespace:

     zn "SAMPLES"
  2. Execute the following command:

     do ##class(DeepSee.Populate).GenerateAll(10000,"ADETR")

    This class method generates 10000 patients. The "ADETR" string means that the sample will include allergy data (A), diagnosis data (D), encounter data (E), details (T), and the city rainfall data (R).

  3. Because we will use SQL queries that run against the tables that we have just populated, it is good practice to run the Tune Table facility on them:

    1. Access the Management Portal and go to the SAMPLES namespace, as described earlier.

    2. Click System Explorer > SQL.

    3. Click the Execute Query tab.

    4. Click Actions and then Tune All Tables.

      The system then displays a dialog box where you select a schema and confirm the action.

    5. For Schema, select the DeepSee_Study schema.

    6. Click Finish.

    7. Click Done.

    The system then runs the Tune Table facility in the background.

FeedbackOpens in a new tab