Skip to content

Commit 4c90faa

Browse files
Thierry Habarthabarthierry-hue
Thierry Habart
authored and
habarthierry-hue
committed
Ticket 25 : Display a case plan instance
1 parent 62162ce commit 4c90faa

File tree

275 files changed

+6101
-4222
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

275 files changed

+6101
-4222
lines changed

‎Architecture.pptx‎

-7.47 KB
Binary file not shown.

‎README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,24 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
3333

3434
## Live demo
3535

36-
CaseManagement live demo : [http://simpleidserver.northeurope.cloudapp.azure.com/](http://simpleidserver.northeurope.cloudapp.azure.com/).
36+
### Performance website
37+
38+
Performance live demo : (?).
39+
40+
Use the following administrator account to authenticate to the performance website.
41+
42+
| Property | Value |
43+
|---------------|-----------------|
44+
| login | administrator |
45+
| value | password |
46+
47+
### Case management website
48+
49+
CaseManagement live demo : [http://simpleidserver.northeurope.cloudapp.azure.com/](http://simpleidserver.northeurope.cloudapp.azure.com/).
50+
51+
Use the following businessanalyst account to authenticate to the case management website.
52+
53+
| Property | Value |
54+
|---------------|-----------------|
55+
| login | businessanalyst |
56+
| value | password |

‎docs/casemanagement-usermanual/launchcaseinstance.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Launch Case Plan instance
2+
=========================

‎docs/casemanagement-usermanual/publishcaseplan.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Publish case plan
2+
=================

‎docs/index.rst‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,23 @@ Nuget feed: https://www.myget.org/F/advance-ict/api/v3/index.json
2424
:hidden:
2525
:caption: Getting started
2626

27+
intro/glossary
2728
intro/architecture
28-
intro/getting-started-with-casemanagement-engine
29-
intro/getting-started-with-casemanagement-api
29+
intro/getting-started
30+
31+
32+
.. toctree::
33+
:maxdepth: 3
34+
:hidden:
35+
:caption: Case Management User Guide
36+
37+
casemanagement-usermanual/publishcaseplan
38+
casemanagement-usermanual/launchcaseinstance
39+
40+
.. toctree::
41+
:maxdepth: 3
42+
:hidden:
43+
:caption: Performance User Guide
44+
45+
performance-usermanual/monitorperformance
46+
performance-usermanual/monitorstatistics

‎docs/intro/architecture.rst‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,25 @@ Architecture overview
44
.. image:: images/architecture-1.png
55
:align: center
66

7-
* Admin Website : the website is developed with angular. It offers some facilities to the end users like :
7+
* **CaseManagement (CM) Website** : the website is developed with angular. It is used by **case workers** or **business analysts** to manage the lifecycle of cases for example : manually activate a task or edit the definition of case plans.
88

9-
* Audit screens : audit performance, view statistics like the number of cases closed since one month.
10-
* Case management : manage the lifecycle of case instances for example : start, suspend or terminate a case instance.
11-
12-
* CaseManagement API : REST.API service which exposes operations to interact with the engine.
9+
* **Admin website** : this website is developed with angular. It is used by administrators to monitor the performance or view the logs.
1310

14-
* CaseManagement Engine : Execute a case instance.
11+
* **Authorization server** : OAUTH2.0 server used by the solution to limit the access to certain API operations based on the **scopes** present in the access token, for example : the Gateway API client can get all the case plans from the CaseManagement API because it has access to the scope **get_caseplan**.
12+
13+
* **Identity server** : OPENID server used by the solution to authenticate the end-user and limit the access to certain API operations based on the claims of the end user, for example : only a user with the role **businessanalyst** can update a case plan.
14+
15+
* **CaseManagement (CM) API** : REST.API service which exposes operations to interact with the engine for example : update the case plan or launch a case plan instance.
16+
17+
* **CaseManagement Engine** : Execute a case plan instance.
18+
19+
Domain model
20+
------------
21+
22+
The DDD aggregate pattern has been used to identify the different domain models present in the CaseManagement API.
23+
24+
.. image:: images/architecture-2.png
25+
:align: center
1526

1627

1728
Clustering model

‎docs/intro/getting-started-with-casemanagement-api.rst‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎docs/intro/getting-started-with-casemanagement-engine.rst‎

Lines changed: 0 additions & 66 deletions
This file was deleted.

‎docs/intro/getting-started.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
How to launch the solution ?
2+
============================
3+
4+
To launch the entire solution follow the steps below :
5+
6+
1. Fetch the sources from Github_.
7+
2. Open a command prompt and navigate to the directory.
8+
3. Launch the following command::
9+
10+
launch.cmd
11+
12+
One console application is launched for each project.
13+
14+
The administration website is available at this URL (http://localhost:8080). Only users with **administrator** role can access to the website.
15+
By default there is one administrator account configured :
16+
17+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
18+
| Property | Value |
19+
+====================+========================================================================================================================================================================+
20+
| Login | administrator |
21+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
22+
| Password | password |
23+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
24+
25+
The case managment website is available at this URL (http://localhost:8081). Only users with **businessanalyst** role can access to the website.
26+
By default there is one businessanalyst account configured :
27+
28+
29+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
30+
| Property | Value |
31+
+====================+========================================================================================================================================================================+
32+
| Login | businessanalyst |
33+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
34+
| Password | password |
35+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
36+
37+
.. _Github: https://github.com/simpleidserver/CaseManagement

‎docs/intro/glossary.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Glossary
2+
========
3+
4+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5+
| Term | Definition |
6+
+====================+========================================================================================================================================================================+
7+
| Case plan | Involves actions taken regarding a subject in a particular situation to achieve a desired outcome |
8+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9+
| Case plan instance | Instance of a case plan launched by a user or by an external event |
10+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
11+
| Milestone | Represents an achievable target |
12+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
13+
| Task | Atomic unit of work. An action is deciding what must be done, a task is what must be done |
14+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
15+
| SEntries | A SEntry is a combination of an event and / or condition. When the event is received, a condition might be applied to evaluated whether the event has effect or not. |
16+
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)