Skip to content

Commit 817a7ab

Browse files
committed
added index.md files, renamed some files
1 parent 9dad863 commit 817a7ab

File tree

11 files changed

+90
-14
lines changed

11 files changed

+90
-14
lines changed

docs/src/.vuepress/theme.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -879,14 +879,14 @@ export default hopeTheme({
879879
icon: "creative",
880880
prefix: "dsf/",
881881
link: "dsf/",
882-
children: ["versions-placeholders-urls.md", "bpmn-process-execution.md", "bpmn-process-variables.md", "draft-task-resources.md", "environment-variables.md", "requester-and-recipient.md", "message-correlation.md", "message-delegates.md", "organization-identifiers.md", "process-plugin-api.md", "read-access-tag.md", "service-delegates.md", "spring-framework-integration.md", "process-plugin-definition.md"],
882+
children: ["bpmn-process-execution.md", "bpmn-process-variables.md", "draft-task-resources.md", "environment-variables.md", "message-correlation.md", "message-delegates.md", "organization-identifiers.md", "process-plugin-api.md", "process-plugin-definition.md", "read-access-tag.md", "requester-and-recipient.md", "service-delegates.md", "spring-framework-integration.md", "versions-placeholders-urls.md"],
883883
},
884884
{
885885
text: "Guides",
886886
icon: "creative",
887887
prefix: "guides/",
888888
link: "guides/",
889-
children: ["accessing-bpmn-process-variables.md", "accessing-task-resources-during-execution.md", "adding-task-input-parameters-to-task-profiles.md", "configuring-the-read-access-tag.md", "creating-an-activity-definition.md", "creating-codesystems-for-dsf-processes.md", "creating-task-resources-based-on-a-definition.md", "creating-valuesets-for-dsf-processes.md", "managing-mutiple-incoming-messages-and-missing-messages.md", "setting-targets-for-message-events.md", "starting-a-process-via-task-resources.md"]
889+
children: ["accessing-bpmn-process-variables.md", "accessing-task-resources-during-execution.md", "adding-task-input-parameters-to-task-profiles.md", "configuring-read-access-tags.md", "creating-activity-definitions.md", "creating-codesystems-for-dsf-processes.md", "creating-task-resources-based-on-a-definition.md", "creating-valuesets-for-dsf-processes.md", "managing-mutiple-incoming-messages-and-missing-messages.md", "setting-targets-for-message-events.md", "starting-a-process-via-task-resources.md"]
890890
}]
891891
}
892892
],

docs/src/develop/bpmn/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ icon: creative
44
---
55

