Skip to content

Commit 82bf643

Browse files
authored
Update README.md
Moved and fixed UDAF section
1 parent 8da317e commit 82bf643

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,6 @@ One of basic dashboards:
4040
<img width="1188" alt="image" src="https://user-images.githubusercontent.com/41373877/184346339-7e896fcd-629b-4225-85c2-950d9fe63723.png">
4141

4242

43-
44-
#### Option: UDAF optimization
45-
If you have a commercial license on IRIS you may have LOGIN and PASSWORD for use in private ZPM registry.
46-
In that case you may install isc-udaf package from there.
47-
Installation command in IRIS looks like this:
48-
```
49-
zpm "repo -n registry -r -url https://pm.intersystems.com/ -user LOGIN -pass PASSWORD"
50-
zpm "install isc-udaf"
51-
```
52-
Next, you have to swith UDAF on in AtScale Data Warehouse settings:
53-
Go to http://[your-atscale-server]:10500/org/default/settings/data-warehouses and set Custom Function Installation Mode to Custom Managed value.
54-
![image](https://user-images.githubusercontent.com/41373877/184353600-f0032b36-cf35-418b-94bf-d79c5e1a9a53.png)
55-
56-
UDAF gives AtScale 2 main advantages:
57-
- 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.
58-
- 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.
59-
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.
60-
61-
AtScale has an internal logic for updating aggregate tables, but it is much more convenient to control this process yourself.
62-
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.
63-
64-
6543
### 2. To start an Atscale server:
6644

6745
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".
@@ -124,6 +102,29 @@ docker-compose down -v
124102
**Warning!** This will remove all created Iris and Atscale containers and any changes saved in them.
125103

126104

105+
### UDAF optimization
106+
UDAF stands for USER Defined aggregate functions. AtScale uses it to build aggregates on a host database server in order to process analytics queries faster. This is a mandatory component to use AtScale effectively.
107+
UDAF component must be installed into IRIS. It can be done manually (check the [documentation]([url](https://docs.intersystems.com/irisforhealthlatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_CREATEUDAF))) or by installing an UDAF package from IPM (InterSystems Package Manager).
108+
IPM is a gated package registry thus will need a token to get the access. Token can be obtained on [IPM site](pm.intersystems.com) using yuor InterSystems credentials.
109+
<img width="1125" alt="Screenshot 2022-08-23 at 09 21 01" src="https://user-images.githubusercontent.com/2781759/186085099-2a38edcf-dc8c-4ea3-8d69-01b72329af31.png">
110+
111+
Open IRIS terminal and run:
112+
```
113+
zpm "repo -n registry -r -url https://pm.intersystems.com/ -token access_token"
114+
zpm "install isc-udaf"
115+
```
116+
Next, you have to turn UDAF on in AtScale Data Warehouse settings:
117+
Go to http://[your-atscale-server]:10500/org/default/settings/data-warehouses and set Custom Function Installation Mode to Custom Managed value.
118+
![image](https://user-images.githubusercontent.com/41373877/184353600-f0032b36-cf35-418b-94bf-d79c5e1a9a53.png)
119+
120+
UDAF gives AtScale 2 main advantages:
121+
- 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.
122+
- 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.
123+
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 performance of analytics queries increases dramatically.
124+
125+
AtScale has an internal logic for updating aggregate tables, but it is much more convenient to control this process yourself.
126+
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.
127+
127128
### 3. Using BI projects
128129

129130
#### Using demo IRIS and AtScale.

0 commit comments

Comments
 (0)