Skip to content

Commit e629264

Browse files
committed
Installation docs
1 parent 588cdff commit e629264

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ RESTful web api for MDX2JSON transformation (also JSONP and XML/A). Also support
66
Installation
77
-----------
88

9+
1. Download MDX2JSON/Installer.cls.xml (from repository or releases page).
10+
2. Run in terminal (any namespace):
11+
12+
do ##class(%Installer.Installer).InstallFromCommandLine("{SourceDir}\Installer.cls.xml","Namespace={Namespace}",0)
13+
14+
where:
15+
16+
{Namespace} is a namespace you want to install to. If it does not exist it would be created automatically. If it does exist only MDX2JSON package would be overwritten.
17+
18+
On this step installer would create (if needed) Namespace and corresponding database, download source code from GitHub and compile it, create required web application (named /{Namespace}) if one does not exist (skipping web application creation process if one does exist), and map MDX2JSON package to %All namespace (which will be created if does not exist).
19+
3. Give the correct roles to /{Namespace} webapplication for it to be able to query desired cubes.
20+
21+
22+
23+
Offline Installation
24+
-----------
25+
926
1. Download zip and unpack it.
1027
2. Run in terminal (any namespace):
1128

@@ -22,6 +39,15 @@ On this step installer would create (if needed) Namespace and corresponding data
2239

2340
For information on how to work with this RESTful web API please refer to included documentation.
2441

42+
Update
43+
-----------
44+
45+
1. Run in terminal (namespace where you installed MDX2JSON):
46+
47+
do ##class(MDX2JSON.Installer).Update()
48+
49+
You can also supply parameters such as fork, desired branch/commit, target namespace, authorization information. Please refer to Caché documentation of MDX2JSON.Installer for correct syntax.
50+
2551
Requests
2652
-----------
2753

@@ -70,7 +96,7 @@ If something goes wrong, server must report an error in the following format {Er
7096
| Problem | Solution |
7197
|-----------------------------|----------------------------------|
7298
| CSP Error | User does not have enough rights. Configure User or Webapplication roles |
73-
| Authenticated access | Guideline to configure [here](https://github.com/intersystems-ru/Cache-MDX2JSON/issues/24)|
99+
| Authenticated access | Web application must have password access, resource for database with MDX2JSON must have public RW rights enabled|
74100
| No dashboards | Configure roles. Change [dashboard scope](https://github.com/intersystems-ru/Cache-MDX2JSON/issues/10)|
75101
| DeepSee errors | Build and compile DeepSee cube(s)|
76102
| MDX errors | Don't forget to escape JSON strings [here](http://json.org/string.gif) |

0 commit comments

Comments
 (0)