You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Project made with InterSystems Analytics (DeepSee)and various BI systems to visualize and analyze members, articles, questions, answers, views and other pieces of content and activity on [InterSystems Developer Community](community.intersystems.com). This project contains pre-configured IRIS and Atscale deployment in Docker containers and project files for BI systems .
6
+
Project made with InterSystems IRIS BI (DeepSee), Power BI and Logi Report Designer to visualize and analyze members, articles, questions, answers, views and other pieces of content and activity on [InterSystems Developer Community](community.intersystems.com). This project contains pre-configured IRIS and Atscale deployment in Docker containers and project files for BI systems . This project also deployed online and you can check it here:
7
7
8
-
[See Live DC analytics](we'll provide the link to online demo as soon as we made it)
8
+
### See Live DC analytics
9
9
10
-
### 1. To start IRIS
11
-
Open the terminal in this directory and run:
10
+
[PowerBI Interactive Dashboard with connection to the Adaptive Analytics Instance](https://app.powerbi.com/view?r=eyJrIjoiMjU0NjgyNjgtYjA0NS00M2Q3LTg3NzUtN2EwNjVjMGQ0Yzk5IiwidCI6IjRlMzI1ZjgzLWE4YWYtNGY2Yy05ODY3LTBkYTA4YmU1MGZjMCIsImMiOjEwfQ%3D%3D&pageName=ReportSection&language=en-us)
11
+
12
+
[Instance of Adaptive Analytics powered by AtScale](http://atscale-public.demo.community.intersystems.com:10500/login)
13
+
14
+
Login: user
15
+
Password: userp@$$
16
+
17
+
### How to run services local:
18
+
First, you need to clone this repository to your local machine. Below in the text we will use relative paths to files when describing what is where. We assume that you are already in the project's root directory.
19
+
20
+
#### Authenticating to the ICR
21
+
To log into the ICR, take the following steps:
22
+
23
+
Load https://containers.intersystems.com/ in your browser and log in with your InterSystems/WRC credentials.
24
+
25
+
Retrieve your Docker login token, or the full login command.
26
+
27
+
In your Docker interface (for example, your PowerShell window or Linux command line), authenticate to the ICR using the provided credentials. You can do this by copying and pasting the full docker login command displayed, for example:
For security reasons, however, you may want to instead enter the command docker login containers.intersystems.com, then enter your username at the Username prompt and paste your password into the Password: prompt.
34
+
35
+
Note: If you are logged into another Docker registry, the docker login command may result in an error; log out of the other registry before logging into containers.intersystems.com.
36
+
37
+
### 1. Starting IRIS
38
+
InterSystem IRIS stores all the data in this sample project/ So we need InterSystems IRIS up and running and persists data. Below we will take the vanila image of InterSystems IRIS and load Community analytics data. Open the terminal in the project directory and run:
- the ability to store query cash (they call it Aggregate Tables), so that the next query, using aggregation on data, takes from the database already pre calculated results.
72
+
- the ability to use additional functions (actually User-Defined Aggregate Functions) and data processing algorithms that AtScale is forced to store in the data source.
73
+
They are stored in the database in a separate table and Adaptive Analytics can call them by name in auto generated queries. When AtScale can use these functions, the speed of queries increases.
22
74
23
-
A license must be entered to run Atscale server. To do this, you need to put the json file with the license in the folder "atscale-dataset/src/license".
75
+
AtScale has an internal logic for updating aggregate tables, but it is much more convenient to control this process yourself.
76
+
You can configure updates on a per-cube basis in the web interface of AtScale and then use scripts from "iris/src/aggregate tables update shedule scripts" to export schedules and import to another instance, or use the exported schedule file as a backup. You will also find a script to set all cubes to the same update schedule if you do not want to configure each one individually.
24
77
25
-
If you need to change hostname parameter, open directory "atscale-dataset", file "atscale.yaml" and edit (ip or dns name):
78
+
79
+
### 2. To start an Atscale server:
80
+
81
+
A license must be provided to run Atscale server. To do this you need to put the json file with the license in the folder "atscale-dataset/src/license".
82
+
#ToDo Add how to give a link by docker-compose having one license for several projects.
83
+
84
+
In case you plan to deploy this project to some server you might want to alter hostname parameter: open directory "atscale-dataset", file "atscale.yaml" and edit (ip or dns name):
26
85
loadbalancer_dns_name: "127.0.0.1"
27
86
28
87
Run docker container with the command:
29
88
```
30
89
docker-compose up -d atscale
31
90
```
32
-
Wait 2-3 minutes while server is starting up and check the availability of the service:
91
+
This will take a few minutes to pull and build the container.
92
+
93
+
After successful build wait 2-3 minutes while server is starting up and check the availability of the service:
94
+
33
95
http://localhost:10500/login
34
96
35
97
Standard login and password:
36
98
admin/admin
37
99
38
-
If you want to access the web interface, at the initialization step, you need to leave the default connection port, leave the login and password admin / admin and select an Embedded directory for storing data. These connection settings are stored in the BI projects settings.
100
+
This web interface lets you create and edin AtScale BI cubes. You need to follow the initial AtScale setup wizard and choose the following options.
101
+
102
+
- you need to leave the default connection port
103
+
- leave the login and password admin / admin
104
+
- select an Embedded directory for storing data
105
+
106
+
These connection settings are stored in the BI projects settings.
107
+
108
+
If you want to modify AtScale cubes you can find them in the projects tab. When you finish editing cubes and want to save changes go to the export tab of the project and download the xml representation of your cube. Then you need to put this file in the “/atscale-server/src/cubes/” folder of the repository (file name doesn't matter) and delete the existing xml file of the project. If you don't delete the original file AtScale wouldn't publish the updated project with the same name and id. At the next build a new version of the project will be automatically passed to AtScale and will be ready for use as a default project.
109
+
110
+
AtScale doesn't provide public documentation. In order to obtain the documentation open http://localhost:10500/org/default/support and go to the Documentation tab. You will be redirected to https://documentation.atscale.com/ and will be able to view it. We recommend examining [this](https://documentation.atscale.com/2022.2.0/creating-and-sharing-cubes/creating-cubes) chapter to work with existing projects.
111
+
112
+
#### Saving changes:
113
+
By default, all changes to the IRIS or Atscale projects are saved inside these systems.
114
+
To cancel all changes and return to the default settings, from the current directory, run the command:
115
+
```
116
+
docker-compose down -v
117
+
```
118
+
**Warning!** This will remove all created Iris and Atscale containers and any changes saved in them.
39
119
40
-
### 3. To use BI projects
120
+
121
+
### 3. Using BI projects
122
+
123
+
#### Using demo IRIS and AtScale.
124
+
125
+
In "analytic dashboards" folder you can find BI projects that are configured for both local data source and deployed online demo.
126
+
127
+
The AtScale online demo located at http://atscale-public.demo.community.intersystems.com:10500/login. Login and password for it: user/userp@$$
41
128
42
129
#### Power BI
130
+
The option of creation and editing of Power BI dashboards is available only for Windows OS.
131
+
132
+
You may simply run the .pbix file from "analytic dashboards\Power BI" in the [Power BI desktop](https://powerbi.microsoft.com/en-gb/desktop/). Power BI stores BI data in this file, so when you open it for the first time it will show BI dashboards with data that was loaded by developers of this project. Click the refresh button to load the actual data into Power BI. Use the same credentials as in the Adaptive Analytics (AtScale) with Simple Auth method (admin/admin).
133
+
134
+
If you want to modify the Power BI dashboards you may check [official beginner's guide](https://docs.microsoft.com/en-us/power-bi/fundamentals/desktop-getting-started) to learn the basics. We already prepare all the data, so you can start from [build report](https://docs.microsoft.com/en-us/power-bi/fundamentals/desktop-getting-started#build-reports) step.
43
135
44
-
You may simply run the .pbix file from "analytic dashboards\Power BI" in Power BI desktop. Power BI stored data in this file, so to have actual data you firstly need to update the report by the Refresh button.
136
+
After you finish modifying the Power BI project and save it, the changes will be automatically stored in the Power BI file in the repository.
45
137
46
138
#### Logi
47
-
You need a licensed copy of the Logi report Designer to run the reports.
139
+
You need a licensed copy of the Logi Report Designer to edit and run the reports. Also, you will need drivers for jdbc connection. You can find them here: https://github.com/teccod/Logi-JDBC-drivers. To use them you need to place [lib](https://github.com/teccod/Logi-JDBC-drivers/tree/main/lib) folder in the root folder of Logi Report Designer's installation directory.
140
+
141
+
#ToDo Describe how to obtain your copy of Logi Designer or Logi Server. From WRC or similar.
142
+
143
+
On the Start page of Logi Report Designer you need to click the Browse button in the Open category and select the path to the .cat file, then open a .cls file.
144
+
145
+
In "analytic dashboards\logi report\En report" folder you may find the Сommunity monthly overview report - x pages report.
146
+
147
+
In "analytic dashboards\logi report\members by community" folder you may find a simple report regarding the distribution of members by different language communities.
148
+
149
+
If you want to modify Logi reports you may be interested in [official beginner's guide](https://devnet.logianalytics.com/hc/en-us/articles/4405661292567-Report-Types) to understand this BI system. If you only want quickly examine some data, you may be interested in explanation how to make a [chart](https://devnet.logianalytics.com/hc/en-us/articles/4405664328087-Lesson-4-Creating-a-Chart-Report) or a [table](https://devnet.logianalytics.com/hc/en-us/articles/4405664328983-Lesson-5-Creating-a-Table-Report#Task1). The beginner's guide describes the process of creating a widget in a new report file. You can insert a chart or table into an existing report. You can do it from the Insert tab or Component window.
48
150
49
-
In the folder "analytic dashboards\logi report\En report" you can find the report for the EN community.
In folder "analytic dashboards\logi report\members by community" you can find the report about distribution of members by different language communities.
153
+
When you finish editing reports, you need to save the changes in the cls file, which is responsible for the visual part and in the cat file both, which is responsible for the structure and data processing.
52
154
53
155
# Collaboration
54
156
55
-
If you want to use this project on your inw IRIS installation, you may use the following instructions.
157
+
If you want to use this project on your onw IRIS installation, you may use the following instructions.
56
158
57
159
## Installation
58
160
### Basic
@@ -68,7 +170,7 @@ DCANALYTICS> do ##class(Community.Utils).setup("path/to/global/archive.gz file")
68
170
7. Open in your browser `<server:port>/dsw/index.html?ns=DCANALYTICS`.
69
171
8. Done
70
172
### With iKnow
71
-
1. Enable iKnow in namespace web-application settings. Be sure, that everything listed above is installed.
173
+
1. Enable iKnow in namespace web-application settings. Be sure that everything listed above is installed.
72
174
2. Download from release `DSW.config.and.iKnow.files.zip` and move files `sets.txt` and `backlist.txt` from archive to `<your_instance>/Mgr/DCANALYTICS/`.
To use this alternative image you need to authorize docker to download images from [ghcr.io](https://ghcr.io).
35
+
Login requires your GitHub account credentials, run the command in the terminal:
36
+
```
37
+
$ docker login ghcr.io
38
+
> Username: your_username
39
+
> Password: your_github_token
40
+
```
41
+
42
+
When entering a password, you need to use the GitHub access token, you can read how to get it at the [link](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token).
43
+
In the "GitHub access token" settings, should be opened access to read packages from the GitHub package registry:
0 commit comments