iris-analytics-for-money

This is my InterSystems IRIS Analytics (DeepSee) solution based on iris-analytics-template. The template contains a very basic example of the BI solution which contains one source class, data, one cube, two pivots and one dashboard.

Installation

ZPM

It's packaged with ZPM so it could be installed as:

zpm "install iris-analytics"

then open http://localhost:32792/csp/irisapp/_DeepSee.UserPortal.Home.zen

Docker

The repo is dockerised so you can clone/git pull the repo into any local directory

$ git clone https://github.com/oliverwilms/iris-analytics.git

Open the terminal in this directory and run:

$ docker-compose up -d

and open then http://localhost:32792/csp/irisapp/_DeepSee.UserPortal.Home.zen

Or, open the cloned folder in VSCode, start docker-compose and open the URL via VSCode menu:

Please note the password for _SYSTEM is changed to abc123.

How to start coding

Prerequisites

Make sure you have git and Docker desktop installed.

This repository is ready to code in VSCode with ObjectScript plugin. Install VSCode, Docker and ObjectScript plugin and open the folder in VSCode.

Read more about folder setup for InterSystems ObjectScript

How this sample was created

The Riches.* classes were originally created for iris-for-money iris-for-money repository.

Test data comes from Excel export in CSV format:

"Date","Check","Merchant","Category","SubCategory","Memo","Credit","Debit","Bill Pay","Debit Card","Account","Balance","Status"
"3/22/2021","","City of Frisco","Utilities","Water","11416638809","","76.29","","","Chase","1526.71","Reconciled"

raw data (https://raw.githubusercontent.com/oliverwilms/iris-analytics/master/export.csv)

Installer code imports test data so it is available to be analyzed.

My first cube was generated from with:

w ##class(%DeepSee.WizardUtils).%GenerateCubeDefinition("Riches.Transact","Riches","Riches.BI.Cube",1)

I created another cube once I had learned how to use Analytics > Architect.

Later I learned to create a dashboard with pivot table and how to export to a Container Class.

Deployment

To deploy this project via ZPM or docker we need: classes, data and DFI.

Pivots and dashboard were created manually and then were exported with isc dev to the format, which standard import procedures and ZPM can import:

zpm "install isc-dev"
do ##class(dev.code).workdir("/irisdev/app/src")
d ##class(dev.code).export("*.DFI")

And data was exported via standard export utility:

do $System.OBJ.Export("dc*.GBL","/irisdev/app/src/gbl/dc.irisbi.covid19D.xml",,.errors)

after that ZPM module.xml was created manually which includes classes, DFI, global and calls %DeepSee.Utils("Covid19Cube") to build the cube data.

What's inside the repository

Dockerfile

The simplest dockerfile which starts IRIS and imports Installer.cls and then runs the Installer.setup method, which creates IRISAPP Namespace and imports ObjectScript code from /src folder into it. Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders. Use .env/ file to adjust the dockerfile being used in docker-compose.

.vscode/settings.json

Settings file to let you immedietly code in VSCode with VSCode ObjectScript plugin)

.vscode/launch.json

Config file if you want to debug with VSCode ObjectScript

Read about all the files in this article