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
{{ message }}
This repository was archived by the owner on Nov 9, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: documentation/INSTALL.md
+28-8Lines changed: 28 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,27 @@
1
-
### Roxy Installation
1
+
##Installation methods
2
2
3
-
To install via roxy, within the roxy directory, edit the properties file for the target environment - for example, ``deploy/local.properties`` and run the following commands:
3
+
There are two main ways to install the marklogicworkflow project:
4
+
5
+
* Roxy Installation (stand-alone project, or starting point for a new project)
6
+
* Add modules to existing project
7
+
8
+
## Roxy Installation
9
+
10
+
To install via roxy, edit the properties file for the target environment - for example, ``deploy/local.properties`` and run the following commands:
4
11
5
12
./ml local bootstrap
6
13
./ml local deploy modules
7
14
./ml local deploy cpf
8
15
9
-
Note that if left as is, the [Roxy test harness](https://github.com/marklogic-community/roxy/wiki/Unit-Testing) will also be set up at http://localhost:8042/test/
16
+
For more deployment details see the [Roxy project ](https://github.com/marklogic-community/roxy)
10
17
11
-
### Configure MIME types
18
+
Note that if left as is, the [Roxy test harness](https://github.com/marklogic-community/roxy/wiki/Unit-Testing) will also be set up at http://localhost:8042/test/
12
19
13
-
Default filenames for SCXML and BPMN2 models are .scxml and .bpmn respectively. These aren't recognised by MarkLogic
14
-
by default. Add these types are application/xml mime types in MarkLogic Server for them to be handled correctly. *This will be performed automatically via roxy bootstrap.*
20
+
## Adding to an existing project
15
21
16
22
### Configuring a database for MarkLogic Workflow
17
23
18
-
You can install a MarkLogic Workflow modules database from the modules folder within this repository. Once done,
24
+
You can install a MarkLogic Workflow modules database from the src/workflowengine folder within this repository. Once done,
19
25
your application's app server can be configured to either use this modules database, or more likely, use a modules
20
26
database whose modules database points to this database (modules database chaining).
21
27
@@ -29,7 +35,21 @@ You need to ensure your content database has a Triggers database configured, and
29
35
30
36
*Installation including triggers and REST extensions will be performed automatically via the Roxy commands above.*
31
37
32
-
## Configure global process task settings
38
+
### Configure MIME types
39
+
40
+
Default filenames for SCXML and BPMN2 models are .scxml and .bpmn respectively. These aren't recognised by MarkLogic
41
+
by default. Add these types are application/xml mime types in MarkLogic Server for them to be handled correctly. *This will be performed automatically via Roxy bootstrap.*
42
+
43
+
### Configure Indexes
44
+
45
+
The project requires two range element attribute indexes:
46
+
47
+
* wf:process/@id
48
+
* wf:process/@attachment
49
+
50
+
See deploy/ml-config.xml for full details. *These will be generated automatically via a Roxy bootstrap.*
51
+
52
+
### Configure global process task settings
33
53
34
54
Some tasks require global configuration. An example of this is the email task which requires SMTP settings.
0 commit comments