docu (Issue #947)

Author: rsoika

src/site/markdown/engine/index.md

@@ -1,32 +1,33 @@
 # The Imixs-Workflow Engine
 
-The Imixs-Workflow engine consists of different service components. Each component maps a specific functionality into your workflow application: 
+The Imixs-Workflow engine consists of different service components. Each component maps a specific functionality into your workflow application:
 
- * The [WorkflowService](./workflowservice.html) → the core component to create and update a process instance
- * The [ModelService](./modelservice.html) → the management component for BPMN models. 
- * The [DocumentService](./documentservice.html) → the data access layer to store workflow related data
- * The [ReportService](./reportservice.html) → a service component to create data reports
+- The [WorkflowService](./workflowservice.html) → the core component to create and update a process instance
+- The [ModelService](./modelservice.html) → the management component for BPMN models.
+- The [DocumentService](./documentservice.html) → the data access layer to store workflow related data
+- The [ReportService](./reportservice.html) → a service component to create data reports
 
-All services can either be injected into a Java Enterprise application or can be accessed through its [RESTfull service API](../restapi/index.html). 
+All services can either be injected into a Java Enterprise application or can be accessed through its [RESTfull service API](../restapi/index.html).
 
-Further more, all services are subject to the [Imixs-Workflow Security Model](./acl.html). In this way only an authenticated access to these service components is allowed. This concept ensures the protection of your business data. 
+Further more, all services are subject to the [Imixs-Workflow Security Model](./acl.html). In this way only an authenticated access to these service components is allowed. This concept ensures the protection of your business data.
 
- 
 ### The WorkflowService
-The `WorkflowService` is the core service to create, update and read a process instance. To create a process instance a workitem is assigned to a BPMN 2.0  model definition managed by the `ModelService`. 
+
+The `WorkflowService` is the core service to create, update and read a process instance. To create a process instance a workitem is assigned to a BPMN 2.0 model definition managed by the `ModelService`.
 
 ```java
 @Inject
 WorkflowService workflowService;
 ItemCollection workitem=new ItemCollection().model("1.0.0").task(100).event(10);
 workitem=workflowService.processWorkItem(workitem);
 ```
- 
+
 Read more about in the section [Imixs WorkflowService](../engine/workflowservice.html).
- 
+
 ### The DocumentService
-The `DocumentService` is the general persistence layer of the Imixs-Workflow engine and provides an interface to store, load and query data objects (`Documents`) within a database. 
-The `DocumentService` is independent from the workflow engine and can not only be used to persist a process instance (`workitem`), but also any other kind of business data, not necessarily associated with the workflow engine (e.g configuration data). 
+
+The `DocumentService` is the general persistence layer of the Imixs-Workflow engine and provides an interface to store, load and query data objects (`Documents`) within a database.
+The `DocumentService` is independent from the workflow engine and can not only be used to persist a process instance (`workitem`), but also any other kind of business data, not necessarily associated with the workflow engine (e.g configuration data).
 
 ```java
 @Inject
@@ -35,7 +36,7 @@ ItemCollection myDocument=new ItemCollection;
 myDocument.setItemValue("type","product");
 myDocument.setItemValue("name","coffee");
 myDocument=documentService.save(myDocument);
-```	  
+```
 
 The `DocumentService` provides also a [Full-Text-Search](./luceneservice.html). In this way documents can be accessed through a search query:
 
@@ -44,17 +45,18 @@ List<ItemCollection> result=documentService.find("(type:'workitem')(imixs*)");
 ```
 
 Read more about in the section [DocumentService](../engine/documentservice.html).
- 
+
 ### The ModelService
-The _ModelService_ provides methods to manage BPMN model definitions. A model can be created with the Eclipse based modeling tool [Imixs-BPMN](../modelling/index.html). 
+
+The _ModelService_ provides methods to manage BPMN model definitions. A model can be created with the Eclipse based modeling tool [Imixs-BPMN](../modelling/index.html).
 
 ```java
 @Inject
 ModelService modelService;
 InputStream inputStream = new FileInputStream(new File("ticket.bpmn"));
 ticketModel = BPMNParser.parseModel(inputStream, "UTF-8");
 modelService.addModel(model);
-```	
+```
 
 The `ModelService` is used internally by the `WorkflowService` but can also be used by your application to navigate through a model definition.
 
@@ -66,8 +68,7 @@ List<ItemCollection> tasks = modelService.findAllTasks();
 ```
 
 Read more about in the section [ModelService](../engine/modelservice.html).
- 
-### The ReportService
 
-The `ReportService` component supports methods to create, find and execute business reports created with the Eclipse based [Imixs-Workflow Modeler](../modelling/index.html). A report is used to generate aggregated information from data objects managed by the `DocumentService`.  
+### The ReportService
 
+The `ReportService` component supports methods to create, find and execute business reports created with the Eclipse based [Imixs-Workflow Modeler](../modelling/index.html). A report is used to generate aggregated information from data objects managed by the `DocumentService`.

src/site/markdown/restapi/index.md

@@ -16,6 +16,7 @@ The different resources provided by Imixs-Workflow are divided in the following
 | [/documents/](./documentservice.html) | This resource provides methods to query documents managed by the DocumentService EJB                          |
 | [/adminp/](./adminp.html)             | This resource provides methods to create and monitor adminP jobs managed by the AdminPService EJB             |
 | [/eventlog/](./eventlogservice.html)  | This resource provides methods to fetch event log entries                                                     |
+| [/scheduler/](./scheduler.html)       | This resource provides methods to control an [Imixs Scheduler service](../engine/scheduling.html).            |
 
 <strong>Note:</strong> The root context of the REST Service is defined by the web application (web.xml) containing the REST Service. The default root context is "/api/".
 

src/site/markdown/restapi/scheduler.md

@@ -0,0 +1,58 @@
+# The Workflow Scheduler Service
+
+The resource _/scheduler_ provides methods to control the [Imixs Workflow Scheduler](../engine/scheduler.html) service.
+The workflow Scheduler can be monitored with the [Imixs-Admin Client](../administration.html).
+
+<img src="../images/imixs-admin-client-06.png" class="screenshot" />  
+ 
+## GET Jobs
+The GET method is used to read all running ore completed jobs:
+
+| URI               | Method | Description                                                                        |
+| ----------------- | ------ | ---------------------------------------------------------------------------------- |
+| /scheduler/{name} | GET    | returns the scheduler configurration by name (e.g. `org.imixs.workflow.scheduler`) |
+
+A scheduler configuration is defined by the following item definitions:
+
+```xml
+<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+    <item name="type">
+        <value xsi:type="xs:string">scheduler</value>
+    </item>
+    <item name="name">
+        <value xsi:type="xs:string">org.imixs.workflow.scheduler</value>
+    </item>
+    <item name="_scheduler_class">
+        <value xsi:type="xs:string">org.imixs.workflow.engine.WorkflowScheduler</value>
+    </item>
+    <item name="_scheduler_definition">
+        <value xsi:type="xs:string">hour=*</value>
+        <value xsi:type="xs:string">minute=30</value>
+    </item>
+    <item name="_scheduler_enabled">
+        <value xsi:type="xs:boolean">true</value>
+    </item>
+</document>
+```
+
+## POST a new Configuration
+
+The methods POST allow to update/create a scheduler configuration. Depending on the flag `_scheduler_enabled` the scheduler will be started or stopped :
+
+| URI         | Method | Description                                                              |
+| ----------- | ------ | ------------------------------------------------------------------------ |
+| /scheduler/ | POST   | posts a scheduler configuration. The post data is expected in xml format |
+
+The following curl example shows how to update a scheduler configuration:
+
+    curl --user admin:adminpassword -H "Content-Type: text/xml" -d \
+      '<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/	XMLSchema"> \
+       <item name="type"><value xsi:type="xs:string">scheduler</value></item> \
+       <item name="name"><value xsi:type="xs:string">org.imixs.workflow.scheduler</value></item> \
+       <item name="_scheduler_class"><value xsi:type="xs:string">org.imixs.workflow.engine.WorkflowScheduler</value></item> \
+       <item name="_scheduler_definition"><value xsi:type="xs:string">hour=*</value></item> \
+       <item name="_scheduler_enabled"><value xsi:type="xs:boolean">true</value></item> \
+    </document>' \
+    http://localhost:8080/api/adminp/jobs
+
+In case the scheduler definition is not valid the attribute '$error_code' will be returned in the response.

src/site/resources/images/imixs-admin-client-06.png

@@ -118,6 +118,7 @@
 				<item name="RestClient" href="./restapi/restclient.html" />
 				<item name="EventLog Service" href="./restapi/eventlogservice.html" />
 				<item name="AdminP Service" href="./restapi/adminp.html" />
+				<item name="Scheduler Service" href="./restapi/scheduler.html" />
 			</item>
 
 			<item name="Web Forms" href="./webforms/index.html" collapse="true">