Skip to content
This repository was archived by the owner on May 18, 2022. It is now read-only.

Commit 32927ce

Browse files
authored
Update README.md
1 parent 93a901d commit 32927ce

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Installation
2+
## Prerequisites
3+
Firstly, please import and compile the [Ensemble Workflow REST API](https://github.com/intersystems-ru/EnsembleWorkflow) project.
4+
5+
Then, you will need to create and setup 2 CSP-applications.
6+
7+
### REST Application
8+
1. Go to Ensemble Management Portal, Web Applications and create a new one for Namespace where you imported Ensemble Workflow REST API project.
9+
2. Set it’s name as `/wf/api` for instance.
10+
3. Set Allowed Authentication Methods for “Password” only.
11+
4. Set Group By ID for any string you want (remember it)
12+
5. Set dispatch class for `Workflow.REST`
13+
6. Set Session Cookie Path for `/wf` (it depends from name of the app in step 2)
14+
7. Assign roles for application if needed (depends on configuration and security rules of your Ensemble instance)
15+
16+
## Client Application
17+
1. Go to Ensemble Management Portal, Web Applications and create a new one for the same Namespace as REST Application.
18+
2. Set it’s name as `/wf` for instance (it depends on app name in step 2 of REST Application setup. The idea is to set the same Cookie Path for both applications, that they could share same CSP-session. Cookie path depends on app name).
19+
3. Set Allowed Authentication Methods for “Password” only.
20+
4. Set Group By ID to value you used in step 4 of REST Application setup.
21+
5. Set CSP Files Physical Path to folder where you will extract files of the current project (or configure it later)
22+
23+
## Use Release
24+
To use the latest release, go to ‘Releases’ tab of this repository. Download and extract zip to the folder you chosen in step 5 of Client Application Setup.
25+
26+
## Build from source
27+
To build application from source you need to install **Node.js** with **npm** package manager.
28+
Then, use following command inside source directory to install all the dependencies: `npm install`
29+
After that, use `npm run build` to build the application. Result application will be placed in `dist` directory.
30+
31+
## Config
32+
**Important**
33+
34+
Go to `/assets/config/config.json` and set apiServer.appName to the name of you REST Application.

0 commit comments

Comments
 (0)