DeepSee Implementation Guide
[Home]  [Next]
InterSystems: The power behind what matters   
Class Reference   

Preface : 
Chapter 1: 
  1.1 Purpose of DeepSee
1.2 DeepSee Components to Add to Your Application
1.3 Recommended Architecture
1.4 Main Implementation Steps
1.5 Implementation Tools
1.5.1 Available Samples
Chapter 2: 
  2.1 Setting Up the Web Applications
2.2 Placing the DeepSee Globals in a Separate Database
2.3 Alternative Mappings for the Globals
2.4 Adjusting the CSP Timeout Period
Chapter 3: 
  3.1 Accessing the DeepSee Settings
3.2 Specifying Basic Settings
3.3 Configuring DeepSee to Support Email
3.4 Customizing Worklists
3.5 Creating Runtime Variables for Use as Default Values for Filters
3.5.1 Editing Runtime Variables
3.5.2 Removing Runtime Variables
3.6 Allowed Default Values for Filters
3.7 Creating Icons
3.8 Creating Custom Color Palettes
Chapter 4: 
  4.1 Introduction to Data Connectors
4.2 Defining a Basic Data Connector
4.2.1 Defining the Query in an XData Block
4.2.2 Defining the Output Specification
4.3 Previewing the Query Results
4.3.1 Viewing the Test Page
4.3.2 Printing the Output in the Terminal
4.4 Defining the Query at Runtime
4.4.1 Restricting the Records When an Update Is Requested
4.4.2 Restricting the Records When a Listing Is Requested
4.4.3 Other Callbacks
4.5 Using a Data Connector Programmatically
Chapter 5: 
  5.1 Result Caching and Cube Updates
5.2 Specifying the Agent Count
5.3 Cache Buckets and Fact Order
5.4 Removing Inactive Cache Buckets
5.5 Precomputing Cube Cells
5.5.1 Defining the Cell Cache
5.5.2 Precomputing the Cube Cells
Chapter 6: 
  6.1 Introduction
6.1.1 Context Information
6.2 Defining the Behavior of Actions
6.2.1 Declaring Actions
6.2.2 Defining the Behavior of the Actions
6.3 Available Context Information
6.3.1 Scenario: Pivot Table Widget with Pivot Table as Data Source
6.3.2 Scenario: Pivot Table Widget with Listing as Data Source
6.3.3 Scenario: Pivot Table Widget with KPI as Data Source
6.3.4 Scenario: Scorecard with KPI as Data Source
6.4 Executing Client-Side Commands
6.4.1 Available Commands
6.4.2 Details for applyFilter and setFilter
6.5 Displaying a Different Dashboard
6.6 Generating a SQL Table from Cube Context
Chapter 7: 
  7.1 Accessing a Dashboard
7.1.1 URL Encoding
7.2 Available URL Parameters
7.3 Options for the SETTINGS Parameter
7.4 Embedding a Dashboard in a Zen Page
7.5 Accessing Other DeepSee Pages from Your Application
7.5.1 Example: Embedding the Analyzer in a Zen Page
Chapter 8: 
  8.1 Overview
8.1.1 Cube Updates and Related Cubes
8.1.2 Cube Updates and the Result Cache
8.2 How Cube Synchronization Works
8.2.1 When Cube Synchronization Is Possible
8.2.2 When Cube Synchronization Is Not Possible
8.2.3 Cube Synchronization in a Mirrored Environment
8.2.4 Structure of the Cube Synchronization Globals
8.3 Enabling Cube Synchronization
8.4 Using the Cube Manager
8.4.1 Introduction to the Cube Manager
8.4.2 Introduction to Update Plans
8.4.3 Accessing the Cube Manager
8.4.4 Modifying the Registry Details
8.4.5 Registering a Cube Group
8.4.6 Specifying an Update Plan
8.4.7 Merging Groups
8.4.8 Building All the Registered Cubes
8.4.9 Performing On-Demand Builds
8.4.10 Unregistering a Cube Group
8.4.11 Viewing Cube Manager Events
8.5 Using %SynchronizeCube()
8.6 Purging DSTIME
8.7 Updating Cubes Manually
8.8 Other Options
8.8.2 Injecting Facts into the Fact Table
8.8.3 Prebuilding Dimension Tables
8.8.4 Updating a Dimension Table Manually
8.9 Examples
Chapter 9: 
  9.1 Using the Result Set API