66
## Introduction
7-
87
The DSF uses BPMN 2.0 to model processes. Specifically, the [Camunda 7](https://docs.camunda.org/manual/7.21/) dialect from the [Camunda Modeler](https://camunda.com/de/download/modeler/). Modeling processes for the DSF requires this modeler or any other modeler which is able to produce the correct Camunda dialect.
98

109
## Details
11-
1210
- [Conditions](conditions.md)
1311
- [Gateways](gateways.md)
1412
- [Messaging](messaging.md)

docs/src/develop/dsf/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: DSF
3+
icon: creative
4+
---
5+
6+
## Details
7+
- [BPMN Process Execution](bpmn-process-execution.md)
8+
- [BPMN Process Variables](bpmn-process-variables.md)
9+
- [Draft Task Resources](draft-task-resources.md)
10+
- [Environment Variables](environment-variables.md)
11+
- [Message Correlation](message-correlation.md)
12+
- [Message Delegates](message-delegates.md)
13+
- [Organization Identifiers](organization-identifiers.md)
14+
- [Process Plugin API](process-plugin-api.md)
15+
- [Process Plugin Definition](process-plugin-definition.md)
16+
- [Read Access Tag](read-access-tag.md)
17+
- [Requester and Recipient](requester-and-recipient.md)
18+
- [Service Delegates](service-delegates.md)
19+
- [Spring Framework Integration](spring-framework-integration.md)
20+
- [Versions, Placeholders and URLs](versions-placeholders-urls.md)

docs/src/develop/dsf/read-access-tag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ You can find all codes for the Read Access Tag in its [CodeSystem](https://githu
1919

2020
The read access rules for [Task](../fhir/task.md) resources are defined through the `requester` and `recipient` elements of the [dsf-extension-process-authorization](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-process-authorization-1.0.0.xml) in your plugin's [ActivityDefinitions](../fhir/activitydefinition.md). Therefore, no `read-access-tag` is needed.
2121

22-
It is also possible to restrict read access of FHIR resources to organizations with a specific role in a parent organization or a specific identifier. If you want to find out more, you may look at the [guide on configuring the Read Access Tag](../guides/configuring-the-read-access-tag.md).
22+
It is also possible to restrict read access of FHIR resources to organizations with a specific role in a parent organization or a specific identifier. If you want to find out more, you may look at the [guide on configuring the Read Access Tag](../guides/configuring-read-access-tags.md).

docs/src/develop/dsf/requester-and-recipient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Requester and Recipient Elements
2+
title: Requester and Recipient
33
icon: creative
44
---
55

docs/src/develop/fhir/activitydefinition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ The `message-name` element contains the name of the [BPMN message start event](.
1818

1919
The `requester` and `recipient` elements define the organisation(s) or person(s) who are allowed to request or receive the message specified by `message-name`. The receiving DSF instance is the one who will execute the process connected to the message.
2020

21-
You will have to create your own [ActivityDefinitions](activitydefinition.md) when developing a process plugin. If you are fluent in reading XML FHIR definitions and translating them into XML resources, you can take a look at the DSF's profile for ActivityDefinitions [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-activity-definition-1.0.0.xml). ActivityDefinitions also reference other resource definitions. Depending on the resource, you will find them in one of [these folders](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir). If you are not as comfortable with these requirements you might want to check out the guide on [creating ActivityDefinitions](../guides/creating-an-activity-definition.md).
21+
You will have to create your own [ActivityDefinitions](activitydefinition.md) when developing a process plugin. If you are fluent in reading XML FHIR definitions and translating them into XML resources, you can take a look at the DSF's profile for ActivityDefinitions [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-activity-definition-1.0.0.xml). ActivityDefinitions also reference other resource definitions. Depending on the resource, you will find them in one of [these folders](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir). If you are not as comfortable with these requirements you might want to check out the guide on [creating ActivityDefinitions](../guides/creating-activity-definitions.md).
2222

2323
You can also find examples for all possible `requester` and `recipient` elements [here](../dsf/requester-and-recipient.md).

docs/src/develop/fhir/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ icon: creative
44
---
55

66
## Introduction
7-
87
The DSF uses a variety of [FHIR resources](https://dsf.dev/intro/info/basics.html#why-are-we-using-fhir-and-bpmn). The DSF uses XML as the format for FHIR resources. The most important resources for plugin development are [ActivityDefinitions](activitydefinition.md), [CodeSystems](codesystem.md), [Tasks](task.md) and [ValueSets](valueset.md). There is also a catalog of DSF-specific FHIR resources including CodeSystems, ValueSets and Extensions. For now, you can find them in the official DSF GitHub repository [here](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir).
98

109
## Details
11-
1210
- [ActivityDefinition](activitydefinition.md)
1311
- [CodeSystem](codesystem.md)
1412
- [Task](task.md)

docs/src/develop/guides/configuring-the-read-access-tag.md renamed to docs/src/develop/guides/configuring-read-access-tags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Configuring the Read Access Tag
2+
title: Configuring Read Access Tags
33
icon: creative
44
---
55

6-
### Configuring the Read Access Tag
6+
### Configuring Read Access Tags
77

88
To start off, you want to take a look at the [CodeSystem](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-read-access-tag-1.0.0.xml) defined for the [Read Access Tag](../dsf/read-access-tag.md) and choose one of the codes from it:
99
```xml

docs/src/develop/guides/creating-an-activity-definition.md renamed to docs/src/develop/guides/creating-activity-definitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Creating an ActivityDefinition
2+
title: Creating ActivityDefinitions
33
icon: creative
44
---
55

6-
### Creating an ActivityDefinition
6+
### Creating ActivityDefinitions
77

88
This guide will teach you how to create an ActivityDefinition based on the [dsf-activity-definition](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-activity-definition-1.0.0.xml) profile for your process plugin.
99
It is divided into steps for each of the main components of ActivityDefinitions:

docs/src/develop/guides/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Guides
3+
icon: creative
4+
---
5+
6+
## Details
7+
- [Accessing BPMN Process Variables](accessing-bpmn-process-variables.md)
8+
- [Accessing Task Resources During Execution](accessing-task-resources-during-execution.md)
9+
- [Adding Task Input Parameters to Task Profiles](adding-task-input-parameters-to-task-profiles.md)
10+
- [Configuring Read Access Tags](configuring-read-access-tags.md)
11+
- [Creating ActivityDefinitions](creating-activity-definitions.md)
12+
- [Creating CodeSystems for DSF Processes](creating-codesystems-for-dsf-processes.md)
13+
- [Creating Task Resources Based on a Definition](creating-task-resources-based-on-a-definition.md)
14+
- [Creating ValueSets for DSF Processes](creating-valuesets-for-dsf-processes.md)
15+
- [Managing Multiple Incoming Messages and Missing Messages](managing-mutiple-incoming-messages-and-missing-messages.md)
16+
- [Setting Targets for Message Events](setting-targets-for-message-events.md)
17+
- [Starting a Process via Task Resources](starting-a-process-via-task-resources.md)

0 commit comments

Comments
 (0)