DeepSee Developer Tutorial

DeepSee Developer Tutorial Version 2010.2 25 April 2011 InterSystems Corporation 1 Memorial Drive Cambridge MA 02142 www.intersystems.comDeepSee Developer Tutorial InterSystems Version 2010.2 25 April 2011 Copyright © 2011 InterSystems Corporation All rights reserved. This book was assembled and formatted in Adobe Page Description Format (PDF) using tools and information from the following sources: Sun Microsystems, RenderX, Inc., Adobe Systems, and the World Wide Web Consortium at www.w3c.org.The primary document development tools were special-purpose XML-processing applications built by InterSystems using Caché and Java. and Caché WEBLINK, Distributed Cache Protocol, M/SQL, M/NET, and M/PACT are registered trademarks of InterSystems Corporation. , , and InterSystems Jalapeño Technology, Enterprise Cache Protocol, ECP, and InterSystems Zen are trademarks of InterSystems Corporation. All other brand or product names used herein are trademarks or registered trademarks of their respective companies or organizations. This document contains trade secret and confidential information which is the property of InterSystems Corporation, One Memorial Drive, Cambridge, MA 02142, or its affiliates, and is furnished for the sole purpose of the operation and maintenance of the products of InterSystems Corporation. No part of this publication is to be used for any other purpose, and this publication is not to be reproduced, copied, disclosed, transmitted, stored in a retrieval system or translated into any human or computer language, in any form, by any means, in whole or in part, without the express prior written consent of InterSystems Corporation. The copying, use and disposition of this document and the software programs described herein is prohibited except to the limited extent set forth in the standard software license agreement(s) of InterSystems Corporation covering such programs and related documentation. InterSystems Corporation makes no representations and warranties concerning such software programs other than those set forth in such standard software license agreement(s). In addition, the liability of InterSystems Corporation for any losses or damages relating to or arising out of the use of such software programs is limited in the manner set forth in such standard software license agreement(s). THE FOREGOING IS A GENERAL SUMMARY OF THE RESTRICTIONS AND LIMITATIONS IMPOSED BY INTERSYSTEMS CORPORATION ON THE USE OF, AND LIABILITY ARISING FROM, ITS COMPUTER SOFTWARE. FOR COMPLETE INFORMATION REFERENCE SHOULD BE MADE TO THE STANDARD SOFTWARE LICENSE AGREEMENT(S) OF INTERSYSTEMS CORPORATION, COPIES OF WHICH WILL BE MADE AVAILABLE UPON REQUEST. InterSystems Corporation disclaims responsibility for errors which may appear in this document, and it reserves the right, in its sole discretion and without notice, to make substitutions and modifications in the products and practices described in this document. For Support questions about any InterSystems products, contact: InterSystems Worldwide Customer Support Tel: +1 617 621-0700 Fax: +1 617 374-9391 Email: support@InterSystems.comTable of Contents About This Book .................................................................................................................................... 1 1 Getting Started 3 1.1 Logging In to DeepSee ............................................................................................................... 3 1.2 Configuring DeepSee to Use Multiple CPUs ............................................................................. 4 1.3 Setting Up the Environment ....................................................................................................... 4 1.4 Generating Data .......................................................................................................................... 5 2 Contents of the DeepSee Sample 7 2.1 The Sample Classes .................................................................................................................... 7 2.2 Diagnosis Data ........................................................................................................................... 9 2.3 The Extra Data Set ................................................................................................................... 10 2.4 Controlling What Is Generated ................................................................................................. 10 2.5 Generating Additional Data ...................................................................................................... 11 2.6 Changing or Deleting Data 11 3 Creating a DeepSee Model ............................................................................................................... 13 3.1 Viewing a Class in the Architect ............................................................................................... 13 3.2 Creating a Basic DeepSee Model ............................................................................................. 17 3.2.1 Relationship of the DeepSee Model to the Class Definition ......................................... 21 3.3 Adding a Detail Listing to the Model ....................................................................................... 22 3.4 Validating the Dimensions ........................................................................................................ 25 3.5 Using a Collection Property ..................................................................................................... 27 3.6 Adding Placeholders for Null Members ................................................................................... 29 3.7 Using Ranges, Translations, and Transformations ................................................................... 33 3.8 Adding Measures in the Analyzer ............................................................................................ 35 3.9 Defining a Filtered Measure 37 3.10 Accessing Other Classes ......................................................................................................... 39 3.11 Model Summary ..................................................................................................................... 40 3.11.1 Dimensions ................................................................................................................... 40 3.11.2 Measures ...................................................................................................................... 41 3.11.3 Listing Fields ................................................................................................................ 41 3.11.4 Detail Lists 42 3.12 Additional Exercises for the Reader ....................................................................................... 42 4 Creating Pivot Tables ....................................................................................................................... 45 4.1 Creating a Basic Pivot Table .................................................................................................... 45 4.2 Additional Basic Options ......................................................................................................... 47 4.3 Specifying the Sort Order 52 4.4 Using Ranking and Nesting Options ........................................................................................ 55 4.5 Using Advanced Layout Options ............................................................................................. 58 4.6 Summary of Pivot Tables 62 5 Creating KPIs ................................................................................................................................... 63 5.1 Creating Simple KPIs ............................................................................................................... 63 5.2 Creating a String-type KPI ....................................................................................................... 64 6 Creating Dashboards ........................................................................................................................ 67 6.1 Creating a Simple Dashboard with a Filter .............................................................................. 67 6.2 Displaying a KPI in a Speedometer ......................................................................................... 70 DeepSee Developer Tutorial                                                                                                                                                   iii6.3 Adding Multiple Filters ............................................................................................................ 73 6.4 Displaying a KPI in a Label ..................................................................................................... 75 7 Using Multiple Subject Areas Together .......................................................................................... 77 7.1 Rules for Creating Multiple Subject Areas .............................................................................. 77 7.2 Multiple Subject Areas in a Pivot Table ................................................................................... 77 7.3 Multiple Subject Areas in a Dashboard .................................................................................... 78 7.4 Setting Up the Initial City Rainfall Subject Area ..................................................................... 80 7.5 Creating the Linked Pivot Table ............................................................................................... 80 7.6 Adjusting the City Rainfall Subject Area and Pivot Table ....................................................... 82 7.7 Creating a Dashboard That Uses Multiple Subject Areas ........................................................ 83 8 Performing Real-time Updates ........................................................