9.2 Basic Example
9.3 Preparing and Executing a Query
9.4 Printing the Query Results
9.5 Examining the Query Results
9.5.1 Getting the Number of Columns and Rows
9.5.2 Getting the Value of a Given Cell
9.5.3 Getting the Column or Row Labels
9.5.4 Getting Details for Cell Contents
9.6 Examining the Query Results for a DRILLTHROUGH Query
9.7 Examining the Query Metadata
9.8 Other Methods
9.9 Executing Query Files
9.9.1 About Query Files
9.9.2 Executing a Query File
Chapter 10: 
  10.1 Overview of Localization in DeepSee
10.1.1 Model Localization
10.1.2 Folder Item Localization
10.2 Preparing for Model Localization
10.3 Preparing for Folder Item Localization
10.3.1 Default Domain
10.3.2 Adding Strings to the Message Dictionary
10.3.3 Using Localizable Strings in a Dashboard, Pivot Table, or Other Folder Item
10.4 Localizing the Strings
Chapter 11: 
  11.1 Overview
11.2 Exporting Folder Items to a Container Class
11.3 Editing the DeepSee Folder Items for Portability
11.3.1 Removing <filterState> Elements
11.3.2 Stripping Out Local Data
11.4 Importing an Exported Container Class
11.5 Using the Folder Manager
11.5.1 Seeing the Dependencies of a Folder Item
11.5.2 Exporting DeepSee Folder Items to the Server
11.5.3 Exporting DeepSee Folder Items to the Browser
11.5.4 Importing DeepSee Folder Items
11.6 Restoring Deleted Folder Items
Chapter 12: 
  12.1 Portlet Basics
12.2 Defining and Using Settings
12.2.1 Types of Settings
12.2.2 Receiving Settings Passed Via URL
12.2.3 Using Settings
12.3 Examples
12.4 Using a Data Source
Chapter 13: 
  13.1 Adding Paper Sizes
13.2 Auditing User Activity
13.2.1 Audit Code Requirements and Options
13.2.2 Example
13.3 Defining Server Initialization Code
Chapter 14: 
  14.1 Overview of Security
14.2 Basic Requirements
14.3 Requirements for Common DeepSee Tasks
14.4 Adding Security for Model Elements
14.5 Specifying the Resource for a Dashboard or Pivot Table
14.6 Specifying the Resource for a Folder
Appendix A: 
  A.1 Introduction to the Cube Version Feature
A.1.1 Keeping the Cube Current
A.1.2 Model Changes Can Break Queries
A.2 Modifying a Cube to Support Versions
A.2.1 Cube Versions and Relationships
A.2.2 Details for %ActivatePendingCubeVersion()
A.3 Updating a Cube Version
A.4 Specifying the Cube to Work With
A.5 Additional Options
A.5.1 Disabling the Cube Version Feature
Appendix B: 
  B.1 Introduction
B.1.1 Use of Bitmap Indices
B.1.2 Caching
B.1.3 Buckets
B.2 Engine Steps
B.3 Axis Folding
B.4 Query Plans
B.5 Query Statistics
Appendix C: 
Appendix D: 
  D.1 Creating a DeepSee Container Class
D.2 Exporting and Importing Folder Items
D.2.1 Exporting Folder Items Programmatically
D.2.2 Importing Folder Items Programmatically
Appendix E: 
  E.1 Configuration
E.2 Disaster Recovery