bugfix, ZPM module update, docker environment update
This is the README file for SAMPLES-BI.
The end of the file has setup instructions.
Use or operation of this code is subject to acceptance of the license available in the code
repository for this code.
Samples-BI is meant for use with the InterSystems IRIS Business Intelligence capabilities.
In order to use this sample, you must have an InterSystems IRIS license that includes these capabilities.
These classes provide sample data that you can use to explore the capabilities of InterSystems IRIS BI.
They also demonstrate ways to create BI models using InterSystems IRIS BI.
This sample contains two packages:
BI
package, which provides simple data representing a fictitious medical study, and also providesHoleFoods
package, which provides simple data representing sales of food products, and also providesThe documentation for InterSystems IRIS Business Intelligence refers extensively to these samples.
The HoleFoods model provides a quick and easy introduction to BI, and the BI model demonstrates
null handling, list-based levels, and other features not included in HoleFoods. The BI package also
explicitly demonstrates how to address more difficult modeling scenarios.
After setup:
The repository also includes a number of configuration files and scripts that are not part of the sample itself.
Please refer to [dev.md] for more about the role of these files.
This package provides simple data representing a fictitious medical study, and also provides
an InterSystems IRIS BI model that uses that data.
BI.Model
package contains the classes that demonstrate BI model capability.
BI.Model.PatientsCube
is the primary model; this defines the PATIENTS cube that isBI.Model.CompoundCube
package contains multiple cube definitions that collectivelyBI.Model.KPIs
package contains sample InterSystems IRIS BI KPIs (key performance indicators).BI.Model.Portlet
package demonstrates a sample custom portlet. For details, see theBI.Model.RelCube
package contains multiple cube definitions that collectivelyBI.Model.SubjectAreas
package contains multiple class definitions that that defineDeepSee.Model.DemoMDX
) is meant for use in getting familiarBI.Study
package contains the classes that generate the data used by these models. The most
important classes are these:
BI.Study.Patient
is the central class and provides the source table for the PATIENTS cube.BI.Diagnosis
generates the diagnosis data used when generating patients. This diagnosisBI.Allergen
generates a common set of allergens, and BI.AllergySeverity generates aBI.Study.Profession
generates a set of professions, to which the working-age patients areBI.Utils.MDXAutoFiltersKPI
is a sample class that adds cube-based filters to a KPI, when used
as a superclass for that KPI. This class is discussed in the advanced modeling guide.
BI.APISamples
demonstrates how to execute BI queries programmatically on the server. For details,
see the BI implementation guide.
BI.DashboardsEtc
contains the pivot table and dashboard definitions based on the models in
the BI.Model package.
BI.Populate
contains the wrapper code used to generate the data for this part of the BI sample.
This package provides simple data representing sales of food products, and also provides
an InterSystems IRIS BI model that uses that data.
HoleFoods.Transaction
, HoleFoods.Country
, HoleFoods.Outlet
, HoleFoods.Product
, and HoleFoods.Region
HoleFoods.Transation
provides the source table used by the cube definitionsHoleFoods.Cube
defines the HOLEFOODS cube, which is meant as a quick and easy introduction to BIHoleFoods.BudgetCube
and HoleFoods.CombinedCube
demonstrate a compound cube.HoleFoods.KPI*
classes define sample InterSystems IRIS BI KPIs (key performance indicators).HoleFoods.SampleListingGroup
is a sample listing group class. Via listing groups, you can defineHoleFoods.SubjectAreaAsia
is a sample subject area. For details, see the modeling guides.HoleFoods.Utils
contains the code used to generate data for the HoleFoods part of the BI sample.ZPM stands for ObjectScript Package Manager. It provides a simple and unified way to install ObjectScript modules Learn More. You can either install ZPM on an existing InterSystems IRIS instance based on these instructions, or use one of the prebuilt Community Edition Docker images that have it pre-installed. The instructions below are for the latter option. If you already have ZPM installed, you can immediately proceed to jump to step 4.
Make sure you have Docker-desktop installed.
Pull the IRIS Community Edition image with zpm:
$ docker pull intersystemsdc/iris-community:2021.1.0.215.0-zpm
You can take the latest tag of IRIS or IRIS for Health Community Edition with ZPM here
$ docker run --name irisce -d --publish 52773:52773 intersystemsdc/iris-community:2021.1.0.215.0-zpm
docker exec -it irisce iris session iris Node: c6e0f00b8d42, Instance: IRIS
USER>
USER>zpm zpm: USER>install samples-bi
[samples-bi] Reload START
[samples-bi] Reload SUCCESS
[samples-bi] Module object refreshed.
[samples-bi] Validate START
[samples-bi] Validate SUCCESS
[samples-bi] Compile START
[samples-bi] Compile SUCCESS
[samples-bi] Activate START
2,187 row(s) created
Building cube [HOLEFOODS]
...
Complete
Elapsed time: 0.009120s
Source expression time: 0.000307s
Defining term list Patients Pivots...
Defining term list Patients RowSpecs...
Defining YEAR pivot variable in PATIENTS cube
[samples-bi] Configure SUCCESS
[samples-bi] Activate SUCCESS
Clone or download the repository. If you downloaded a ZIP, extract the files to a directory on the server. You will need to refer to these files’ location in step 8.
If you have not yet created a namespace in InterSystems IRIS, follow the detailed instructions to do so.
In the Management Portal, click System Administration > Security > Applications > Web Applications.
Click the link in the first column of the row /csp/mynamespace where mynamespace
is the namespace from step 2.
Click the Analytics checkbox and then click Save.
Open the InterSystems IRIS Terminal.
Enter the following command (replacing mynamespace
with the namespace from step 2):
ZN "mynamespace"
Enter the following commands (replacing full-path-to-Build.SampleBI.cls
with the full path of the buildsample/Build.SampleBI.cls
file):
do $system.OBJ.Load("full-path-to-Build.SampleBI.cls","ck")
do ##class(Build.SampleBI).Build()
When prompted, enter the full path of the directory to which you downloaded this sample. The method then loads and compiles the code and performs other needed setup steps.
Now, when you access the Analytics submenu of the Management Portal, this namespace will be listed. For example, you can now use the Analyzer with the cubes that are included within this sample.
IMPORTANT: If the namespace is not listed when you access the Analytics submenu of the Management Portal, see Setting Up the Web Application in the book Implementing InterSystems IRIS Business Intelligence.