Skip to content

Commit e0e464b

Browse files
committed
Fixed index and readme being in one directory. This time deleting index, because its contents are already present in "concept.md". Also, some more minor fixes to things like broken links
1 parent a216aaf commit e0e464b

File tree

10 files changed

+32
-98
lines changed

10 files changed

+32
-98
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: API v1
3+
icon: code
4+
---
5+
## Overview
6+
- [About API1](description)
7+
- [Implementation Guide](implementation)

docs/src/process-development/api-v1/concept.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ This site is work in progress, please come back later.
3636
- [Requester and Recipient](dsf/requester-and-recipient.md)
3737
- [Service Delegates](dsf/service-delegates.md)
3838
- [Spring Framework Integration](dsf/spring-framework-integration.md)
39+
- [Target and Targets](dsf/target-and-targets.md)
3940
- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md)
4041

4142
## Guides

docs/src/process-development/api-v1/dsf/service-delegates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: creative
77

88
Service Delegates are the Java representation of the [Service Tasks](../bpmn/service-tasks.md) in a BPMN model. Service Delegates are linked to a certain [Service Task](../bpmn/service-tasks.md) by selecting the [Service Task](../bpmn/service-tasks.md) in the [Camunda Modeler](https://camunda.com/download/modeler/) and adding a Java class to the `Implementation` field. This uses the fully qualified class name:
99
```
10-
org.package.myClass
10+
org.package.MyClass
1111
```
1212
Java classes need to extend `AbstractServiceDelegate` and override the `doExecute` method. This method holds the actual business logic. The method will be called when the [BPMN process execution](../dsf/bpmn-process-execution.md) arrives at the [Service Task](../bpmn/service-tasks.md) a Service Delegate is linked to. The constructor of delegate classes also has to forward a `ProcessPluginApi` instance to its superclass constructor. An instance of the API can be [autowired](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config/autowired.html) in the plugin's Spring configuration class when registering the delegate as a [Spring Bean](https://docs.spring.io/spring-framework/reference/core/beans/introduction.html).
1313

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Target and Targets
3+
icon: creative
4+
---
5+
6+
## Target
7+
8+
A target is a container for all information necessary to send messages to other DSF instances. This information includes:
9+
- **Organization Identifier:** Identifier of an [Organization Resource](https://www.hl7.org/fhir/R4/organization.html). Can be acquired through the API's `OrganizationProvider` or by querying a FHIR server (usually the DSF FHIR server) using a `FhirWebserviceClient` provided by the API's `FhirWebserviceProvider`.
10+
- **Endpoint Identifier:** Identifier of an [Endpoint Resource](https://www.hl7.org/fhir/R4/endpoint.html) with the `managingOrganization` being the same organization as the one from the `Organization Identifier` above. Can be acquired through the API's `EndpointProvider` or by querying a FHIR server (usually the DSF FHIR server) using a `FhirWebserviceClient` provided by the API's `FhirWebserviceProvider`.
11+
- **Endpoint URL:** The URL of the endpoint. The [Endpoint Resource](https://www.hl7.org/fhir/R4/endpoint.html) provides this value through its `address` field.
12+
- **Correlation Key:** A value used to correlate messages, that are sent to this target, to their correct process instances. More information on this mechanism can be found in [Message Correlation](message-correlation.md).
13+
14+
## Targets
15+
16+
Targets is a container class for a collection of [Target](#target) objects. It also provides utility methods for manipulating the underlying collection.
17+
18+
## Related Topics
19+
[Message Correlation](message-correlation.md), [Setting Targets for Message Events](../guides/setting-targets-for-message-events.md)

docs/src/process-development/api-v1/guides/user-tasks-in-the-dsf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: creative
77

88
Creating a [User Task](../bpmn/user-tasks.md) in a BPMN model causes the DSF to automatically generate a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resource based on the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) specified in the [User Task's](../bpmn/user-tasks.md) `Forms` field when process execution reaches the [User Task](../bpmn/user-tasks.md). The `Forms` field must have the type `Embedded or External Task Forms`, with the `Form key` set to the URL of the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource must be placed in the `src/main/resources/fhir/Questionnaire` directory.
99

10-
The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can be accessed and answered by navigating to `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress` in the DSF FHIR server UI. After completing and submitting the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html), the process execution will proceed to the next BPMN element following the [User Task](../bpmn/user-tasks.md). The updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will then be accessible via the [Process Plugin Api's](../dsf/process-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
10+
The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can be accessed and answered by navigating to `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress` in the DSF FHIR server UI. After completing and submitting the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html), the process execution will proceed to the next BPMN element following the [User Task](../bpmn/user-tasks.md). The updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will then be accessible via the [Process Plugin Api's](../dsf/process-plugin-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
1111

1212
It is also possible to register a [Task Listener](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener) on the [User Task](../bpmn/user-tasks.md). This enables manipulation of the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) before it is posted to the DSF FHIR server. This can be achieved by extending the `DefaultUserTaskListener` class, which provides overrides for interacting with the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html).
1313

docs/src/process-development/api-v1/index.md

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

docs/src/process-development/api-v2/concept.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ This site is work in progress, please come back later.
3737
- [Requester and Recipient](dsf/requester-and-recipient.md)
3838
- [Service Delegates](dsf/service-delegates.md)
3939
- [Spring Framework Integration](dsf/spring-framework-integration.md)
40+
- [Target and Targets](dsf/target-and-targets.md)
4041
- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md)
4142

4243
## Guides

docs/src/process-development/api-v2/dsf/service-delegates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: creative
77

88
Service Delegates are the Java representation of the [Service Tasks](../bpmn/service-tasks.md) in a BPMN model. Service Delegates are linked to a certain [Service Task](../bpmn/service-tasks.md) by selecting the [Service Task](../bpmn/service-tasks.md) in the [Camunda Modeler](https://camunda.com/download/modeler/) and adding a Java class to the `Implementation` field. This uses the fully qualified class name:
99
```
10-
org.package.myClass
10+
org.package.MyClass
1111
```
1212
Java classes need to implement the `ServiceTask` interface and override the `execute` method. This method holds the actual business logic. The method will be called when the [BPMN process execution](../dsf/bpmn-process-execution.md) arrives at the [Service Task](../bpmn/service-tasks.md) a Service Delegate is linked to.
1313

docs/src/process-development/api-v2/guides/user-tasks-in-the-dsf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: creative
77

88
Creating a [User Task](../bpmn/user-tasks.md) in a BPMN model causes the DSF to automatically generate a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resource based on the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) specified in the [User Task's](../bpmn/user-tasks.md) `Forms` field when process execution reaches the [User Task](../bpmn/user-tasks.md). The `Forms` field must have the type `Embedded or External Task Forms`, with the `Form key` set to the URL of the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource must be placed in the `src/main/resources/fhir/Questionnaire` directory.
99

10-
The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can be accessed and answered by navigating to `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress` in the DSF FHIR server UI. After completing and submitting the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html), the process execution will proceed to the next BPMN element following the [User Task](../bpmn/user-tasks.md). The updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will then be accessible via the [Process Plugin Api's](../dsf/process-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
10+
The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can be accessed and answered by navigating to `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress` in the DSF FHIR server UI. After completing and submitting the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html), the process execution will proceed to the next BPMN element following the [User Task](../bpmn/user-tasks.md). The updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will then be accessible via the [Process Plugin Api's](../dsf/process-plugin-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
1111

1212
It is also possible to register a [Task Listener](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener) on the [User Task](../bpmn/user-tasks.md). This enables manipulation of the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) before it is posted to the DSF FHIR server. This can be achieved by extending the `DefaultUserTaskListener` class, which provides overrides for interacting with the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html).
1313

docs/src/process-development/api-v2/index.md

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

0 commit comments

Comments
 (0)