A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Gives access to services available to process plugins. This api and all services excepted Variables can be
- injected using Autowired into spring Configuration classes.
Gives access to services available to process plugins. This api and all services excepted Variables can be
+ injected using Autowired into spring Configuration classes.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/". For more details on the
- content of the provider configuration file, see ServiceLoader.
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process.
Return List.of("foo.bpmn"); for a foo.bpmn file located in the root folder of the process plugin
- jar. The returned files will be read via ClassLoader.getResourceAsStream(String).
-
- Occurrences of#{version}will be replaced with the value of
- getResourceVersion()
- Occurrences of#{date}will be replaced with the value of
- getResourceReleaseDate()
- Occurrences of#{organization}will be replaced with the local organization DSF identifier
- value, or"null"if no local organization can be found in the allow list
- Other placeholders of the form#{property.name}will be replaced with values from equivalent
- environment variable, e.g.PROPERTY_NAME
-
-
Returns:
-
*.bpmn files inside the process plugin jar, paths relative to root folder of process plugin
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process. The returned files will be read via
- ClassLoader.getResourceAsStream(String).
-
- Supported metadata resource types are ActivityDefinition, CodeSystem, Library, Measure, NamingSystem,
- Questionnaire, StructureDefinition, Task and ValueSet.
-
- Occurrences of#{version}will be replaced with the value of
- getResourceVersion()
- Occurrences of#{date}will be replaced with the value of
- getResourceReleaseDate()
- Occurrences of#{organization}will be replaced with the local organization DSF identifier
- value, or"null"if no local organization can be found in the allow list
- Other placeholders of the form#{property.name}will be replaced with values from equivalent
- environment variable, e.g.PROPERTY_NAME
-
-
Returns:
-
*.xml or *.json files inside the process plugin jar per process, paths relative to root folder of process
- plugin
- All implementations used for BPMN service tasks, message send tasks and throw events as well as task- and user
- task listeners need to be declared as spring Beans with Scope"prototype".
- Other classes not directly used within BPMN activities should be declared with the default singleton scope.
-
- Configuration classes that defined private fields annotated with Value defining property placeholders,
- can be configured via environment variables. A fieldprivate boolean specialFunction;
- annotated with@Value("${org.test.process.special:false}")can be configured with the
- environment variableORG_TEST_PROCESS_SPECIAL. To take advantage of the
- "dsf-tools-documentation-generator" maven plugin to generate a markdown file with configuration options for the
- plugin also add the ProcessDocumentation annotation.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/". For more details on the
+ content of the provider configuration file, see ServiceLoader.
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process.
Return List.of("foo.bpmn"); for a foo.bpmn file located in the root folder of the process plugin
+ jar. The returned files will be read via ClassLoader.getResourceAsStream(String).
+
+ Occurrences of#{version}will be replaced with the value of
+ getResourceVersion()
+ Occurrences of#{date}will be replaced with the value of
+ getResourceReleaseDate()
+ Occurrences of#{organization}will be replaced with the local organization DSF identifier
+ value, or"null"if no local organization can be found in the allow list
+ Other placeholders of the form#{property.name}will be replaced with values from equivalent
+ environment variable, e.g.PROPERTY_NAME
+
+
Returns:
+
*.bpmn files inside the process plugin jar, paths relative to root folder of process plugin
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process. The returned files will be read via
+ ClassLoader.getResourceAsStream(String).
+
+ Supported metadata resource types are ActivityDefinition, CodeSystem, Library, Measure, NamingSystem,
+ Questionnaire, StructureDefinition, Task and ValueSet.
+
+ Occurrences of#{version}will be replaced with the value of
+ getResourceVersion()
+ Occurrences of#{date}will be replaced with the value of
+ getResourceReleaseDate()
+ Occurrences of#{organization}will be replaced with the local organization DSF identifier
+ value, or"null"if no local organization can be found in the allow list
+ Other placeholders of the form#{property.name}will be replaced with values from equivalent
+ environment variable, e.g.PROPERTY_NAME
+
+
Returns:
+
*.xml or *.json files inside the process plugin jar per process, paths relative to root folder of process
+ plugin
+ All implementations used for BPMN service tasks, message send tasks and throw events as well as task- and user
+ task listeners need to be declared as spring Beans with Scope"prototype".
+ Other classes not directly used within BPMN activities should be declared with the default singleton scope.
+
+ Configuration classes that defined private fields annotated with Value defining property placeholders,
+ can be configured via environment variables. A fieldprivate boolean specialFunction;
+ annotated with@Value("${org.test.process.special:false}")can be configured with the
+ environment variableORG_TEST_PROCESS_SPECIAL. To take advantage of the
+ "dsf-tools-documentation-generator" maven plugin to generate a markdown file with configuration options for the
+ plugin also add the ProcessDocumentation annotation.
public interface ProcessPluginDeploymentStateListener
-
Listener called after process plugin deployment with a list of deployed process-ids from this plugin. List contains
- all processes deployed in the bpe depending on the exclusion and retired config.
-
- Register a singleton Bean implementing this interface to execute custom code like connection tests if a
- process has been deployed.
public interface ProcessPluginDeploymentStateListener
+
Listener called after process plugin deployment with a list of deployed process-ids from this plugin. List contains
+ all processes deployed in the bpe depending on the exclusion and retired config.
+
+ Register a singleton Bean implementing this interface to execute custom code like connection tests if a
+ process has been deployed.
public abstract class AbstractServiceDelegate
-extends Object
-implements org.camunda.bpm.engine.delegate.JavaDelegate, org.springframework.beans.factory.InitializingBean
-
Abstract implementation of the JavaDelegate interface with added error handling and convenient access to
- process execution variables with the variables parameter of the
- doExecute(DelegateExecution, Variables) method.
-
- Configure BPMN service tasks with an implementation of type 'Java class' with the fully qualified class name of the
- class extending this abstract implementation.
-
- Configure your service task implementation as a Bean in your spring Configuration class with scope
- "prototype".
Implement this method to execute custom business logic within BPMN service tasks.
-
-
Parameters:
-
execution - Process instance information and variables
-
variables - DSF process variables
-
Throws:
-
org.camunda.bpm.engine.delegate.BpmnError - Thrown when an error boundary event should be called
-
Exception - Uncaught exceptions thrown by this method will result in Task status failed for all current
- in-progress Task resource with the exception message added as an error output. An exception
- (not BpmnError) thrown by this method will also result in the process instance stopping
- execution and being deleted.
public abstract class AbstractServiceDelegate
+extends Object
+implements org.camunda.bpm.engine.delegate.JavaDelegate, org.springframework.beans.factory.InitializingBean
+
Abstract implementation of the JavaDelegate interface with added error handling and convenient access to
+ process execution variables with the variables parameter of the
+ doExecute(DelegateExecution, Variables) method.
+
+ Configure BPMN service tasks with an implementation of type 'Java class' with the fully qualified class name of the
+ class extending this abstract implementation.
+
+ Configure your service task implementation as a Bean in your spring Configuration class with scope
+ "prototype".
Implement this method to execute custom business logic within BPMN service tasks.
+
+
Parameters:
+
execution - Process instance information and variables
+
variables - DSF process variables
+
Throws:
+
org.camunda.bpm.engine.delegate.BpmnError - Thrown when an error boundary event should be called
+
Exception - Uncaught exceptions thrown by this method will result in Task status failed for all current
+ in-progress Task resource with the exception message added as an error output. An exception
+ (not BpmnError) thrown by this method will also result in the process instance stopping
+ execution and being deleted.
public abstract class AbstractTaskMessageSend
-extends Object
-implements org.camunda.bpm.engine.delegate.JavaDelegate, org.springframework.beans.factory.InitializingBean
-
Base class for implementing BPMN message send tasks, intermediate message throw events and message end events using
- FHIR Task resources. Requires three String fields to be injected via BPMN:
-
-
instantiatesCanonical with the URL (including version) of the Activity to start or continue.
-
messageName with the with the BPMN message-name of the start event, intermediate message catch event or
- message receive task.
-
profile with the URL (including version) of the profile (StructureDefinition) that the Task resource used
- should conform to.
-
-
- Configure BPMN message send tasks, intermediate message throw events and message end event with an implementation of
- type 'Java class' with the fully qualified class name of the class extending this abstract implementation.
-
- Configure your service task implementation as a Bean in your spring Configuration class with scope
- "prototype".
Retrieves the instantiatesCanonical value used for Task resources send by this class via the injected field
- instantiatesCanonical.
-
- Override this method to use a different mechanism for retrieving the value for instantiatesCanonical. For
- example via a process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file
- in order to comply with the validation performed during plugin loading.
-
-
Parameters:
-
execution - not null
-
variables - not null
-
Returns:
-
instantiatesCanonical value used for Task resources send by this class
Retrieves the messageName value used for Task resources send by this class via the injected field
- messageName.
-
- Override this method to use a different mechanism for retrieving the value for messageName. For example via a
- process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file in order to
- comply with the validation performed during plugin loading.
-
-
Parameters:
-
execution - not null
-
variables - not null
-
Returns:
-
messageName value used for Task resources send by this class
Retrieves the profile value used for Task resources send by this class via the injected field profile.
-
- Override this method to use a different mechanism for retrieving the value for profile. For example via a
- process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file in order to
- comply with the validation performed during plugin loading.
-
-
Parameters:
-
execution - not null
-
variables - not null
-
Returns:
-
profile value used for Task resources send by this class
-
-
-
-
-
-
execute
-
public finalvoidexecute(org.camunda.bpm.engine.delegate.DelegateExecution execution)
- throws Exception
-
-
Specified by:
-
execute in interface org.camunda.bpm.engine.delegate.JavaDelegate
public abstract class AbstractTaskMessageSend
+extends Object
+implements org.camunda.bpm.engine.delegate.JavaDelegate, org.springframework.beans.factory.InitializingBean
+
Base class for implementing BPMN message send tasks, intermediate message throw events and message end events using
+ FHIR Task resources. Requires three String fields to be injected via BPMN:
+
+
instantiatesCanonical with the URL (including version) of the Activity to start or continue.
+
messageName with the with the BPMN message-name of the start event, intermediate message catch event or
+ message receive task.
+
profile with the URL (including version) of the profile (StructureDefinition) that the Task resource used
+ should conform to.
+
+
+ Configure BPMN message send tasks, intermediate message throw events and message end event with an implementation of
+ type 'Java class' with the fully qualified class name of the class extending this abstract implementation.
+
+ Configure your service task implementation as a Bean in your spring Configuration class with scope
+ "prototype".
Retrieves the instantiatesCanonical value used for Task resources send by this class via the injected field
+ instantiatesCanonical.
+
+ Override this method to use a different mechanism for retrieving the value for instantiatesCanonical. For
+ example via a process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file
+ in order to comply with the validation performed during plugin loading.
+
+
Parameters:
+
execution - not null
+
variables - not null
+
Returns:
+
instantiatesCanonical value used for Task resources send by this class
Retrieves the messageName value used for Task resources send by this class via the injected field
+ messageName.
+
+ Override this method to use a different mechanism for retrieving the value for messageName. For example via a
+ process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file in order to
+ comply with the validation performed during plugin loading.
+
+
Parameters:
+
execution - not null
+
variables - not null
+
Returns:
+
messageName value used for Task resources send by this class
Retrieves the profile value used for Task resources send by this class via the injected field profile.
+
+ Override this method to use a different mechanism for retrieving the value for profile. For example via a
+ process variable. Note: A non empty value e.g 'disable' still needs to be injected in the BPMN file in order to
+ comply with the validation performed during plugin loading.
+
+
Parameters:
+
execution - not null
+
variables - not null
+
Returns:
+
profile value used for Task resources send by this class
+
+
+
+
+
+
execute
+
public finalvoidexecute(org.camunda.bpm.engine.delegate.DelegateExecution execution)
+ throws Exception
+
+
Specified by:
+
execute in interface org.camunda.bpm.engine.delegate.JavaDelegate
public class DefaultUserTaskListener
-extends Object
-implements org.camunda.bpm.engine.delegate.TaskListener, org.springframework.beans.factory.InitializingBean
-
Default TaskListener implementation. This listener will be added to user tasks if no other
- TaskListener is defined for the 'create' event type.
-
- BPMN user tasks need to define the form to be used with type 'Embedded or External Task Forms' and the canonical URL
- of the a Questionnaire resource as the form key.
-
- To modify the behavior of the listener, for example to set default values in the created 'in-progress'
- QuestionnaireResponse, extend this class, register it as a prototype Bean and specify the class name
- as a task listener with event type 'create' in the BPMN.
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from interface org.camunda.bpm.engine.delegate.TaskListener
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
-
-
Parameters:
-
userTask - not null, user task on which this QuestionnaireResponse is based
-
beforeCreate - not null, containing an answer placeholder for every item in the corresponding
- Questionnaire
public class DefaultUserTaskListener
+extends Object
+implements org.camunda.bpm.engine.delegate.TaskListener, org.springframework.beans.factory.InitializingBean
+
Default TaskListener implementation. This listener will be added to user tasks if no other
+ TaskListener is defined for the 'create' event type.
+
+ BPMN user tasks need to define the form to be used with type 'Embedded or External Task Forms' and the canonical URL
+ of the a Questionnaire resource as the form key.
+
+ To modify the behavior of the listener, for example to set default values in the created 'in-progress'
+ QuestionnaireResponse, extend this class, register it as a prototype Bean and specify the class name
+ as a task listener with event type 'create' in the BPMN.
+
+
+
+
+
+
+
Field Summary
+
+
Fields inherited from interface org.camunda.bpm.engine.delegate.TaskListener
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
+
+
Parameters:
+
userTask - not null, user task on which this QuestionnaireResponse is based
+
beforeCreate - not null, containing an answer placeholder for every item in the corresponding
+ Questionnaire
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
-
- Configured no-proxy URLs are matched exactly and against sub-domains. If a port is configured, only URLs with the
- same port (or default port) return a true result.
-
-
-
No-Proxy URL examples
-
-
Configured
-
Given
-
Result
-
-
-
foo.bar, test.com:8080
-
https://foo.bar/fhir
-
true
-
-
-
foo.bar, test.com:8080
-
https://baz.foo.bar/test
-
true
-
-
-
foo.bar, test.com:8080
-
https://test.com:8080/fhir
-
true
-
-
-
foo.bar, test.com:8080
-
https://test.com/fhir
-
false
-
-
-
foo.bar:443
-
https://foo.bar/fhir
-
true
-
-
-
-
Parameters:
-
url - may be null
-
Returns:
-
true if the given url is not null and is configured as a no-proxy url
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
+
+ Configured no-proxy URLs are matched exactly and against sub-domains. If a port is configured, only URLs with the
+ same port (or default port) return a true result.
+
+
+
No-Proxy URL examples
+
+
Configured
+
Given
+
Result
+
+
+
foo.bar, test.com:8080
+
https://foo.bar/fhir
+
true
+
+
+
foo.bar, test.com:8080
+
https://baz.foo.bar/test
+
true
+
+
+
foo.bar, test.com:8080
+
https://test.com:8080/fhir
+
true
+
+
+
foo.bar, test.com:8080
+
https://test.com/fhir
+
false
+
+
+
foo.bar:443
+
https://foo.bar/fhir
+
true
+
+
+
+
Parameters:
+
url - may be null
+
Returns:
+
true if the given url is not null and is configured as a no-proxy url
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target. See corresponding
- protected method in AbstractTaskMessageSend on how to create and use an alternative
- business-key.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target. See corresponding
+ protected method in AbstractTaskMessageSend on how to create and use an alternative
+ business-key.
Annotation for documenting DSF process plugin properties. Add this annotation in addition to Value to fields
- of your spring Configuration class in order to take advantage of the "dsf-tools-documentation-generator"
- maven plugin to generate a markdown file.
-
- Example:
-
-
- @ProcessDocumentation(description = "Set to `true` to enable a special function", processNames = "testorg_process")
- @Value("${org.test.process.special:false}")
- private boolean specialFunction;
-
Annotation for documenting DSF process plugin properties. Add this annotation in addition to Value to fields
+ of your spring Configuration class in order to take advantage of the "dsf-tools-documentation-generator"
+ maven plugin to generate a markdown file.
+
+ Example:
+
+
+ @ProcessDocumentation(description = "Set to `true` to enable a special function", processNames = "testorg_process")
+ @Value("${org.test.process.special:false}")
+ private boolean specialFunction;
+
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
DSF identifier of the Endpoint resource from the local DSF FHIR server associated with the
- configured base URL, empty Optional if no such resource exists or the Endpoint does not
- have a DSF identifier
DSF identifier value of the Endpoint resource from the local DSF FHIR server associated with the
- configured base URL, empty Optional if no such resource exists or the Endpoint does not
- have a DSF identifier
Active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier,
- empty Optional if no such resource exists or the given identifier is null
Active Endpoint resource from the local DSF FHIR server with the given DSF
- endpointIdentifierValue, empty Optional if no such resource exists or the given identifier
- value is null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
- endpointIdentifier, empty Optional if no such resource exists or the given identifier is
- null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
- DSF endpointIdentifierValue, empty Optional if no such resource exists or the given
- identifier value is null
Active Endpoint resource from the local DSF FHIR server associated with the given
- memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the
- given parentOrganizationIdentifier, empty Optional if no such resource exists or one of
- the parameters is null; only considers Endpoints from active OrganizationAffiliation
- resources
Active Endpoint resource from the local DSF FHIR server associated with the given DSF
- memberOrganizationIdentifierValue and memberOrganizationRole in a parent organization with
- the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource exists
- or one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
- the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization
- with the given parentOrganizationIdentifier, empty Optional if no such resource exists or
- one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
- the given DSF memberOrganizationIdentifierValue and memberOrganizationRole in a parent
- organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no
- such resource exists or one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
- memberOrganizationRole in a parent organization with the given
- parentOrganizationIdentifier, empty List if no resources exist or one of the parameters is
- null; only considers Endpoints from active OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
- memberOrganizationRole in a parent organization with the given DSF
- parentOrganizationIdentifierValue, empty List if no resources exist or one of the
- parameters is null; only considers Endpoints from active OrganizationAffiliation
- resources
DSF identifier of the Endpoint resource from the local DSF FHIR server associated with the
+ configured base URL, empty Optional if no such resource exists or the Endpoint does not
+ have a DSF identifier
DSF identifier value of the Endpoint resource from the local DSF FHIR server associated with the
+ configured base URL, empty Optional if no such resource exists or the Endpoint does not
+ have a DSF identifier
Active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier,
+ empty Optional if no such resource exists or the given identifier is null
Active Endpoint resource from the local DSF FHIR server with the given DSF
+ endpointIdentifierValue, empty Optional if no such resource exists or the given identifier
+ value is null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
+ endpointIdentifier, empty Optional if no such resource exists or the given identifier is
+ null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
+ DSF endpointIdentifierValue, empty Optional if no such resource exists or the given
+ identifier value is null
Active Endpoint resource from the local DSF FHIR server associated with the given
+ memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the
+ given parentOrganizationIdentifier, empty Optional if no such resource exists or one of
+ the parameters is null; only considers Endpoints from active OrganizationAffiliation
+ resources
Active Endpoint resource from the local DSF FHIR server associated with the given DSF
+ memberOrganizationIdentifierValue and memberOrganizationRole in a parent organization with
+ the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource exists
+ or one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
+ the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization
+ with the given parentOrganizationIdentifier, empty Optional if no such resource exists or
+ one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
+ the given DSF memberOrganizationIdentifierValue and memberOrganizationRole in a parent
+ organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no
+ such resource exists or one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
+ memberOrganizationRole in a parent organization with the given
+ parentOrganizationIdentifier, empty List if no resources exist or one of the parameters is
+ null; only considers Endpoints from active OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
+ memberOrganizationRole in a parent organization with the given DSF
+ parentOrganizationIdentifierValue, empty List if no resources exist or one of the
+ parameters is null; only considers Endpoints from active OrganizationAffiliation
+ resources
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
Retrieves the local Organization resources by searching for the managing Organization of the
- local Endpoint resources. The local Endpoint resource is identified by the DSF FHIR server
- address configured for the DSF BPE server.
-
-
Returns:
-
Managing Organization for the Endpoint resource with address equal to the DSF FHIR server
- base address configured for this DSF BPE, empty Optional if no such resource exists
DSF organization identifier from the local Organization resource, empty Optional if no
- such resource exists or the Organization does not have a DSF organization identifier
DSF organization identifier value from the local Organization resource, empty Optional if
- no such resource exists or the Organization does not have a DSF organization identifier
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier, empty List if no parent organization found,
- parent has no participating organizations configured via OrganizationAffiliation resources or the
- given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given DSF parentOrganizationIdentifierValue, empty List if no parent organization
- found, parent has no participating organizations configured via OrganizationAffiliation resources
- or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier and role equal to the given
- memberOrganizationRole, empty List if no parent organization found, parent has no
- participating organizations configured via OrganizationAffiliation resources with the given role
- or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier and role equal to the given
- memberOrganizationRole, empty List if no parent organization found, parent has no
- participating organizations configured via OrganizationAffiliation resources with the given role
- or the given identifier is null
Retrieves the local Organization resources by searching for the managing Organization of the
+ local Endpoint resources. The local Endpoint resource is identified by the DSF FHIR server
+ address configured for the DSF BPE server.
+
+
Returns:
+
Managing Organization for the Endpoint resource with address equal to the DSF FHIR server
+ base address configured for this DSF BPE, empty Optional if no such resource exists
DSF organization identifier from the local Organization resource, empty Optional if no
+ such resource exists or the Organization does not have a DSF organization identifier
DSF organization identifier value from the local Organization resource, empty Optional if
+ no such resource exists or the Organization does not have a DSF organization identifier
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier, empty List if no parent organization found,
+ parent has no participating organizations configured via OrganizationAffiliation resources or the
+ given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given DSF parentOrganizationIdentifierValue, empty List if no parent organization
+ found, parent has no participating organizations configured via OrganizationAffiliation resources
+ or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier and role equal to the given
+ memberOrganizationRole, empty List if no parent organization found, parent has no
+ participating organizations configured via OrganizationAffiliation resources with the given role
+ or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier and role equal to the given
+ memberOrganizationRole, empty List if no parent organization found, parent has no
+ participating organizations configured via OrganizationAffiliation resources with the given role
+ or the given identifier is null
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
- A notnullcorrelationKey should be used if return messages aka. Task resources
- from multiple organizations with the same message-name are expected in a following multi instance message receive
- task or intermediate message catch event in a multi instance subprocess.
- Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
- message receive task or intermediate message catch event of a subprocess before incoming messages aka. Task
- resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with name:
- BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and value:
- ${target.correlationKey}.
-
- A notnullcorrelationKey should also be used when sending a message aka. Task
- resource back to an organization waiting for multiple returns.
-
-
Parameters:
-
organizationIdentifierValue - not null
-
endpointIdentifierValue - not null
-
endpointAddress - not null
-
correlationKey - not null if used for sending multiple messages and multiple messages with the same
- message-name are expected in return
Creates a new target list.
-
- Use${targets.entries}as a multi instance collection andtargetas
- the element variable to loop over this list in a multi instance task or subprocess.
-
-
Parameters:
-
targets - Target objects to incorporate into the created list
-
Returns:
-
a new target list
-
Throws:
-
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
- this Variables implementation
Creates a new target list.
-
- Use${targets.entries}as a multi instance collection andtargetas
- the element variable to loop over this list in a multi instance task or subprocess.
-
-
Parameters:
-
targets - Target objects to incorporate into the created list, may be null
-
Returns:
-
a new target list
-
Throws:
-
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
- this Variables implementation
Does nothing if the given task is null. Forces an update to the Task list variable used
- internally to track all received Task resources if the given task object is already part of this list.
+ A notnullcorrelationKey should be used if return messages aka. Task resources
+ from multiple organizations with the same message-name are expected in a following multi instance message receive
+ task or intermediate message catch event in a multi instance subprocess.
+ Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
+ message receive task or intermediate message catch event of a subprocess before incoming messages aka. Task
+ resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with name:
+ BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and value:
+ ${target.correlationKey}.
+
+ A notnullcorrelationKey should also be used when sending a message aka. Task
+ resource back to an organization waiting for multiple returns.
+
+
Parameters:
+
organizationIdentifierValue - not null
+
endpointIdentifierValue - not null
+
endpointAddress - not null
+
correlationKey - not null if used for sending multiple messages and multiple messages with the same
+ message-name are expected in return
Creates a new target list.
+
+ Use${targets.entries}as a multi instance collection andtargetas
+ the element variable to loop over this list in a multi instance task or subprocess.
+
+
Parameters:
+
targets - Target objects to incorporate into the created list
+
Returns:
+
a new target list
+
Throws:
+
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
+ this Variables implementation
Creates a new target list.
+
+ Use${targets.entries}as a multi instance collection andtargetas
+ the element variable to loop over this list in a multi instance task or subprocess.
+
+
Parameters:
+
targets - Target objects to incorporate into the created list, may be null
+
Returns:
+
a new target list
+
Throws:
+
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
+ this Variables implementation
Does nothing if the given task is null. Forces an update to the Task list variable used
+ internally to track all received Task resources if the given task object is already part of this list.
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
-
-
Parameters:
-
resource - may be null
-
Returns:
-
false if given resource is null or resource not valid
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
-
Parameters:
-
resource - may be null
-
organizationWithIdentifierExists - not null
-
roleExists - not null
-
Returns:
-
false if given resource is null or resource not valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
+
+
Parameters:
+
resource - may be null
+
Returns:
+
false if given resource is null or resource not valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+
Parameters:
+
resource - may be null
+
organizationWithIdentifierExists - not null
+
roleExists - not null
+
Returns:
+
false if given resource is null or resource not valid
-Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
-
-
Search
-
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
-The following sections describe the different kinds of pages in this collection.
-
-
Overview
-
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-
Package
-
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
-
-
Interfaces
-
Classes
-
Enum Classes
-
Exception Classes
-
Annotation Interfaces
-
-
-
-
Class or Interface
-
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
-
-
Class Inheritance Diagram
-
Direct Subclasses
-
All Known Subinterfaces
-
All Known Implementing Classes
-
Class or Interface Declaration
-
Class or Interface Description
-
-
-
-
Nested Class Summary
-
Enum Constant Summary
-
Field Summary
-
Property Summary
-
Constructor Summary
-
Method Summary
-
Required Element Summary
-
Optional Element Summary
-
-
-
-
Enum Constant Details
-
Field Details
-
Property Details
-
Constructor Details
-
Method Details
-
Element Details
-
-
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
-
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-
Other Files
-
Packages and modules may contain pages with additional information related to the declarations nearby.
-
-
-
Use
-
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
-
-
-
Tree (Class Hierarchy)
-
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
-
-
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
-
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
-
-
-
-
Deprecated API
-
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The All Packages page contains an alphabetic index of all packages contained in the documentation.
-
-
-
All Classes and Interfaces
-
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
-
-
-
Index
-
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
-
-
-
-This help file applies to API documentation generated by the standard doclet.
-
-
-
-
-
+
+
+
+
+API Help (DSF BPE Process API v1 2.0.0-M3 API)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
+
+
Search
+
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
+The following sections describe the different kinds of pages in this collection.
+
+
Overview
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+
Interfaces
+
Classes
+
Enum Classes
+
Exception Classes
+
Annotation Interfaces
+
+
+
+
Class or Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+
Class Inheritance Diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class or Interface Declaration
+
Class or Interface Description
+
+
+
+
Nested Class Summary
+
Enum Constant Summary
+
Field Summary
+
Property Summary
+
Constructor Summary
+
Method Summary
+
Required Element Summary
+
Optional Element Summary
+
+
+
+
Enum Constant Details
+
Field Details
+
Property Details
+
Constructor Details
+
Method Details
+
Element Details
+
+
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Other Files
+
Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+
Use
+
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+
All Classes and Interfaces
+
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
Index
+
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target.
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
-
-
L
-
-
localAll() - Static method in interface dev.dsf.fhir.authorization.process.Recipient
-
-
localAll() - Static method in interface dev.dsf.fhir.authorization.process.Requester
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target.
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+
+
L
+
+
localAll() - Static method in interface dev.dsf.fhir.authorization.process.Recipient
+
+
localAll() - Static method in interface dev.dsf.fhir.authorization.process.Requester
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
The help page provides an introduction to the scope and syntax of JavaDoc search.
-
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
-
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
The help page provides an introduction to the scope and syntax of JavaDoc search.
+
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
+
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
+link
+
+
+
+
+
Loading search index...
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/src/.vuepress/public/assets/javadoc/api-v1/search.js b/docs/src/.vuepress/public/assets/javadoc/api-v1/search.js
index bd1a8e072..d3986705e 100644
--- a/docs/src/.vuepress/public/assets/javadoc/api-v1/search.js
+++ b/docs/src/.vuepress/public/assets/javadoc/api-v1/search.js
@@ -1,458 +1,458 @@
-/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-"use strict";
-const messages = {
- enterTerm: "Enter a search term",
- noResult: "No results found",
- oneResult: "Found one result",
- manyResults: "Found {0} results",
- loading: "Loading search index...",
- searching: "Searching...",
- redirecting: "Redirecting to first result...",
- linkIcon: "Link icon",
- linkToSection: "Link to this section"
-}
-const categories = {
- modules: "Modules",
- packages: "Packages",
- types: "Classes and Interfaces",
- members: "Members",
- searchTags: "Search Tags"
-};
-const highlight = "$&";
-const NO_MATCH = {};
-const MAX_RESULTS = 300;
-function checkUnnamed(name, separator) {
- return name === "" || !name ? "" : name + separator;
-}
-function escapeHtml(str) {
- return str.replace(//g, ">");
-}
-function getHighlightedText(str, boundaries, from, to) {
- var start = from;
- var text = "";
- for (var i = 0; i < boundaries.length; i += 2) {
- var b0 = boundaries[i];
- var b1 = boundaries[i + 1];
- if (b0 >= to || b1 <= from) {
- continue;
- }
- text += escapeHtml(str.slice(start, Math.max(start, b0)));
- text += "";
- text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1)));
- text += "";
- start = Math.min(to, b1);
- }
- text += escapeHtml(str.slice(start, to));
- return text;
-}
-function getURLPrefix(item, category) {
- var urlPrefix = "";
- var slash = "/";
- if (category === "modules") {
- return item.l + slash;
- } else if (category === "packages" && item.m) {
- return item.m + slash;
- } else if (category === "types" || category === "members") {
- if (item.m) {
- urlPrefix = item.m + slash;
- } else {
- $.each(packageSearchIndex, function(index, it) {
- if (it.m && item.p === it.l) {
- urlPrefix = it.m + slash;
- }
- });
- }
- }
- return urlPrefix;
-}
-function getURL(item, category) {
- if (item.url) {
- return item.url;
- }
- var url = getURLPrefix(item, category);
- if (category === "modules") {
- url += "module-summary.html";
- } else if (category === "packages") {
- if (item.u) {
- url = item.u;
- } else {
- url += item.l.replace(/\./g, '/') + "/package-summary.html";
- }
- } else if (category === "types") {
- if (item.u) {
- url = item.u;
- } else {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html";
- }
- } else if (category === "members") {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#";
- if (item.u) {
- url += item.u;
- } else {
- url += item.l;
- }
- } else if (category === "searchTags") {
- url += item.u;
- }
- item.url = url;
- return url;
-}
-function createMatcher(term, camelCase) {
- if (camelCase && !isUpperCase(term)) {
- return null; // no need for camel-case matcher for lower case query
- }
- var pattern = "";
- var upperCase = [];
- term.trim().split(/\s+/).forEach(function(w, index, array) {
- var tokens = w.split(/(?=[A-Z,.()<>?[\/])/);
- for (var i = 0; i < tokens.length; i++) {
- var s = tokens[i];
- // ',' and '?' are the only delimiters commonly followed by space in java signatures
- pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")";
- upperCase.push(false);
- var isWordToken = /\w$/.test(s);
- if (isWordToken) {
- if (i === tokens.length - 1 && index < array.length - 1) {
- // space in query string matches all delimiters
- pattern += "(.*?)";
- upperCase.push(isUpperCase(s[0]));
- } else {
- if (!camelCase && isUpperCase(s) && s.length === 1) {
- pattern += "()";
- } else {
- pattern += "([a-z0-9$<>?[\\]]*?)";
- }
- upperCase.push(isUpperCase(s[0]));
- }
- } else {
- pattern += "()";
- upperCase.push(false);
- }
- }
- });
- var re = new RegExp(pattern, "gi");
- re.upperCase = upperCase;
- return re;
-}
-function findMatch(matcher, input, startOfName, endOfName) {
- var from = startOfName;
- matcher.lastIndex = from;
- var match = matcher.exec(input);
- // Expand search area until we get a valid result or reach the beginning of the string
- while (!match || match.index + match[0].length < startOfName || endOfName < match.index) {
- if (from === 0) {
- return NO_MATCH;
- }
- from = input.lastIndexOf(".", from - 2) + 1;
- matcher.lastIndex = from;
- match = matcher.exec(input);
- }
- var boundaries = [];
- var matchEnd = match.index + match[0].length;
- var score = 5;
- var start = match.index;
- var prevEnd = -1;
- for (var i = 1; i < match.length; i += 2) {
- var isUpper = isUpperCase(input[start]);
- var isMatcherUpper = matcher.upperCase[i];
- // capturing groups come in pairs, match and non-match
- boundaries.push(start, start + match[i].length);
- // make sure groups are anchored on a left word boundary
- var prevChar = input[start - 1] || "";
- var nextChar = input[start + 1] || "";
- if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) {
- if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) {
- score -= 0.1;
- } else if (isMatcherUpper && start === prevEnd) {
- score -= isUpper ? 0.1 : 1.0;
- } else {
- return NO_MATCH;
- }
- }
- prevEnd = start + match[i].length;
- start += match[i].length + match[i + 1].length;
-
- // lower score for parts of the name that are missing
- if (match[i + 1] && prevEnd < endOfName) {
- score -= rateNoise(match[i + 1]);
- }
- }
- // lower score if a type name contains unmatched camel-case parts
- if (input[matchEnd - 1] !== "." && endOfName > matchEnd)
- score -= rateNoise(input.slice(matchEnd, endOfName));
- score -= rateNoise(input.slice(0, Math.max(startOfName, match.index)));
-
- if (score <= 0) {
- return NO_MATCH;
- }
- return {
- input: input,
- score: score,
- boundaries: boundaries
- };
-}
-function isUpperCase(s) {
- return s !== s.toLowerCase();
-}
-function isLowerCase(s) {
- return s !== s.toUpperCase();
-}
-function rateNoise(str) {
- return (str.match(/([.(])/g) || []).length / 5
- + (str.match(/([A-Z]+)/g) || []).length / 10
- + str.length / 20;
-}
-function doSearch(request, response) {
- var term = request.term.trim();
- var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
- var matcher = {
- plainMatcher: createMatcher(term, false),
- camelCaseMatcher: createMatcher(term, true)
- }
- var indexLoaded = indexFilesLoaded();
-
- function getPrefix(item, category) {
- switch (category) {
- case "packages":
- return checkUnnamed(item.m, "/");
- case "types":
- return checkUnnamed(item.p, ".");
- case "members":
- return checkUnnamed(item.p, ".") + item.c + ".";
- default:
- return "";
- }
- }
- function useQualifiedName(category) {
- switch (category) {
- case "packages":
- return /[\s/]/.test(term);
- case "types":
- case "members":
- return /[\s.]/.test(term);
- default:
- return false;
- }
- }
- function searchIndex(indexArray, category) {
- var matches = [];
- if (!indexArray) {
- if (!indexLoaded) {
- matches.push({ l: messages.loading, category: category });
- }
- return matches;
- }
- $.each(indexArray, function (i, item) {
- var prefix = getPrefix(item, category);
- var simpleName = item.l;
- var qualifiedName = prefix + simpleName;
- var useQualified = useQualifiedName(category);
- var input = useQualified ? qualifiedName : simpleName;
- var startOfName = useQualified ? prefix.length : 0;
- var endOfName = category === "members" && input.indexOf("(", startOfName) > -1
- ? input.indexOf("(", startOfName) : input.length;
- var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName);
- if (m === NO_MATCH && matcher.camelCaseMatcher) {
- m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName);
- }
- if (m !== NO_MATCH) {
- m.indexItem = item;
- m.prefix = prefix;
- m.category = category;
- if (!useQualified) {
- m.input = qualifiedName;
- m.boundaries = m.boundaries.map(function(b) {
- return b + prefix.length;
- });
- }
- matches.push(m);
- }
- return true;
- });
- return matches.sort(function(e1, e2) {
- return e2.score - e1.score;
- }).slice(0, maxResults);
- }
-
- var result = searchIndex(moduleSearchIndex, "modules")
- .concat(searchIndex(packageSearchIndex, "packages"))
- .concat(searchIndex(typeSearchIndex, "types"))
- .concat(searchIndex(memberSearchIndex, "members"))
- .concat(searchIndex(tagSearchIndex, "searchTags"));
-
- if (!indexLoaded) {
- updateSearchResults = function() {
- doSearch(request, response);
- }
- } else {
- updateSearchResults = function() {};
- }
- response(result);
-}
-// JQuery search menu implementation
-$.widget("custom.catcomplete", $.ui.autocomplete, {
- _create: function() {
- this._super();
- this.widget().menu("option", "items", "> .result-item");
- // workaround for search result scrolling
- this.menu._scrollIntoView = function _scrollIntoView( item ) {
- var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight;
- if ( this._hasScroll() ) {
- borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0;
- paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0;
- offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop;
- scroll = this.activeMenu.scrollTop();
- elementHeight = this.activeMenu.height() - 26;
- itemHeight = item.outerHeight();
-
- if ( offset < 0 ) {
- this.activeMenu.scrollTop( scroll + offset );
- } else if ( offset + itemHeight > elementHeight ) {
- this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight );
- }
- }
- };
- },
- _renderMenu: function(ul, items) {
- var currentCategory = "";
- var widget = this;
- widget.menu.bindings = $();
- $.each(items, function(index, item) {
- if (item.category && item.category !== currentCategory) {
- ul.append("
Provides methods for:
-
- Creating and using RSA and ECDH key encapsulation mechanism
- Reading X509 certificates and private-keys (encrypted or not encrypted)
- Reading JKS and PKCS12 key-stores
- Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
- Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
- Validating key-pairs to check if a private-key belongs to a public-key
- Validating certificates
- Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
- and certificate chain
-
When implementations of this interface are registered as singleton Bean, modify methods are called during
- process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Provides methods for:
+
+ Creating and using RSA and ECDH key encapsulation mechanism
+ Reading X509 certificates and private-keys (encrypted or not encrypted)
+ Reading JKS and PKCS12 key-stores
+ Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
+ Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
+ Validating key-pairs to check if a private-key belongs to a public-key
+ Validating certificates
+ Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
+ and certificate chain
+
When implementations of this interface are registered as singleton Bean, modify methods are called during
+ process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Gives access to services available to process plugins. This api and all services excepted Variables can be
- injected using Autowired into spring Configuration classes.
Gives access to services available to process plugins. This api and all services excepted Variables can be
+ injected using Autowired into spring Configuration classes.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/". For more details on the
- content of the provider configuration file, see ServiceLoader.
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process.
Return List.of("foo.bpmn"); for a foo.bpmn file located in the root folder of the process plugin
- jar. The returned files will be read via ClassLoader.getResourceAsStream(String).
-
- Occurrences of#{version}will be replaced with the value of
- getResourceVersion()
- Occurrences of#{date}will be replaced with the value of
- getResourceReleaseDate()
- Occurrences of#{organization}will be replaced with the local organization DSF identifier
- value, or"null"if no local organization can be found in the allow list
- Other placeholders of the form#{property.name}will be replaced with values from equivalent
- environment variable, e.g.PROPERTY_NAME
-
-
Returns:
-
*.bpmn files inside the process plugin jar, paths relative to root folder of process plugin
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process. The returned files will be read via
- ClassLoader.getResourceAsStream(String).
-
- Supported metadata resource types are ActivityDefinition, CodeSystem, Library, Measure, NamingSystem,
- Questionnaire, StructureDefinition, Task and ValueSet.
-
- Occurrences of#{version}will be replaced with the value of
- getResourceVersion()
- Occurrences of#{date}will be replaced with the value of
- getResourceReleaseDate()
- Occurrences of#{organization}will be replaced with the local organization DSF identifier
- value, or"null"if no local organization can be found in the allow list
- Other placeholders of the form#{property.name}will be replaced with values from equivalent
- environment variable, e.g.PROPERTY_NAME
-
-
Returns:
-
*.xml or *.json files inside the process plugin jar per process, paths relative to root folder of process
- plugin
- All implementations used for BPMN service tasks, message send tasks and throw events as well as task- and user
- task listeners need to be declared as spring Beans with Scope"prototype".
- Other classes not directly used within BPMN activities should be declared with the default singleton scope.
-
- Configuration classes that defined private fields annotated with Value defining property placeholders,
- can be configured via environment variables. A fieldprivate boolean specialFunction;
- annotated with@Value("${org.test.process.special:false}")can be configured with the
- environment variableORG_TEST_PROCESS_SPECIAL. To take advantage of the
- "dsf-tools-documentation-generator" maven plugin to generate a markdown file with configuration options for the
- plugin also add the ProcessDocumentation annotation.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/". For more details on the
+ content of the provider configuration file, see ServiceLoader.
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process.
Return List.of("foo.bpmn"); for a foo.bpmn file located in the root folder of the process plugin
+ jar. The returned files will be read via ClassLoader.getResourceAsStream(String).
+
+ Occurrences of#{version}will be replaced with the value of
+ getResourceVersion()
+ Occurrences of#{date}will be replaced with the value of
+ getResourceReleaseDate()
+ Occurrences of#{organization}will be replaced with the local organization DSF identifier
+ value, or"null"if no local organization can be found in the allow list
+ Other placeholders of the form#{property.name}will be replaced with values from equivalent
+ environment variable, e.g.PROPERTY_NAME
+
+
Returns:
+
*.bpmn files inside the process plugin jar, paths relative to root folder of process plugin
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process. The returned files will be read via
+ ClassLoader.getResourceAsStream(String).
+
+ Supported metadata resource types are ActivityDefinition, CodeSystem, Library, Measure, NamingSystem,
+ Questionnaire, StructureDefinition, Task and ValueSet.
+
+ Occurrences of#{version}will be replaced with the value of
+ getResourceVersion()
+ Occurrences of#{date}will be replaced with the value of
+ getResourceReleaseDate()
+ Occurrences of#{organization}will be replaced with the local organization DSF identifier
+ value, or"null"if no local organization can be found in the allow list
+ Other placeholders of the form#{property.name}will be replaced with values from equivalent
+ environment variable, e.g.PROPERTY_NAME
+
+
Returns:
+
*.xml or *.json files inside the process plugin jar per process, paths relative to root folder of process
+ plugin
+ All implementations used for BPMN service tasks, message send tasks and throw events as well as task- and user
+ task listeners need to be declared as spring Beans with Scope"prototype".
+ Other classes not directly used within BPMN activities should be declared with the default singleton scope.
+
+ Configuration classes that defined private fields annotated with Value defining property placeholders,
+ can be configured via environment variables. A fieldprivate boolean specialFunction;
+ annotated with@Value("${org.test.process.special:false}")can be configured with the
+ environment variableORG_TEST_PROCESS_SPECIAL. To take advantage of the
+ "dsf-tools-documentation-generator" maven plugin to generate a markdown file with configuration options for the
+ plugin also add the ProcessDocumentation annotation.
Listener called after process plugin deployment with a list of deployed process-ids from this plugin. List contains
- all processes deployed in the bpe depending on the exclusion and retired config.
-
- Register a singleton Bean implementing this interface to execute custom code like connection tests if a
- process has been deployed.
Listener called after process plugin deployment with a list of deployed process-ids from this plugin. List contains
+ all processes deployed in the bpe depending on the exclusion and retired config.
+
+ Register a singleton Bean implementing this interface to execute custom code like connection tests if a
+ process has been deployed.
Default UserTaskListener implementation. This listener will be added to user tasks if no other
- UserTaskListener is defined for the 'create' event type.
-
- BPMN user tasks need to define the form to be used with type 'Embedded or External Task Forms' and the canonical URL
- of the a Questionnaire resource as the form key.
-
- To modify the behavior of the listener, for example to set default values in the created 'in-progress'
- QuestionnaireResponse, extend this class, register it as a prototype Bean and specify the class name
- as a task listener with event type 'create' in the BPMN.
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
-
-
Parameters:
-
api - not null
-
variables - not null
-
createQuestionnaireResponseValues - not null
-
beforeCreate - not null, containing an answer placeholder for every item in the corresponding
- Questionnaire
Default UserTaskListener implementation. This listener will be added to user tasks if no other
+ UserTaskListener is defined for the 'create' event type.
+
+ BPMN user tasks need to define the form to be used with type 'Embedded or External Task Forms' and the canonical URL
+ of the a Questionnaire resource as the form key.
+
+ To modify the behavior of the listener, for example to set default values in the created 'in-progress'
+ QuestionnaireResponse, extend this class, register it as a prototype Bean and specify the class name
+ as a task listener with event type 'create' in the BPMN.
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
+
+
Parameters:
+
api - not null
+
variables - not null
+
createQuestionnaireResponseValues - not null
+
beforeCreate - not null, containing an answer placeholder for every item in the corresponding
+ Questionnaire
Returns the enum constant of this class with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this class. (Extraneous whitespace characters are
-not permitted.)
-
-
Parameters:
-
name - the name of the enum constant to be returned.
Returns the enum constant of this class with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this class. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
- server.
- Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
- an active Endpoint resource and the given fhirServerId as the
- "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
+ server.
+ Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
+ an active Endpoint resource and the given fhirServerId as the
+ "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
OidcClientException - if response status not 200 OK, response issuer not matching base-url or response supported grant
- types does not include "client_credentials"
OidcClientException - if response status not 200 OK, OIDC provider does not support client credentials grant (Keycloak:
- service accounts roles) or returned access token could not be verified
OidcClientException - if response status not 200 OK, response issuer not matching base-url or response supported grant
+ types does not include "client_credentials"
OidcClientException - if response status not 200 OK, OIDC provider does not support client credentials grant (Keycloak:
+ service accounts roles) or returned access token could not be verified
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
true if a proxy url is configured, '*' is not set as a no-proxy url and the given
- targetUrl is not set as a no-proxy url, false if the given targetUrl is
- null, blank or configured as a no-proxy url
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
-
- Configured no-proxy URLs are matched exactly and against sub-domains. If a port is configured, only URLs with the
- same port (or default port) return a true result.
-
-
-
No-Proxy URL examples
-
-
Configured
-
Given
-
Result
-
-
-
foo.bar, test.com:8080
-
https://foo.bar/fhir
-
true
-
-
-
foo.bar, test.com:8080
-
https://baz.foo.bar/test
-
true
-
-
-
foo.bar, test.com:8080
-
https://test.com:8080/fhir
-
true
-
-
-
foo.bar, test.com:8080
-
https://test.com/fhir
-
false
-
-
-
foo.bar:443
-
https://foo.bar/fhir
-
true
-
-
-
-
Parameters:
-
url - may be null
-
Returns:
-
true if the given url is not null and is configured as a no-proxy url
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
true if a proxy url is configured, '*' is not set as a no-proxy url and the given
+ targetUrl is not set as a no-proxy url, false if the given targetUrl is
+ null, blank or configured as a no-proxy url
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
+
+ Configured no-proxy URLs are matched exactly and against sub-domains. If a port is configured, only URLs with the
+ same port (or default port) return a true result.
+
+
+
No-Proxy URL examples
+
+
Configured
+
Given
+
Result
+
+
+
foo.bar, test.com:8080
+
https://foo.bar/fhir
+
true
+
+
+
foo.bar, test.com:8080
+
https://baz.foo.bar/test
+
true
+
+
+
foo.bar, test.com:8080
+
https://test.com:8080/fhir
+
true
+
+
+
foo.bar, test.com:8080
+
https://test.com/fhir
+
false
+
+
+
foo.bar:443
+
https://foo.bar/fhir
+
true
+
+
+
+
Parameters:
+
url - may be null
+
Returns:
+
true if the given url is not null and is configured as a no-proxy url
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target.
Annotation for documenting DSF process plugin properties. Add this annotation in addition to Value to fields
- of your spring Configuration class in order to take advantage of the "dsf-tools-documentation-generator"
- maven plugin to generate a markdown file.
-
- Example:
-
-
- @ProcessDocumentation(description = "Set to `true` to enable a special function", processNames = "testorg_process")
- @Value("${org.test.process.special:false}")
- private boolean specialFunction;
-
Annotation for documenting DSF process plugin properties. Add this annotation in addition to Value to fields
+ of your spring Configuration class in order to take advantage of the "dsf-tools-documentation-generator"
+ maven plugin to generate a markdown file.
+
+ Example:
+
+
+ @ProcessDocumentation(description = "Set to `true` to enable a special function", processNames = "testorg_process")
+ @Value("${org.test.process.special:false}")
+ private boolean specialFunction;
+
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
-
- Exceptions thrown while updating the Task resources to status failed are logged.
-
- Returns the given Exception resulting in a deleted i.e. stopped process instance.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
+
+ Exceptions thrown while updating the Task resources to status failed are logged.
+
+ Returns the given Exception resulting in a deleted i.e. stopped process instance.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
-
- Exceptions thrown while updating the Task resources to status failed are logged.
-
- Returns null resulting in a continuing process instance.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
+
+ Exceptions thrown while updating the Task resources to status failed are logged.
+
+ Returns null resulting in a continuing process instance.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
-
- Exceptions thrown while updating the Task resources to status failed are logged.
-
- Returns the given Exception resulting in a deleted i.e. stopped process instance.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
+
+ Exceptions thrown while updating the Task resources to status failed are logged.
+
+ Returns the given Exception resulting in a deleted i.e. stopped process instance.
Single instance message send task (Targets variables not set or empty):
-
- Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
-
- Exceptions thrown while updating the Task resources to status failed are logged. Returns the given
- Exception resulting in a deleted i.e. stopped process instance.
-
- Multi instance message send task (Targets variables set and not empty):
-
- Removes the current Target from the Targets variable and logs the error. Returns
- null resulting in a continuing process instance.
Single instance message send task (Targets variables not set or empty):
+
+ Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
+
+ Exceptions thrown while updating the Task resources to status failed are logged. Returns the given
+ Exception resulting in a deleted i.e. stopped process instance.
+
+ Multi instance message send task (Targets variables set and not empty):
+
+ Removes the current Target from the Targets variable and logs the error. Returns
+ null resulting in a continuing process instance.
When implementations of this interface are registered as singleton Bean, modify methods are called during
- process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
-
- Warning: Modifications that are non static i.e. depend on values that can change from one start of the BPE to the
- next like environment variables and allow-list entries, require a stop BPE, remove plugin, start BPE, stop BPE, add
- plugin and start BPE cycle. Since not many modifications to the FHIR resources of a process plugin keep the plugin
- compatible across DSF instances, use this feature with care.
-
When implementations of this interface are registered as singleton Bean, modify methods are called during
+ process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
+
+ Warning: Modifications that are non static i.e. depend on values that can change from one start of the BPE to the
+ next like environment variables and allow-list entries, require a stop BPE, remove plugin, start BPE, stop BPE, add
+ plugin and start BPE cycle. Since not many modifications to the FHIR resources of a process plugin keep the plugin
+ compatible across DSF instances, use this feature with care.
+
When implementations of this interface are registered as singleton Bean, modify methods are called during
- process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
When implementations of this interface are registered as singleton Bean, modify methods are called during
+ process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
When implementations of this interface are registered as singleton Bean, modify methods are called during
- process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
When implementations of this interface are registered as singleton Bean, modify methods are called during
+ process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Encrypts the given InputStream with an AES session key calculated by KEM for the given
- PublicKey. The returned InputStream has the form [encapsulation length (big-endian, 2 bytes),
- encapsulation, AES initialization vector (12 bytes), AES encrypted data].
-
-
Parameters:
-
data - not null
-
publicKey - not null
-
Returns:
-
byte array of [encapsulation length (big-endian, 2 bytes), encapsulation, iv (12 bytes), encrypted
- data]
Encrypts the given InputStream with an AES session key calculated by KEM for the given
- PublicKey. The returned InputStream has the form [encapsulation length (big-endian, 2 bytes),
- encapsulation, AES initialization vector (12 bytes), AES encrypted data].
-
-
Parameters:
-
data - not null
-
publicKey - not null
-
Returns:
-
InputStream of [encapsulation length (big-endian, 2 bytes), encapsulation, iv (12 bytes),
- encrypted data]
Encrypts the given InputStream with an AES session key calculated by KEM for the given
+ PublicKey. The returned InputStream has the form [encapsulation length (big-endian, 2 bytes),
+ encapsulation, AES initialization vector (12 bytes), AES encrypted data].
+
+
Parameters:
+
data - not null
+
publicKey - not null
+
Returns:
+
byte array of [encapsulation length (big-endian, 2 bytes), encapsulation, iv (12 bytes), encrypted
+ data]
Encrypts the given InputStream with an AES session key calculated by KEM for the given
+ PublicKey. The returned InputStream has the form [encapsulation length (big-endian, 2 bytes),
+ encapsulation, AES initialization vector (12 bytes), AES encrypted data].
+
+
Parameters:
+
data - not null
+
publicKey - not null
+
Returns:
+
InputStream of [encapsulation length (big-endian, 2 bytes), encapsulation, iv (12 bytes),
+ encrypted data]
Checks if the given privateKey and publicKey match by checking if a generated signature can be
- verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
- key pair.
key encapsulation mechanism with Diffie–Hellman key exchange for AES-256, use with elliptic curve key
- pairs like X25519, X448, secp256r1, secp384r1 and secp521r1
Checks if the given privateKey and publicKey match by checking if a generated signature can be
- verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
- key pair. If the privateKey is a RSAPrivateCrtKey and the publicKey is a
- RSAPublicKey modulus and public-exponent will be compared.
CertificateException - if the the given certificate or certificate chain is not trusted as a client certificate by a PKIX
- trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a client certificate by a PKIX
- trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a server certificate by a PKIX
- trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a server certificate by a PKIX
- trust manager created for the given trust store
Checks if the given privateKey and publicKey match by checking if a generated signature can be
+ verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
+ key pair.
key encapsulation mechanism with Diffie–Hellman key exchange for AES-256, use with elliptic curve key
+ pairs like X25519, X448, secp256r1, secp384r1 and secp521r1
Checks if the given privateKey and publicKey match by checking if a generated signature can be
+ verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
+ key pair. If the privateKey is a RSAPrivateCrtKey and the publicKey is a
+ RSAPublicKey modulus and public-exponent will be compared.
CertificateException - if the the given certificate or certificate chain is not trusted as a client certificate by a PKIX
+ trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a client certificate by a PKIX
+ trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a server certificate by a PKIX
+ trust manager created for the given trust store
CertificateException - if the the given certificate or certificate chain is not trusted as a server certificate by a PKIX
+ trust manager created for the given trust store
DSF identifier of the Endpoint resource from the local DSF FHIR server associated with the
- configured base URL, empty Optional if no such resource exists or the Endpoint does not
- have a DSF identifier
DSF identifier value of the Endpoint resource from the local DSF FHIR server associated with the
- configured base URL, empty Optional if no such resource exists or the Endpoint does not
- have a DSF identifier
Active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier,
- empty Optional if no such resource exists or the given identifier is null
Active Endpoint resource from the local DSF FHIR server with the given DSF
- endpointIdentifierValue, empty Optional if no such resource exists or the given identifier
- value is null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
- endpointIdentifier, empty Optional if no such resource exists or the given identifier is
- null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
- DSF endpointIdentifierValue, empty Optional if no such resource exists or the given
- identifier value is null
Active Endpoint resource from the local DSF FHIR server associated with the given
- memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the
- given parentOrganizationIdentifier, empty Optional if no such resource exists or one of
- the parameters is null; only considers Endpoints from active OrganizationAffiliation
- resources
Active Endpoint resource from the local DSF FHIR server associated with the given DSF
- memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent organization
- with the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource
- exists or one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
- the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization
- with the given parentOrganizationIdentifier, empty Optional if no such resource exists or
- one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
- the given DSF memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent
- organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no
- such resource exists or one of the parameters is null; only considers Endpoints from active
- OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
- memberOrganizationRole in a parent organization with the given
- parentOrganizationIdentifier, empty List if no resources exist or one of the parameters is
- null; only considers Endpoints from active OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
- memberOrganizationRoleCode in a parent organization with the given DSF
- parentOrganizationIdentifierValue, empty List if no resources exist or one of the
- parameters is null; only considers Endpoints from active OrganizationAffiliation
- resources
DSF identifier of the Endpoint resource from the local DSF FHIR server associated with the
+ configured base URL, empty Optional if no such resource exists or the Endpoint does not
+ have a DSF identifier
DSF identifier value of the Endpoint resource from the local DSF FHIR server associated with the
+ configured base URL, empty Optional if no such resource exists or the Endpoint does not
+ have a DSF identifier
Active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier,
+ empty Optional if no such resource exists or the given identifier is null
Active Endpoint resource from the local DSF FHIR server with the given DSF
+ endpointIdentifierValue, empty Optional if no such resource exists or the given identifier
+ value is null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
+ endpointIdentifier, empty Optional if no such resource exists or the given identifier is
+ null
Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given
+ DSF endpointIdentifierValue, empty Optional if no such resource exists or the given
+ identifier value is null
Active Endpoint resource from the local DSF FHIR server associated with the given
+ memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the
+ given parentOrganizationIdentifier, empty Optional if no such resource exists or one of
+ the parameters is null; only considers Endpoints from active OrganizationAffiliation
+ resources
Active Endpoint resource from the local DSF FHIR server associated with the given DSF
+ memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent organization
+ with the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource
+ exists or one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
+ the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization
+ with the given parentOrganizationIdentifier, empty Optional if no such resource exists or
+ one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with
+ the given DSF memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent
+ organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no
+ such resource exists or one of the parameters is null; only considers Endpoints from active
+ OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
+ memberOrganizationRole in a parent organization with the given
+ parentOrganizationIdentifier, empty List if no resources exist or one of the parameters is
+ null; only considers Endpoints from active OrganizationAffiliation resources
Active Endpoint resources from the local DSF FHIR server associated with the given
+ memberOrganizationRoleCode in a parent organization with the given DSF
+ parentOrganizationIdentifierValue, empty List if no resources exist or one of the
+ parameters is null; only considers Endpoints from active OrganizationAffiliation
+ resources
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection to the local DSF FHIR server.
- Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
- Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
- value (ignoring the # character).
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
- server.
- Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
- an active Endpoint resource and the given fhirServerId as the
- "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection to the local DSF FHIR server.
- Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
- Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
- value (ignoring the # character).
-
-
Parameters:
-
fhirServerId - may be null
-
Returns:
-
never null, Optional.empty() if no client is configured for the given
- fhirServerId
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
- server.
- Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
- an active Endpoint resource and the given fhirServerId as the
- "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
-
-
Parameters:
-
fhirServerId - may be null
-
Returns:
-
never null, Optional.empty() if no client is configured for the given
- fhirServerId
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection to the local DSF FHIR server.
+ Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
+ Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
+ value (ignoring the # character).
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
+ server.
+ Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
+ an active Endpoint resource and the given fhirServerId as the
+ "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection to the local DSF FHIR server.
+ Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
+ Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
+ value (ignoring the # character).
+
+
Parameters:
+
fhirServerId - may be null
+
Returns:
+
never null, Optional.empty() if no client is configured for the given
+ fhirServerId
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
+ server.
+ Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
+ an active Endpoint resource and the given fhirServerId as the
+ "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
+
+
Parameters:
+
fhirServerId - may be null
+
Returns:
+
never null, Optional.empty() if no client is configured for the given
+ fhirServerId
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
Detects the mimetype of the provided byte array and validates if the detected mimetype equals the declared
- mimetype. Logs a warning if the full mimetypes do not match, throws a RuntimeException if the base
- mimetypes do not match.
-
-
Parameters:
-
data - byte array of which the mimetype should be detected
-
declared - the declared mimetype of the data
-
Throws:
-
RuntimeException - if the detected and the declared base mimetype do not match
Detects the mimetype of the provided input stream and validates if the detected mimetype equals the declared
- mimetype. Logs a warning if the full mimetypes do not match, throws a RuntimeException if the base
- mimetypes do not match.
-
-
Parameters:
-
stream - input stream of which the mimetype should be detected
-
declared - the declared mimetype of the data
-
Throws:
-
RuntimeException - if the detected and the declared base mimetype do not match
Detects the mimetype of the provided byte array and validates if the detected mimetype equals the declared
+ mimetype. Logs a warning if the full mimetypes do not match, throws a RuntimeException if the base
+ mimetypes do not match.
+
+
Parameters:
+
data - byte array of which the mimetype should be detected
+
declared - the declared mimetype of the data
+
Throws:
+
RuntimeException - if the detected and the declared base mimetype do not match
Detects the mimetype of the provided input stream and validates if the detected mimetype equals the declared
+ mimetype. Logs a warning if the full mimetypes do not match, throws a RuntimeException if the base
+ mimetypes do not match.
+
+
Parameters:
+
stream - input stream of which the mimetype should be detected
+
declared - the declared mimetype of the data
+
Throws:
+
RuntimeException - if the detected and the declared base mimetype do not match
Retrieves the local Organization resources by searching for the managing Organization of the
- local Endpoint resources. The local Endpoint resource is identified by the DSF FHIR server
- address configured for the DSF BPE server.
-
-
Returns:
-
Managing Organization for the Endpoint resource with address equal to the DSF FHIR server
- base address configured for this DSF BPE, empty Optional if no such resource exists
DSF organization identifier from the local Organization resource, empty Optional if no
- such resource exists or the Organization does not have a DSF organization identifier
DSF organization identifier value from the local Organization resource, empty Optional if
- no such resource exists or the Organization does not have a DSF organization identifier
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier, empty List if no parent organization found,
- parent has no participating organizations configured via OrganizationAffiliation resources or the
- given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given DSF parentOrganizationIdentifierValue, empty List if no parent organization
- found, parent has no participating organizations configured via OrganizationAffiliation resources
- or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier and role equal to the given
- memberOrganizationRole, empty List if no parent organization found, parent has no
- participating organizations configured via OrganizationAffiliation resources with the given role
- or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
- with the given parentOrganizationIdentifier and role equal to the given
- memberOrganizationRole, empty List if no parent organization found, parent has no
- participating organizations configured via OrganizationAffiliation resources with the given role
- or the given identifier is null
Retrieves the local Organization resources by searching for the managing Organization of the
+ local Endpoint resources. The local Endpoint resource is identified by the DSF FHIR server
+ address configured for the DSF BPE server.
+
+
Returns:
+
Managing Organization for the Endpoint resource with address equal to the DSF FHIR server
+ base address configured for this DSF BPE, empty Optional if no such resource exists
DSF organization identifier from the local Organization resource, empty Optional if no
+ such resource exists or the Organization does not have a DSF organization identifier
DSF organization identifier value from the local Organization resource, empty Optional if
+ no such resource exists or the Organization does not have a DSF organization identifier
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier, empty List if no parent organization found,
+ parent has no participating organizations configured via OrganizationAffiliation resources or the
+ given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given DSF parentOrganizationIdentifierValue, empty List if no parent organization
+ found, parent has no participating organizations configured via OrganizationAffiliation resources
+ or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier and role equal to the given
+ memberOrganizationRole, empty List if no parent organization found, parent has no
+ participating organizations configured via OrganizationAffiliation resources with the given role
+ or the given identifier is null
Active Organizations configured as participatingOrganization for an active parent Organization
+ with the given parentOrganizationIdentifier and role equal to the given
+ memberOrganizationRole, empty List if no parent organization found, parent has no
+ participating organizations configured via OrganizationAffiliation resources with the given role
+ or the given identifier is null
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
-
-
Parameters:
-
resource - may be null
-
Returns:
-
false if given resource is null or resource not valid
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
-
Parameters:
-
resource - may be null
-
organizationWithIdentifierExists - not null
-
roleExists - not null
-
Returns:
-
false if given resource is null or resource not valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
+
+
Parameters:
+
resource - may be null
+
Returns:
+
false if given resource is null or resource not valid
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+
Parameters:
+
resource - may be null
+
organizationWithIdentifierExists - not null
+
roleExists - not null
+
Returns:
+
false if given resource is null or resource not valid
A correlationKey should be used if return messages i.e. Task resources from multiple organizations
- with the same message-name are expected in a following multi instance message receive task or intermediate
- message catch event in a multi instance subprocess.
- Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
- message receive task or intermediate message catch event of a subprocess before incoming messages i.e. Task
- resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with
- name: BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and
- value: ${target.correlationKey}.
-
- A correlationKey should also be used when sending a message i.e. Task resource back to an
- organization waiting for multiple returns.
A correlationKey should be used if return messages i.e. Task resources from multiple organizations
+ with the same message-name are expected in a following multi instance message receive task or intermediate
+ message catch event in a multi instance subprocess.
+ Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
+ message receive task or intermediate message catch event of a subprocess before incoming messages i.e. Task
+ resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with
+ name: BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and
+ value: ${target.correlationKey}.
+
+ A correlationKey should also be used when sending a message i.e. Task resource back to an
+ organization waiting for multiple returns.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
Provides methods for:
-
- Creating and using RSA and ECDH key encapsulation mechanism
- Reading X509 certificates and private-keys (encrypted or not encrypted)
- Reading JKS and PKCS12 key-stores
- Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
- Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
- Validating key-pairs to check if a private-key belongs to a public-key
- Validating certificates
- Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
- and certificate chain
-
Provides methods for:
+
+ Creating and using RSA and ECDH key encapsulation mechanism
+ Reading X509 certificates and private-keys (encrypted or not encrypted)
+ Reading JKS and PKCS12 key-stores
+ Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
+ Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
+ Validating key-pairs to check if a private-key belongs to a public-key
+ Validating certificates
+ Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
+ and certificate chain
+
Provides methods for:
-
- Creating and using RSA and ECDH key encapsulation mechanism
- Reading X509 certificates and private-keys (encrypted or not encrypted)
- Reading JKS and PKCS12 key-stores
- Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
- Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
- Validating key-pairs to check if a private-key belongs to a public-key
- Validating certificates
- Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
- and certificate chain
-
Provides methods for:
+
+ Creating and using RSA and ECDH key encapsulation mechanism
+ Reading X509 certificates and private-keys (encrypted or not encrypted)
+ Reading JKS and PKCS12 key-stores
+ Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
+ Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
+ Validating key-pairs to check if a private-key belongs to a public-key
+ Validating certificates
+ Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
+ and certificate chain
+
- A notnullcorrelationKey should be used if return messages i.e. Task resources
- from multiple organizations with the same message-name are expected in a following multi instance message receive
- task or intermediate message catch event in a multi instance subprocess.
- Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
- message receive task or intermediate message catch event of a subprocess before incoming messages i.e. Task
- resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with name:
- BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and value:
- ${target.correlationKey}.
-
- A notnullcorrelationKey should also be used when sending a message i.e. Task
- resource back to an organization waiting for multiple returns.
-
-
Parameters:
-
organizationIdentifierValue - not null
-
endpointIdentifierValue - not null
-
endpointAddress - not null
-
correlationKey - not null if used for sending multiple messages and multiple messages with the same
- message-name are expected in return
Creates a new target list.
-
- Use${targets.entries}as a multi instance collection andtargetas
- the element variable to loop over this list in a multi instance task or subprocess.
-
-
Parameters:
-
targets - Target objects to incorporate into the created list
-
Returns:
-
a new target list
-
Throws:
-
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
- this Variables implementation
Creates a new target list.
-
- Use${targets.entries}as a multi instance collection andtargetas
- the element variable to loop over this list in a multi instance task or subprocess.
-
-
Parameters:
-
targets - Target objects to incorporate into the created list, may be null
-
Returns:
-
a new target list
-
Throws:
-
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
- this Variables implementation
Does nothing if the given task is null. Forces an update to the Task list variable used
- internally to track all received Task resources if the given task object is already part of this list.
+ A notnullcorrelationKey should be used if return messages i.e. Task resources
+ from multiple organizations with the same message-name are expected in a following multi instance message receive
+ task or intermediate message catch event in a multi instance subprocess.
+ Note: The correlationKey needs to be set as a BpmnExecutionVariables.CORRELATION_KEY variable in the
+ message receive task or intermediate message catch event of a subprocess before incoming messages i.e. Task
+ resources can be correlated. Within a BPMN file this can be accomplished by setting an input variable with name:
+ BpmnExecutionVariables.CORRELATION_KEY, type:string or expression, and value:
+ ${target.correlationKey}.
+
+ A notnullcorrelationKey should also be used when sending a message i.e. Task
+ resource back to an organization waiting for multiple returns.
+
+
Parameters:
+
organizationIdentifierValue - not null
+
endpointIdentifierValue - not null
+
endpointAddress - not null
+
correlationKey - not null if used for sending multiple messages and multiple messages with the same
+ message-name are expected in return
Creates a new target list.
+
+ Use${targets.entries}as a multi instance collection andtargetas
+ the element variable to loop over this list in a multi instance task or subprocess.
+
+
Parameters:
+
targets - Target objects to incorporate into the created list
+
Returns:
+
a new target list
+
Throws:
+
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
+ this Variables implementation
Creates a new target list.
+
+ Use${targets.entries}as a multi instance collection andtargetas
+ the element variable to loop over this list in a multi instance task or subprocess.
+
+
Parameters:
+
targets - Target objects to incorporate into the created list, may be null
+
Returns:
+
a new target list
+
Throws:
+
IllegalArgumentException - if one of the given target objects is not supported, meaning the object was not created by
+ this Variables implementation
Does nothing if the given task is null. Forces an update to the Task list variable used
+ internally to track all received Task resources if the given task object is already part of this list.
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
-Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
-
-
Search
-
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
-The following sections describe the different kinds of pages in this collection.
-
-
Overview
-
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-
Package
-
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
-
-
Interfaces
-
Classes
-
Enum Classes
-
Exception Classes
-
Annotation Interfaces
-
-
-
-
Class or Interface
-
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
-
-
Class Inheritance Diagram
-
Direct Subclasses
-
All Known Subinterfaces
-
All Known Implementing Classes
-
Class or Interface Declaration
-
Class or Interface Description
-
-
-
-
Nested Class Summary
-
Enum Constant Summary
-
Field Summary
-
Property Summary
-
Constructor Summary
-
Method Summary
-
Required Element Summary
-
Optional Element Summary
-
-
-
-
Enum Constant Details
-
Field Details
-
Property Details
-
Constructor Details
-
Method Details
-
Element Details
-
-
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
-
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-
Other Files
-
Packages and modules may contain pages with additional information related to the declarations nearby.
-
-
-
Use
-
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
-
-
-
Tree (Class Hierarchy)
-
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
-
-
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
-
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
-
-
-
All Packages
-
The All Packages page contains an alphabetic index of all packages contained in the documentation.
-
-
-
All Classes and Interfaces
-
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
-
-
-
Index
-
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
-
-
-
-This help file applies to API documentation generated by the standard doclet.
-
-
-
-
-
+
+
+
+
+API Help (DSF BPE Process API v2 2.0.0-M3 API)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
+
+
Search
+
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
+The following sections describe the different kinds of pages in this collection.
+
+
Overview
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+
Interfaces
+
Classes
+
Enum Classes
+
Exception Classes
+
Annotation Interfaces
+
+
+
+
Class or Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+
Class Inheritance Diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class or Interface Declaration
+
Class or Interface Description
+
+
+
+
Nested Class Summary
+
Enum Constant Summary
+
Field Summary
+
Property Summary
+
Constructor Summary
+
Method Summary
+
Required Element Summary
+
Optional Element Summary
+
+
+
+
Enum Constant Details
+
Field Details
+
Property Details
+
Constructor Details
+
Method Details
+
Element Details
+
+
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Other Files
+
Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+
Use
+
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
+
+
+
All Packages
+
The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+
All Classes and Interfaces
+
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
Index
+
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
- waiting process instance if an alternative business-key was created for a communication target.
Override this method to modify the QuestionnaireResponse before it will be created in state
- QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Provides methods for:
-
- Creating and using RSA and ECDH key encapsulation mechanism
- Reading X509 certificates and private-keys (encrypted or not encrypted)
- Reading JKS and PKCS12 key-stores
- Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
- Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
- Validating key-pairs to check if a private-key belongs to a public-key
- Validating certificates
- Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
- and certificate chain
-
When implementations of this interface are registered as singleton Bean, modify methods are called during
- process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection to the local DSF FHIR server.
- Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
- Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
- value (ignoring the # character).
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
-
- Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
- server.
- Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
- an active Endpoint resource and the given fhirServerId as the
- "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
- folder of the process plugin jar needed for a process called testcom_process.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
- if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
- if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType and the input parameter has an extension with the
- given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
- of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
- the input parameter has the given expectedType and the input parameter has an extension with the given
- extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
- value of the input parameter has the given expectedType.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
- to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Checks if the given privateKey and publicKey match by checking if a generated signature can be
- verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
- key pair.
Returns true if the given url is not null and the domain + port of the given
- url is configured as a no-proxy URL based on the environment configuration.
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
-
- Does not check if referenced organizations or roles exist
Resource with access tags valid if:
-
- 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
- or
- 1 ALL tag
-
- All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
- implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
- messageModifier can be used to modify elements of the generated MimeMessage before it is send to
- the SMTP server.
Value of the alternativeBusinessKey variable is used to correlated incoming Task resource to a
+ waiting process instance if an alternative business-key was created for a communication target.
Override this method to modify the QuestionnaireResponse before it will be created in state
+ QuestionnaireResponse.QuestionnaireResponseStatus.INPROGRESS on the DSF FHIR server
Provides methods for:
+
+ Creating and using RSA and ECDH key encapsulation mechanism
+ Reading X509 certificates and private-keys (encrypted or not encrypted)
+ Reading JKS and PKCS12 key-stores
+ Creating JKS and PKCS12 key-stores based on trusted certificates or private-key and certificate chain
+ Generating RSA (4096 bit), EC (secp256r1, secp384r1, secp521r1, X25519, X448) key-pairs
+ Validating key-pairs to check if a private-key belongs to a public-key
+ Validating certificates
+ Creating SSLContexts based on a key-store with trusted certificates and/or a key-store with private-key
+ and certificate chain
+
When implementations of this interface are registered as singleton Bean, modify methods are called during
+ process plugin loading and before the plugin FHIR resource are stored in the DSF FHIR server.
HAPI FHIR client for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection to the local DSF FHIR server.
+ Use #<value> as the fhirServerId for a connection to a DSF FHIR server with an active
+ Endpoint resource and the given fhirServerId as the "http://dsf.dev/sid/endpoint-identifier"
+ value (ignoring the # character).
FHIR client config for a FHIR server configured via YAML with the given fhirServerId.
+
+ Use #local as the fhirServerId for a connection configuration to the local DSF FHIR
+ server.
+ Use #<value> as the fhirServerId for a connection configuration to a DSF FHIR server with
+ an active Endpoint resource and the given fhirServerId as the
+ "http://dsf.dev/sid/endpoint-identifier" value (ignoring the # character).
Return Map.of("testcom_process", List.of("foo.xml")); for a foo.xml file located in the root
+ folder of the process plugin jar needed for a process called testcom_process.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter is of type 'string'.
Returns the first input parameter value from the given task with the given system and code,
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter value from the given task with the given coding (system, code),
+ if the value of the input parameter has the given expectedType.
Returns the first input parameter from the given task with the given system and code, if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the first input parameter from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType and the input parameter has an extension with the
+ given extensionUrl.
Returns the input parameters from the given task with the given coding (system, code), if the value
+ of the input parameter has the given expectedType.
Returns input parameters from the given task with the given system and code, if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameters from the given task with the given coding (system, code), if the value of
+ the input parameter has the given expectedType and the input parameter has an extension with the given
+ extensionUrl.
Returns input parameter values from the given task with the given coding (system, code), if the
+ value of the input parameter has the given expectedType.
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Logs the given Exception, updates all received Task resource with Task.TaskStatus.INPROGRESS
+ to Task.TaskStatus.FAILED and adds a Task.TaskOutputComponent of type CodeSystems.BpmnMessage.error().
Checks if the given privateKey and publicKey match by checking if a generated signature can be
+ verified for RSA, EC and EdDSA key pairs or a Diffie-Hellman key agreement produces the same secret key for a XDH
+ key pair.
Returns true if the given url is not null and the domain + port of the given
+ url is configured as a no-proxy URL based on the environment configuration.
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
+
+ Does not check if referenced organizations or roles exist
Resource with access tags valid if:
+
+ 1 LOCAL tag and n {ORGANIZATION, ROLE} tags (n >= 0)
+ or
+ 1 ALL tag
+
+ All tags {LOCAL, ORGANIZATION, ROLE, ALL} valid
A provider configuration file named "dev.dsf.ProcessPluginDefinition" containing the canonical name of the class
+ implementing this interface needs to be part of the process plugin at "/META-INF/services/".
Sends the given MimeBodyPart as content of a mail to the BPE wide configured recipients, the
+ messageModifier can be used to modify elements of the generated MimeMessage before it is send to
+ the SMTP server.
The help page provides an introduction to the scope and syntax of JavaDoc search.
-
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
-
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
The help page provides an introduction to the scope and syntax of JavaDoc search.
+
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
+
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
+link
+
+
+
+
+
Loading search index...
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/src/.vuepress/public/assets/javadoc/api-v2/search.js b/docs/src/.vuepress/public/assets/javadoc/api-v2/search.js
index bd1a8e072..d3986705e 100644
--- a/docs/src/.vuepress/public/assets/javadoc/api-v2/search.js
+++ b/docs/src/.vuepress/public/assets/javadoc/api-v2/search.js
@@ -1,458 +1,458 @@
-/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-"use strict";
-const messages = {
- enterTerm: "Enter a search term",
- noResult: "No results found",
- oneResult: "Found one result",
- manyResults: "Found {0} results",
- loading: "Loading search index...",
- searching: "Searching...",
- redirecting: "Redirecting to first result...",
- linkIcon: "Link icon",
- linkToSection: "Link to this section"
-}
-const categories = {
- modules: "Modules",
- packages: "Packages",
- types: "Classes and Interfaces",
- members: "Members",
- searchTags: "Search Tags"
-};
-const highlight = "$&";
-const NO_MATCH = {};
-const MAX_RESULTS = 300;
-function checkUnnamed(name, separator) {
- return name === "" || !name ? "" : name + separator;
-}
-function escapeHtml(str) {
- return str.replace(//g, ">");
-}
-function getHighlightedText(str, boundaries, from, to) {
- var start = from;
- var text = "";
- for (var i = 0; i < boundaries.length; i += 2) {
- var b0 = boundaries[i];
- var b1 = boundaries[i + 1];
- if (b0 >= to || b1 <= from) {
- continue;
- }
- text += escapeHtml(str.slice(start, Math.max(start, b0)));
- text += "";
- text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1)));
- text += "";
- start = Math.min(to, b1);
- }
- text += escapeHtml(str.slice(start, to));
- return text;
-}
-function getURLPrefix(item, category) {
- var urlPrefix = "";
- var slash = "/";
- if (category === "modules") {
- return item.l + slash;
- } else if (category === "packages" && item.m) {
- return item.m + slash;
- } else if (category === "types" || category === "members") {
- if (item.m) {
- urlPrefix = item.m + slash;
- } else {
- $.each(packageSearchIndex, function(index, it) {
- if (it.m && item.p === it.l) {
- urlPrefix = it.m + slash;
- }
- });
- }
- }
- return urlPrefix;
-}
-function getURL(item, category) {
- if (item.url) {
- return item.url;
- }
- var url = getURLPrefix(item, category);
- if (category === "modules") {
- url += "module-summary.html";
- } else if (category === "packages") {
- if (item.u) {
- url = item.u;
- } else {
- url += item.l.replace(/\./g, '/') + "/package-summary.html";
- }
- } else if (category === "types") {
- if (item.u) {
- url = item.u;
- } else {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html";
- }
- } else if (category === "members") {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#";
- if (item.u) {
- url += item.u;
- } else {
- url += item.l;
- }
- } else if (category === "searchTags") {
- url += item.u;
- }
- item.url = url;
- return url;
-}
-function createMatcher(term, camelCase) {
- if (camelCase && !isUpperCase(term)) {
- return null; // no need for camel-case matcher for lower case query
- }
- var pattern = "";
- var upperCase = [];
- term.trim().split(/\s+/).forEach(function(w, index, array) {
- var tokens = w.split(/(?=[A-Z,.()<>?[\/])/);
- for (var i = 0; i < tokens.length; i++) {
- var s = tokens[i];
- // ',' and '?' are the only delimiters commonly followed by space in java signatures
- pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")";
- upperCase.push(false);
- var isWordToken = /\w$/.test(s);
- if (isWordToken) {
- if (i === tokens.length - 1 && index < array.length - 1) {
- // space in query string matches all delimiters
- pattern += "(.*?)";
- upperCase.push(isUpperCase(s[0]));
- } else {
- if (!camelCase && isUpperCase(s) && s.length === 1) {
- pattern += "()";
- } else {
- pattern += "([a-z0-9$<>?[\\]]*?)";
- }
- upperCase.push(isUpperCase(s[0]));
- }
- } else {
- pattern += "()";
- upperCase.push(false);
- }
- }
- });
- var re = new RegExp(pattern, "gi");
- re.upperCase = upperCase;
- return re;
-}
-function findMatch(matcher, input, startOfName, endOfName) {
- var from = startOfName;
- matcher.lastIndex = from;
- var match = matcher.exec(input);
- // Expand search area until we get a valid result or reach the beginning of the string
- while (!match || match.index + match[0].length < startOfName || endOfName < match.index) {
- if (from === 0) {
- return NO_MATCH;
- }
- from = input.lastIndexOf(".", from - 2) + 1;
- matcher.lastIndex = from;
- match = matcher.exec(input);
- }
- var boundaries = [];
- var matchEnd = match.index + match[0].length;
- var score = 5;
- var start = match.index;
- var prevEnd = -1;
- for (var i = 1; i < match.length; i += 2) {
- var isUpper = isUpperCase(input[start]);
- var isMatcherUpper = matcher.upperCase[i];
- // capturing groups come in pairs, match and non-match
- boundaries.push(start, start + match[i].length);
- // make sure groups are anchored on a left word boundary
- var prevChar = input[start - 1] || "";
- var nextChar = input[start + 1] || "";
- if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) {
- if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) {
- score -= 0.1;
- } else if (isMatcherUpper && start === prevEnd) {
- score -= isUpper ? 0.1 : 1.0;
- } else {
- return NO_MATCH;
- }
- }
- prevEnd = start + match[i].length;
- start += match[i].length + match[i + 1].length;
-
- // lower score for parts of the name that are missing
- if (match[i + 1] && prevEnd < endOfName) {
- score -= rateNoise(match[i + 1]);
- }
- }
- // lower score if a type name contains unmatched camel-case parts
- if (input[matchEnd - 1] !== "." && endOfName > matchEnd)
- score -= rateNoise(input.slice(matchEnd, endOfName));
- score -= rateNoise(input.slice(0, Math.max(startOfName, match.index)));
-
- if (score <= 0) {
- return NO_MATCH;
- }
- return {
- input: input,
- score: score,
- boundaries: boundaries
- };
-}
-function isUpperCase(s) {
- return s !== s.toLowerCase();
-}
-function isLowerCase(s) {
- return s !== s.toUpperCase();
-}
-function rateNoise(str) {
- return (str.match(/([.(])/g) || []).length / 5
- + (str.match(/([A-Z]+)/g) || []).length / 10
- + str.length / 20;
-}
-function doSearch(request, response) {
- var term = request.term.trim();
- var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
- var matcher = {
- plainMatcher: createMatcher(term, false),
- camelCaseMatcher: createMatcher(term, true)
- }
- var indexLoaded = indexFilesLoaded();
-
- function getPrefix(item, category) {
- switch (category) {
- case "packages":
- return checkUnnamed(item.m, "/");
- case "types":
- return checkUnnamed(item.p, ".");
- case "members":
- return checkUnnamed(item.p, ".") + item.c + ".";
- default:
- return "";
- }
- }
- function useQualifiedName(category) {
- switch (category) {
- case "packages":
- return /[\s/]/.test(term);
- case "types":
- case "members":
- return /[\s.]/.test(term);
- default:
- return false;
- }
- }
- function searchIndex(indexArray, category) {
- var matches = [];
- if (!indexArray) {
- if (!indexLoaded) {
- matches.push({ l: messages.loading, category: category });
- }
- return matches;
- }
- $.each(indexArray, function (i, item) {
- var prefix = getPrefix(item, category);
- var simpleName = item.l;
- var qualifiedName = prefix + simpleName;
- var useQualified = useQualifiedName(category);
- var input = useQualified ? qualifiedName : simpleName;
- var startOfName = useQualified ? prefix.length : 0;
- var endOfName = category === "members" && input.indexOf("(", startOfName) > -1
- ? input.indexOf("(", startOfName) : input.length;
- var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName);
- if (m === NO_MATCH && matcher.camelCaseMatcher) {
- m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName);
- }
- if (m !== NO_MATCH) {
- m.indexItem = item;
- m.prefix = prefix;
- m.category = category;
- if (!useQualified) {
- m.input = qualifiedName;
- m.boundaries = m.boundaries.map(function(b) {
- return b + prefix.length;
- });
- }
- matches.push(m);
- }
- return true;
- });
- return matches.sort(function(e1, e2) {
- return e2.score - e1.score;
- }).slice(0, maxResults);
- }
-
- var result = searchIndex(moduleSearchIndex, "modules")
- .concat(searchIndex(packageSearchIndex, "packages"))
- .concat(searchIndex(typeSearchIndex, "types"))
- .concat(searchIndex(memberSearchIndex, "members"))
- .concat(searchIndex(tagSearchIndex, "searchTags"));
-
- if (!indexLoaded) {
- updateSearchResults = function() {
- doSearch(request, response);
- }
- } else {
- updateSearchResults = function() {};
- }
- response(result);
-}
-// JQuery search menu implementation
-$.widget("custom.catcomplete", $.ui.autocomplete, {
- _create: function() {
- this._super();
- this.widget().menu("option", "items", "> .result-item");
- // workaround for search result scrolling
- this.menu._scrollIntoView = function _scrollIntoView( item ) {
- var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight;
- if ( this._hasScroll() ) {
- borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0;
- paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0;
- offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop;
- scroll = this.activeMenu.scrollTop();
- elementHeight = this.activeMenu.height() - 26;
- itemHeight = item.outerHeight();
-
- if ( offset < 0 ) {
- this.activeMenu.scrollTop( scroll + offset );
- } else if ( offset + itemHeight > elementHeight ) {
- this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight );
- }
- }
- };
- },
- _renderMenu: function(ul, items) {
- var currentCategory = "";
- var widget = this;
- widget.menu.bindings = $();
- $.each(items, function(index, item) {
- if (item.category && item.category !== currentCategory) {
- ul.append("
Returns the enum constant of this class with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this class. (Extraneous whitespace characters are
-not permitted.)
-
-
Parameters:
-
name - the name of the enum constant to be returned.
Returns the enum constant of this class with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this class. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
public static record CertificateGenerator.CertificationRequestConfig(BiFunction<de.hsheilbronn.mi.utils.crypto.ca.CertificateAuthority,de.hsheilbronn.mi.utils.crypto.ca.CertificationRequest,X509Certificate> signer, String commonName, List<String> dnsNames)
-extends Record
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
public static record CertificateGenerator.CertificationRequestConfig(BiFunction<de.hsheilbronn.mi.utils.crypto.ca.CertificateAuthority,de.hsheilbronn.mi.utils.crypto.ca.CertificationRequest,X509Certificate> signer, String commonName, List<String> dnsNames)
+extends Record
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
-Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
-
-
Search
-
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
-The following sections describe the different kinds of pages in this collection.
-
-
Overview
-
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-
Package
-
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
-
-
Interfaces
-
Classes
-
Enum Classes
-
Exception Classes
-
Annotation Interfaces
-
-
-
-
Class or Interface
-
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
-
-
Class Inheritance Diagram
-
Direct Subclasses
-
All Known Subinterfaces
-
All Known Implementing Classes
-
Class or Interface Declaration
-
Class or Interface Description
-
-
-
-
Nested Class Summary
-
Enum Constant Summary
-
Field Summary
-
Property Summary
-
Constructor Summary
-
Method Summary
-
Required Element Summary
-
Optional Element Summary
-
-
-
-
Enum Constant Details
-
Field Details
-
Property Details
-
Constructor Details
-
Method Details
-
Element Details
-
-
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
-
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-
Other Files
-
Packages and modules may contain pages with additional information related to the declarations nearby.
-
-
-
Use
-
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
-
-
-
Tree (Class Hierarchy)
-
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
-
-
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
-
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
-
-
-
All Packages
-
The All Packages page contains an alphabetic index of all packages contained in the documentation.
-
-
-
All Classes and Interfaces
-
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
-
-
-
Index
-
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
-
-
-
-This help file applies to API documentation generated by the standard doclet.
-
-
+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
+
+
Search
+
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
+The following sections describe the different kinds of pages in this collection.
+
+
Overview
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+
Interfaces
+
Classes
+
Enum Classes
+
Exception Classes
+
Annotation Interfaces
+
+
+
+
Class or Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+
Class Inheritance Diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class or Interface Declaration
+
Class or Interface Description
+
+
+
+
Nested Class Summary
+
Enum Constant Summary
+
Field Summary
+
Property Summary
+
Constructor Summary
+
Method Summary
+
Required Element Summary
+
Optional Element Summary
+
+
+
+
Enum Constant Details
+
Field Details
+
Property Details
+
Constructor Details
+
Method Details
+
Element Details
+
+
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Other Files
+
Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+
Use
+
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
+
+
+
All Packages
+
The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+
All Classes and Interfaces
+
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
Index
+
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
The help page provides an introduction to the scope and syntax of JavaDoc search.
-
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
-
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
The help page provides an introduction to the scope and syntax of JavaDoc search.
+
You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
+
The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
+link
+
+
+
+
+
Loading search index...
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/src/.vuepress/public/assets/javadoc/maven-plugin/search.js b/docs/src/.vuepress/public/assets/javadoc/maven-plugin/search.js
index bd1a8e072..d3986705e 100644
--- a/docs/src/.vuepress/public/assets/javadoc/maven-plugin/search.js
+++ b/docs/src/.vuepress/public/assets/javadoc/maven-plugin/search.js
@@ -1,458 +1,458 @@
-/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-"use strict";
-const messages = {
- enterTerm: "Enter a search term",
- noResult: "No results found",
- oneResult: "Found one result",
- manyResults: "Found {0} results",
- loading: "Loading search index...",
- searching: "Searching...",
- redirecting: "Redirecting to first result...",
- linkIcon: "Link icon",
- linkToSection: "Link to this section"
-}
-const categories = {
- modules: "Modules",
- packages: "Packages",
- types: "Classes and Interfaces",
- members: "Members",
- searchTags: "Search Tags"
-};
-const highlight = "$&";
-const NO_MATCH = {};
-const MAX_RESULTS = 300;
-function checkUnnamed(name, separator) {
- return name === "" || !name ? "" : name + separator;
-}
-function escapeHtml(str) {
- return str.replace(//g, ">");
-}
-function getHighlightedText(str, boundaries, from, to) {
- var start = from;
- var text = "";
- for (var i = 0; i < boundaries.length; i += 2) {
- var b0 = boundaries[i];
- var b1 = boundaries[i + 1];
- if (b0 >= to || b1 <= from) {
- continue;
- }
- text += escapeHtml(str.slice(start, Math.max(start, b0)));
- text += "";
- text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1)));
- text += "";
- start = Math.min(to, b1);
- }
- text += escapeHtml(str.slice(start, to));
- return text;
-}
-function getURLPrefix(item, category) {
- var urlPrefix = "";
- var slash = "/";
- if (category === "modules") {
- return item.l + slash;
- } else if (category === "packages" && item.m) {
- return item.m + slash;
- } else if (category === "types" || category === "members") {
- if (item.m) {
- urlPrefix = item.m + slash;
- } else {
- $.each(packageSearchIndex, function(index, it) {
- if (it.m && item.p === it.l) {
- urlPrefix = it.m + slash;
- }
- });
- }
- }
- return urlPrefix;
-}
-function getURL(item, category) {
- if (item.url) {
- return item.url;
- }
- var url = getURLPrefix(item, category);
- if (category === "modules") {
- url += "module-summary.html";
- } else if (category === "packages") {
- if (item.u) {
- url = item.u;
- } else {
- url += item.l.replace(/\./g, '/') + "/package-summary.html";
- }
- } else if (category === "types") {
- if (item.u) {
- url = item.u;
- } else {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html";
- }
- } else if (category === "members") {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#";
- if (item.u) {
- url += item.u;
- } else {
- url += item.l;
- }
- } else if (category === "searchTags") {
- url += item.u;
- }
- item.url = url;
- return url;
-}
-function createMatcher(term, camelCase) {
- if (camelCase && !isUpperCase(term)) {
- return null; // no need for camel-case matcher for lower case query
- }
- var pattern = "";
- var upperCase = [];
- term.trim().split(/\s+/).forEach(function(w, index, array) {
- var tokens = w.split(/(?=[A-Z,.()<>?[\/])/);
- for (var i = 0; i < tokens.length; i++) {
- var s = tokens[i];
- // ',' and '?' are the only delimiters commonly followed by space in java signatures
- pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")";
- upperCase.push(false);
- var isWordToken = /\w$/.test(s);
- if (isWordToken) {
- if (i === tokens.length - 1 && index < array.length - 1) {
- // space in query string matches all delimiters
- pattern += "(.*?)";
- upperCase.push(isUpperCase(s[0]));
- } else {
- if (!camelCase && isUpperCase(s) && s.length === 1) {
- pattern += "()";
- } else {
- pattern += "([a-z0-9$<>?[\\]]*?)";
- }
- upperCase.push(isUpperCase(s[0]));
- }
- } else {
- pattern += "()";
- upperCase.push(false);
- }
- }
- });
- var re = new RegExp(pattern, "gi");
- re.upperCase = upperCase;
- return re;
-}
-function findMatch(matcher, input, startOfName, endOfName) {
- var from = startOfName;
- matcher.lastIndex = from;
- var match = matcher.exec(input);
- // Expand search area until we get a valid result or reach the beginning of the string
- while (!match || match.index + match[0].length < startOfName || endOfName < match.index) {
- if (from === 0) {
- return NO_MATCH;
- }
- from = input.lastIndexOf(".", from - 2) + 1;
- matcher.lastIndex = from;
- match = matcher.exec(input);
- }
- var boundaries = [];
- var matchEnd = match.index + match[0].length;
- var score = 5;
- var start = match.index;
- var prevEnd = -1;
- for (var i = 1; i < match.length; i += 2) {
- var isUpper = isUpperCase(input[start]);
- var isMatcherUpper = matcher.upperCase[i];
- // capturing groups come in pairs, match and non-match
- boundaries.push(start, start + match[i].length);
- // make sure groups are anchored on a left word boundary
- var prevChar = input[start - 1] || "";
- var nextChar = input[start + 1] || "";
- if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) {
- if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) {
- score -= 0.1;
- } else if (isMatcherUpper && start === prevEnd) {
- score -= isUpper ? 0.1 : 1.0;
- } else {
- return NO_MATCH;
- }
- }
- prevEnd = start + match[i].length;
- start += match[i].length + match[i + 1].length;
-
- // lower score for parts of the name that are missing
- if (match[i + 1] && prevEnd < endOfName) {
- score -= rateNoise(match[i + 1]);
- }
- }
- // lower score if a type name contains unmatched camel-case parts
- if (input[matchEnd - 1] !== "." && endOfName > matchEnd)
- score -= rateNoise(input.slice(matchEnd, endOfName));
- score -= rateNoise(input.slice(0, Math.max(startOfName, match.index)));
-
- if (score <= 0) {
- return NO_MATCH;
- }
- return {
- input: input,
- score: score,
- boundaries: boundaries
- };
-}
-function isUpperCase(s) {
- return s !== s.toLowerCase();
-}
-function isLowerCase(s) {
- return s !== s.toUpperCase();
-}
-function rateNoise(str) {
- return (str.match(/([.(])/g) || []).length / 5
- + (str.match(/([A-Z]+)/g) || []).length / 10
- + str.length / 20;
-}
-function doSearch(request, response) {
- var term = request.term.trim();
- var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
- var matcher = {
- plainMatcher: createMatcher(term, false),
- camelCaseMatcher: createMatcher(term, true)
- }
- var indexLoaded = indexFilesLoaded();
-
- function getPrefix(item, category) {
- switch (category) {
- case "packages":
- return checkUnnamed(item.m, "/");
- case "types":
- return checkUnnamed(item.p, ".");
- case "members":
- return checkUnnamed(item.p, ".") + item.c + ".";
- default:
- return "";
- }
- }
- function useQualifiedName(category) {
- switch (category) {
- case "packages":
- return /[\s/]/.test(term);
- case "types":
- case "members":
- return /[\s.]/.test(term);
- default:
- return false;
- }
- }
- function searchIndex(indexArray, category) {
- var matches = [];
- if (!indexArray) {
- if (!indexLoaded) {
- matches.push({ l: messages.loading, category: category });
- }
- return matches;
- }
- $.each(indexArray, function (i, item) {
- var prefix = getPrefix(item, category);
- var simpleName = item.l;
- var qualifiedName = prefix + simpleName;
- var useQualified = useQualifiedName(category);
- var input = useQualified ? qualifiedName : simpleName;
- var startOfName = useQualified ? prefix.length : 0;
- var endOfName = category === "members" && input.indexOf("(", startOfName) > -1
- ? input.indexOf("(", startOfName) : input.length;
- var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName);
- if (m === NO_MATCH && matcher.camelCaseMatcher) {
- m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName);
- }
- if (m !== NO_MATCH) {
- m.indexItem = item;
- m.prefix = prefix;
- m.category = category;
- if (!useQualified) {
- m.input = qualifiedName;
- m.boundaries = m.boundaries.map(function(b) {
- return b + prefix.length;
- });
- }
- matches.push(m);
- }
- return true;
- });
- return matches.sort(function(e1, e2) {
- return e2.score - e1.score;
- }).slice(0, maxResults);
- }
-
- var result = searchIndex(moduleSearchIndex, "modules")
- .concat(searchIndex(packageSearchIndex, "packages"))
- .concat(searchIndex(typeSearchIndex, "types"))
- .concat(searchIndex(memberSearchIndex, "members"))
- .concat(searchIndex(tagSearchIndex, "searchTags"));
-
- if (!indexLoaded) {
- updateSearchResults = function() {
- doSearch(request, response);
- }
- } else {
- updateSearchResults = function() {};
- }
- response(result);
-}
-// JQuery search menu implementation
-$.widget("custom.catcomplete", $.ui.autocomplete, {
- _create: function() {
- this._super();
- this.widget().menu("option", "items", "> .result-item");
- // workaround for search result scrolling
- this.menu._scrollIntoView = function _scrollIntoView( item ) {
- var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight;
- if ( this._hasScroll() ) {
- borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0;
- paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0;
- offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop;
- scroll = this.activeMenu.scrollTop();
- elementHeight = this.activeMenu.height() - 26;
- itemHeight = item.outerHeight();
-
- if ( offset < 0 ) {
- this.activeMenu.scrollTop( scroll + offset );
- } else if ( offset + itemHeight > elementHeight ) {
- this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight );
- }
- }
- };
- },
- _renderMenu: function(ul, items) {
- var currentCategory = "";
- var widget = this;
- widget.menu.bindings = $();
- $.each(items, function(index, item) {
- if (item.category && item.category !== currentCategory) {
- ul.append("
+
+
diff --git a/docs/src/.vuepress/public/assets/javadoc/maven-plugin/stylesheet.css b/docs/src/.vuepress/public/assets/javadoc/maven-plugin/stylesheet.css
index 96c6c2ecd..f71489f86 100644
--- a/docs/src/.vuepress/public/assets/javadoc/maven-plugin/stylesheet.css
+++ b/docs/src/.vuepress/public/assets/javadoc/maven-plugin/stylesheet.css
@@ -1,1272 +1,1272 @@
-/*
- * Javadoc style sheet
- */
-
-@import url('resources/fonts/dejavu.css');
-
-/*
- * These CSS custom properties (variables) define the core color and font
- * properties used in this stylesheet.
- */
-:root {
- /* body, block and code fonts */
- --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
- --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
- --code-font-family: 'DejaVu Sans Mono', monospace;
- /* Base font sizes for body and code elements */
- --body-font-size: 14px;
- --code-font-size: 14px;
- /* Text colors for body and block elements */
- --body-text-color: #353833;
- --block-text-color: #474747;
- /* Background colors for various structural elements */
- --body-background-color: #ffffff;
- --section-background-color: #f8f8f8;
- --detail-background-color: #ffffff;
- /* Colors for navigation bar and table captions */
- --navbar-background-color: #4D7A97;
- --navbar-text-color: #ffffff;
- /* Background color for subnavigation and various headers */
- --subnav-background-color: #dee3e9;
- /* Background and text colors for selected tabs and navigation items */
- --selected-background-color: #f8981d;
- --selected-text-color: #253441;
- --selected-link-color: #1f389c;
- /* Background colors for generated tables */
- --even-row-color: #ffffff;
- --odd-row-color: #eeeeef;
- /* Text color for page title */
- --title-color: #2c4557;
- /* Text colors for links */
- --link-color: #4A6782;
- --link-color-active: #bb7a2a;
- /* Snippet colors */
- --snippet-background-color: #ebecee;
- --snippet-text-color: var(--block-text-color);
- --snippet-highlight-color: #f7c590;
- /* Border colors for structural elements and user defined tables */
- --border-color: #ededed;
- --table-border-color: #000000;
- /* Search input colors */
- --search-input-background-color: #ffffff;
- --search-input-text-color: #000000;
- --search-input-placeholder-color: #909090;
- /* Highlight color for active search tag target */
- --search-tag-highlight-color: #ffff00;
- /* Adjustments for icon and active background colors of copy-to-clipboard buttons */
- --copy-icon-brightness: 100%;
- --copy-button-background-color-active: rgba(168, 168, 176, 0.3);
- /* Colors for invalid tag notifications */
- --invalid-tag-background-color: #ffe6e6;
- --invalid-tag-text-color: #000000;
-}
-/*
- * Styles for individual HTML elements.
- *
- * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
- * HTML element throughout the page.
- */
-body {
- background-color:var(--body-background-color);
- color:var(--body-text-color);
- font-family:var(--body-font-family);
- font-size:var(--body-font-size);
- margin:0;
- padding:0;
- height:100%;
- width:100%;
-}
-iframe {
- margin:0;
- padding:0;
- height:100%;
- width:100%;
- overflow-y:scroll;
- border:none;
-}
-a:link, a:visited {
- text-decoration:none;
- color:var(--link-color);
-}
-a[href]:hover, a[href]:focus {
- text-decoration:none;
- color:var(--link-color-active);
-}
-pre {
- font-family:var(--code-font-family);
- font-size:1em;
-}
-h1 {
- font-size:1.428em;
-}
-h2 {
- font-size:1.285em;
-}
-h3 {
- font-size:1.14em;
-}
-h4 {
- font-size:1.072em;
-}
-h5 {
- font-size:1.001em;
-}
-h6 {
- font-size:0.93em;
-}
-/* Disable font boosting for selected elements */
-h1, h2, h3, h4, h5, h6, div.member-signature {
- max-height: 1000em;
-}
-ul {
- list-style-type:disc;
-}
-code, tt {
- font-family:var(--code-font-family);
-}
-:not(h1, h2, h3, h4, h5, h6) > code,
-:not(h1, h2, h3, h4, h5, h6) > tt {
- font-size:var(--code-font-size);
- padding-top:4px;
- margin-top:8px;
- line-height:1.4em;
-}
-dt code {
- font-family:var(--code-font-family);
- font-size:1em;
- padding-top:4px;
-}
-.summary-table dt code {
- font-family:var(--code-font-family);
- font-size:1em;
- vertical-align:top;
- padding-top:4px;
-}
-sup {
- font-size:8px;
-}
-button {
- font-family: var(--body-font-family);
- font-size: 1em;
-}
-/*
- * Styles for HTML generated by javadoc.
- *
- * These are style classes that are used by the standard doclet to generate HTML documentation.
- */
-
-/*
- * Styles for document title and copyright.
- */
-.about-language {
- float:right;
- padding:0 21px 8px 8px;
- font-size:0.915em;
- margin-top:-9px;
- height:2.9em;
-}
-.legal-copy {
- margin-left:.5em;
-}
-/*
- * Styles for navigation bar.
- */
-@media screen {
- div.flex-box {
- position:fixed;
- display:flex;
- flex-direction:column;
- height: 100%;
- width: 100%;
- }
- header.flex-header {
- flex: 0 0 auto;
- }
- div.flex-content {
- flex: 1 1 auto;
- overflow-y: auto;
- }
-}
-.top-nav {
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
- float:left;
- width:100%;
- clear:right;
- min-height:2.8em;
- padding:10px 0 0 0;
- overflow:hidden;
- font-size:0.857em;
-}
-button#navbar-toggle-button {
- display:none;
-}
-ul.sub-nav-list-small {
- display: none;
-}
-.sub-nav {
- background-color:var(--subnav-background-color);
- float:left;
- width:100%;
- overflow:hidden;
- font-size:0.857em;
-}
-.sub-nav div {
- clear:left;
- float:left;
- padding:6px;
- text-transform:uppercase;
-}
-.sub-nav .sub-nav-list {
- padding-top:4px;
-}
-ul.nav-list {
- display:block;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.sub-nav-list {
- float:left;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.nav-list li {
- list-style:none;
- float:left;
- padding: 5px 6px;
- text-transform:uppercase;
-}
-.sub-nav .nav-list-search {
- float:right;
- margin:0;
- padding:6px;
- clear:none;
- text-align:right;
- position:relative;
-}
-ul.sub-nav-list li {
- list-style:none;
- float:left;
-}
-.top-nav a:link, .top-nav a:active, .top-nav a:visited {
- color:var(--navbar-text-color);
- text-decoration:none;
- text-transform:uppercase;
-}
-.top-nav a:hover {
- color:var(--link-color-active);
-}
-.nav-bar-cell1-rev {
- background-color:var(--selected-background-color);
- color:var(--selected-text-color);
- margin: auto 5px;
-}
-.skip-nav {
- position:absolute;
- top:auto;
- left:-9999px;
- overflow:hidden;
-}
-/*
- * Hide navigation links and search box in print layout
- */
-@media print {
- ul.nav-list, div.sub-nav {
- display:none;
- }
-}
-/*
- * Styles for page header.
- */
-.title {
- color:var(--title-color);
- margin:10px 0;
-}
-.sub-title {
- margin:5px 0 0 0;
-}
-ul.contents-list {
- margin: 0 0 15px 0;
- padding: 0;
- list-style: none;
-}
-ul.contents-list li {
- font-size:0.93em;
-}
-/*
- * Styles for headings.
- */
-body.class-declaration-page .summary h2,
-body.class-declaration-page .details h2,
-body.class-use-page h2,
-body.module-declaration-page .block-list h2 {
- font-style: italic;
- padding:0;
- margin:15px 0;
-}
-body.class-declaration-page .summary h3,
-body.class-declaration-page .details h3,
-body.class-declaration-page .summary .inherited-list h2 {
- background-color:var(--subnav-background-color);
- border:1px solid var(--border-color);
- margin:0 0 6px -8px;
- padding:7px 5px;
-}
-/*
- * Styles for page layout containers.
- */
-main {
- clear:both;
- padding:10px 20px;
- position:relative;
-}
-dl.notes > dt {
- font-family: var(--body-font-family);
- font-size:0.856em;
- font-weight:bold;
- margin:10px 0 0 0;
- color:var(--body-text-color);
-}
-dl.notes > dd {
- margin:5px 10px 10px 0;
- font-size:1em;
- font-family:var(--block-font-family)
-}
-dl.name-value > dt {
- margin-left:1px;
- font-size:1.1em;
- display:inline;
- font-weight:bold;
-}
-dl.name-value > dd {
- margin:0 0 0 1px;
- font-size:1.1em;
- display:inline;
-}
-/*
- * Styles for lists.
- */
-li.circle {
- list-style:circle;
-}
-ul.horizontal li {
- display:inline;
- font-size:0.9em;
-}
-div.inheritance {
- margin:0;
- padding:0;
-}
-div.inheritance div.inheritance {
- margin-left:2em;
-}
-ul.block-list,
-ul.details-list,
-ul.member-list,
-ul.summary-list {
- margin:10px 0 10px 0;
- padding:0;
-}
-ul.block-list > li,
-ul.details-list > li,
-ul.member-list > li,
-ul.summary-list > li {
- list-style:none;
- margin-bottom:15px;
- line-height:1.4;
-}
-ul.ref-list {
- padding:0;
- margin:0;
-}
-ul.ref-list > li {
- list-style:none;
-}
-.summary-table dl, .summary-table dl dt, .summary-table dl dd {
- margin-top:0;
- margin-bottom:1px;
-}
-ul.tag-list, ul.tag-list-long {
- padding-left: 0;
- list-style: none;
-}
-ul.tag-list li {
- display: inline;
-}
-ul.tag-list li:not(:last-child):after,
-ul.tag-list-long li:not(:last-child):after
-{
- content: ", ";
- white-space: pre-wrap;
-}
-ul.preview-feature-list {
- list-style: none;
- margin:0;
- padding:0.1em;
- line-height: 1.6em;
-}
-/*
- * Styles for tables.
- */
-.summary-table, .details-table {
- width:100%;
- border-spacing:0;
- border:1px solid var(--border-color);
- border-top:0;
- padding:0;
-}
-.caption {
- position:relative;
- text-align:left;
- background-repeat:no-repeat;
- color:var(--selected-text-color);
- clear:none;
- overflow:hidden;
- padding: 10px 0 0 1px;
- margin:0;
-}
-.caption a:link, .caption a:visited {
- color:var(--selected-link-color);
-}
-.caption a:hover,
-.caption a:active {
- color:var(--navbar-text-color);
-}
-.caption span {
- font-weight:bold;
- white-space:nowrap;
- padding:5px 12px 7px 12px;
- display:inline-block;
- float:left;
- background-color:var(--selected-background-color);
- border: none;
- height:16px;
-}
-div.table-tabs {
- padding:10px 0 0 1px;
- margin:10px 0 0 0;
-}
-div.table-tabs > button {
- border: none;
- cursor: pointer;
- padding: 5px 12px 7px 12px;
- font-weight: bold;
- margin-right: 8px;
-}
-div.table-tabs > .active-table-tab {
- background: var(--selected-background-color);
- color: var(--selected-text-color);
-}
-div.table-tabs > button.table-tab {
- background: var(--navbar-background-color);
- color: var(--navbar-text-color);
-}
-.two-column-search-results {
- display: grid;
- grid-template-columns: minmax(400px, max-content) minmax(400px, auto);
-}
-div.checkboxes {
- line-height: 2em;
-}
-div.checkboxes > span {
- margin-left: 10px;
-}
-div.checkboxes > label {
- margin-left: 8px;
- white-space: nowrap;
-}
-div.checkboxes > label > input {
- margin: 0 2px;
-}
-.two-column-summary {
- display: grid;
- grid-template-columns: minmax(25%, max-content) minmax(25%, auto);
-}
-.three-column-summary {
- display: grid;
- grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto);
-}
-.three-column-release-summary {
- display: grid;
- grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto);
-}
-.four-column-summary {
- display: grid;
- grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto);
-}
-@media screen and (max-width: 1000px) {
- .four-column-summary {
- display: grid;
- grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
- }
-}
-@media screen and (max-width: 800px) {
- .two-column-search-results {
- display: grid;
- grid-template-columns: minmax(40%, max-content) minmax(40%, auto);
- }
- .three-column-summary {
- display: grid;
- grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
- }
- .three-column-release-summary {
- display: grid;
- grid-template-columns: minmax(70%, max-content) minmax(30%, max-content)
- }
- .three-column-summary .col-last,
- .three-column-release-summary .col-last{
- grid-column-end: span 2;
- }
-}
-@media screen and (max-width: 600px) {
- .two-column-summary {
- display: grid;
- grid-template-columns: 1fr;
- }
-}
-.summary-table > div, .details-table > div {
- text-align:left;
- padding: 8px 3px 3px 7px;
- overflow-x: auto;
- scrollbar-width: thin;
-}
-.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
- vertical-align:top;
- padding-right:0;
- padding-top:8px;
- padding-bottom:3px;
-}
-.table-header {
- background:var(--subnav-background-color);
- font-weight: bold;
-}
-/* Sortable table columns */
-.table-header[onclick] {
- cursor: pointer;
-}
-.table-header[onclick]::after {
- content:"";
- display:inline-block;
- background-image:url('data:image/svg+xml; utf8, \
- ');
- background-size:100% 100%;
- width:9px;
- height:14px;
- margin-left:4px;
- margin-bottom:-3px;
-}
-.table-header[onclick].sort-asc::after {
- background-image:url('data:image/svg+xml; utf8, \
- ');
-
-}
-.table-header[onclick].sort-desc::after {
- background-image:url('data:image/svg+xml; utf8, \
- ');
-}
-.col-first, .col-first {
- font-size:0.93em;
-}
-.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
- font-size:0.93em;
-}
-.col-first, .col-second, .col-constructor-name {
- vertical-align:top;
- overflow: auto;
-}
-.col-last {
- white-space:normal;
-}
-.col-first a:link, .col-first a:visited,
-.col-second a:link, .col-second a:visited,
-.col-first a:link, .col-first a:visited,
-.col-second a:link, .col-second a:visited,
-.col-constructor-name a:link, .col-constructor-name a:visited,
-.col-summary-item-name a:link, .col-summary-item-name a:visited {
- font-weight:bold;
-}
-.even-row-color, .even-row-color .table-header {
- background-color:var(--even-row-color);
-}
-.odd-row-color, .odd-row-color .table-header {
- background-color:var(--odd-row-color);
-}
-/*
- * Styles for contents.
- */
-div.block {
- font-size:var(--body-font-size);
- font-family:var(--block-font-family);
-}
-.col-last div {
- padding-top:0;
-}
-.col-last a {
- padding-bottom:3px;
-}
-.module-signature,
-.package-signature,
-.type-signature,
-.member-signature {
- font-family:var(--code-font-family);
- font-size:1em;
- margin:14px 0;
- white-space: pre-wrap;
-}
-.module-signature,
-.package-signature,
-.type-signature {
- margin-top: 0;
-}
-.member-signature .type-parameters-long,
-.member-signature .parameters,
-.member-signature .exceptions {
- display: inline-block;
- vertical-align: top;
- white-space: pre;
-}
-.member-signature .type-parameters {
- white-space: normal;
-}
-/*
- * Styles for formatting effect.
- */
-.source-line-no {
- /* Color of line numbers in source pages can be set via custom property below */
- color:var(--source-linenumber-color, green);
- padding:0 30px 0 0;
-}
-.block {
- display:block;
- margin:0 10px 5px 0;
- color:var(--block-text-color);
-}
-.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link,
-.module-label-in-package, .module-label-in-type, .package-label-in-type,
-.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
- font-weight:bold;
-}
-.deprecation-comment, .help-footnote, .preview-comment {
- font-style:italic;
-}
-.deprecation-block {
- font-size:1em;
- font-family:var(--block-font-family);
- border-style:solid;
- border-width:thin;
- border-radius:10px;
- padding:10px;
- margin-bottom:10px;
- margin-right:10px;
- display:inline-block;
-}
-.preview-block {
- font-size:1em;
- font-family:var(--block-font-family);
- border-style:solid;
- border-width:thin;
- border-radius:10px;
- padding:10px;
- margin-bottom:10px;
- margin-right:10px;
- display:inline-block;
-}
-div.block div.deprecation-comment {
- font-style:normal;
-}
-details.invalid-tag, span.invalid-tag {
- font-size:1em;
- font-family:var(--block-font-family);
- color: var(--invalid-tag-text-color);
- background: var(--invalid-tag-background-color);
- border: thin solid var(--table-border-color);
- border-radius:2px;
- padding: 2px 4px;
- display:inline-block;
-}
-details summary {
- cursor: pointer;
-}
-/*
- * Styles specific to HTML5 elements.
- */
-main, nav, header, footer, section {
- display:block;
-}
-/*
- * Styles for javadoc search.
- */
-.ui-state-active {
- /* Overrides the color of selection used in jQuery UI */
- background: var(--selected-background-color);
- border: 1px solid var(--selected-background-color);
- color: var(--selected-text-color);
-}
-.ui-autocomplete-category {
- font-weight:bold;
- font-size:15px;
- padding:7px 0 7px 3px;
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
-}
-.ui-autocomplete {
- max-height:85%;
- max-width:65%;
- overflow-y:auto;
- overflow-x:auto;
- scrollbar-width: thin;
- white-space:nowrap;
- box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
-}
-ul.ui-autocomplete {
- position:fixed;
- z-index:1;
- background-color: var(--body-background-color);
-}
-ul.ui-autocomplete li {
- float:left;
- clear:both;
- min-width:100%;
-}
-ul.ui-autocomplete li.ui-static-link {
- position:sticky;
- bottom:0;
- left:0;
- background: var(--subnav-background-color);
- padding: 5px 0;
- font-family: var(--body-font-family);
- font-size: 0.93em;
- font-weight: bolder;
- z-index: 2;
-}
-li.ui-static-link a, li.ui-static-link a:visited {
- text-decoration:none;
- color:var(--link-color);
- float:right;
- margin-right:20px;
-}
-.ui-autocomplete .result-item {
- font-size: inherit;
-}
-.ui-autocomplete .result-highlight {
- font-weight:bold;
-}
-#search-input, #page-search-input {
- background-image:url('resources/glass.png');
- background-size:13px;
- background-repeat:no-repeat;
- background-position:2px 3px;
- background-color: var(--search-input-background-color);
- color: var(--search-input-text-color);
- border-color: var(--border-color);
- padding-left:20px;
- width: 250px;
- margin: 0;
-}
-#search-input {
- margin-left: 4px;
-}
-#reset-button {
- background-color: transparent;
- background-image:url('resources/x.png');
- background-repeat:no-repeat;
- background-size:contain;
- border:0;
- border-radius:0;
- width:12px;
- height:12px;
- position:absolute;
- right:12px;
- top:10px;
- font-size:0;
-}
-::placeholder {
- color:var(--search-input-placeholder-color);
- opacity: 1;
-}
-.search-tag-desc-result {
- font-style:italic;
- font-size:11px;
-}
-.search-tag-holder-result {
- font-style:italic;
- font-size:12px;
-}
-.search-tag-result:target {
- background-color:var(--search-tag-highlight-color);
-}
-details.page-search-details {
- display: inline-block;
-}
-div#result-container {
- font-size: 1em;
-}
-div#result-container a.search-result-link {
- padding: 0;
- margin: 4px 0;
- width: 100%;
-}
-#result-container .result-highlight {
- font-weight:bolder;
-}
-.page-search-info {
- background-color: var(--subnav-background-color);
- border-radius: 3px;
- border: 0 solid var(--border-color);
- padding: 0 8px;
- overflow: hidden;
- height: 0;
- transition: all 0.2s ease;
-}
-div.table-tabs > button.table-tab {
- background: var(--navbar-background-color);
- color: var(--navbar-text-color);
-}
-.page-search-header {
- padding: 5px 12px 7px 12px;
- font-weight: bold;
- margin-right: 3px;
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
- display: inline-block;
-}
-button.page-search-header {
- border: none;
- cursor: pointer;
-}
-span#page-search-link {
- text-decoration: underline;
-}
-.module-graph span, .sealed-graph span {
- display:none;
- position:absolute;
-}
-.module-graph:hover span, .sealed-graph:hover span {
- display:block;
- margin: -100px 0 0 100px;
- z-index: 1;
-}
-.inherited-list {
- margin: 10px 0 10px 0;
-}
-section.class-description {
- line-height: 1.4;
-}
-.summary section[class$="-summary"], .details section[class$="-details"],
-.class-uses .detail, .serialized-class-details {
- padding: 0 20px 5px 10px;
- border: 1px solid var(--border-color);
- background-color: var(--section-background-color);
-}
-.inherited-list, section[class$="-details"] .detail {
- padding:0 0 5px 8px;
- background-color:var(--detail-background-color);
- border:none;
-}
-.vertical-separator {
- padding: 0 5px;
-}
-ul.help-section-list {
- margin: 0;
-}
-ul.help-subtoc > li {
- display: inline-block;
- padding-right: 5px;
- font-size: smaller;
-}
-ul.help-subtoc > li::before {
- content: "\2022" ;
- padding-right:2px;
-}
-.help-note {
- font-style: italic;
-}
-/*
- * Indicator icon for external links.
- */
-main a[href*="://"]::after {
- content:"";
- display:inline-block;
- background-image:url('data:image/svg+xml; utf8, \
- ');
- background-size:100% 100%;
- width:7px;
- height:7px;
- margin-left:2px;
- margin-bottom:4px;
-}
-main a[href*="://"]:hover::after,
-main a[href*="://"]:focus::after {
- background-image:url('data:image/svg+xml; utf8, \
- ');
-}
-/*
- * Styles for header/section anchor links
- */
-a.anchor-link {
- opacity: 0;
- transition: opacity 0.1s;
-}
-:hover > a.anchor-link {
- opacity: 80%;
-}
-a.anchor-link:hover,
-a.anchor-link:focus-visible,
-a.anchor-link.visible {
- opacity: 100%;
-}
-a.anchor-link > img {
- width: 0.9em;
- height: 0.9em;
-}
-/*
- * Styles for copy-to-clipboard buttons
- */
-button.copy {
- opacity: 70%;
- border: none;
- border-radius: 3px;
- position: relative;
- background:none;
- transition: opacity 0.3s;
- cursor: pointer;
-}
-:hover > button.copy {
- opacity: 80%;
-}
-button.copy:hover,
-button.copy:active,
-button.copy:focus-visible,
-button.copy.visible {
- opacity: 100%;
-}
-button.copy img {
- position: relative;
- background: none;
- filter: brightness(var(--copy-icon-brightness));
-}
-button.copy:active {
- background-color: var(--copy-button-background-color-active);
-}
-button.copy span {
- color: var(--body-text-color);
- position: relative;
- top: -0.1em;
- transition: all 0.1s;
- font-size: 0.76rem;
- line-height: 1.2em;
- opacity: 0;
-}
-button.copy:hover span,
-button.copy:focus-visible span,
-button.copy.visible span {
- opacity: 100%;
-}
-/* search page copy button */
-button#page-search-copy {
- margin-left: 0.4em;
- padding:0.3em;
- top:0.13em;
-}
-button#page-search-copy img {
- width: 1.2em;
- height: 1.2em;
- padding: 0.01em 0;
- top: 0.15em;
-}
-button#page-search-copy span {
- color: var(--body-text-color);
- line-height: 1.2em;
- padding: 0.2em;
- top: -0.18em;
-}
-div.page-search-info:hover button#page-search-copy span {
- opacity: 100%;
-}
-/* snippet copy button */
-button.snippet-copy {
- position: absolute;
- top: 6px;
- right: 6px;
- height: 1.7em;
- padding: 2px;
-}
-button.snippet-copy img {
- width: 18px;
- height: 18px;
- padding: 0.05em 0;
-}
-button.snippet-copy span {
- line-height: 1.2em;
- padding: 0.2em;
- position: relative;
- top: -0.5em;
-}
-div.snippet-container:hover button.snippet-copy span {
- opacity: 100%;
-}
-/*
- * Styles for user-provided tables.
- *
- * borderless:
- * No borders, vertical margins, styled caption.
- * This style is provided for use with existing doc comments.
- * In general, borderless tables should not be used for layout purposes.
- *
- * plain:
- * Plain borders around table and cells, vertical margins, styled caption.
- * Best for small tables or for complex tables for tables with cells that span
- * rows and columns, when the "striped" style does not work well.
- *
- * striped:
- * Borders around the table and vertical borders between cells, striped rows,
- * vertical margins, styled caption.
- * Best for tables that have a header row, and a body containing a series of simple rows.
- */
-
-table.borderless,
-table.plain,
-table.striped {
- margin-top: 10px;
- margin-bottom: 10px;
-}
-table.borderless > caption,
-table.plain > caption,
-table.striped > caption {
- font-weight: bold;
- font-size: smaller;
-}
-table.borderless th, table.borderless td,
-table.plain th, table.plain td,
-table.striped th, table.striped td {
- padding: 2px 5px;
-}
-table.borderless,
-table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
-table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
- border: none;
-}
-table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
- background-color: transparent;
-}
-table.plain {
- border-collapse: collapse;
- border: 1px solid var(--table-border-color);
-}
-table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
- background-color: transparent;
-}
-table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
-table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
- border: 1px solid var(--table-border-color);
-}
-table.striped {
- border-collapse: collapse;
- border: 1px solid var(--table-border-color);
-}
-table.striped > thead {
- background-color: var(--subnav-background-color);
-}
-table.striped > thead > tr > th, table.striped > thead > tr > td {
- border: 1px solid var(--table-border-color);
-}
-table.striped > tbody > tr:nth-child(even) {
- background-color: var(--odd-row-color)
-}
-table.striped > tbody > tr:nth-child(odd) {
- background-color: var(--even-row-color)
-}
-table.striped > tbody > tr > th, table.striped > tbody > tr > td {
- border-left: 1px solid var(--table-border-color);
- border-right: 1px solid var(--table-border-color);
-}
-table.striped > tbody > tr > th {
- font-weight: normal;
-}
-/**
- * Tweak style for small screens.
- */
-@media screen and (max-width: 920px) {
- header.flex-header {
- max-height: 100vh;
- overflow-y: auto;
- }
- div#navbar-top {
- height: 2.8em;
- transition: height 0.35s ease;
- }
- ul.nav-list {
- display: block;
- width: 40%;
- float:left;
- clear: left;
- margin: 10px 0 0 0;
- padding: 0;
- }
- ul.nav-list li {
- float: none;
- padding: 6px;
- margin-left: 10px;
- margin-top: 2px;
- }
- ul.sub-nav-list-small {
- display:block;
- height: 100%;
- width: 50%;
- float: right;
- clear: right;
- background-color: var(--subnav-background-color);
- color: var(--body-text-color);
- margin: 6px 0 0 0;
- padding: 0;
- }
- ul.sub-nav-list-small ul {
- padding-left: 20px;
- }
- ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited {
- color:var(--link-color);
- }
- ul.sub-nav-list-small a:hover {
- color:var(--link-color-active);
- }
- ul.sub-nav-list-small li {
- list-style:none;
- float:none;
- padding: 6px;
- margin-top: 1px;
- text-transform:uppercase;
- }
- ul.sub-nav-list-small > li {
- margin-left: 10px;
- }
- ul.sub-nav-list-small li p {
- margin: 5px 0;
- }
- div#navbar-sub-list {
- display: none;
- }
- .top-nav a:link, .top-nav a:active, .top-nav a:visited {
- display: block;
- }
- button#navbar-toggle-button {
- width: 3.4em;
- height: 2.8em;
- background-color: transparent;
- display: block;
- float: left;
- border: 0;
- margin: 0 10px;
- cursor: pointer;
- font-size: 10px;
- }
- button#navbar-toggle-button .nav-bar-toggle-icon {
- display: block;
- width: 24px;
- height: 3px;
- margin: 1px 0 4px 0;
- border-radius: 2px;
- transition: all 0.1s;
- background-color: var(--navbar-text-color);
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) {
- transform: rotate(45deg);
- transform-origin: 10% 10%;
- width: 26px;
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) {
- opacity: 0;
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) {
- transform: rotate(-45deg);
- transform-origin: 10% 90%;
- width: 26px;
- }
-}
-@media screen and (max-width: 800px) {
- .about-language {
- padding-right: 16px;
- }
- ul.nav-list li {
- margin-left: 5px;
- }
- ul.sub-nav-list-small > li {
- margin-left: 5px;
- }
- main {
- padding: 10px;
- }
- .summary section[class$="-summary"], .details section[class$="-details"],
- .class-uses .detail, .serialized-class-details {
- padding: 0 8px 5px 8px;
- }
- body {
- -webkit-text-size-adjust: none;
- }
-}
-@media screen and (max-width: 400px) {
- .about-language {
- font-size: 10px;
- padding-right: 12px;
- }
-}
-@media screen and (max-width: 400px) {
- .nav-list-search {
- width: 94%;
- }
- #search-input, #page-search-input {
- width: 70%;
- }
-}
-@media screen and (max-width: 320px) {
- .nav-list-search > label {
- display: none;
- }
- .nav-list-search {
- width: 90%;
- }
- #search-input, #page-search-input {
- width: 80%;
- }
-}
-
-pre.snippet {
- background-color: var(--snippet-background-color);
- color: var(--snippet-text-color);
- padding: 10px;
- margin: 12px 0;
- overflow: auto;
- white-space: pre;
-}
-div.snippet-container {
- position: relative;
-}
-@media screen and (max-width: 800px) {
- pre.snippet {
- padding-top: 26px;
- }
- button.snippet-copy {
- top: 4px;
- right: 4px;
- }
-}
-pre.snippet .italic {
- font-style: italic;
-}
-pre.snippet .bold {
- font-weight: bold;
-}
-pre.snippet .highlighted {
- background-color: var(--snippet-highlight-color);
- border-radius: 10%;
-}
+/*
+ * Javadoc style sheet
+ */
+
+@import url('resources/fonts/dejavu.css');
+
+/*
+ * These CSS custom properties (variables) define the core color and font
+ * properties used in this stylesheet.
+ */
+:root {
+ /* body, block and code fonts */
+ --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
+ --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+ --code-font-family: 'DejaVu Sans Mono', monospace;
+ /* Base font sizes for body and code elements */
+ --body-font-size: 14px;
+ --code-font-size: 14px;
+ /* Text colors for body and block elements */
+ --body-text-color: #353833;
+ --block-text-color: #474747;
+ /* Background colors for various structural elements */
+ --body-background-color: #ffffff;
+ --section-background-color: #f8f8f8;
+ --detail-background-color: #ffffff;
+ /* Colors for navigation bar and table captions */
+ --navbar-background-color: #4D7A97;
+ --navbar-text-color: #ffffff;
+ /* Background color for subnavigation and various headers */
+ --subnav-background-color: #dee3e9;
+ /* Background and text colors for selected tabs and navigation items */
+ --selected-background-color: #f8981d;
+ --selected-text-color: #253441;
+ --selected-link-color: #1f389c;
+ /* Background colors for generated tables */
+ --even-row-color: #ffffff;
+ --odd-row-color: #eeeeef;
+ /* Text color for page title */
+ --title-color: #2c4557;
+ /* Text colors for links */
+ --link-color: #4A6782;
+ --link-color-active: #bb7a2a;
+ /* Snippet colors */
+ --snippet-background-color: #ebecee;
+ --snippet-text-color: var(--block-text-color);
+ --snippet-highlight-color: #f7c590;
+ /* Border colors for structural elements and user defined tables */
+ --border-color: #ededed;
+ --table-border-color: #000000;
+ /* Search input colors */
+ --search-input-background-color: #ffffff;
+ --search-input-text-color: #000000;
+ --search-input-placeholder-color: #909090;
+ /* Highlight color for active search tag target */
+ --search-tag-highlight-color: #ffff00;
+ /* Adjustments for icon and active background colors of copy-to-clipboard buttons */
+ --copy-icon-brightness: 100%;
+ --copy-button-background-color-active: rgba(168, 168, 176, 0.3);
+ /* Colors for invalid tag notifications */
+ --invalid-tag-background-color: #ffe6e6;
+ --invalid-tag-text-color: #000000;
+}
+/*
+ * Styles for individual HTML elements.
+ *
+ * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
+ * HTML element throughout the page.
+ */
+body {
+ background-color:var(--body-background-color);
+ color:var(--body-text-color);
+ font-family:var(--body-font-family);
+ font-size:var(--body-font-size);
+ margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+}
+iframe {
+ margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+ overflow-y:scroll;
+ border:none;
+}
+a:link, a:visited {
+ text-decoration:none;
+ color:var(--link-color);
+}
+a[href]:hover, a[href]:focus {
+ text-decoration:none;
+ color:var(--link-color-active);
+}
+pre {
+ font-family:var(--code-font-family);
+ font-size:1em;
+}
+h1 {
+ font-size:1.428em;
+}
+h2 {
+ font-size:1.285em;
+}
+h3 {
+ font-size:1.14em;
+}
+h4 {
+ font-size:1.072em;
+}
+h5 {
+ font-size:1.001em;
+}
+h6 {
+ font-size:0.93em;
+}
+/* Disable font boosting for selected elements */
+h1, h2, h3, h4, h5, h6, div.member-signature {
+ max-height: 1000em;
+}
+ul {
+ list-style-type:disc;
+}
+code, tt {
+ font-family:var(--code-font-family);
+}
+:not(h1, h2, h3, h4, h5, h6) > code,
+:not(h1, h2, h3, h4, h5, h6) > tt {
+ font-size:var(--code-font-size);
+ padding-top:4px;
+ margin-top:8px;
+ line-height:1.4em;
+}
+dt code {
+ font-family:var(--code-font-family);
+ font-size:1em;
+ padding-top:4px;
+}
+.summary-table dt code {
+ font-family:var(--code-font-family);
+ font-size:1em;
+ vertical-align:top;
+ padding-top:4px;
+}
+sup {
+ font-size:8px;
+}
+button {
+ font-family: var(--body-font-family);
+ font-size: 1em;
+}
+/*
+ * Styles for HTML generated by javadoc.
+ *
+ * These are style classes that are used by the standard doclet to generate HTML documentation.
+ */
+
+/*
+ * Styles for document title and copyright.
+ */
+.about-language {
+ float:right;
+ padding:0 21px 8px 8px;
+ font-size:0.915em;
+ margin-top:-9px;
+ height:2.9em;
+}
+.legal-copy {
+ margin-left:.5em;
+}
+/*
+ * Styles for navigation bar.
+ */
+@media screen {
+ div.flex-box {
+ position:fixed;
+ display:flex;
+ flex-direction:column;
+ height: 100%;
+ width: 100%;
+ }
+ header.flex-header {
+ flex: 0 0 auto;
+ }
+ div.flex-content {
+ flex: 1 1 auto;
+ overflow-y: auto;
+ }
+}
+.top-nav {
+ background-color:var(--navbar-background-color);
+ color:var(--navbar-text-color);
+ float:left;
+ width:100%;
+ clear:right;
+ min-height:2.8em;
+ padding:10px 0 0 0;
+ overflow:hidden;
+ font-size:0.857em;
+}
+button#navbar-toggle-button {
+ display:none;
+}
+ul.sub-nav-list-small {
+ display: none;
+}
+.sub-nav {
+ background-color:var(--subnav-background-color);
+ float:left;
+ width:100%;
+ overflow:hidden;
+ font-size:0.857em;
+}
+.sub-nav div {
+ clear:left;
+ float:left;
+ padding:6px;
+ text-transform:uppercase;
+}
+.sub-nav .sub-nav-list {
+ padding-top:4px;
+}
+ul.nav-list {
+ display:block;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.sub-nav-list {
+ float:left;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.nav-list li {
+ list-style:none;
+ float:left;
+ padding: 5px 6px;
+ text-transform:uppercase;
+}
+.sub-nav .nav-list-search {
+ float:right;
+ margin:0;
+ padding:6px;
+ clear:none;
+ text-align:right;
+ position:relative;
+}
+ul.sub-nav-list li {
+ list-style:none;
+ float:left;
+}
+.top-nav a:link, .top-nav a:active, .top-nav a:visited {
+ color:var(--navbar-text-color);
+ text-decoration:none;
+ text-transform:uppercase;
+}
+.top-nav a:hover {
+ color:var(--link-color-active);
+}
+.nav-bar-cell1-rev {
+ background-color:var(--selected-background-color);
+ color:var(--selected-text-color);
+ margin: auto 5px;
+}
+.skip-nav {
+ position:absolute;
+ top:auto;
+ left:-9999px;
+ overflow:hidden;
+}
+/*
+ * Hide navigation links and search box in print layout
+ */
+@media print {
+ ul.nav-list, div.sub-nav {
+ display:none;
+ }
+}
+/*
+ * Styles for page header.
+ */
+.title {
+ color:var(--title-color);
+ margin:10px 0;
+}
+.sub-title {
+ margin:5px 0 0 0;
+}
+ul.contents-list {
+ margin: 0 0 15px 0;
+ padding: 0;
+ list-style: none;
+}
+ul.contents-list li {
+ font-size:0.93em;
+}
+/*
+ * Styles for headings.
+ */
+body.class-declaration-page .summary h2,
+body.class-declaration-page .details h2,
+body.class-use-page h2,
+body.module-declaration-page .block-list h2 {
+ font-style: italic;
+ padding:0;
+ margin:15px 0;
+}
+body.class-declaration-page .summary h3,
+body.class-declaration-page .details h3,
+body.class-declaration-page .summary .inherited-list h2 {
+ background-color:var(--subnav-background-color);
+ border:1px solid var(--border-color);
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+/*
+ * Styles for page layout containers.
+ */
+main {
+ clear:both;
+ padding:10px 20px;
+ position:relative;
+}
+dl.notes > dt {
+ font-family: var(--body-font-family);
+ font-size:0.856em;
+ font-weight:bold;
+ margin:10px 0 0 0;
+ color:var(--body-text-color);
+}
+dl.notes > dd {
+ margin:5px 10px 10px 0;
+ font-size:1em;
+ font-family:var(--block-font-family)
+}
+dl.name-value > dt {
+ margin-left:1px;
+ font-size:1.1em;
+ display:inline;
+ font-weight:bold;
+}
+dl.name-value > dd {
+ margin:0 0 0 1px;
+ font-size:1.1em;
+ display:inline;
+}
+/*
+ * Styles for lists.
+ */
+li.circle {
+ list-style:circle;
+}
+ul.horizontal li {
+ display:inline;
+ font-size:0.9em;
+}
+div.inheritance {
+ margin:0;
+ padding:0;
+}
+div.inheritance div.inheritance {
+ margin-left:2em;
+}
+ul.block-list,
+ul.details-list,
+ul.member-list,
+ul.summary-list {
+ margin:10px 0 10px 0;
+ padding:0;
+}
+ul.block-list > li,
+ul.details-list > li,
+ul.member-list > li,
+ul.summary-list > li {
+ list-style:none;
+ margin-bottom:15px;
+ line-height:1.4;
+}
+ul.ref-list {
+ padding:0;
+ margin:0;
+}
+ul.ref-list > li {
+ list-style:none;
+}
+.summary-table dl, .summary-table dl dt, .summary-table dl dd {
+ margin-top:0;
+ margin-bottom:1px;
+}
+ul.tag-list, ul.tag-list-long {
+ padding-left: 0;
+ list-style: none;
+}
+ul.tag-list li {
+ display: inline;
+}
+ul.tag-list li:not(:last-child):after,
+ul.tag-list-long li:not(:last-child):after
+{
+ content: ", ";
+ white-space: pre-wrap;
+}
+ul.preview-feature-list {
+ list-style: none;
+ margin:0;
+ padding:0.1em;
+ line-height: 1.6em;
+}
+/*
+ * Styles for tables.
+ */
+.summary-table, .details-table {
+ width:100%;
+ border-spacing:0;
+ border:1px solid var(--border-color);
+ border-top:0;
+ padding:0;
+}
+.caption {
+ position:relative;
+ text-align:left;
+ background-repeat:no-repeat;
+ color:var(--selected-text-color);
+ clear:none;
+ overflow:hidden;
+ padding: 10px 0 0 1px;
+ margin:0;
+}
+.caption a:link, .caption a:visited {
+ color:var(--selected-link-color);
+}
+.caption a:hover,
+.caption a:active {
+ color:var(--navbar-text-color);
+}
+.caption span {
+ font-weight:bold;
+ white-space:nowrap;
+ padding:5px 12px 7px 12px;
+ display:inline-block;
+ float:left;
+ background-color:var(--selected-background-color);
+ border: none;
+ height:16px;
+}
+div.table-tabs {
+ padding:10px 0 0 1px;
+ margin:10px 0 0 0;
+}
+div.table-tabs > button {
+ border: none;
+ cursor: pointer;
+ padding: 5px 12px 7px 12px;
+ font-weight: bold;
+ margin-right: 8px;
+}
+div.table-tabs > .active-table-tab {
+ background: var(--selected-background-color);
+ color: var(--selected-text-color);
+}
+div.table-tabs > button.table-tab {
+ background: var(--navbar-background-color);
+ color: var(--navbar-text-color);
+}
+.two-column-search-results {
+ display: grid;
+ grid-template-columns: minmax(400px, max-content) minmax(400px, auto);
+}
+div.checkboxes {
+ line-height: 2em;
+}
+div.checkboxes > span {
+ margin-left: 10px;
+}
+div.checkboxes > label {
+ margin-left: 8px;
+ white-space: nowrap;
+}
+div.checkboxes > label > input {
+ margin: 0 2px;
+}
+.two-column-summary {
+ display: grid;
+ grid-template-columns: minmax(25%, max-content) minmax(25%, auto);
+}
+.three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto);
+}
+.three-column-release-summary {
+ display: grid;
+ grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto);
+}
+.four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto);
+}
+@media screen and (max-width: 1000px) {
+ .four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
+ }
+}
+@media screen and (max-width: 800px) {
+ .two-column-search-results {
+ display: grid;
+ grid-template-columns: minmax(40%, max-content) minmax(40%, auto);
+ }
+ .three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
+ }
+ .three-column-release-summary {
+ display: grid;
+ grid-template-columns: minmax(70%, max-content) minmax(30%, max-content)
+ }
+ .three-column-summary .col-last,
+ .three-column-release-summary .col-last{
+ grid-column-end: span 2;
+ }
+}
+@media screen and (max-width: 600px) {
+ .two-column-summary {
+ display: grid;
+ grid-template-columns: 1fr;
+ }
+}
+.summary-table > div, .details-table > div {
+ text-align:left;
+ padding: 8px 3px 3px 7px;
+ overflow-x: auto;
+ scrollbar-width: thin;
+}
+.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
+ vertical-align:top;
+ padding-right:0;
+ padding-top:8px;
+ padding-bottom:3px;
+}
+.table-header {
+ background:var(--subnav-background-color);
+ font-weight: bold;
+}
+/* Sortable table columns */
+.table-header[onclick] {
+ cursor: pointer;
+}
+.table-header[onclick]::after {
+ content:"";
+ display:inline-block;
+ background-image:url('data:image/svg+xml; utf8, \
+ ');
+ background-size:100% 100%;
+ width:9px;
+ height:14px;
+ margin-left:4px;
+ margin-bottom:-3px;
+}
+.table-header[onclick].sort-asc::after {
+ background-image:url('data:image/svg+xml; utf8, \
+ ');
+
+}
+.table-header[onclick].sort-desc::after {
+ background-image:url('data:image/svg+xml; utf8, \
+ ');
+}
+.col-first, .col-first {
+ font-size:0.93em;
+}
+.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
+ font-size:0.93em;
+}
+.col-first, .col-second, .col-constructor-name {
+ vertical-align:top;
+ overflow: auto;
+}
+.col-last {
+ white-space:normal;
+}
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-constructor-name a:link, .col-constructor-name a:visited,
+.col-summary-item-name a:link, .col-summary-item-name a:visited {
+ font-weight:bold;
+}
+.even-row-color, .even-row-color .table-header {
+ background-color:var(--even-row-color);
+}
+.odd-row-color, .odd-row-color .table-header {
+ background-color:var(--odd-row-color);
+}
+/*
+ * Styles for contents.
+ */
+div.block {
+ font-size:var(--body-font-size);
+ font-family:var(--block-font-family);
+}
+.col-last div {
+ padding-top:0;
+}
+.col-last a {
+ padding-bottom:3px;
+}
+.module-signature,
+.package-signature,
+.type-signature,
+.member-signature {
+ font-family:var(--code-font-family);
+ font-size:1em;
+ margin:14px 0;
+ white-space: pre-wrap;
+}
+.module-signature,
+.package-signature,
+.type-signature {
+ margin-top: 0;
+}
+.member-signature .type-parameters-long,
+.member-signature .parameters,
+.member-signature .exceptions {
+ display: inline-block;
+ vertical-align: top;
+ white-space: pre;
+}
+.member-signature .type-parameters {
+ white-space: normal;
+}
+/*
+ * Styles for formatting effect.
+ */
+.source-line-no {
+ /* Color of line numbers in source pages can be set via custom property below */
+ color:var(--source-linenumber-color, green);
+ padding:0 30px 0 0;
+}
+.block {
+ display:block;
+ margin:0 10px 5px 0;
+ color:var(--block-text-color);
+}
+.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link,
+.module-label-in-package, .module-label-in-type, .package-label-in-type,
+.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
+ font-weight:bold;
+}
+.deprecation-comment, .help-footnote, .preview-comment {
+ font-style:italic;
+}
+.deprecation-block {
+ font-size:1em;
+ font-family:var(--block-font-family);
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
+}
+.preview-block {
+ font-size:1em;
+ font-family:var(--block-font-family);
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
+}
+div.block div.deprecation-comment {
+ font-style:normal;
+}
+details.invalid-tag, span.invalid-tag {
+ font-size:1em;
+ font-family:var(--block-font-family);
+ color: var(--invalid-tag-text-color);
+ background: var(--invalid-tag-background-color);
+ border: thin solid var(--table-border-color);
+ border-radius:2px;
+ padding: 2px 4px;
+ display:inline-block;
+}
+details summary {
+ cursor: pointer;
+}
+/*
+ * Styles specific to HTML5 elements.
+ */
+main, nav, header, footer, section {
+ display:block;
+}
+/*
+ * Styles for javadoc search.
+ */
+.ui-state-active {
+ /* Overrides the color of selection used in jQuery UI */
+ background: var(--selected-background-color);
+ border: 1px solid var(--selected-background-color);
+ color: var(--selected-text-color);
+}
+.ui-autocomplete-category {
+ font-weight:bold;
+ font-size:15px;
+ padding:7px 0 7px 3px;
+ background-color:var(--navbar-background-color);
+ color:var(--navbar-text-color);
+}
+.ui-autocomplete {
+ max-height:85%;
+ max-width:65%;
+ overflow-y:auto;
+ overflow-x:auto;
+ scrollbar-width: thin;
+ white-space:nowrap;
+ box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
+}
+ul.ui-autocomplete {
+ position:fixed;
+ z-index:1;
+ background-color: var(--body-background-color);
+}
+ul.ui-autocomplete li {
+ float:left;
+ clear:both;
+ min-width:100%;
+}
+ul.ui-autocomplete li.ui-static-link {
+ position:sticky;
+ bottom:0;
+ left:0;
+ background: var(--subnav-background-color);
+ padding: 5px 0;
+ font-family: var(--body-font-family);
+ font-size: 0.93em;
+ font-weight: bolder;
+ z-index: 2;
+}
+li.ui-static-link a, li.ui-static-link a:visited {
+ text-decoration:none;
+ color:var(--link-color);
+ float:right;
+ margin-right:20px;
+}
+.ui-autocomplete .result-item {
+ font-size: inherit;
+}
+.ui-autocomplete .result-highlight {
+ font-weight:bold;
+}
+#search-input, #page-search-input {
+ background-image:url('resources/glass.png');
+ background-size:13px;
+ background-repeat:no-repeat;
+ background-position:2px 3px;
+ background-color: var(--search-input-background-color);
+ color: var(--search-input-text-color);
+ border-color: var(--border-color);
+ padding-left:20px;
+ width: 250px;
+ margin: 0;
+}
+#search-input {
+ margin-left: 4px;
+}
+#reset-button {
+ background-color: transparent;
+ background-image:url('resources/x.png');
+ background-repeat:no-repeat;
+ background-size:contain;
+ border:0;
+ border-radius:0;
+ width:12px;
+ height:12px;
+ position:absolute;
+ right:12px;
+ top:10px;
+ font-size:0;
+}
+::placeholder {
+ color:var(--search-input-placeholder-color);
+ opacity: 1;
+}
+.search-tag-desc-result {
+ font-style:italic;
+ font-size:11px;
+}
+.search-tag-holder-result {
+ font-style:italic;
+ font-size:12px;
+}
+.search-tag-result:target {
+ background-color:var(--search-tag-highlight-color);
+}
+details.page-search-details {
+ display: inline-block;
+}
+div#result-container {
+ font-size: 1em;
+}
+div#result-container a.search-result-link {
+ padding: 0;
+ margin: 4px 0;
+ width: 100%;
+}
+#result-container .result-highlight {
+ font-weight:bolder;
+}
+.page-search-info {
+ background-color: var(--subnav-background-color);
+ border-radius: 3px;
+ border: 0 solid var(--border-color);
+ padding: 0 8px;
+ overflow: hidden;
+ height: 0;
+ transition: all 0.2s ease;
+}
+div.table-tabs > button.table-tab {
+ background: var(--navbar-background-color);
+ color: var(--navbar-text-color);
+}
+.page-search-header {
+ padding: 5px 12px 7px 12px;
+ font-weight: bold;
+ margin-right: 3px;
+ background-color:var(--navbar-background-color);
+ color:var(--navbar-text-color);
+ display: inline-block;
+}
+button.page-search-header {
+ border: none;
+ cursor: pointer;
+}
+span#page-search-link {
+ text-decoration: underline;
+}
+.module-graph span, .sealed-graph span {
+ display:none;
+ position:absolute;
+}
+.module-graph:hover span, .sealed-graph:hover span {
+ display:block;
+ margin: -100px 0 0 100px;
+ z-index: 1;
+}
+.inherited-list {
+ margin: 10px 0 10px 0;
+}
+section.class-description {
+ line-height: 1.4;
+}
+.summary section[class$="-summary"], .details section[class$="-details"],
+.class-uses .detail, .serialized-class-details {
+ padding: 0 20px 5px 10px;
+ border: 1px solid var(--border-color);
+ background-color: var(--section-background-color);
+}
+.inherited-list, section[class$="-details"] .detail {
+ padding:0 0 5px 8px;
+ background-color:var(--detail-background-color);
+ border:none;
+}
+.vertical-separator {
+ padding: 0 5px;
+}
+ul.help-section-list {
+ margin: 0;
+}
+ul.help-subtoc > li {
+ display: inline-block;
+ padding-right: 5px;
+ font-size: smaller;
+}
+ul.help-subtoc > li::before {
+ content: "\2022" ;
+ padding-right:2px;
+}
+.help-note {
+ font-style: italic;
+}
+/*
+ * Indicator icon for external links.
+ */
+main a[href*="://"]::after {
+ content:"";
+ display:inline-block;
+ background-image:url('data:image/svg+xml; utf8, \
+ ');
+ background-size:100% 100%;
+ width:7px;
+ height:7px;
+ margin-left:2px;
+ margin-bottom:4px;
+}
+main a[href*="://"]:hover::after,
+main a[href*="://"]:focus::after {
+ background-image:url('data:image/svg+xml; utf8, \
+ ');
+}
+/*
+ * Styles for header/section anchor links
+ */
+a.anchor-link {
+ opacity: 0;
+ transition: opacity 0.1s;
+}
+:hover > a.anchor-link {
+ opacity: 80%;
+}
+a.anchor-link:hover,
+a.anchor-link:focus-visible,
+a.anchor-link.visible {
+ opacity: 100%;
+}
+a.anchor-link > img {
+ width: 0.9em;
+ height: 0.9em;
+}
+/*
+ * Styles for copy-to-clipboard buttons
+ */
+button.copy {
+ opacity: 70%;
+ border: none;
+ border-radius: 3px;
+ position: relative;
+ background:none;
+ transition: opacity 0.3s;
+ cursor: pointer;
+}
+:hover > button.copy {
+ opacity: 80%;
+}
+button.copy:hover,
+button.copy:active,
+button.copy:focus-visible,
+button.copy.visible {
+ opacity: 100%;
+}
+button.copy img {
+ position: relative;
+ background: none;
+ filter: brightness(var(--copy-icon-brightness));
+}
+button.copy:active {
+ background-color: var(--copy-button-background-color-active);
+}
+button.copy span {
+ color: var(--body-text-color);
+ position: relative;
+ top: -0.1em;
+ transition: all 0.1s;
+ font-size: 0.76rem;
+ line-height: 1.2em;
+ opacity: 0;
+}
+button.copy:hover span,
+button.copy:focus-visible span,
+button.copy.visible span {
+ opacity: 100%;
+}
+/* search page copy button */
+button#page-search-copy {
+ margin-left: 0.4em;
+ padding:0.3em;
+ top:0.13em;
+}
+button#page-search-copy img {
+ width: 1.2em;
+ height: 1.2em;
+ padding: 0.01em 0;
+ top: 0.15em;
+}
+button#page-search-copy span {
+ color: var(--body-text-color);
+ line-height: 1.2em;
+ padding: 0.2em;
+ top: -0.18em;
+}
+div.page-search-info:hover button#page-search-copy span {
+ opacity: 100%;
+}
+/* snippet copy button */
+button.snippet-copy {
+ position: absolute;
+ top: 6px;
+ right: 6px;
+ height: 1.7em;
+ padding: 2px;
+}
+button.snippet-copy img {
+ width: 18px;
+ height: 18px;
+ padding: 0.05em 0;
+}
+button.snippet-copy span {
+ line-height: 1.2em;
+ padding: 0.2em;
+ position: relative;
+ top: -0.5em;
+}
+div.snippet-container:hover button.snippet-copy span {
+ opacity: 100%;
+}
+/*
+ * Styles for user-provided tables.
+ *
+ * borderless:
+ * No borders, vertical margins, styled caption.
+ * This style is provided for use with existing doc comments.
+ * In general, borderless tables should not be used for layout purposes.
+ *
+ * plain:
+ * Plain borders around table and cells, vertical margins, styled caption.
+ * Best for small tables or for complex tables for tables with cells that span
+ * rows and columns, when the "striped" style does not work well.
+ *
+ * striped:
+ * Borders around the table and vertical borders between cells, striped rows,
+ * vertical margins, styled caption.
+ * Best for tables that have a header row, and a body containing a series of simple rows.
+ */
+
+table.borderless,
+table.plain,
+table.striped {
+ margin-top: 10px;
+ margin-bottom: 10px;
+}
+table.borderless > caption,
+table.plain > caption,
+table.striped > caption {
+ font-weight: bold;
+ font-size: smaller;
+}
+table.borderless th, table.borderless td,
+table.plain th, table.plain td,
+table.striped th, table.striped td {
+ padding: 2px 5px;
+}
+table.borderless,
+table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
+table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
+ border: none;
+}
+table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
+ background-color: transparent;
+}
+table.plain {
+ border-collapse: collapse;
+ border: 1px solid var(--table-border-color);
+}
+table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
+ background-color: transparent;
+}
+table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
+table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
+ border: 1px solid var(--table-border-color);
+}
+table.striped {
+ border-collapse: collapse;
+ border: 1px solid var(--table-border-color);
+}
+table.striped > thead {
+ background-color: var(--subnav-background-color);
+}
+table.striped > thead > tr > th, table.striped > thead > tr > td {
+ border: 1px solid var(--table-border-color);
+}
+table.striped > tbody > tr:nth-child(even) {
+ background-color: var(--odd-row-color)
+}
+table.striped > tbody > tr:nth-child(odd) {
+ background-color: var(--even-row-color)
+}
+table.striped > tbody > tr > th, table.striped > tbody > tr > td {
+ border-left: 1px solid var(--table-border-color);
+ border-right: 1px solid var(--table-border-color);
+}
+table.striped > tbody > tr > th {
+ font-weight: normal;
+}
+/**
+ * Tweak style for small screens.
+ */
+@media screen and (max-width: 920px) {
+ header.flex-header {
+ max-height: 100vh;
+ overflow-y: auto;
+ }
+ div#navbar-top {
+ height: 2.8em;
+ transition: height 0.35s ease;
+ }
+ ul.nav-list {
+ display: block;
+ width: 40%;
+ float:left;
+ clear: left;
+ margin: 10px 0 0 0;
+ padding: 0;
+ }
+ ul.nav-list li {
+ float: none;
+ padding: 6px;
+ margin-left: 10px;
+ margin-top: 2px;
+ }
+ ul.sub-nav-list-small {
+ display:block;
+ height: 100%;
+ width: 50%;
+ float: right;
+ clear: right;
+ background-color: var(--subnav-background-color);
+ color: var(--body-text-color);
+ margin: 6px 0 0 0;
+ padding: 0;
+ }
+ ul.sub-nav-list-small ul {
+ padding-left: 20px;
+ }
+ ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited {
+ color:var(--link-color);
+ }
+ ul.sub-nav-list-small a:hover {
+ color:var(--link-color-active);
+ }
+ ul.sub-nav-list-small li {
+ list-style:none;
+ float:none;
+ padding: 6px;
+ margin-top: 1px;
+ text-transform:uppercase;
+ }
+ ul.sub-nav-list-small > li {
+ margin-left: 10px;
+ }
+ ul.sub-nav-list-small li p {
+ margin: 5px 0;
+ }
+ div#navbar-sub-list {
+ display: none;
+ }
+ .top-nav a:link, .top-nav a:active, .top-nav a:visited {
+ display: block;
+ }
+ button#navbar-toggle-button {
+ width: 3.4em;
+ height: 2.8em;
+ background-color: transparent;
+ display: block;
+ float: left;
+ border: 0;
+ margin: 0 10px;
+ cursor: pointer;
+ font-size: 10px;
+ }
+ button#navbar-toggle-button .nav-bar-toggle-icon {
+ display: block;
+ width: 24px;
+ height: 3px;
+ margin: 1px 0 4px 0;
+ border-radius: 2px;
+ transition: all 0.1s;
+ background-color: var(--navbar-text-color);
+ }
+ button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) {
+ transform: rotate(45deg);
+ transform-origin: 10% 10%;
+ width: 26px;
+ }
+ button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) {
+ opacity: 0;
+ }
+ button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) {
+ transform: rotate(-45deg);
+ transform-origin: 10% 90%;
+ width: 26px;
+ }
+}
+@media screen and (max-width: 800px) {
+ .about-language {
+ padding-right: 16px;
+ }
+ ul.nav-list li {
+ margin-left: 5px;
+ }
+ ul.sub-nav-list-small > li {
+ margin-left: 5px;
+ }
+ main {
+ padding: 10px;
+ }
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0 8px 5px 8px;
+ }
+ body {
+ -webkit-text-size-adjust: none;
+ }
+}
+@media screen and (max-width: 400px) {
+ .about-language {
+ font-size: 10px;
+ padding-right: 12px;
+ }
+}
+@media screen and (max-width: 400px) {
+ .nav-list-search {
+ width: 94%;
+ }
+ #search-input, #page-search-input {
+ width: 70%;
+ }
+}
+@media screen and (max-width: 320px) {
+ .nav-list-search > label {
+ display: none;
+ }
+ .nav-list-search {
+ width: 90%;
+ }
+ #search-input, #page-search-input {
+ width: 80%;
+ }
+}
+
+pre.snippet {
+ background-color: var(--snippet-background-color);
+ color: var(--snippet-text-color);
+ padding: 10px;
+ margin: 12px 0;
+ overflow: auto;
+ white-space: pre;
+}
+div.snippet-container {
+ position: relative;
+}
+@media screen and (max-width: 800px) {
+ pre.snippet {
+ padding-top: 26px;
+ }
+ button.snippet-copy {
+ top: 4px;
+ right: 4px;
+ }
+}
+pre.snippet .italic {
+ font-style: italic;
+}
+pre.snippet .bold {
+ font-weight: bold;
+}
+pre.snippet .highlighted {
+ background-color: var(--snippet-highlight-color);
+ border-radius: 10%;
+}
diff --git a/docs/src/operations/latest b/docs/src/operations/latest
deleted file mode 120000
index 4e2cea3bb..000000000
--- a/docs/src/operations/latest
+++ /dev/null
@@ -1 +0,0 @@
-v1.8.0
\ No newline at end of file
diff --git a/docs/src/operations/latest b/docs/src/operations/latest
new file mode 100644
index 000000000..4e2cea3bb
--- /dev/null
+++ b/docs/src/operations/latest
@@ -0,0 +1 @@
+v1.8.0
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/common-http-status-codes.md b/docs/src/operations/troubleshooting/common-http-status-codes.md
new file mode 100644
index 000000000..9f3348159
--- /dev/null
+++ b/docs/src/operations/troubleshooting/common-http-status-codes.md
@@ -0,0 +1,9 @@
+---
+title: Common HTTP Status Codes
+icon: support
+---
+
+# 403 Forbidden
+This HTTP status code may be encountered in many different way in the context of the DSF:
+- Process plugin is not installed at FHIR server where the Task resource was posted
+- Client certificate of the FHIR server where the Task resource was posted is invalid
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/connection-refused.md b/docs/src/operations/troubleshooting/connection-refused.md
new file mode 100644
index 000000000..16c201d83
--- /dev/null
+++ b/docs/src/operations/troubleshooting/connection-refused.md
@@ -0,0 +1,4 @@
+---
+title: Connection Refused
+icon: cog
+---
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/connection-timeout.md b/docs/src/operations/troubleshooting/connection-timeout.md
new file mode 100644
index 000000000..84b9d1036
--- /dev/null
+++ b/docs/src/operations/troubleshooting/connection-timeout.md
@@ -0,0 +1,13 @@
+---
+title: Connection Timeout
+icon: time
+---
+
+A connection timeout happens when a connection attempt is made but there is no response from the endpoint in a certain timeframe.
+There are many possible reasons for why this happens:
+- The server is currently down or unreachable due to network configuration
+- The server is under heavy load and thus unresponsive
+- Firewalls might be blocking outgoing connections to the server
+- Arbitrary network issues
+
+If this is happens during the execution of a DSF process, it is recommended to try starting the process again to see if the issue persists. If the issue persists, it is recommended to ensure no firewall settings are blocking the outgoing connection attempt. If this is not the root of the issue, further troubleshooting has to take place that may have to include someone knowledgeable about the process plugin or someone from the team maintaining the server or a combination of both.
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/read-timeout.md b/docs/src/operations/troubleshooting/read-timeout.md
new file mode 100644
index 000000000..b732b01f5
--- /dev/null
+++ b/docs/src/operations/troubleshooting/read-timeout.md
@@ -0,0 +1,12 @@
+---
+title: Read Timeout
+icon: time
+---
+
+A read timeout is a network error that usually happens when a resource is read from a server but the resource takes too long to arrive at the client.
+There are many possible reasons for why this happens:
+- The server unexpectedly went down during transmission
+- The server is under heavy load and unable to process the request in a timely manner
+- Arbitrary network issues
+
+If this is happens during the execution of a DSF process, it is recommended to try starting the process again to see if the issue persists. If the issue persists, further troubleshooting has to take place that may have to include someone knowledgeable about the process plugin or someone from the team maintaining the server or a combination of both.
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/ssl.md b/docs/src/operations/troubleshooting/ssl.md
new file mode 100644
index 000000000..b6e5db3e7
--- /dev/null
+++ b/docs/src/operations/troubleshooting/ssl.md
@@ -0,0 +1,18 @@
+---
+title: SSL
+icon: lock
+---
+
+SSL issues arise if there is a misconfiguration of client/server certificates.
+Client certificates may:
+- Be expired
+- Have an untrusted root
+- Be revoked
+
+Server certificates may:
+- Be expired
+- Have an untrusted root
+- Be revoked
+- Have the wrong host as the subject
+
+It is recommended to use [OpenSSL](https://openssl.org/) for further debugging.
\ No newline at end of file
diff --git a/docs/src/operations/troubleshooting/unknown-host.md b/docs/src/operations/troubleshooting/unknown-host.md
new file mode 100644
index 000000000..9dc7d09ef
--- /dev/null
+++ b/docs/src/operations/troubleshooting/unknown-host.md
@@ -0,0 +1,6 @@
+---
+title: Unknown Host
+icon: question
+---
+
+This error occurs if a host name cannot be mapped to an IP address. Either because of a spelling mistake of the host name or because of DNS problems. If this happens in the context of a DSF process, it is recommended to review the configuration of the process plugin or contact the process plugin's maintainers in case of the former. DNS problems have a wide variety of sources and usually have to be resolved on the side of the sender.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/README.md b/docs/src/process-development/api-v1/README.md
new file mode 100644
index 000000000..66b21f9b4
--- /dev/null
+++ b/docs/src/process-development/api-v1/README.md
@@ -0,0 +1,7 @@
+---
+title: API v1
+icon: code
+---
+## Overview
+- [About API1](description)
+- [Implementation Guide](implementation)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/bpmn/conditions.md b/docs/src/process-development/api-v1/bpmn/conditions.md
index 41447df07..12360366d 100644
--- a/docs/src/process-development/api-v1/bpmn/conditions.md
+++ b/docs/src/process-development/api-v1/bpmn/conditions.md
@@ -3,6 +3,6 @@ title: Conditions
icon: creative
---
-### Conditions
+## Conditions
-[Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) allow you to change the behaviour of BPMN processes during execution. There are two ways you are able to add decision logic to Conditions. The [Camunda Modeler](https://camunda.com/download/modeler/) refers to them as `Type`. You can find them in the ``Condition`` tab of certain BPMN elements. The first one is `Script`. This allows you to add arbitrary complexity to your decisions logic and is rarely used for process plugins. The more common Type is `Expression`. Expressions have the following syntax: `${expression}`. An example of a simple expression would be a boolean condition like `var == true`. For this to work during BPMN process execution, the variable you want to use for the boolean condition must be available in the BPMN process variables before [Sequence Flow](sequence-flow.md) reaches the evaluation of the expression. You can learn more advanced features of Expressions [here](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/).
\ No newline at end of file
+BPMN elements can have a property attached to them which either executes a script or evaluates an expression in order to make a decision. The most common example of this is the [Sequence Flow](./sequence-flow.md) elements following an [Exclusive Gateway](./gateways.md). Each [Sequence Flow](./sequence-flow.md) element will have a condition attached to decide which flow should be pursued. The [Camunda Modeler](https://camunda.com/download/modeler/) distinguishes the two types in the `Type` attribute of the `Condition` tab in a BPMN element. Camunda comes with a GraalVM JavaScript engine but can be extended with other types of scripting engines. See the Camunda documentation on [scripting](https://docs.camunda.org/manual/latest/user-guide/process-engine/scripting/) for more details. Expressions are short boolean evaluations and have the following syntax: `${expression}`. An example of a simple expression would be a condition like `var = true`. For this to work during BPMN process execution, the variable that is used for the boolean condition must be available in the BPMN process variables before the [Sequence Flow](sequence-flow.md) reaches the evaluation of the expression. You can learn more advanced features of Expressions [here](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/).
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/bpmn/gateways.md b/docs/src/process-development/api-v1/bpmn/gateways.md
index 630b26ae0..cbf844bf6 100644
--- a/docs/src/process-development/api-v1/bpmn/gateways.md
+++ b/docs/src/process-development/api-v1/bpmn/gateways.md
@@ -3,14 +3,18 @@ title: Gateways
icon: creative
---
-### Gateways
+## Gateways
-[Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/) allow you to control the [Sequence Flow](sequence-flow.md). Different types of gateways are useful for different scenarios.
+[Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/) allow modelling of decision-based and concurrent workflows. [Exclusive Gateways](#exclusive-gateways) model a decision where one flow gets pursued over other flows. [Event-based Gateways](#event-based-gateways) also model a decision, but are based on events. [Parallel Gateways](#parallel-gateways) model concurrency.
-#### Exclusive Gateways
+### Exclusive Gateways
-[Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) allow you to decide which [Sequence Flow](sequence-flow.md) should be followed based on [conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions). [Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) are not part of the [Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) themselves. You set them through the sequence flow exiting the [Exclusive Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/). In the [Camunda Modeler](https://camunda.com/download/modeler/), you can add conditions to [Sequence Flow](sequence-flow.md) by selecting a [Sequence Flow](sequence-flow.md) and opening the `Condition` tab. You can find more information on how to use Conditions [here](conditions.md).
+[Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) decide which one out of multiple [Sequence Flow](sequence-flow.md) should be followed based on [conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions). [Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) are not part of the [Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) themselves. They are set through the sequence flow exiting the [Exclusive Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/). In the [Camunda Modeler](https://camunda.com/download/modeler/), conditions can be added to [Sequence Flows](sequence-flow.md) by selecting a [Sequence Flow](sequence-flow.md) and opening the `Condition` tab. More information on how to use Conditions can be found in [Conditions](conditions.md).
-#### Event-based Gateway
+### Event-based Gateways
-The [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) allows you model scenarios where you are expecting one out of a number of events to occur.
\ No newline at end of file
+The [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) models a decision in the workflow. But instead of [conditions](./conditions.md), the [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) uses the triggering of an event to decide which [Sequence Flow](sequence-flow.md) to pursue.
+
+### Parallel Gateways
+
+[Parallel Gateways](https://docs.camunda.org/manual/latest/reference/bpmn20/gateways/parallel-gateway/) model concurrent workflows. Their outgoing flows can be joined together again with another [Parallel Gateway](https://docs.camunda.org/manual/latest/reference/bpmn20/gateways/parallel-gateway/). This makes process execution wait for both flows to arrive at the gateway before continuing.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/bpmn/messaging.md b/docs/src/process-development/api-v1/bpmn/messaging.md
index 97d05703b..10657a006 100644
--- a/docs/src/process-development/api-v1/bpmn/messaging.md
+++ b/docs/src/process-development/api-v1/bpmn/messaging.md
@@ -4,21 +4,21 @@ icon: creative
---
-### Messaging
+## Messaging
-In order to enable communication with other lanes, pools or even entirely separate processes you need to be able to exchange information. In BPMN, you can use [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) to model this information exchange. Modeling communication with [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) in the same diagram uses Message Flow. Message Flow is typically represented by a dashed line arrow between BPMN elements with a black (send) or white (receive) envelope icon. The following BPMN collaboration diagram shows message exchange between two processes.
+Enabling communication with other lanes, pools or even entirely separate processes requires the ability to exchange information. In BPMN, [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) are used to model this information exchange. Modeling communication with [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) in the same diagram uses Message Flow. Message Flow is typically represented by a dashed line arrow between BPMN elements with a black (send) or white (receive) envelope icon. The following BPMN collaboration diagram shows message exchange between two processes.
-#### Message Start Event
+### Message Start Event
-[Message Start Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) allow a BPMN process to be started by an incoming message. In the DSF, all BPMN processes are started via messages. Therefore, you will have to include a [Message Start Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) at the beginning of all of your BPMN models.
+[Message Start Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) allow a BPMN process to be started by an incoming message. In the DSF, all BPMN processes are started via messages. Therefore, a [Message Start Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) has to be included at the beginning of all of your BPMN models.
-#### Message Intermediate Throwing Event
+### Message Intermediate Throwing Event
[Message Intermediate Throwing Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-throwing-event) are used to send messages during process execution.
-#### Message Intermediate Catching Event
-[Message Intermediate Catching Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-catching-event) serve as the counterpart to [Message Intermediate Throwing Events](messaging.md#message-intermediate-throwing-event). Use them whenever you expect to receive a message from another process or organization during execution.
+### Message Intermediate Catching Event
+[Message Intermediate Catching Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-catching-event) serve as the counterpart to [Message Intermediate Throwing Events](messaging.md#message-intermediate-throwing-event). Use them whenever it is expected to receive a message from another process or organization during execution.
-#### Message End Event
+### Message End Event
The [Message End Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-end-event) will stop the execution of a BPMN process and finish by sending a message.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/bpmn/sequence-flow.md b/docs/src/process-development/api-v1/bpmn/sequence-flow.md
index 3650cc635..2a248406d 100644
--- a/docs/src/process-development/api-v1/bpmn/sequence-flow.md
+++ b/docs/src/process-development/api-v1/bpmn/sequence-flow.md
@@ -3,5 +3,5 @@ title: Sequence Flow
icon: creative
---
-### Sequence Flow
+## Sequence Flow
BPMN 2.0 calls the continuous arrows connecting the BPMN elements in BPMN models, Sequence Flow. Sequence Flow exits one BPMN element and points at the next BPMN element to be processed.
diff --git a/docs/src/process-development/api-v1/bpmn/service-tasks.md b/docs/src/process-development/api-v1/bpmn/service-tasks.md
index ebe8ad3c9..4128d5a2e 100644
--- a/docs/src/process-development/api-v1/bpmn/service-tasks.md
+++ b/docs/src/process-development/api-v1/bpmn/service-tasks.md
@@ -3,6 +3,6 @@ title: Service Tasks
icon: creative
---
-### Service Tasks
+## Service Tasks
-One of the most common types of BPMN Tasks used for modeling DSF processes is the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/). They are different from regular BPMN Tasks in that they offer the ability to link an implementation to the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/) which can be called and executed by a BPMN engine. The BPE (Business Process Engine) server of the DSF leverages this engine to execute your BPMN processes.
\ No newline at end of file
+One of the most common types of BPMN Tasks used for modeling DSF processes is the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/). They are different from regular BPMN Tasks in that they offer the ability to link an implementation to the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/) which can be called and executed by a BPMN engine. The BPE (Business Process Engine) server of the DSF leverages this engine to execute BPMN processes.
diff --git a/docs/src/process-development/api-v1/bpmn/timer-intermediate-catching-events.md b/docs/src/process-development/api-v1/bpmn/timer-intermediate-catching-events.md
index 49ab4a8fc..ff19cb3a8 100644
--- a/docs/src/process-development/api-v1/bpmn/timer-intermediate-catching-events.md
+++ b/docs/src/process-development/api-v1/bpmn/timer-intermediate-catching-events.md
@@ -3,6 +3,6 @@ title: Timer Intermediate Catching Events
icon: creative
---
-### Timer Intermediate Catching Events
+## Timer Intermediate Catching Events
-A [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event) allows you to model stopwatch behavior. A timer is started once the BPMN execution arrives at the event. The duration until the timer runs out is specified using the [ISO 8601 Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations) format. Examples can be found [here](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#time-duration). After running out, the BPMN process executes the [Sequence Flow](sequence-flow.md) following the [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event).
\ No newline at end of file
+A [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event) allows for modelling stopwatch behavior. A timer is started once the BPMN execution arrives at the event. The duration until the timer runs out is specified using the [ISO 8601 Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations) format. Examples can be found [here](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#time-duration). After running out, the BPMN process executes the [Sequence Flow](sequence-flow.md) following the [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event).
diff --git a/docs/src/process-development/api-v1/bpmn/user-tasks.md b/docs/src/process-development/api-v1/bpmn/user-tasks.md
index 8dda98d17..a34f257f7 100644
--- a/docs/src/process-development/api-v1/bpmn/user-tasks.md
+++ b/docs/src/process-development/api-v1/bpmn/user-tasks.md
@@ -3,6 +3,6 @@ title: User Tasks
icon: creative
---
-### User Tasks
+## User Tasks
-User Tasks define a process step that requires some kind of human interaction. Usually this is done by providing some kind of form the user can fill out. The Camunda Modeler allows to configure these forms as either a propriatary format called [Camunda Forms](https://docs.camunda.io/docs/guides/utilizing-forms/) or custom forms called `Embedded or External Task Forms`. The DSF uses such `External Task Forms` in the form of [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [Questionnaire Response](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources. This mechanism is further expanded upon in [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
\ No newline at end of file
+User Tasks define a process step that requires some kind of human interaction. Usually this is done by providing some kind of form the user can fill out. The Camunda Modeler allows to configure these forms as either a proprietary format called [Camunda Forms](https://docs.camunda.io/docs/guides/utilizing-forms/) or custom forms called `Embedded or External Task Forms`. The DSF uses such `External Task Forms` in the form of [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [Questionnaire Response](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources. This mechanism is further expanded upon in [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
diff --git a/docs/src/process-development/api-v1/concept.md b/docs/src/process-development/api-v1/concept.md
index f983d5e66..02af1c12f 100644
--- a/docs/src/process-development/api-v1/concept.md
+++ b/docs/src/process-development/api-v1/concept.md
@@ -31,6 +31,7 @@ icon: info
- [Requester and Recipient](dsf/requester-and-recipient.md)
- [Service Delegates](dsf/service-delegates.md)
- [Spring Framework Integration](dsf/spring-framework-integration.md)
+- [Target and Targets](dsf/target-and-targets.md)
- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md)
## Guides
diff --git a/docs/src/process-development/api-v1/dsf/bpmn-process-execution.md b/docs/src/process-development/api-v1/dsf/bpmn-process-execution.md
index f711532c9..94a9b04ec 100644
--- a/docs/src/process-development/api-v1/dsf/bpmn-process-execution.md
+++ b/docs/src/process-development/api-v1/dsf/bpmn-process-execution.md
@@ -3,6 +3,6 @@ title: BPMN Process Execution
icon: creative
---
-### BPMN Process Execution
+## BPMN Process Execution
-The BPMN process execution is the in-memory representation of a running BPMN process. BPMN processes have their executions structured as a tree hierarchy. Each BPMN process starts with the [process instance](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-engine-concepts/#process-instances) as its root level execution. If, for example, this root execution reaches a parallel gateway with two paths, it would spawn two child executions under itself for them to process all tasks along their paths on their own. Executions can access all the BPMN elements from the BPMN model as well as the [BPMN process variables](bpmn-process-variables.md). You have access to this representation in your Java code through the `execution` parameter when overriding certain methods in [Service](service-delegates.md) / [Message](message-delegates.md) Delegates like `execute` or `getAdditionalInputParameters` through the `variables` parameter.
\ No newline at end of file
+The BPMN process execution is the in-memory representation of a running BPMN process. BPMN processes have their executions structured as a tree hierarchy. Each BPMN process starts with the [process instance](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-engine-concepts/#process-instances) as its root level execution. If, for example, this root execution reaches a parallel gateway with two paths, it would spawn two child executions under itself for them to process all tasks along their paths on their own. Executions can access all the BPMN elements from the BPMN model as well as the [BPMN process variables](bpmn-process-variables.md). Access to this representation in the Java code is provided through the `execution` parameter when overriding certain methods in [Service](service-delegates.md) / [Message](message-delegates.md) Delegates like `execute` or `getAdditionalInputParameters`.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/dsf/bpmn-process-variables.md b/docs/src/process-development/api-v1/dsf/bpmn-process-variables.md
index 6170e1b1e..cd2baf68e 100644
--- a/docs/src/process-development/api-v1/dsf/bpmn-process-variables.md
+++ b/docs/src/process-development/api-v1/dsf/bpmn-process-variables.md
@@ -3,8 +3,8 @@ title: BPMN Process Variables
icon: creative
---
-### BPMN Process Variables
+## BPMN Process Variables
BPMN process variables hold additional information which has to be available during BPMN process execution. Variables can be directly related to BPMN elements like the boolean value for [Conditions](../bpmn/conditions.md), but do not have to be. BPMN process variables are stored as key-value pairs with the key being the variable name. They are accessible during the entirety of the execution to all [Service](service-delegates.md) / [Message](message-delegates.md) Delegates.
-You can learn how to access to the BPMN process variables [here](../guides/accessing-bpmn-process-variables.md).
\ No newline at end of file
+More information on how to access to the BPMN process variables is found in the guide on accessing [BPMN process variables](../guides/accessing-bpmn-process-variables.md).
diff --git a/docs/src/process-development/api-v1/dsf/draft-task-resources.md b/docs/src/process-development/api-v1/dsf/draft-task-resources.md
index c1bcaa28c..c8ed0e4f4 100644
--- a/docs/src/process-development/api-v1/dsf/draft-task-resources.md
+++ b/docs/src/process-development/api-v1/dsf/draft-task-resources.md
@@ -3,9 +3,9 @@ title: Draft Task Resources
icon: creative
---
-### Draft Task Resources
+## Draft Task Resources
-[Task](../fhir/task.md) resources with status `draft` are used to create the DSF FHIR server's functionality of starting processes via its web interface. They are stored in `.../tutorial-process/src/main/resources/fhir/Task`. Compared to regular [Task](../fhir/task.md) resources used to start BPMN processes, this type of [Task](../fhir/task.md) resource requires the status `draft` instead the usual `requested`. It also replaces the value for `authoredOn` with the placeholder `#{date}`, the values of organization identifiers with the placeholder `#{organization}` and all instances of version numbers with `#{version}`. Additionally, it requires setting the `Task.identifier` element. It should look something like this:
+[Task](../fhir/task.md) resources with status `draft` are used to create the DSF FHIR server's functionality of starting processes via its web interface. They are stored in `.../tutorial-process/src/main/resources/fhir/Task`. Compared to regular [Task](../fhir/task.md) resources used to start BPMN processes, this type of [Task](../fhir/task.md) resource requires the status `draft` instead of the usual `requested`. It also replaces the value for `authoredOn` with the placeholder `#{date}`, the values of organization identifiers with the placeholder `#{organization}` and all instances of version numbers with `#{version}`. Additionally, it requires setting the `Task.identifier` element. It should look something like this:
```xml
@@ -14,8 +14,8 @@ icon: creative
```
`processKey` should be the same one used in [URLs](versions-placeholders-urls.md#urls).
-`task-name` can be any String you wish to identify this task with. E.g. you can use the file name of the Draft Task.
+`task-name` can be any String this task should be identified with. E.g. you can use the file name of the Draft Task.
-For a complete example you can take a look at the Draft Task Resource in one of the solution branches and compare it to the one needed for cURL. The [Task](../fhir/task.md) resource created for cURL can be found at `.../tutorial-process/src/main/resources/example-task.xml`.
+A complete example for a Draft Task Resource can be found in the [Ping Pong Process Plugin](https://github.com/datasharingframework/dsf-process-ping-pong/blob/main/src/main/resources/fhir/Task/dsf-task-start-ping.xml).
-You might also want to check out [this guide](../guides/creating-task-resources-based-on-a-definition.md) if you do not know how to create [Task](../fhir/task.md) resources in general.
\ No newline at end of file
+There is also a [guide for creating task resources based on a StructureDefinition](../guides/creating-task-resources-based-on-a-definition.md) if more information on how to create [Task](../fhir/task.md) resources is required.
diff --git a/docs/src/process-development/api-v1/dsf/environment-variables.md b/docs/src/process-development/api-v1/dsf/environment-variables.md
index fcea6697c..4f0b5bd7e 100644
--- a/docs/src/process-development/api-v1/dsf/environment-variables.md
+++ b/docs/src/process-development/api-v1/dsf/environment-variables.md
@@ -3,8 +3,8 @@ title: Environment Variables
icon: creative
---
-### Environment Variables
+## Environment Variables
-Environment variables offer a way to make configuration data available at the start of a [BPMN process execution](bpmn-process-execution.md). They are the same for all running process instances. They can be defined by adding a member variable with the [Spring-Framework @Value](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-value-annotations) annotation to the configuration class `TutorialConfig`. The value of the annotation uses the `${..}` notation and follows the form `${some.property:defaultValue}`, where each dot in the property name corresponds to an underscore in the equivalent environment variable. Environment variables are always written upper-case. The property `some.property` therefore corresponds to the environment variable `SOME_PROPERTY`.
+Environment variables offer a way to make configuration data available at the start of a [BPMN process execution](bpmn-process-execution.md). They are the same for all running process instances. They can be defined by adding a member variable with the [Spring-Framework @Value](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-value-annotations) annotation to any Spring managed bean. For the DSF, the most prominent are classes annotated with [`@Configuration`](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html). The value of the annotation uses the `${..}` notation and follows the form `${some.property:defaultValue}`, where each dot in the property name corresponds to an underscore in the equivalent environment variable. Environment variables are always written upper-case. The property `some.property` therefore corresponds to the environment variable `SOME_PROPERTY`.
-The DSF provides a feature to automatically generate documentation of environment variables during the Maven build process. You can use the `@ProcessDocumentation` annotation to automatically generate Markdown documentation for all fields with this annotation. You simply have to add [dsf-tools-documentation-generator](https://mvnrepository.com/artifact/dev.dsf/dsf-tools-documentation-generator) as a maven plugin. You can take a look at the `pom.xml` for the `tutorial-process` submodule [here](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/pom.xml) to see how you can add it to your own project. Keep in mind to point the `` field to the package you want documentation for.
\ No newline at end of file
+The DSF provides a feature to automatically generate documentation of environment variables during the Maven build process. The `@ProcessDocumentation` annotation can be used to automatically generate Markdown documentation for all fields with this annotation. This requires adding [dsf-tools-documentation-generator](https://mvnrepository.com/artifact/dev.dsf/dsf-tools-documentation-generator) as a maven plugin. There is an example `pom.xml` for the `tutorial-process` submodule located on [GitHub](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/pom.xml) which uses the maven plugin. The `` field has to point to the package where documentation is desired.
diff --git a/docs/src/process-development/api-v1/dsf/message-correlation.md b/docs/src/process-development/api-v1/dsf/message-correlation.md
index 23b18e3e3..2c7ba5a10 100644
--- a/docs/src/process-development/api-v1/dsf/message-correlation.md
+++ b/docs/src/process-development/api-v1/dsf/message-correlation.md
@@ -3,8 +3,8 @@ title: Message Correlation
icon: creative
---
-### Message Correlation
+## Message Correlation
-In order for messages to be able to be sent back and forth between organizations with potentially multiple of the same process plugin instances running at the same time and still arriving at the correct process instance, we need some mechanism to map messages to their rightful process instance. This mechanism is called Message Correlation and requires attaching a unique identifier to every process instance. This identifier is called the `business-key`. The `business-key` will get attached to every outgoing message automatically.
+In order for messages to be able to be sent back and forth between organizations with potentially multiple of the same process plugin instances running at the same time and still arriving at the correct process instance, some mechanism is needed to map messages to their rightful process instance. This mechanism is called Message Correlation and requires attaching a unique identifier to every process instance. This identifier is called the `business-key`. The `business-key` will get attached to every outgoing message automatically.
-It is possible that the `business-key` is insufficient to map messages to the correct process instance. This happens when you use subprocesses in your BPMN model which all expect messages to be sent to them, not the parent process. To solve this issue, [Task](../fhir/task.md) resources also come with an [Input Parameter](../fhir/task.md#task-input-parameters) called `correlation-key`. This is a secondary identifier you can attach to all messages if you need them to arrive at a specific subprocess. You can learn more about how `correlation-keys` are used by studying the [Ping-Pong Process](https://github.com/datasharingframework/dsf-process-ping-pong).
\ No newline at end of file
+It is possible that the `business-key` is insufficient to map messages to the correct process instance. This happens during subprocesses in your BPMN model which all expect messages to be sent to them, not the parent process. To solve this issue, [Task](../fhir/task.md) resources also come with an [Input Parameter](../fhir/task.md#task-input-parameters) called `correlation-key`. This is a secondary identifier that has to be attached to all messages in order for them to arrive at a specific subprocess. This is done when creating [targets](../dsf/target-and-targets.md#targets) for outgoing messages and requires setting the `correlation-key` as a local variable using the constant `BpmnExecutionVariables.CORRELATION_KEY` before a message is received in the subprocess.
diff --git a/docs/src/process-development/api-v1/dsf/message-delegates.md b/docs/src/process-development/api-v1/dsf/message-delegates.md
index 61a1a06f1..3c95d96a9 100644
--- a/docs/src/process-development/api-v1/dsf/message-delegates.md
+++ b/docs/src/process-development/api-v1/dsf/message-delegates.md
@@ -3,13 +3,17 @@ title: Message Delegates
icon: creative
---
-### Message Delegates
+## Message Delegates
-Message Delegates are the Java representation of the [Message Events](../bpmn/messaging.md) in your BPMN model. You link a Message Delegate to a certain [Message Event](../bpmn/messaging.md) by selecting the Message Event in the [Camunda Modeler](https://camunda.com/download/modeler/) and adding a Java class to the `Implementation` field. Make sure you use the fully qualified class name. Like this:
+Message Delegates are the Java representation of the [Message Events](../bpmn/messaging.md) in a BPMN model. Message Delegates are linked to a certain [Message Event](../bpmn/messaging.md) by selecting the Message Event 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. For example:
```
-org.package.myClass
+org.package.MyClass
```
-You will only need Message Delegates for [Message Send Events](../bpmn/messaging.md). Incoming messages will be resolved to the correct [BPMN process execution](bpmn-process-execution.md) automatically using [Message Correlation](message-correlation.md) and the message inputs will be added to that execution's [process variables](bpmn-process-variables.md).
+Message Delegates are only needed for [Message Send Events](../bpmn/messaging.md). Incoming messages will be resolved to the correct [BPMN process execution](bpmn-process-execution.md) automatically using [Message Correlation](message-correlation.md) and the message inputs will be added to that execution's [process variables](bpmn-process-variables.md).
-To make a Message Delegate for [Message Send Events](../bpmn/messaging.md), your Java class needs to extend `AbstractTaskMessageSend`. Most of the time, you will not be adding any processing logic to your Message Delegates, therefore you usually won't be overwriting the `doExecute` method like with [Service Delegates](service-delegates.md). Instead, you most likely want to aggregate the information you processed in earlier steps and attach it to a message. For this you need to overwrite the `getAdditionalInputParamters` method. The DSF translates BPMN messages into FHIR [Task](../fhir/task.md) resources to execute the communication modeled by your BPMN diagrams. The information you are sending to another BPMN process is specified in the Task.input elements a.k.a. [Input Parameters](../fhir/task.md#task-input-parameters), hence the name of the method. The constructor of your delegate class should also forward a `ProcessPluginApi` instance to its superclass constructor. You can learn more about the `ProcessPluginApi` [here](process-plugin-api.md).
+To make a Message Delegate for [Message Send Events](../bpmn/messaging.md), the Java class needs to extend `AbstractTaskMessageSend`. Most of the time, there will not be any processing logic inside Message Delegates, therefore the `execute` method will not be overridden like with [Service Delegates](../dsf/service-delegates.md). Although there might be cases where this is necessary. Instead, Message Delegates should be used to aggregate previously computed data and attach it to the message. This is done by overriding the `getAdditionalInputParamters` method. The DSF translates BPMN messages into FHIR [Task](../fhir/task.md) resources to execute the communication modeled in BPMN diagrams. The information being sent to another BPMN process is specified in the Task.input elements a.k.a. [Input Parameters](../fhir/task.md#task-input-parameters), hence the name of the method. The constructor of your delegate class should also forward a `ProcessPluginApi` instance to its superclass constructor.
+
+
+## Related Topics
+[Messaging](../bpmn/messaging.md), [Input Parameters](../fhir/task.md#task-input-parameters), [Adding Input Parameter to Task Profiles](../guides/adding-task-input-parameters-to-task-profiles.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/dsf/organization-identifiers.md b/docs/src/process-development/api-v1/dsf/organization-identifiers.md
index 691a551d8..dfb78a204 100644
--- a/docs/src/process-development/api-v1/dsf/organization-identifiers.md
+++ b/docs/src/process-development/api-v1/dsf/organization-identifiers.md
@@ -3,8 +3,11 @@ title: Organization Identifiers
icon: creative
---
-### Organization Identifiers
-DSF FHIR server instances always have something called an `organization identifer`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is configured as an [environment variable](https://dsf.dev/operations/latest/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). You can make a GET request to `https://domain/fhir/Organization` to get a list of all organizations for the DSF FHIR server instance running under `domain`. The results will also include the `organization identifier` of each organization.
+## Organization Identifiers
+DSF FHIR server instances can configure an `organization identifier`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is set as an [environment variable](https://dsf.dev/stable/maintain/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). A GET request to `https://domain/fhir/Organization` will return a list of all organizations for the DSF FHIR server instance running under `domain`. The results will also include the `organization identifier` of each organization.
-#### Organization Identifiers in Task Resources
-[Task](../fhir/task.md) resources require you to reference an organization via its identifier as the `Task.requester` and `Task.restriction.recipient` elements. The exact values for these elements depend on the [ActivityDefinition](../fhir/activitydefinition.md) the [Task](../fhir/task.md) resource should conform to. As a general rule, you will want to put the identifier of your own organization as the `Task.requester` and `Task.restriction.recipient` elements for [Task](../fhir/task.md) resources which initially start processes. All other cases depend on the context of the message being sent during process execution.
\ No newline at end of file
+### Organization Identifiers in Task Resources
+[Task](../fhir/task.md) resources require a reference to an organization via its identifier as the `Task.requester` and `Task.restriction.recipient` elements. The exact values for these elements depend on the [ActivityDefinition](../fhir/activitydefinition.md) the [Task](../fhir/task.md) resource should conform to. As a general rule, the identifier of your own organization should be used as the `Task.requester` and `Task.restriction.recipient` elements for [Task](../fhir/task.md) resources which initially start processes. All other cases depend on the context of the message being sent during process execution. An easy way to generalize this in [Draft Task Resources](draft-task-resources.md) is to use the `#{organization}` [placeholder](versions-placeholders-urls.md#placeholders).
+
+## Related Topics
+[Allow-List](https://dsf.dev/intro/info/allowList.html), [ActivityDefinition](../fhir/activitydefinition.md), [Environment Variables](environment-variables.md), [Requester and Recipient](requester-and-recipient.md), [Task](../fhir/task.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/dsf/process-plugin-api.md b/docs/src/process-development/api-v1/dsf/process-plugin-api.md
index 5d1381a5a..f09d3ef3b 100644
--- a/docs/src/process-development/api-v1/dsf/process-plugin-api.md
+++ b/docs/src/process-development/api-v1/dsf/process-plugin-api.md
@@ -3,9 +3,9 @@ title: Process Plugin API
icon: creative
---
-### Process Plugin API v1 Maven Module
+## Process Plugin API Maven Module
-The [DSF Process Plugin API module](https://mvnrepository.com/artifact/dev.dsf/dsf-bpe-process-api-v1) consists of a set of utility classes designed to provide easy access to solutions for process plugin use cases. This includes for example the `Variables` class, which provides access to the [BPMN process variables](bpmn-process-variables.md).
+The [DSF Process Plugin API module](https://central.sonatype.com/artifact/dev.dsf/dsf-bpe-process-api-v2) consists of a set of utility classes designed to provide easy access to common solutions for process plugin use cases which would otherwise require lots of boilerplate code. An example is the `Variables` class, which provides access to the [BPMN process variables](bpmn-process-variables.md).
Maven Dependency:
@@ -20,9 +20,9 @@ Maven Dependency:
```
-#### Process Plugin Api
-When creating [Service Delegates](service-delegates.md) or [Message Delegates](message-delegates.md) you wil notice that you need to provide a constructor which expects a `ProcessPluginApi` object and forward it to the superclasses' constructor.
-This API instance provides a variety of utility classes:
+### Process Plugin Api
+[Service Delegates](service-delegates.md) or [Message Delegates](message-delegates.md) require a constructor which expects a `ProcessPluginApi` object which is forwarded to the superclasses' constructor. The API instance can then be used when overriding their `execute` and/or `getAdditionalInputParameters` methods.
+It provides the following utility classes:
- `ProxyConfig`**:** forward proxy configuration
- `EndpointProvider`**:** access to Endpoint resources
- `FhirContext`**:** HAPI FHIR Context for parsing/serializing
diff --git a/docs/src/process-development/api-v1/dsf/process-plugin-definition.md b/docs/src/process-development/api-v1/dsf/process-plugin-definition.md
index a13bdbe26..498ae2514 100644
--- a/docs/src/process-development/api-v1/dsf/process-plugin-definition.md
+++ b/docs/src/process-development/api-v1/dsf/process-plugin-definition.md
@@ -3,14 +3,17 @@ title: Process Plugin Definition
icon: creative
---
-### Process Plugin Definition
+## Process Plugin Definition
-In order for the DSF BPE server to load your plugin you need to provide it with the following information:
+In order for the DSF BPE server to load a plugin properly, it needs to provide the following information in what is called the process plugin definition:
* A plugin [version](versions-placeholders-urls.md#version-pattern)
* A release date
* A plugin name
* The BPMN model files
-* The FHIR resources grouped by BPMN process ID. Your plugin may have any number of BPMN models. Each has their own BPMN process ID and FHIR resources specific to that BPMN process (think [Task](../fhir/task.md) resources needed for messages specific to that BPMN model)
-* The Class holding your [Spring Framework Configuration](spring-framework-integration.md)
+* The FHIR resources grouped by BPMN process ID. A plugin may have any number of BPMN models. Each has their own BPMN process ID and FHIR resources specific to that BPMN process (like [Task](../fhir/task.md) resources needed for messages specific to that BPMN model)
+* The Class holding a [Spring Framework Configuration](spring-framework-integration.md)
-You will provide this information by implementing the `dev.dsf.bpe.ProcessPluginDefinition` interface. The DSF BPE server then searches for classes implementing this interface using the Java [ServiceLoader](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ServiceLoader.html) mechanism. Therefore, you will have to register your interface implementation in the `src/main/resources/META-INF/services/dev.dsf.bpe.ProcessPluginDefinition` file. For this tutorial, the class implementing the `ProcessPluginDefinition` interface, `TutorialProcessPluginDefinition`, has already been added to the file. You can use it as a reference for later when you want to create your own plugin.
\ No newline at end of file
+To provide this information, one of the classes in the process plugin has to implement the `dev.dsf.bpe.ProcessPluginDefinition` interface. The DSF BPE server then searches for classes implementing this interface using the Java [ServiceLoader](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ServiceLoader.html) mechanism. Therefore, the class also needs to be registered in the `src/main/resources/META-INF/services/dev.dsf.bpe.ProcessPluginDefinition` file. An example of this can be found in the [process plugin tutorial](https://github.com/datasharingframework/dsf-process-tutorial/).
+
+## Related Topics
+[Spring Integration](spring-framework-integration.md), [Versions, Placeholders and URLs](versions-placeholders-urls.md)
diff --git a/docs/src/process-development/api-v1/dsf/read-access-tag.md b/docs/src/process-development/api-v1/dsf/read-access-tag.md
index 47a02b2c1..90aad4ced 100644
--- a/docs/src/process-development/api-v1/dsf/read-access-tag.md
+++ b/docs/src/process-development/api-v1/dsf/read-access-tag.md
@@ -3,9 +3,9 @@ title: Read Access Tag
icon: creative
---
-### Read Access Tag
+## Read Access Tag
-Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/task.md)) to the DSF FHIR server unless it is your own organization. By default, the same applies to reading FHIR resources (again except [Task](../fhir/task.md)). But since the DSF is often used to offer medical data in form of FHIR resources, you will find yourself wanting other organizations to be allowed to read the resources you are offering. The `Resource.meta.tag` element is used define access rules for all FHIR resources in the DSF, with the exception of [Task](../fhir/task.md) resources. We will explain the reason for this exception shortly. For example, allowing read access for all organizations, you would use the following `system` and `code` in your FHIR resource:
+Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/task.md)) to the DSF FHIR server unless it is the organization running the instance, which is [configurable](https://dsf.dev/operations/latest/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). By default, the same applies to reading FHIR resources (again except [Task](../fhir/task.md)). But since the DSF is often used to offer medical data in form of FHIR resources, other organizations should be allowed to read some of the resources on the DSF FHIR server. The `Resource.meta.tag` element is used define access rules for all FHIR resources in the DSF, with the exception of [Task](../fhir/task.md) resources. For example, allowing read access for all organizations would use the following `system` and `code` in your FHIR resource:
```xml
@@ -15,8 +15,11 @@ Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/
```
-You can find all codes for the Read Access Tag in its [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).
+All codes for the Read Access Tag can be found in its [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).
-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.
+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 a plugin's [ActivityDefinitions](../fhir/activitydefinition.md). Therefore, no `read-access-tag` is needed.
-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).
+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. More information on that can be found in the [guide on configuring the Read Access Tag](../guides/configuring-read-access-tags.md).
+
+## Related Topics
+[Configuring Read Access Tags](../guides/configuring-read-access-tags.md)
diff --git a/docs/src/process-development/api-v1/dsf/requester-and-recipient.md b/docs/src/process-development/api-v1/dsf/requester-and-recipient.md
index 8407bb318..0aa1a7e9d 100644
--- a/docs/src/process-development/api-v1/dsf/requester-and-recipient.md
+++ b/docs/src/process-development/api-v1/dsf/requester-and-recipient.md
@@ -3,11 +3,11 @@ title: Requester and Recipient
icon: creative
---
-### Requester and Recipient Elements
+## Requester and Recipient Elements
-Below you will find a set of examples for each Coding used by `requester` and `recipient` elements from 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). CodeSystems referenced in the examples can be found [here](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem). Use this collection as a reference point when creating your own [ActivityDefinitions](../fhir/activitydefinition.md).
+Below is a set of examples for each Coding used by `requester` and `recipient` elements from 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). CodeSystems referenced in the examples can be found [here](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem). This collection aims to provide a reference point when creating [ActivityDefinitions](../fhir/activitydefinition.md).
-#### Requester
+### Requester
The `requester` element uses one of the following Codings:
```xml
@@ -21,7 +21,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local All
+#### Local All
```xml
@@ -31,7 +31,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local All Practitioner
+#### Local All Practitioner
```xml
@@ -47,7 +47,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Organization
+#### Local Organization
```xml
@@ -63,7 +63,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Organization Practitioner
+#### Local Organization Practitioner
```xml
@@ -87,7 +87,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Parent Organization Role
+#### Local Parent Organization Role
```xml
@@ -111,7 +111,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Parent Organization Role Practitioner
+#### Local Parent Organization Role Practitioner
```xml
@@ -141,7 +141,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote All
+#### Remote All
```xml
@@ -151,7 +151,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote Organization
+#### Remote Organization
```xml
@@ -167,7 +167,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote Parent Organization Role
+#### Remote Parent Organization Role
```xml
@@ -191,7 +191,7 @@ The `requester` element uses one of the following Codings:
```
-#### Recipient
+### Recipient
The `recipeint` element uses one of the following Codings:
```xml
@@ -199,7 +199,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local All
+#### Local All
```xml
@@ -209,7 +209,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local Organization
+#### Local Organization
```xml
@@ -225,7 +225,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local Parent Organization Role
+#### Local Parent Organization Role
```xml
@@ -248,3 +248,7 @@ The `recipeint` element uses one of the following Codings:
```
+
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md)
diff --git a/docs/src/process-development/api-v1/dsf/service-delegates.md b/docs/src/process-development/api-v1/dsf/service-delegates.md
index 278b51e34..09c86ecdb 100644
--- a/docs/src/process-development/api-v1/dsf/service-delegates.md
+++ b/docs/src/process-development/api-v1/dsf/service-delegates.md
@@ -3,10 +3,13 @@ title: Service Delegates
icon: creative
---
-### Service Delegates
+## Service Delegates
-Service Delegates are the Java representation of the [Service Tasks](../bpmn/service-tasks.md) in your BPMN model. You link a Service Delegate 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. Make sure you use the fully qualified class name. Like this:
+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:
```
-org.package.myClass
+org.package.MyClass
```
-All that is left is for your Java class to extend `AbstractServiceDelegate` and override the `doExecute` method. This is the place where you can put your actual business logic. The method will be called when the [BPMN process execution](bpmn-process-execution.md) arrives at the [Service Task](../bpmn/service-tasks.md) your Service Delegate is linked to. The constructor of your delegate class should also forward a `ProcessPluginApi` instance to its superclass constructor. You can learn more about the `ProcessPluginApi` [here](process-plugin-api.md).
\ No newline at end of file
+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).
+
+## Related Topics
+[BPMN Process Execution](../dsf/bpmn-process-execution.md), [Message Delegates](message-delegates.md), [Process Plugin API](process-plugin-api.md), [Service Tasks](../bpmn/service-tasks.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/dsf/spring-framework-integration.md b/docs/src/process-development/api-v1/dsf/spring-framework-integration.md
index 55f96f342..8f6d080f9 100644
--- a/docs/src/process-development/api-v1/dsf/spring-framework-integration.md
+++ b/docs/src/process-development/api-v1/dsf/spring-framework-integration.md
@@ -3,12 +3,62 @@ title: Spring Framework Integration
icon: creative
---
-### Spring Framework Integration
+## Spring Framework Integration
-Since the DSF also employs the use of the [Spring Framework](https://spring.io/projects/spring-framework) you will also have to provide some Spring functionality. When deployed, every process plugin exists in its own [Spring context](https://docs.spring.io/spring-framework/reference/core/beans/introduction.html). To make the process plugin work, you have to provide [Spring Beans](https://docs.spring.io/spring-framework/reference/core/beans/definition.html) with `prototype` [scope](https://docs.spring.io/spring-framework/reference/core/beans/factory-scopes.html) for all classes which either extend or implement the following classes/interfaces (as of version 1.4.0):
+The DSF uses some of the [Spring Framework's](https://spring.io/projects/spring-framework) functionality. When deployed, every process plugin exists in its own [Spring context](https://docs.spring.io/spring-framework/reference/core/beans/introduction.html). Process plugins require [Spring Beans](https://docs.spring.io/spring-framework/reference/core/beans/definition.html) with `prototype` [scope](https://docs.spring.io/spring-framework/reference/core/beans/factory-scopes.html) for all classes which either extend or implement the following classes/interfaces:
- `AbstractTaskMessageSend`
- `AbstractServiceDelegate`
- `DefaultUserTaskListener`
- `ProcessPluginDeploymentStateListener`
-A [Spring-Framework configuration class](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java-basic-concepts) located in `spring/config` is expected to provide the Spring Beans. For this tutorial, the `TutorialConfig` class will take this role. If you are unfamiliar with the Spring Framework, you might want to check out the chapter [Java-based Container Configuration](https://docs.spring.io/spring-framework/reference/core/beans/java.html) of the Spring Framework documentation, specifically the topics [Using the @Bean Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/bean-annotation.html) and [Using the @Configuration Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html).
\ No newline at end of file
+A [Spring-Framework configuration class](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java-basic-concepts) located in the `spring/config` directory is expected to provide the Spring Beans. If you are unfamiliar with the Spring Framework, you can find more information in [Java-based Container Configuration](https://docs.spring.io/spring-framework/reference/core/beans/java.html) of the Spring Framework documentation, specifically the topics [Using the @Bean Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/bean-annotation.html) and [Using the @Configuration Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html).
+
+Below is an example of a Spring configuration class:
+```java
+@Configuration
+public class TutorialConfig
+{
+ @Autowired
+ private ProcessPluginApi api; //instance will be injected at runtime
+
+ @Value("${dev.dsf.process.tutorial.loggingEnabled:false}")
+ @ProcessDocumentation(description = "Set to true to enable logging", required = false, processNames = PROCESS_NAME_FULL_DIC)
+ private boolean loggingEnabled; //environment variable
+
+ @Value("${dev.dsf.process.tutorial.userVote:false}")
+ @ProcessDocumentation(description = "Set to true to enable users to vote", required = false, processNames = PROCESS_NAME_FULL_VOTING_PROCESS)
+ private boolean userVote; //environment variable
+
+ //register classes as prototype beans
+ @Bean
+ @Scope(SCOPE_PROTOTYPE)
+ public DicTask dicTask()
+ {
+ return new DicTask(api, loggingEnabled);
+ }
+
+ @Bean
+ @Scope(SCOPE_PROTOTYPE)
+ public DecideWhetherUserVote decideWhetherUserVote()
+ {
+ return new DecideWhetherUserVote(api, userVote);
+ }
+
+ @Bean
+ @Scope(SCOPE_PROTOTYPE)
+ public HelloCosMessage helloCosMessage()
+ {
+ return new HelloCosMessage(api);
+ }
+
+ @Bean
+ @Scope(SCOPE_PROTOTYPE)
+ public UserVoteListener userVoteListener()
+ {
+ return new UserVoteListener(api);
+ }
+}
+```
+
+## Related Topics
+[Environment Variables](environment-variables.md), [Message Delegates](message-delegates.md), [Service Delegates](service-delegates.md)
diff --git a/docs/src/process-development/api-v1/dsf/target-and-targets.md b/docs/src/process-development/api-v1/dsf/target-and-targets.md
new file mode 100644
index 000000000..8b8df62db
--- /dev/null
+++ b/docs/src/process-development/api-v1/dsf/target-and-targets.md
@@ -0,0 +1,19 @@
+---
+title: Target and Targets
+icon: creative
+---
+
+## Target
+
+A target is a container for all information necessary to send messages to other DSF instances. This information includes:
+- **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`.
+- **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`.
+- **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.
+- **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).
+
+## Targets
+
+Targets is a container class for a collection of [Target](#target) objects. It also provides utility methods for manipulating the underlying collection.
+
+## Related Topics
+[Message Correlation](message-correlation.md), [Setting Targets for Message Events](../guides/setting-targets-for-message-events.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/dsf/versions-placeholders-urls.md b/docs/src/process-development/api-v1/dsf/versions-placeholders-urls.md
index 0381ec629..1fb0ecf0c 100644
--- a/docs/src/process-development/api-v1/dsf/versions-placeholders-urls.md
+++ b/docs/src/process-development/api-v1/dsf/versions-placeholders-urls.md
@@ -3,9 +3,9 @@ title: Versions, Placeholders and URLs
icon: creative
---
-### Versions, Placeholders and URLs
+## Versions, Placeholders and URLs
-#### Version Pattern
+### Version Pattern
Process plugin versions have to obey the pattern:
```
@@ -14,25 +14,28 @@ Process plugin versions have to obey the pattern:
The first two numbers (`1.2`) are used in FHIR resources and signal changes which break compatibility with previous process versions. For example, altering FHIR resources usually results in a breaking change. The latter two (`3.4`) signal changes which do not break compatibility with previous process versions. Specifically, the 4th number is reserved for bug-fixes and the 3rd number includes all other non-breaking changes.
-#### Placeholders
+### Placeholders
To avoid specifying the version and release date in multiple files, the placeholders `#{version}` and `#{date}` can be used within FHIR resources and BPMN models. They are replaced with the values returned by the methods `ProcessPluginDefinition#getResourceVersion` and `ProcessPluginDefinition#getReleaseDate` respectively during deployment of a process plugin by the DSF BPE server. There is also a placeholder for the organization the DSF instance is running in: `#{organization}`, typically use in [Draft Task Resources](draft-task-resources.md).
-#### URLs
+### URLs
-BPMN models have an ID call process definition key. The BPMN process definition key needs to be specified following the pattern:
+BPMN models have an ID called process definition key. The BPMN process definition key needs to be specified following the pattern:
```
^[-a-zA-Z0-9]+_[-a-zA-Z0-9]+$ Example: domainorg_processKey
```
-In addition, the BPMN model needs to specify a version. You should be using the ``#{version}`` [placeholder](#placeholders) for this as well. The DSF will also reference this process in URL form in FHIR resources:
+In addition, the BPMN model needs to specify a version. The `#{version}` [placeholder](#placeholders) should be used for this as well. The DSF will also reference this process in URL form in FHIR resources:
```
http://domain.org/bpe/Process/processKey|1.2
```
-As you can see, the version in the URL ``|1.2`` only uses the resource version and omits the code base version. As mentioned in [Version Pattern](#version-pattern), this means that only changes to the first two version numbers are significant to signal compatibility when communicating with other process plugin instances. The process definition key and URL are also related to each other. The DSF will try to match BPMN models to FHIR resources by transforming the URL into a process definition key. That is why it is important you obey the pattern above.
+The version in the URL `|1.2` only uses the resource version and omits the code base version. As mentioned in [Version Pattern](#version-pattern), this means that only changes to the first two version numbers are significant to signal compatibility when communicating with other process plugin instances. The process definition key and URL are also related to each other. The DSF will try to match BPMN models to FHIR resources by transforming the URL into a process definition key. That is why it is mandatory to follow the pattern above.
-You will use the above URL as your instantiatesCanonical value for [Task](../fhir/task.md) profile definitions as well as references to [Task](../fhir/task.md) profiles in other resources. You will also use it as the URL value for your [ActivityDefinitions](../fhir/activitydefinition.md). In this case though, you have to split up the URL into two parts. You will separate the version (``|1.2``) from the URL and use it as a value for the `ActivityDefinition.version` element. Since it refers to the plugin's resource version, you should also use the `#{version}` [placeholder](#placeholders) here instead. Going by the example from above, you will be left with a URL that looks like this:
+The above URL will be used as the instantiatesCanonical value for [Task](../fhir/task.md) profile definitions as well as references to [Task](../fhir/task.md) profiles in other resources. It is also used as the URL value for [ActivityDefinitions](../fhir/activitydefinition.md). In this case though, the URL has to be split into two parts. The version (`|1.2`) needs to be separated from the URL and used as a value for the `ActivityDefinition.version` element. Since it refers to the plugin's resource version, the `#{version}` [placeholder](#placeholders) should be used here instead. Going by the example from above, the final URL looks like this:
```
http://domain.org/bpe/Process/processKey
```
-This will be the value for your `ActivityDefinition.url` element with `#{version}` as the value for your `ActivityDefinition.version` element.
\ No newline at end of file
+This will be the value for the `ActivityDefinition.url` element with `#{version}` as the value for the `ActivityDefinition.version` element.
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md), [Process Plugin Definition](process-plugin-definition.md)
diff --git a/docs/src/process-development/api-v1/fhir/activitydefinition.md b/docs/src/process-development/api-v1/fhir/activitydefinition.md
index 5cd27ca91..ae4e64c9a 100644
--- a/docs/src/process-development/api-v1/fhir/activitydefinition.md
+++ b/docs/src/process-development/api-v1/fhir/activitydefinition.md
@@ -3,7 +3,7 @@ title: ActivityDefinition
icon: creative
---
-### ActivityDefinition
+## ActivityDefinition
[ActivityDefinitions](http://hl7.org/fhir/R4/activitydefinition.html) are used by the DSF to advertise which processes are available at any given instance and who is allowed to request and who is allowed to execute a process. The DSF defined elements for this purpose in 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.
@@ -16,8 +16,9 @@ The most important elements in ActivityDefinitions are:
The `message-name` element contains the name of the [BPMN message start event](../bpmn/messaging.md#message-start-event) or [BPMN message intermediate catching event](../bpmn/messaging.md#message-intermediate-catching-event) which expects a [Task](task.md) resource complying to the profile defined by `task-profile`.
-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.
+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. A list of examples for all possible `requester` and `recipient` elements is located [here](../dsf/requester-and-recipient.md).
-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).
+Creating [ActivityDefinitions](activitydefinition.md) is part of developing a process plugin. Readers fluent in understanding XML FHIR definitions and translating them into resources may 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 they are located in one of [these folders](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir). There is also the guide on [creating ActivityDefinitions](../guides/creating-activity-definitions.md) for more in-depth information.
-You can also find examples for all possible `requester` and `recipient` elements [here](../dsf/requester-and-recipient.md).
\ No newline at end of file
+## Related Topics
+[Requester and Recipient](../dsf/requester-and-recipient.md), [Read Access Tag](../dsf/read-access-tag.md), [Task](task.md)
diff --git a/docs/src/process-development/api-v1/fhir/codesystem.md b/docs/src/process-development/api-v1/fhir/codesystem.md
index e40a365f2..ec31894dd 100644
--- a/docs/src/process-development/api-v1/fhir/codesystem.md
+++ b/docs/src/process-development/api-v1/fhir/codesystem.md
@@ -3,10 +3,13 @@ title: CodeSystem
icon: creative
---
-### CodeSystem
+## CodeSystem
-[CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) usually represent a set of concepts which can be assigned to a code (think LOINC). If you want to use a Code in a resource, you will usually include them in a [ValueSet](valueset.md).
+[CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) usually represent a set of concepts which can be assigned to a code (think LOINC). Using a Code in a resource requires them to be included in a [ValueSet](valueset.md).
Plugin development for the DSF requires the use of [CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) in two major ways:
1. Using existing [DSF CodeSystems](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem) in other FHIR resources like 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).
-2. Creating your own CodeSystem to add additional [Input Parameters](task.md#task-input-parameters) to your [Task](task.md) profiles.
\ No newline at end of file
+2. Creating custom CodeSystem to add additional [Input Parameters](task.md#task-input-parameters) to [Task](task.md) profiles.
+
+## Related Topics
+[ActivityDefinition](activitydefinition.md), [Task](task.md), [ValueSet](valueset.md)
diff --git a/docs/src/process-development/api-v1/fhir/index.md b/docs/src/process-development/api-v1/fhir/index.md
index 47e4a6cda..e3ad1350a 100644
--- a/docs/src/process-development/api-v1/fhir/index.md
+++ b/docs/src/process-development/api-v1/fhir/index.md
@@ -9,5 +9,6 @@ The DSF uses a variety of [FHIR resources](https://dsf.dev/intro/info/basics.htm
## Details
- [ActivityDefinition](activitydefinition.md)
- [CodeSystem](codesystem.md)
+- [Questionnaire and QuestionnaireResponse](questionnaire-and-questionnaireresponse.md)
- [Task](task.md)
- [ValueSet](valueset.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/fhir/questionnaire-and-questionnaireresponse.md b/docs/src/process-development/api-v1/fhir/questionnaire-and-questionnaireresponse.md
new file mode 100644
index 000000000..8dfdc4944
--- /dev/null
+++ b/docs/src/process-development/api-v1/fhir/questionnaire-and-questionnaireresponse.md
@@ -0,0 +1,11 @@
+---
+title: Questionnaire and QuestionnaireResponse
+icon: creative
+---
+
+## Questionnaire and QuestionnaireResponse
+
+[Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources are used by the DSF to implement the user interaction required in [User Tasks](../bpmn/user-tasks.md). Whenever a [User Task](../bpmn/user-tasks.md) is processed, the DSF will create a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) response resource on the DSF FHIR server. This [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) is based on a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource that is provided by the process plugin. This mechanism is described in more detail in the topic on [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
+
+## Related Topics
+[User Tasks](../bpmn/user-tasks.md), [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/fhir/task.md b/docs/src/process-development/api-v1/fhir/task.md
index a647fc46c..53503e18c 100644
--- a/docs/src/process-development/api-v1/fhir/task.md
+++ b/docs/src/process-development/api-v1/fhir/task.md
@@ -3,17 +3,18 @@ title: Task
icon: creative
---
-### Task
+## Task
-The [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource enables the DSF's distributed communication. Whenever a BPMN process instance communicates with a different process instance, the DSF will create a Task resource based on parameters you set in the BPMN model and during execution. It will then automatically send the Task resource to the recipient to start or continue whatever process the Task resource referred to. All Task resources used in the DSF derive from the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). This profile includes a splicing for `Task.input` with three additional [Input Parameters](task.md#task-input-parameters):
+The [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource enables the DSF's distributed communication. Whenever a BPMN process instance communicates with a different process instance, the DSF will create a Task resource based on parameters set in the BPMN model and during execution. It will then automatically send the Task resource to the recipient to start or continue whatever process the Task resource referred to. All Task resources used in the DSF derive from the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). This profile includes a splicing for `Task.input` with three additional [Input Parameters](task.md#task-input-parameters):
- `message-name`
- `business-key`
- `correlation-key`
-When creating your own plugin, you will want to create your own profiles based on the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml).
+When creating a process plugin, it is usually necessary to create new profiles based on the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) and put them into `src/resources/fhir/StructureDefinition`.
-#### Task Input Parameters
+### Task Input Parameters
-Task Input Parameters allow you to add additional information to [Task](task.md#task) resources. For example, if your particular data exchange requires additional medical data, you would add a slice to your Task profile in the same way the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) adds slices to the original [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource. Notice that this also requires creating a [CodeSystem](codesystem.md) and including it in a [ValueSet](valueset.md) to be able to use it in the Task resource.
+Task Input Parameters allow adding additional information to [Task](task.md#task) resources. For example, if a particular data exchange requires additional medical data, one would add a slice to the Task profile in the same way the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) adds slices to the original [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource. It is import to know that this also requires creating a [CodeSystem](codesystem.md) and including it in a [ValueSet](valueset.md) to be able to use it in the Task resource.
-If these instructions are insufficient you can check out the guide on [how to add Task Input Parameters](../guides/adding-task-input-parameters-to-task-profiles.md).
\ No newline at end of file
+## Related Topics
+[ActivityDefinition](activitydefinition.md), [Adding Task Input Parameter to Task Profiles](../guides/adding-task-input-parameters-to-task-profiles.md)
diff --git a/docs/src/process-development/api-v1/fhir/valueset.md b/docs/src/process-development/api-v1/fhir/valueset.md
index 6be03a3fb..e980c4cf3 100644
--- a/docs/src/process-development/api-v1/fhir/valueset.md
+++ b/docs/src/process-development/api-v1/fhir/valueset.md
@@ -3,8 +3,11 @@ title: ValueSet
icon: creative
---
-### ValueSet
+## ValueSet
[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) bind codes from [CodeSystems](codesystem.md) to coded elements like `code`, `Coding` or `CodeableConcept`.
-[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) are mostly needed to use the [Concepts](https://www.hl7.org/fhir/R4/codesystem-definitions.html#CodeSystem.concept) from [CodeSystems](codesystem.md) in your [Task](task.md) profiles.
\ No newline at end of file
+[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) are mostly needed to use the [Concepts](https://www.hl7.org/fhir/R4/codesystem-definitions.html#CodeSystem.concept) from [CodeSystems](codesystem.md) in [Task](task.md) profiles.
+
+## Related Topics
+[CodeSystem](codesystem.md), [Task](task.md)
diff --git a/docs/src/process-development/api-v1/guides/accessing-bpmn-process-variables.md b/docs/src/process-development/api-v1/guides/accessing-bpmn-process-variables.md
index f03bee5d0..2c809593c 100644
--- a/docs/src/process-development/api-v1/guides/accessing-bpmn-process-variables.md
+++ b/docs/src/process-development/api-v1/guides/accessing-bpmn-process-variables.md
@@ -3,8 +3,12 @@ title: Accessing BPMN Process Variables
icon: creative
---
-### Accessing BPMN Process Variables
+## Accessing BPMN Process Variables
-After creating a [Service Delegate](../dsf/service-delegates.md) or [Message Delegate](../dsf/message-delegates.md), you might want to retrieve data from or store data in the [BPMN process variables](../dsf/bpmn-process-variables.md). You can achieve this either through the [BPMN process execution](../dsf/bpmn-process-execution.md) or via the `Variables` class. *It is very much recommended to use the latter method*.
+Access to retrieve data from or store data in the [BPMN process variables](../dsf/bpmn-process-variables.md) can be acquired via the `Variables` class. An instance is usually available when overriding methods in [Service Delegates](../dsf/service-delegates.md) and [Message Delegates](../dsf/message-delegates.md). If an instance is missing in a place where it should be accessible, please [let us know](https://dsf.dev/community/contribute/).
-The `Variables` class provides lots of utility methods to read or write certain types of [BPMN process variables](../dsf/bpmn-process-variables.md). If for some reason you need to fall back on the [BPMN process execution](../dsf/bpmn-process-execution.md) to solve your problem, we would like to learn how the current API of the `Variables` class is limiting you. Contact us, and we might turn it into a feature request ([Contribute](https://dsf.dev/stable/contribute)).
+The `Variables` class provides lots of utility methods to read or write certain types
+of [BPMN process variables](../dsf/bpmn-process-variables.md). If the methods provided by the `Variables` class are insufficient to solve a problem, we would like to learn in what way the current API of the `Variables` class is limiting. Again, please [let us know](https://dsf.dev/community/contribute/).
+
+## Related Topics
+[BPMN Process Variables](../dsf/bpmn-process-variables.md), [Message Delegates](../dsf/message-delegates.md), [Service Delegates](../dsf/service-delegates.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/guides/accessing-task-resources-during-execution.md b/docs/src/process-development/api-v1/guides/accessing-task-resources-during-execution.md
index 196e16381..f5cbf1e50 100644
--- a/docs/src/process-development/api-v1/guides/accessing-task-resources-during-execution.md
+++ b/docs/src/process-development/api-v1/guides/accessing-task-resources-during-execution.md
@@ -3,10 +3,14 @@ title: Accessing Task Resources During Execution
icon: creative
---
-### Accessing Task Resources During Execution
+## Accessing Task Resources During Execution
-If you want access to the [Task](../fhir/task.md) resources in your [Service](../dsf/service-delegates.md) / [Message](../dsf/message-delegates.md) Delegates, the `Variables` class will provide methods which return certain kinds of [Task](../fhir/task.md) resources. The most commonly used ones are the start [Task](../fhir/task.md), referring to the [Task](../fhir/task.md) / [Message Start Event](../bpmn/messaging.md#message-start-event) responsible for starting the process, and the latest [Task](../fhir/task.md), referring to most recently received [Task](../fhir/task.md) / Message.
-In principle, this is sufficient to access all information in a [Task](../fhir/task.md) resource, since you have the [Task](../fhir/task.md) resource's Java object, but very cumbersome.
-Instead of navigating the [Task](../fhir/task.md) resource's element tree, you should first try to use the [ProcessPluginApi's](../dsf/process-plugin-api.md) `TaskHelper` in conjunction with the method above. The `TaskHelper` class offers specific methods related to [Task](../fhir/task.md) resources.
-The most common use case for this is retrieving data from a [Task's](../fhir/task.md) [Input Parameter](../fhir/task.md#task-input-parameters) or creating a new [Input Parameter](../fhir/task.md#task-input-parameters) for a [Message Delegate's](../dsf/message-delegates.md) `getAdditionalInputParameters` method. When retrieving data from a [Task's](../fhir/task.md) Input Parameter you first have to get to the [Input Parameter](../fhir/task.md#task-input-parameters) you are looking to extract data from. You can use one of the `TaskHelper's` getters for [Input Parameters](../fhir/task.md#task-input-parameters) to find the right one. The methods will try to match the provided [CodeSystem](../fhir/codesystem.md) and Code to any [Input Parameter](../fhir/task.md#task-input-parameters) of the provided [Task](../fhir/task.md) resource. Depending on the method you chose you will for example receive all matches or just the first one.
-To create new [Input Parameters](../fhir/task.md#task-input-parameters) to attach to a [Task](../fhir/task.md) resource, you may invoke the `TaskHelper#createInput` method. This is most often used when overriding the `getAdditionalInputParamters` method of you [Message Delegate](../dsf/message-delegates.md).
\ No newline at end of file
+Access to the [Task](../fhir/task.md) resources in [Service](../dsf/service-delegates.md) / [Message](../dsf/message-delegates.md) Delegates is provided by the `Variables` class. It comes with methods which return certain kinds of [Task](../fhir/task.md) resources. The most commonly used ones are the start [Task](../fhir/task.md), referring to the [Task](../fhir/task.md) / [Message Start Event](../bpmn/messaging.md#message-start-event) responsible for starting the process, and the latest [Task](../fhir/task.md), referring to most recently received [Task](../fhir/task.md) / Message.
+In principle, this is sufficient to access all information in a [Task](../fhir/task.md) resource, since there is access to the full in-memory representation of the [Task](../fhir/task.md) resource. This however can be very cumbersome to use and produces a lot of boilerplate when traversing the resource tree to access certain common elements.
+Instead of navigating the [Task](../fhir/task.md) resource's element tree, it is recommended to use the [ProcessPluginApi's](../dsf/process-plugin-api.md) `TaskHelper` in conjunction with the method above. The `TaskHelper` class offers specific methods related to [Task](../fhir/task.md) resources.
+The most common use case for this is retrieving data from a [Task's](../fhir/task.md) [Input Parameter](../fhir/task.md#task-input-parameters) or creating a new [Input Parameter](../fhir/task.md#task-input-parameters) for a [Message Delegate's](../dsf/message-delegates.md) `getAdditionalInputParameters` method. When retrieving data from a [Task's](../fhir/task.md) Input Parameter one first has to get to the [Input Parameter](../fhir/task.md#task-input-parameters) one is looking to extract data from. The `TaskHelper's` getters for [Input Parameters](../fhir/task.md#task-input-parameters) are useful to find the right one. The methods will try to match the provided [CodeSystem](../fhir/codesystem.md) and Code to any [Input Parameter](../fhir/task.md#task-input-parameters) of the provided [Task](../fhir/task.md) resource. Depending on the method it is possible to receive all matches or just the first one.
+To create new [Input Parameters](../fhir/task.md#task-input-parameters) to attach to a [Task](../fhir/task.md) resource, one may invoke the `TaskHelper#createInput` method. This is most often used when overriding the `getAdditionalInputParameters` method of a [Message Delegate](../dsf/message-delegates.md).
+
+
+## Related Topics
+[Accessing BPMN Process Variables](accessing-bpmn-process-variables.md), [Message Delegates](../dsf/message-delegates.md), [Service Delegates](../dsf/service-delegates.md), [Task](../fhir/task.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/guides/adding-task-input-parameters-to-task-profiles.md b/docs/src/process-development/api-v1/guides/adding-task-input-parameters-to-task-profiles.md
index 7a625d5f4..1480ee8f8 100644
--- a/docs/src/process-development/api-v1/guides/adding-task-input-parameters-to-task-profiles.md
+++ b/docs/src/process-development/api-v1/guides/adding-task-input-parameters-to-task-profiles.md
@@ -3,13 +3,13 @@ title: Adding Task Input Parameters to Task Profiles
icon: creative
---
-### Adding Task Input Parameters to Task Profiles
+## Adding Task Input Parameters to Task Profiles
-When adding a new [Input Parameter](../fhir/task.md#task-input-parameters) to a [Task](../fhir/task.md) profile, you are essentially adding a new slice to `Task.input`. [Slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) is part of [profiling](https://www.hl7.org/fhir/R4/profiling.html) in FHIR. Profiling lets you create your own FHIR definitions based on pre-existing FHIR definitions. A slicing defines constraints on element lists like `Task.input` e.g. by only allowing the elements to be of certain types.
-For example, you might have a list of fruits in a `FruitBasket` resource. Constraining that list to only include fruits of type `Apple`, `Banana` and `Orange` would be considered [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing).
-This guide will not cover how slicing works in general, only for the case presented by the DSF FHIR resource context. Our goal will be to add a new [Input Parameter](../fhir/task.md#task-input-parameters) of type `example-input` to the `task-start-dic-process.xml` profile which will be used to submit `integer` values to our `dicProcess`.
+When adding a new [Input Parameter](../fhir/task.md#task-input-parameters) to a [Task](../fhir/task.md) profile, a new slice is added to `Task.input`. [Slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) is part of [profiling](https://www.hl7.org/fhir/R4/profiling.html) in FHIR. Profiling lets you create your own FHIR definitions based on pre-existing FHIR definitions. A slicing defines constraints on element lists like `Task.input` e.g. by only allowing the elements to be of certain types.
+For example, there might be a list of fruits in a `FruitBasket` resource. Constraining that list to only include fruits of type `Apple`, `Banana` and `Orange` would be considered [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing).
+This guide will not cover how slicing works in general, only for the case presented by the DSF FHIR resource context. The goal will be to add a new [Input Parameter](../fhir/task.md#task-input-parameters) of type `example-input` to the `task-start-dic-process.xml` profile which will be used to submit `integer` values to a process called `dicProcess`.
-Let us start out by adding a slice to `task-start-dic-process.xml`. Since there is already a slicing defined on `Task.input` by `task-start-dic-process.xml`'s `baseDefinition`, we have to check out this resource first. As a part of the [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement, slicing also uses [Element Definitions](https://www.hl7.org/fhir/R4/elementdefinition.html).
+As a first step, a slice to `task-start-dic-process.xml` is added. Since there is already a slicing defined on `Task.input` by `task-start-dic-process.xml`'s `baseDefinition`, this resource has to be looked at first. As a part of the [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement, slicing also uses [Element Definitions](https://www.hl7.org/fhir/R4/elementdefinition.html).
The slicing for `Task.input` is defined in this part of the `baseDefinition`:
```xml
@@ -33,9 +33,9 @@ The slicing for `Task.input` is defined in this part of the `baseDefinition`:
```
*The resource can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml)*
-We will only need to take a look at the `discrimitator` tag for now. Discriminators define the elements a FHIR processor needs to distinguish slices by. In our case, a processor would look at the values for `type.coding.system` and `type.coding.code` to determine which slice this element belongs to. The discriminator type `value` implies that `type.coding.system` and `type.coding.code` have to be present in all slices and need to have a fixed value. You can learn more about discriminators [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator).
+First look at the `discriminator` tag. Discriminators define the elements a FHIR processor needs to distinguish slices by. In this case, a processor would look at the values for `type.coding.system` and `type.coding.code` to determine which slice this element belongs to. The discriminator type `value` implies that `type.coding.system` and `type.coding.code` have to be present in all slices and need to have a fixed value. There is more information about discriminators in the [official FHIR documentation](https://www.hl7.org/fhir/R4/profiling.html#discriminator).
-Let us revisit `task-start-dic-process.xml` and start adding a slice called `example-input` to it:
+Now revisit `task-start-dic-process.xml` and start adding a slice called `example-input` to it:
```xml
...
@@ -52,9 +52,9 @@ Let us revisit `task-start-dic-process.xml` and start adding a slice called `exa
```
*Irrelevant elements for this guide are hidden by ... placeholders.*
-We have now defined a slice on `Task.input` with the name and id of `example-input` and cardinality of `1..1`. You might want a different cardinality for your use case. We recommend you also take a look at the documentation for [ElementDefinition.id](https://www.hl7.org/fhir/R4/elementdefinition.html#id) and [ElementDefinition.path](https://www.hl7.org/fhir/R4/elementdefinition.html#path). They explain how to create the proper values for these elements. Cardinality is also part of the [element definition](https://www.hl7.org/fhir/R4/elementdefinition.html) hierarchy (see [ElementDefinition.min](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.min) and [ElementDefinition.max](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.max)).
+There is now a slice defined on `Task.input` with the name and id of `example-input` and cardinality of `1..1`. The name and cardinality depend on the use case. It is recommended to also take a look at the documentation for [ElementDefinition.id](https://www.hl7.org/fhir/R4/elementdefinition.html#id) and [ElementDefinition.path](https://www.hl7.org/fhir/R4/elementdefinition.html#path). They explain how to create the proper values for these elements. Cardinality is also part of the [element definition](https://www.hl7.org/fhir/R4/elementdefinition.html) hierarchy (see [ElementDefinition.min](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.min) and [ElementDefinition.max](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.max)).
-Next up, we need to define the binding for `Task.input:example-input.type`. Because `Task.input.type` is a `CodeableConcept` which uses codings from a [ValueSet](../fhir/valueset.md), the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires us to use `required` as the binding strength:
+Next up is the binding for `Task.input:example-input.type`. Because `Task.input.type` is a `CodeableConcept` which uses codings from a [ValueSet](../fhir/valueset.md), the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires the use of `required` as the binding strength:
```xml
...
@@ -76,9 +76,9 @@ Next up, we need to define the binding for `Task.input:example-input.type`. Beca
```
-As you can see, we referenced a [ValueSet](../fhir/valueset.md) in this binding. When adding an actual slice for your use case, you will have to reference an existing [ValueSet](../fhir/valueset.md) resource or create a new one. A guide on how to create them can be found [here](../guides/creating-valuesets-for-dsf-processes.md).
+The binding now references a [ValueSet](../fhir/valueset.md). Moving beyond this example will require referencing an existing [ValueSet](../fhir/valueset.md) resource or create a new one. A guide on how to create them can be found [here](../guides/creating-valuesets-for-dsf-processes.md).
-Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires `Task.input.coding.code` and `Task.input.coding.system` to be present, we will make `Task.input.coding` mandatory as well:
+Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires `Task.input.coding.code` and `Task.input.coding.system` to be present, `Task.input.coding` will be marked as mandatory as well:
```xml
...
@@ -105,7 +105,7 @@ Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminat
```
-In the beginning we mentioned how `Task.input.type.coding.system` and `Task.input.type.coding.code` have to use fixed values. Here is how we accomplish this:
+The beginning mentioned how `Task.input.type.coding.system` and `Task.input.type.coding.code` have to use fixed values. Here is how this is accomplished:
```xml
@@ -142,9 +142,9 @@ In the beginning we mentioned how `Task.input.type.coding.system` and `Task.inpu
```
-*Notice that we also made the two elements mandatory because they are required by the discriminator.*
+*Notice the two new elements were marked as mandatory because they are required by the discriminator.*
-For the `type.coding.system` element we referenced a [CodeSystem](../fhir/codesystem.md). The `type.coding.code` element uses a code from this [CodeSystem](../fhir/codesystem.md) called `example-input`. This is the mechanism by which you actually "name" your [Input Parameter](../fhir/task.md#task-input-parameters). The `type.coding.code` value will identify your [Input Parameter](../fhir/task.md#task-input-parameters) when you use it in an actual [Task](../fhir/task.md#task-input-parameters) resource. Here is how this would look like:
+The `type.coding.system` element references a [CodeSystem](../fhir/codesystem.md). The `type.coding.code` element uses a code from this [CodeSystem](../fhir/codesystem.md) called `example-input`. This is the mechanism by which [Input Parameter](../fhir/task.md#task-input-parameters) are "named". The `type.coding.code` value will identify the [Input Parameter](../fhir/task.md#task-input-parameters) when it is used in an actual [Task](../fhir/task.md#task-input-parameters) resource. Here is how this would look like:
```xml
@@ -161,9 +161,9 @@ For the `type.coding.system` element we referenced a [CodeSystem](../fhir/codesy
```
-When adding an actual slice for your use case, you will also need to reference an existing [CodeSystem](../fhir/codesystem.md) resource or create a new one to reference. A guide on how to create them can be found [here](../guides/creating-codesystems-for-dsf-processes.md).
+Adding a slice in a different use case will also require to reference an existing [CodeSystem](../fhir/codesystem.md) resource or create a new one to reference. A guide on how to create them can be found [here](../guides/creating-codesystems-for-dsf-processes.md).
-`Task.input.value[x]` is the actual value you will submit using your Input Parameter. You can make it any of [these](https://www.hl7.org/fhir/R4/datatypes.html#open) data types. This is because `Type.input.value[x]` refers to `*` instead of any particular type in its [definition](https://www.hl7.org/fhir/R4/task-definitions.html#Task.input.value_x_). Let us define it as an `integer` type`:
+`Task.input.value[x]` is the actual value submitted when using the Input Parameter. They may be any of [these](https://www.hl7.org/fhir/R4/datatypes.html#open) data types. This is because `Type.input.value[x]` refers to `*` instead of any particular type in its [definition](https://www.hl7.org/fhir/R4/task-definitions.html#Task.input.value_x_). In this case, let it be an `integer` type`:
```xml
@@ -207,4 +207,7 @@ When adding an actual slice for your use case, you will also need to reference a
```
-Now we have a new Input Parameter of type `example-input` which accepts any `integer` as its value.
+There is now a new Input Parameter of type `example-input` which accepts any `integer` as its value.
+
+## Related Topics
+[Creating CodeSystems for DSF processes](creating-codesystems-for-dsf-processes.md), [Creating ValueSets for DSF processes](creating-valuesets-for-dsf-processes.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v1/guides/configuring-read-access-tags.md b/docs/src/process-development/api-v1/guides/configuring-read-access-tags.md
index 404f2286e..7ac655e5a 100644
--- a/docs/src/process-development/api-v1/guides/configuring-read-access-tags.md
+++ b/docs/src/process-development/api-v1/guides/configuring-read-access-tags.md
@@ -3,9 +3,9 @@ title: Configuring Read Access Tags
icon: creative
---
-### Configuring Read Access Tags
+## Configuring Read Access Tags
-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:
+Before starting to configure anything, it is advised 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:
```xml
...
@@ -44,7 +44,7 @@ The codes `LOCAL` and `ALL` are trivial. Their [Read Access Tag](../dsf/read-acc
```
-Let us try to configure a Read Access Tag whose code uses an extension. We will choose `ROLE` for this example. We start out the same way as before:
+Now to configure a Read Access Tag whose code uses an extension. This example will use the code `ROLE`. It starts out the same way as before:
```xml
@@ -56,7 +56,7 @@ Let us try to configure a Read Access Tag whose code uses an extension. We will
The `definition` element of the `ROLE` code references an extension called [dsf-extension-read-access-parent-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-read-access-parent-organization-role-1.0.0.xml).
-The most important part of it is the `differential` statement. It uses [element definitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to describe how we need to implement the extension:
+The most important part of it is the `differential` statement. It uses [element definitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to describe how the extensions needs to be implemented:
```xml
...
@@ -142,7 +142,7 @@ All extensions for the [Read Access Tag](../dsf/read-access-tag.md) CodeSystem a
```
-That is why the first element we are adding to `meta.tag` is an `extension` element:
+That is why the first element to be added to `meta.tag` is an `extension` element:
```xml
@@ -155,7 +155,7 @@ That is why the first element we are adding to `meta.tag` is an `extension` elem
```
-We will now go through the `differential` statement one element at a time, starting at the top:
+Now to process the `differential` statement one element at a time, starting at the top:
```xml
...
@@ -175,7 +175,7 @@ We will now go through the `differential` statement one element at a time, start
```
-It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for the `Extension.extension` element, meaning we are dealing with a nested extension. The `discriminator` element tells us that slices will be identified by the value of their `url` attribute. A `rules` element with value `open` means other types of slices may be added later on e.g. when creating a profile. We do not have to add any elements from here to the `meta.tag.extension` element. Next up is the first slice called `parentOrganization`:
+It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for the `Extension.extension` element, meaning this is a nested extension. The `discriminator` element defines that slices will be identified by the value of their `url` attribute. A `rules` element with value `open` means other types of slices may be added later on e.g. when creating a profile. This element is not added to the `meta.tag.extension` element it only serves the purpose of defining the `discriminator`. Next up is the first slice called `parentOrganization`:
```xml
@@ -213,7 +213,7 @@ It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for t
```
-The first element defines a slice called `parentOrganization` on the `Extension.extension` element with cardinality `1..1`. The second element defines the url attribute of the `parentOrganization` slice to be fixed to the value `parent-organization`. With this information we can add the next element to `meta.tag`. Since it is defined on `Extension.extension` we will add it to `meta.tag.extension.extension` like this:
+The first element defines a slice called `parentOrganization` on the `Extension.extension` element with cardinality `1..1`. The second element defines the url attribute of the `parentOrganization` slice to be fixed to the value `parent-organization`. With this information the next element can be added to `meta.tag`. Since it is defined on `Extension.extension` it will be added it to `meta.tag.extension.extension` like this:
```xml
@@ -228,7 +228,7 @@ The first element defines a slice called `parentOrganization` on the `Extension.
```
-After that, it defines `parentOrganization.value[x]` to occur at least once and have a type of `Identifier`. To turn this into an element to add to `meta.tag.extension.extension` we have to replace `[x]` with our code in `value[x].type`, which in this case is `Identifier`. It is important to note, that should the value in the code element be lowercase, you will have make it uppercase before replacement. In our case this means we will have a `meta.tag.extension.extension.valueIdentifier` element:
+After that, it defines `parentOrganization.value[x]` to occur at least once and have a type of `Identifier`. To turn this into an element to add to `meta.tag.extension.extension` requires replacing `[x]` with the code in `value[x].type`, which in this case is `Identifier`. It is important to note, that `value[x]` should be camel cased after replacement. This means there will be a `meta.tag.extension.extension.valueIdentifier` element:
```xml
@@ -245,7 +245,7 @@ After that, it defines `parentOrganization.value[x]` to occur at least once and
```
-The last two elements define a `system` element with a fixed value and `value` element we can fill in on our own, since it does not have any constraints applied. Notice that the element definition still uses `value[x].system` and `value[x].value`. The replacement mentioned earlier does not happen in the element definition, but since `value[x]` is defined to have the type `Identifier` it is inferred that we mean to reference `Identifier.system` and `Identifier.value`. We will choose an arbitrary `Idenfier` value, but you should be using an actual organization identifier depending on who you want to allow read access to the resource.
+The last two elements define a `system` element with a fixed value and `value` element that can be freely set, since it does not have any constraints applied. Notice that the element definition still uses `value[x].system` and `value[x].value`. The replacement mentioned earlier does not happen in the element definition, but since `value[x]` is defined to have the type `Identifier`, it is inferred that `Identifier.system` and `Identifier.value` are referenced. The example will use an arbitrary `Identifier` value, but real application should be using an actual organization identifier depending on which organization has read access to the resource.
```xml
@@ -300,7 +300,7 @@ Next is the slice is called `organizationRole`:
```
-Like with `parentOrganization`, we will add an extension element to `meta.tag.extension` with the fixed url value defined above:
+Like with `parentOrganization`, an extension element to `meta.tag.extension` is added with the fixed url value defined above:
```xml
@@ -321,7 +321,7 @@ Like with `parentOrganization`, we will add an extension element to `meta.tag.ex
```
-Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` type. This means we will add a `valueCoding` element to the extension:
+Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` type. This the next element to add will be `valueCoding`:
```xml
@@ -344,7 +344,7 @@ Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` typ
```
-A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF has a CodeSystem called [dsf-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-organization-role-1.0.0.xml). Before creating your own CodeSystem, it is worth taking a look at it to see if an appropriate role already exists for your organization. For demonstration purposes, we will be using the `DIC` role:
+A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF has a CodeSystem called [dsf-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-organization-role-1.0.0.xml). Before creating new CodeSystems, it is worth taking a look at it to see if an appropriate role already exists for an organization. The example will be using the `DIC` role:
```xml
@@ -368,7 +368,7 @@ A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF ha
```
-Now we only have two elements left in the `differential` statement:
+Now there is only two elements left in the `differential` statement:
```xml
@@ -387,7 +387,7 @@ Now we only have two elements left in the `differential` statement:
```
-The `Extension.url` element tells us to add a url attribute to `meta.tag.extension`. The last element makes it so we must not add a `meta.tag.extension.value[x]` element. This leaves us with this final Read Access Tag:
+The `Extension.url` element requires a url attribute to be added to `meta.tag.extension`. The last element defines that there must not be a `meta.tag.extension.value[x]` element. This results in this final Read Access Tag:
```xml
@@ -412,4 +412,5 @@ The `Extension.url` element tells us to add a url attribute to `meta.tag.extensi
```
-You can follow the same method to configure the other types of Read Access Tags as well.
\ No newline at end of file
+## Related Topics
+[Read Access Tag](../dsf/read-access-tag.md)
diff --git a/docs/src/process-development/api-v1/guides/creating-activity-definitions.md b/docs/src/process-development/api-v1/guides/creating-activity-definitions.md
index 163d47032..fe296007b 100644
--- a/docs/src/process-development/api-v1/guides/creating-activity-definitions.md
+++ b/docs/src/process-development/api-v1/guides/creating-activity-definitions.md
@@ -3,9 +3,9 @@ title: Creating ActivityDefinitions
icon: creative
---
-### Creating ActivityDefinitions
+## Creating ActivityDefinitions
-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.
+This guide will explain 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 a process plugin.
It is divided into steps for each of the main components of ActivityDefinitions:
1. Read Access Tag
2. Extension: process authorization
@@ -14,17 +14,17 @@ It is divided into steps for each of the main components of ActivityDefinitions:
*Regular elements* are all elements not part of the first 3 main components.
-*We will assume you know how to translate [ElementDefinitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to actual elements in a FHIR resource. If you do not, you might want to check out the guide on [creating Task resources](../guides/creating-task-resources-based-on-a-definition.md) first.*
+*This guide assumes the reader knows how to translate [ElementDefinitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to actual elements in a FHIR resource. If not, the guide on [creating Task resources](../guides/creating-task-resources-based-on-a-definition.md) includes explanations for this.*
-#### 1. Read Access Tag
-Let us start out with an empty [ActivityDefinition](../fhir/activitydefinition.md):
+### 1. Read Access Tag
+Start out with an empty [ActivityDefinition](../fhir/activitydefinition.md):
```xml
```
-The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/read-access-tag.md). It describes who is allowed to read this resource through the DSF FHIR server's REST API. You can learn more complex configurations of the [Read Access Tag](../dsf/read-access-tag.md) in [this guide](../dsf/read-access-tag.md). In this case, we will allow read access to everyone:
+The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/read-access-tag.md). It describes who is allowed to read this resource through the DSF FHIR server's REST API. More complex configurations of the [Read Access Tag](../dsf/read-access-tag.md) are explained in [this guide](../dsf/read-access-tag.md). For this example, everyone will be allowed to read the resource:
```xml
@@ -37,8 +37,8 @@ The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/r
```
-#### 2. Extension: Process Authorization
-This part of your ActivityDefinition will tell the DSF who is allowed to request and receive messages ([Task](../fhir/task.md) resources) for your BPMN process. If your plugin contains more than one BPMN process, you will have to create one [ActivityDefinition](../fhir/activitydefinition.md) for each BPMN process. It is important to note that you need to include authorization rules for **ALL** messages received in your BPMN process. This includes the message starting your BPMN process initially. You can find the extension [here](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). Let us continue by adding the [extension element](http://hl7.org/fhir/R4/extensibility.html#extension) with the correct URL. You can get the value for the URL from the `Extension.url` element:
+### 2. Extension: Process Authorization
+This part of the ActivityDefinition will tell the DSF who is allowed to request and receive messages ([Task](../fhir/task.md) resources) for BPMN process. If the plugin contains more than one BPMN process, there will have to be one [ActivityDefinition](../fhir/activitydefinition.md) for each BPMN process. It is important to note that authorization rules need to be included for **ALL** messages received in the BPMN process. This includes the messages starting the BPMN process initially. The extension containing all possible rules is found [here](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). Next up is adding the [extension element](http://hl7.org/fhir/R4/extensibility.html#extension) with the correct URL. The value for the URL is found in the `Extension.url` element:
```xml
...
@@ -47,7 +47,7 @@ This part of your ActivityDefinition will tell the DSF who is allowed to request
```
-*Elements not relevant to the current component are hidden with ... to increase readability.*
+*Elements not relevant to the current component are hidden with `...` to increase readability.*
The [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement starts by defining the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) for the `Extension.extension` element:
@@ -74,9 +74,9 @@ The [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statemen
```
-The above states that whenever this extension is used in a profile, the profile needs to include this extension at least once (``). The [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension` tells us that elements of this [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) are identified by the value of their URL (``), which is always the case for extensions, and that other extensions can be added to the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) (``). Since there is a [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension`, we are dealing with a nested extension.
+The above states that whenever this extension is used in a profile, the profile needs to include this extension at least once (``). The [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension` defines that elements of this [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) are identified by the value of their URL (``), which is always the case for extensions, and that other extensions can be added to the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) (``). Since there is a [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension`, this is a nested extension.
-After these initial element definitions come the elements relevant for your process plugin. The first one is the `message-name` slice:
+After these initial element definitions come the elements relevant for the process plugin. The first one is the `message-name` slice:
```xml
...
@@ -104,17 +104,17 @@ After these initial element definitions come the elements relevant for your proc
```
-This section tells us that we need to include exactly one extension element from the `message-name` slice in our [ActivityDefinition](../fhir/activitydefinition.md). The extension element will have a URL value of `message-name`. If you remember the `discriminator` configuration, this URL value identifies the element to belong to the `message-name` slice on `Extension.extension`. Lastly, the extension element includes a `valueString` element. In case you are wondering how `value[x]` turned into `valueString`, FHIR does not allow using `value[x]` as actual element. The value in `value[x]` is always strictly bound to some kind of type. FHIR uses the `value[x].type.code` value to determine this type and replaces `[x]` with an uppercase version of `element.type.code`. This results in the following extension element we will add to our [ActivityDefinition](../fhir/activitydefinition.md):
+This section defines that there has to be exactly one extension element from the `message-name` slice in the [ActivityDefinition](../fhir/activitydefinition.md). The extension element will have a URL value of `message-name`. This URL value identifies the element to belong to the `message-name` slice on `Extension.extension`, in accordance with the `discriminator`. Lastly, the extension element includes a `valueString` element. FHIR does not allow using `value[x]` as actual element. The value in `value[x]` is always strictly bound to some kind of type. FHIR uses the `value[x].type.code` value to determine this type and replaces `[x]` with an uppercase version of `element.type.code`. This results in the following extension element:
```xml
```
-For your use case, you have to replace `myMessage` with the name of the [BPMN message event](../bpmn/messaging.md) that is expecting this message.
+`myMessage` will have to be replaced with the name of the [BPMN message event](../bpmn/messaging.md) in a BPMN process that is expecting this message.
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -161,7 +161,7 @@ The next slice is called `task-profile`:
```
-This section has almost the same structure as `message-name`. The only difference is the value for `value[x].type.code`. This means that instead of `valueString`, we will have to use a `valueCanonical` element for `task-profile.value[x]`. Canonical values referring to [Task](../fhir/task.md) profiles in ActivityDefinitions have to conform to the rules outlined by the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls). From the definition above, we will create the following extension element and add it to our [ActivityDefinition](../fhir/activitydefinition.md):
+This section has almost the same structure as `message-name`. The only difference is the value for `value[x].type.code`. This means that instead of `valueString`, it requires using a `valueCanonical` element for `task-profile.value[x]`. Canonical values referring to [Task](../fhir/task.md) profiles in ActivityDefinitions have to conform to the rules outlined by the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls). From the definition above, the following extension element is created and added to the [ActivityDefinition](../fhir/activitydefinition.md):
```xml
@@ -169,7 +169,7 @@ This section has almost the same structure as `message-name`. The only differenc
```
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -230,7 +230,7 @@ The next slice is `requester`:
```
-Instead of a `string` or `canonical` type for `value[x]` we now have a `Coding` type. See the [FHIR documentation on Codings](https://www.hl7.org/fhir/R4/datatypes.html#Coding) for more in-depth information. `Codings` are elements which contain, among other things, a `code` and the `system` the code belongs to. In the same way we transformed `value[x]` into `valueString` or `valueCanonical` before, we will also have to turn `value[x]` into `valueCoding`. To use `Codings` in `valueCoding` elements, they are usually bound to the element through a [ValueSet](../fhir/valueset.md). This is the responsibility of the `binding` element. You can also see that `value[x].type.profile` lists a number of profiles. Instead of defining the elements in the same file, they were defined in different files for better readability. Depending on your use case, you have to pick one of the profiles.
+Instead of a `string` or `canonical` type for `value[x]` there now is a `Coding` type. See the [FHIR documentation on Codings](https://www.hl7.org/fhir/R4/datatypes.html#Coding) for more in-depth information. `Codings` are elements which contain, among other things, a `code` and the `system` the code belongs to. In the same way `value[x]` transformed into `valueString` or `valueCanonical` before, `value[x]` will be transformed into `valueCoding`. To use `Codings` in `valueCoding` elements, they are usually bound to the element through a [ValueSet](../fhir/valueset.md). This is the responsibility of the `binding` element. There is also a list of `value[x].type.profile` elements referencing other [StructureDefinitions](https://www.hl7.org/fhir/R4/structuredefinition.html). Instead of defining the elements in the same file, they were defined in different files for better readability. The use case decides which one to pick.
Here is what they mean:
- `local-all`: All local requests will be allowed. Local requests are identified by matching the requester's certificate to a thumbprint which was internally marked by the DSF FHIR server as belonging to a local organization.
- `local-organization`: All local requests made from an organization with a specific `organization-identifier` will be allowed.
@@ -238,11 +238,11 @@ Here is what they mean:
- `remote` versions of the above rules work the same but the requester's certificate is instead required to match a thumbprint marked as a remote organization.
- `practitioner` suffixes all work the same. They include the same rules as their prefixes but now additionally require the requester to match a certain `practitioner-role`. A list of them
can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml). This allows
- for more granularity when defining authorization rules within an organization and can be integrated into local user management via [OpenID Connect](https://dsf.dev/operations/latest/fhir/access-control.html).
+ for more granularity when defining authorization rules within an organization and can be integrated into local user management via [OpenID Connect](https://dsf.dev/stable/maintain/fhir/access-control.html).
-As you can see, there are no `practitioner` versions of `remote` authorization rules. From the perspective of the receiving DSF instance, remote requests are always issued by an organization. They do not hold any information about the local user management of the requesting organization. You can also find examples of all Codings from above [here](../dsf/requester-and-recipient.md).
+There are no `practitioner` versions of `remote` authorization rules. From the perspective of the receiving DSF instance, remote requests are always issued by an organization. They do not hold any information about the local user management of the requesting organization. Examples of all Codings from above can be found [here](../dsf/requester-and-recipient.md).
-It is also good to keep in mind that you are allowed to add any number of `requester` elements into your [ActivityDefinition](../fhir/activitydefinition.md). Let us start out by adding a `requester` element like we did for previous elements:
+It is also good to keep in mind that any number of `requester` elements may be added to an [ActivityDefinition](../fhir/activitydefinition.md). Start out by adding a `requester` element like previous extensions:
```xml
@@ -252,7 +252,7 @@ It is also good to keep in mind that you are allowed to add any number of `reque
```
-We now have to look at the elements that are defined in one of the profiles to fill in the remaining elements since they are not defined by the `requester` extension. For demonstration purposes, we will choose the [dsf-coding-process-authorization-local-organization-practitioner](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-practitioner-1.0.0.xml) profile. Since all elements listed in the [Coding definition](https://www.hl7.org/fhir/R4/datatypes.html#codesystem) are optional, we only have to look at the `differential` element from the profile we just selected:
+The remaining element definitions are found in one of the profiles. This example will use the [dsf-coding-process-authorization-local-organization-practitioner](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-practitioner-1.0.0.xml) profile. Since all elements listed in the [Coding definition](https://www.hl7.org/fhir/R4/datatypes.html#codesystem) are optional, only the `differential` elements from the profile are relevant:
```xml
@@ -288,7 +288,7 @@ We now have to look at the elements that are defined in one of the profiles to f
```
-It defines an extension called `organization-practitioner` which is identified through its url attribute. Again, the extension is only referenced, its location is in a different file. You can find it [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-process-authorization-organization-practitioner-1.0.0.xml). Let us look at its `differential` element in the extension file to see how we need to populate the extension:
+It defines an extension called `organization-practitioner` which is identified through its url attribute. Again, the extension is only referenced, its location is in a [different file](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-process-authorization-organization-practitioner-1.0.0.xml). Below is its `differential` element in order to see how the extension needs to be populated:
```xml
@@ -368,16 +368,16 @@ It defines an extension called `organization-practitioner` which is identified t
```
-This extension does not reference any other files. This means we reached the "deepest" level. So now we can start working our way back up again from here, by translating this definition into actual extension elements, then inserting it into the Coding we selected, translating the rest of the element definitions from the Coding resource and adding everything to our [ActivityDefinition](../fhir/activitydefinition.md).
+This extension does not reference any other files. This means this is the "deepest" level. The process can now proceed by translating this definition into actual extension elements, inserting it into the selected Coding, translating the remaining element definitions from the Coding resource, and incorporating all components into the [ActivityDefinition](../fhir/activitydefinition.md).
-We will start with the `Extension.url` element, since the `Extension` element is the parent element for all slices on the `Extension.extension` elements:
+Start with the `Extension.url` element, since the `Extension` element is the parent element for all slices on the `Extension.extension` elements:
```xml
```
-Next, we will add the `organization` slice:
+Next, add the `organization` slice:
```xml
@@ -388,7 +388,7 @@ Next, we will add the `organization` slice:
```
-Finally, we will add the `practitionerRole` slice:
+Finally, add the `practitionerRole` slice:
```xml
@@ -407,9 +407,9 @@ Finally, we will add the `practitionerRole` slice:
```
-Notice that there is no `binding` element specified for `practitionerRole.value[x]`. This is intentional. In the example we used a code from the [dsf-practitioner-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml) CodeSystem. This CodeSystem includes a standard set of codes which are often sufficient for DSF use cases. You can freely add other CodeSystems if you find these codes do not apply for your use case. The code you set here can be used in the [DSF role config](https://dsf.dev/operations/latest/fhir/access-control.html) to allow certain users with this `practitioner-role` to send requests.
+There is no `binding` element specified for `practitionerRole.value[x]`. This is intentional. The example used a code from the [dsf-practitioner-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml) CodeSystem. This CodeSystem includes a standard set of codes which are often sufficient for DSF use cases. Other/new CodeSystems if may be added if these codes do not apply for a given use case. The code set here can be used in the [DSF role config](https://dsf.dev/stable/maintain/fhir/access-control.html) to allow certain users with this `practitioner-role` to send requests.
-Working our way back up to the Coding we selected, we will now add the extension we just created as the `Coding.extension:organization-practitioner` element:
+Now add the extension as the `Coding.extension:organization-practitioner` element:
```xml
@@ -430,7 +430,7 @@ Working our way back up to the Coding we selected, we will now add the extension
```
-Now might be a good time to look at the [differential](#coding-differential) from the Coding again. Our next elements to be added are `Coding.system` and `Coding.code`:
+Look at the [differential](#coding-differential) from the Coding again. The next elements to be added are `Coding.system` and `Coding.code`:
```xml
@@ -453,10 +453,10 @@ Now might be a good time to look at the [differential](#coding-differential) fro
```
-Now we are finished with the `requester` extension and can add it to our [ActivityDefinition](../fhir/activitydefinition.md) under 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).
+The `requester` extension is now finished and can be added it to the [ActivityDefinition](../fhir/activitydefinition.md) under 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).
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -498,7 +498,7 @@ Now we are finished with the `requester` extension and can add it to our [Activi
```
-Now we are back to looking at 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) again. The last slice for this extension is `recipient`:
+Back to looking at 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) again. The last slice for this extension is `recipient`:
```xml
...
@@ -532,10 +532,10 @@ Now we are back to looking at the [dsf-extension-process-authorization](https://
```
-The `recipient` will decide which DSF instance is allowed to process that message. That is the reason why you will not find any Codings for `remote` or `practitioner` here. For `requester`, we already decided that we will only allow users with a certain role from our own (local) organization to send this message. So now we will only allow the DSF instance run by that same local organization to process the message. The right Coding for this job is the [coding-process-authorization-local-organization](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-1.0.0.xml). The configuration of a local requester and local receiver is often used for the message that starts up the first BPMN process of the plugin. The process of adding the `recipient` slice is the exact same as it is for `requester`. You can follow the steps for the `requester` slice again but just use a different Coding.
+The `recipient` will decide which DSF instance is allowed to process that message. That is the reason why there are no Codings for `remote` or `practitioner` here. For `requester`, it was decided to only allow users with a certain role from a local organization to send this message. The message should now also only be processable by that same local organization. The right Coding for this job is the [coding-process-authorization-local-organization](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-1.0.0.xml). The configuration of a local requester and local receiver is often used for the message that starts up the first BPMN process of the plugin. The process of adding the `recipient` slice is the exact same as it is for `requester`. It's possible to follow the same steps for the `requester` slice again but using a different Coding.
-Using the Coding we just decided on, this is how your ActivityDefinition should look like
+This is how the ActivityDefinition should look like
```xml
@@ -589,7 +589,7 @@ The `recipient` will decide which DSF instance is allowed to process that messag
```
-The last element defined in the [process authorization extension](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) is `Extension.url`. But since we added this element at the very beginning of the working through the extension, we are finished with it here.
+The last element defined in the [process authorization extension](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) is `Extension.url`. This was already added at the very beginning of the working through the extension, so there is nothing more to add.
#### 3. BPE Managed Elements
@@ -597,11 +597,11 @@ Some elements of [ActivityDefinitions](../fhir/activitydefinition.md) are manage
The following elements are managed by the DSF BPE:
- `ActivityDefinition.version` should use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{version}`
-- `ActivityDefinition.date` is not required, but should you decide to include it, use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{date}`
+- `ActivityDefinition.date` is not required, but if it is included, it should use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{date}`
- `ActivityDefinition.status` must have a value of `unknown`
-Your ActivityDefinition should now look like this
+The ActivityDefinition should now look like this
```xml
@@ -661,10 +661,10 @@ The following elements are managed by the DSF BPE:
```
-#### 4. Regular Elements
+### 4. Regular Elements
-The only required elements in this set are `ActivityDefinition.url` and `ActivityDefinition.kind`. Check out the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls) on how to choose the correct value for `ActivityDefinition.url`. `ActivityDefinition.kind` must have the value `Task`.
-All other elements can technically be omitted. Still, we recommend you include the following elements:
+The only required elements in this set are `ActivityDefinition.url` and `ActivityDefinition.kind`. `ActivityDefinition.url` expects a certain format. This is explained in detail in the [documentation on URLs](../dsf/versions-placeholders-urls.md#urls). `ActivityDefinition.kind` must have the value `Task`.
+All other elements can technically be omitted. Still, the following elements are recommended to be populated:
- `AcitivityDefinition.name`
- `AcitivityDefinition.title`
- `AcitivityDefinition.subtitle`
@@ -674,7 +674,7 @@ All other elements can technically be omitted. Still, we recommend you include t
- `AcitivityDefinition.description`
-Your finished ActivityDefinition should now look something like this
+The finished ActivityDefinition should now look something like this
```xml
@@ -747,4 +747,7 @@ All other elements can technically be omitted. Still, we recommend you include t
```
-
\ No newline at end of file
+
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md), [Creating CodeSystems for DSF Processes](creating-codesystems-for-dsf-processes.md), [Creating ValueSets for DSF Processes](creating-valuesets-for-dsf-processes.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v1/guides/creating-codesystems-for-dsf-processes.md b/docs/src/process-development/api-v1/guides/creating-codesystems-for-dsf-processes.md
index 5ab6d87f1..c6e45e0d0 100644
--- a/docs/src/process-development/api-v1/guides/creating-codesystems-for-dsf-processes.md
+++ b/docs/src/process-development/api-v1/guides/creating-codesystems-for-dsf-processes.md
@@ -3,9 +3,9 @@ title: Creating CodeSystems for DSF Processes
icon: creative
---
-### Creating CodeSystems for DSF Processes
+## Creating CodeSystems for DSF Processes
-You might find yourself in a situation where you need to create a [CodeSystem](../fhir/codesystem.md). For example, when defining the type of an [Input Parameter](../fhir/task.md#task-input-parameters). [CodeSystems](../fhir/codesystem.md) for the DSF differ from regular [CodeSystems](../fhir/codesystem.md) in that some element's values are managed by the DSF BPE server. You can use the following XML as a template:
+Sometimes it is necessary to create custom [CodeSystem](../fhir/codesystem.md) resources. For example, when defining the type of an [Input Parameter](../fhir/task.md#task-input-parameters). [CodeSystems](../fhir/codesystem.md) for the DSF differ from regular [CodeSystems](../fhir/codesystem.md) in that some element's values are managed by the DSF BPE server. The following template can be populated with custom values:
```xml
@@ -37,6 +37,9 @@ You might find yourself in a situation where you need to create a [CodeSystem](.
```
-Replace dummy values with appropriate values of your own. Do not change elements managed by the DSF BPE server. You can add as many codes as you like by defining more `concept` elements.
+Dummy values should be replaced with appropriate values. Elements managed by the DSF BPE server should not be changed. More codes can be added by defining more `concept` elements.
-The DSF BPE server will read your [CodeSystem](../fhir/codesystem.md) from `tutorial-process/src/main/resources/fhir/CodeSystem`.
\ No newline at end of file
+When building a plugin, the [CodeSystem](../fhir/codesystem.md) is expected to be in `src/main/resources/fhir/CodeSystem` of the Java project.
+
+## Related Topics
+[Adding Task Input Parameters to Task Profiles](adding-task-input-parameters-to-task-profiles.md), [CodeSystem](../fhir/codesystem.md), [Creating ValueSets for DSF processes](creating-valuesets-for-dsf-processes.md), [ValueSet](../fhir/valueset.md)
diff --git a/docs/src/process-development/api-v1/guides/creating-task-resources-based-on-a-definition.md b/docs/src/process-development/api-v1/guides/creating-task-resources-based-on-a-definition.md
index 6306ab128..34a1c0092 100644
--- a/docs/src/process-development/api-v1/guides/creating-task-resources-based-on-a-definition.md
+++ b/docs/src/process-development/api-v1/guides/creating-task-resources-based-on-a-definition.md
@@ -3,27 +3,29 @@ title: Creating Task Resources Based on a Definition
icon: creative
---
-### Creating Task Resources Based on a Definition
+## Creating Task Resources Based on a Definition
-This short guide should help you understand how you can create [Task](../fhir/task.md) resources for use in [Starting A Process Via Task Resources](../guides/starting-a-process-via-task-resources.md). We will employ the use of the free version of [Forge](https://simplifier.net/forge?utm_source=firely-forge) to help with visualization. You are invited to create a free account and follow along, but we will include screenshots of relevant views either way. Remember that the free version of Forge [must not be used commercially](https://simplifier.net/pricing). As an example, we will create a [Task](../fhir/task.md) resource from the `task-start-dic-process.xml` profile.
+This short guide provides an overview of how to create [Task](../fhir/task.md) resources for use in [Starting A Process Via Task Resources](../guides/starting-a-process-via-task-resources.md). The free version of [Forge](https://simplifier.net/forge?utm_source=firely-forge) is used to support visualization. A free account can be created to follow the process directly; however, screenshots of relevant views are included for reference. Note that the free version of Forge [must not be used commercially](https://simplifier.net/pricing). As an example, a [Task](../fhir/task.md) resource based on the [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) profile is created.
-#### 1st Step: Removing Placeholders
-`task-start-dic-process.xml` includes placeholders for the `version` and `date` elements. For the duration of this guide, you can either remove or comment these elements, so Forge does not try to perform type checking on them, which would result in an error and Forge not loading the file.
-#### 2nd Step: Differential Chain
-If the resource profile is only available as a [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot), like in our case, we will want to aggregate the changes made to the base resource (in this case [Task](../fhir/task.md)) by all profiles to make it more readable. To do this, we first need all the profiles involved. We already have `task-start-dic-process.xml` in our `StructureDefinition` folder. It lists a resource called `task-base` in its `baseDefinition` element. This resource is part of the DSF and can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). Put it into the `StructureDefinition` folder. Since `task-base` has the original FHIR Task as its `baseDefinition` element, we are done with this chain. In forge, you should now be able to open the `StructureDefinition` folder and select the `task-start-dic-process.xml` profile. It should look something like this:
+### 1st Step: Removing Placeholders
+[`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) includes placeholders for the `version` and `date` elements. For the purpose of this guide, these elements can either be removed or commented out to prevent Forge from performing type checking on them, which would otherwise result in an error and cause Forge to not load the file.
+
+### 2nd Step: Differential Chain
+If the resource profile is only available as a [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot), as in this case, it is helpful to aggregate the changes made to the base resource (in this case [Task](../fhir/task.md)) by all profiles to improve readability. To accomplish this, all relevant profiles are required. The [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) file is already present. This file lists a resource called `task-base` in its `baseDefinition` element. The `task-base` resource is part of the DSF and can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). It should also be placed in the same folder as [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml). Since `task-base` uses the original FHIR Task as its `baseDefinition` element, no additional resources are needed to complete this chain. In Forge, opening the folder containing both resources and selecting the [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) profile should display a view similar to the following:
+
-#### 3rd Step: Building the Task Resource
-We will now go through each element one by one and include it into our [Task](../fhir/task.md) resource, provided it is mandatory (cardinality at least `1..1`) according to the profile. It is important that you not use any placeholders like `#{version}` for resources not read by the DSF BPE server. This is the case if we want a [Task](../fhir/task.md) resource for use with [cURL](../guides/starting-a-process-via-task-resources.md#using-curl). But, placeholders should be used in [Draft Task Resources](../dsf/draft-task-resources.md) instead of actual values wherever possible, since those are read by the DSF BPE server. This guide will create a [Task](../fhir/task.md) resource without placeholders. We will start out with the base element for all [Task](../fhir/task.md) resources:
+### 3rd Step: Building the Task Resource
+Each element will now be reviewed and included in the [Task](../fhir/task.md) resource if it is mandatory (cardinality of at least `1..1`) according to the profile. Placeholders such as `#{version}` must not be used for resources that are not read by the DSF BPE server. This applies when creating a [Task](../fhir/task.md) resource intended for use with [cURL](../guides/starting-a-process-via-task-resources.md#using-curl). In contrast, placeholders should be used in [Draft Task Resources](../dsf/draft-task-resources.md) instead of actual values wherever possible, as these resources are read by the DSF BPE server. This guide demonstrates the creation of a [Task](../fhir/task.md) resource without placeholders, beginning with the base element required for all [Task](../fhir/task.md) resources:
```xml
```
-Before we start adding any elements listed in Forge's element tree, we have to include the `Task.meta.profile` element. Its requirement cannot be seen here which is why we mention it specifically. This is the only instance you will not see it in the element tree. It should look like this:
+Before adding any elements listed in Forge's element tree, the `Task.meta.profile` element must be included. Its requirement is not visible in the element tree, which is why it is mentioned explicitly. This is the only instance where it does not appear in the element tree. It should look like this:
```xml
@@ -32,7 +34,7 @@ Before we start adding any elements listed in Forge's element tree, we have to i
```
-The first element which can be found in the element tree is the `instantiatesCanonical` element. To add it, we will create an XML element with the same name and the value according to [URLs](../dsf/versions-placeholders-urls.md#urls):
+The first element listed in the element tree is the `instantiatesCanonical` element. To add this element, an XML element with the same name should be created, using a value as specified in [URLs](../dsf/versions-placeholders-urls.md#urls):
```xml
@@ -43,7 +45,7 @@ The first element which can be found in the element tree is the `instantiatesCan
```
We can continue this process for all primitive elements like these. Just make sure you pay attention to use the correct data type (e.g. proper coding value for elements with `coding` type).
-By now your [Task](../fhir/task.md) resources should look something like this:
+The [Task](../fhir/task.md) resource should look something like this:
Suggested solution
@@ -60,11 +62,11 @@ By now your [Task](../fhir/task.md) resources should look something like this:
```
-Let us look at a more complex element like the `requester` element:
+Now a more complex element like the `requester` element:
-We will start the same way we started with primitive elements, by adding the `requester` element:
+The beginning is the same as primitive elements, adding the `requester` element:
```xml
@@ -80,7 +82,7 @@ We will start the same way we started with primitive elements, by adding the `re
```
-Then, we will add primitive elements to `requester` like we did before for `Task`:
+Then, primitive elements are added to `requester` like before for `Task`:
```xml
@@ -97,7 +99,7 @@ Then, we will add primitive elements to `requester` like we did before for `Task
```
*Important to note here that the value for the `status` will always be `requested` for Tasks being posted using cURL and the `type` element for `requester` and `recipient` will always have the value `Organization` in the DSF context.*
-Next, we will add the `identifier` element and its primitive sub-elements just like we started out doing it for the `requester` element. The `identifier.value` in this case will be `dic.dsf.test`. To understand why, take a look at the topic on [organization identifiers](../dsf/organization-identifiers.md):
+Next, the `identifier` element and its primitive sub-elements are added just like before. The `identifier.value` in this case will be `dic.dsf.test`. To understand why, take a look at the topic on [organization identifiers](../dsf/organization-identifiers.md):
```xml
@@ -116,9 +118,9 @@ Next, we will add the `identifier` element and its primitive sub-elements just l
```
-*Notice that `requester.identifier.system` has a `Fixed value` annotation. You can see what the value is supposed to be by clicking on the `system` element in Forge or looking at the XML for the right Task profile. The right side will have all information about that element, including the actual value for `Fixed value`.*
+*The `requester.identifier.system` has a `Fixed value` annotation. Clicking on the `system` element in Forge or looking at the XML for the right Task profile reveals what the value is supposed to be. The right side will have all information about that element, including the actual value for `Fixed value`.*
-You should now be able to fill out all elements in your [Task](../fhir/task.md) resource until you reach the [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for `Task.input`. Your [Task](../fhir/task.md) resource should look something like this:
+Filling out all elements in the [Task](../fhir/task.md) resource is now the same until the [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for `Task.input`. The [Task](../fhir/task.md) resource should look something like this:
Suggested solution
@@ -152,11 +154,11 @@ You should now be able to fill out all elements in your [Task](../fhir/task.md)
-[Slicings](https://www.hl7.org/fhir/R4/profiling.html#slicing) are a bit different from regular elements. Let us look at the slice `message-name`:
+[Slicings](https://www.hl7.org/fhir/R4/profiling.html#slicing) are a bit different from regular elements. Starting with the slice `message-name`:
-If we were to continue including slices to the [Task](../fhir/task.md) resource like we did so far, we would add a `message-name` element to our XML like this:
+Including slices to the [Task](../fhir/task.md) resource like previous element would add a `message-name` element to our XML like this:
```xml
@@ -169,7 +171,7 @@ If we were to continue including slices to the [Task](../fhir/task.md) resource
```
-This approach however, would not work. FHIR processors do not use the name of the slice to map entries in your [Task](../fhir/task.md) resource to the correct slice. They use [discriminators](https://www.hl7.org/fhir/R4/profiling.html#discriminator). Discriminators define the elements a processor needs to distinguish slices by. You can see how the discriminator is configured by selecting the `input` element in Forge. In our case, a processor would look at the values for `input.type.coding.system` and `input.type.coding.code` to determine which slice this element belongs to. This only works because `input.type.coding.system` and `input.type.coding.code` are present in all slices and have a `Fixed value`. You can learn more about discriminators [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator). All this means is that we effectively ignore the name of the slice as an element and start adding elements like we did before:
+This approach however, would not work. FHIR processors do not use the name of the slice to map entries in your [Task](../fhir/task.md) resource to the correct slice. They use [discriminators](https://www.hl7.org/fhir/R4/profiling.html#discriminator). Discriminators define the elements a processor needs to distinguish slices by. The discriminator configuration can be seen by selecting the `input` element in Forge. In this case, a processor would look at the values for `input.type.coding.system` and `input.type.coding.code` to determine which slice this element belongs to. This only works because `input.type.coding.system` and `input.type.coding.code` are present in all slices and have a `Fixed value`. More about discriminators can be read [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator). This means effectively ignoring the name of the slice as an element and start adding elements like before:
```xml
@@ -186,7 +188,7 @@ This approach however, would not work. FHIR processors do not use the name of th
```
-Now you should be able to add all remaining mandatory elements to your [Task](../fhir/task.md) resource on your own. In the end, it should look something like this:
+This covers all ways of adding elements. Adding the remaining elements is left as an exercise. In the end, it should look something like this:
Suggested solution
@@ -228,4 +230,7 @@ Now you should be able to add all remaining mandatory elements to your [Task](..
```
-**Do not forget to restore the version and date placeholders in `task-start-dic-process.xml`!**
\ No newline at end of file
+**Do not forget to restore the version and date placeholders in [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) when reusing the resource in a process plugin!**
+
+## Related Topics
+[Draft Task Resources](../dsf/draft-task-resources.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v1/guides/creating-valuesets-for-dsf-processes.md b/docs/src/process-development/api-v1/guides/creating-valuesets-for-dsf-processes.md
index f273196ec..69f7744db 100644
--- a/docs/src/process-development/api-v1/guides/creating-valuesets-for-dsf-processes.md
+++ b/docs/src/process-development/api-v1/guides/creating-valuesets-for-dsf-processes.md
@@ -3,10 +3,10 @@ title: Creating ValueSets for DSF Processes
icon: creative
---
-### Creating ValueSets for DSF Processes
+## Creating ValueSets for DSF Processes
+
+In some cases, it may be necessary to create a [ValueSet](../fhir/valueset.md). For example, when adding [Input Parameters](../fhir/task.md#task-input-parameters) to DSF [Task](../fhir/task.md) resources, a [ValueSet](../fhir/valueset.md) resource must also be referenced in the binding for `Task.input.type` to define the type of the [Input Parameter](../fhir/task.md#task-input-parameters). [ValueSets](../fhir/valueset.md) for the DSF differ from regular [ValueSets](../fhir/valueset.md) in that certain element values are managed by the DSF BPE server. The following template can be used for a [ValueSet](../fhir/valueset.md):
-You might find yourself in the situation where you need to create a [ValueSet](../fhir/valueset.md). For example, when adding [Input Parameters](../fhir/task.md#task-input-parameters) to DSF [Task](../fhir/task.md) resources, you will also have to reference a [ValueSet](../fhir/valueset.md) resource in your binding for `Task.input.type` to be able to set the type of your [Input Parameter](../fhir/task.md#task-input-parameters). [ValueSets](../fhir/valueset.md) for the DSF differ from regular [ValueSets](../fhir/valueset.md) in that some element's values are managed by the DSF BPE server. You can use the following template for your
-[ValueSet](../fhir/valueset.md):
```xml
@@ -36,7 +36,7 @@ You might find yourself in the situation where you need to create a [ValueSet](.
```
-Replace dummy values with appropriate values of your own. Do not change elements managed by the DSF BPE server. The `compose` element defines the codes included in this [ValueSet](../fhir/valueset.md). It holds at least one `include` element. Each `include` element refers to a [CodeSystem](../fhir/codesystem.md) and contains a list of `concept` elements which in turn contain the actual `code` element. Using one code from `my-code-system` and one code from `my-other-code-system` would result in the following `compose` element:
+Dummy values should be replaced with appropriate, context-specific values. Elements managed by the DSF BPE server must not be modified. The `compose` element defines the codes included in this [ValueSet](../fhir/valueset.md) and contains at least one `include` element. Each `include` element references a [CodeSystem](../fhir/codesystem.md) and includes a list of `concept` elements, each containing an individual `code` element. The use of one code from `my-code-system` and one code from `my-other-code-system` results in the following `compose` element:
```xml
...
@@ -58,6 +58,7 @@ Replace dummy values with appropriate values of your own. Do not change elements
```
-The DSF BPE server will read your [ValueSet](../fhir/valueset.md) from `tutorial-process/src/main/resources/fhir/ValueSet`.
+When building a plugin, the [ValueSet](../fhir/valueset.md) is expected to be in `src/main/resources/fhir/CodeSystem` of the Java project.
-You might also want to check out [this guide](../guides/creating-codesystems-for-dsf-processes.md) on how to create [CodeSystems](../fhir/codesystem.md).
\ No newline at end of file
+## Related Topics
+[CodeSystem](../fhir/codesystem.md), [Creating CodeSystems for DSF processes](creating-codesystems-for-dsf-processes.md), [ValueSet](../fhir/valueset.md)
diff --git a/docs/src/process-development/api-v1/guides/managing-mutiple-incoming-messages-and-missing-messages.md b/docs/src/process-development/api-v1/guides/managing-mutiple-incoming-messages-and-missing-messages.md
index a0c8f6120..a0cf72993 100644
--- a/docs/src/process-development/api-v1/guides/managing-mutiple-incoming-messages-and-missing-messages.md
+++ b/docs/src/process-development/api-v1/guides/managing-mutiple-incoming-messages-and-missing-messages.md
@@ -3,16 +3,20 @@ title: Managing Multiple Incoming Messages and Missing Messages
icon: creative
---
-### Managing Multiple Incoming Messages and Missing Messages
+## Managing Multiple Incoming Messages and Missing Messages
If an already running process instance is waiting for a message from another organization, the corresponding FHIR [Task](../fhir/task.md) may never arrive. Either because the other organization decides to never send the message or because some technical problem prohibits the [Task](../fhir/task.md) resource from being posted to the DSF FHIR server. This would result in stale process instances that never finish.
-At the same time, you might also expect to receive one out of a number of different message types at once.
+At the same time, it might also be expected to receive one out of a number of different message types at once.
-In order to solve both problems we can add an [Event Based Gateway](../bpmn/gateways.md#event-based-gateway) to the process waiting for a response and then either handle a [Task](../fhir/task.md) resource with the response and finish the process in a success state or trigger a [Timer Intermediate Catching Event](../bpmn/timer-intermediate-catching-events.md) after a defined wait period and finish the process in an error state. The following BPMN collaboration diagram shows how the process at the first organization would look like if we wanted to react to multiple different messages or missing messages:
+An [Event Based Gateway](../bpmn/gateways.md#event-based-gateway) can be used to solve both problems by adding it to the process waiting for a response and then either handling a [Task](../fhir/task.md) resource with the response and finish the process in a success state or triggering a [Timer Intermediate Catching Event](../bpmn/timer-intermediate-catching-events.md) after a defined wait period and finish the process in an error state. The following BPMN collaboration diagram shows how the process at the first organization would look like if we wanted to react to multiple different messages or missing messages:
+
+
+## Related Topics
+[Gateways](../bpmn/gateways.md), [Message Correlation](../dsf/message-correlation.md), [Message Delegates](../dsf/message-delegates.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/guides/setting-targets-for-message-events.md b/docs/src/process-development/api-v1/guides/setting-targets-for-message-events.md
index 68db0b1e0..d5ea828e5 100644
--- a/docs/src/process-development/api-v1/guides/setting-targets-for-message-events.md
+++ b/docs/src/process-development/api-v1/guides/setting-targets-for-message-events.md
@@ -3,12 +3,10 @@ title: Setting Targets for Message Events
icon: creative
---
-### Setting Targets for Message Events
+## Setting Targets for Message Events
-Setting a target for a message event requires a `Target` object. To create one, you require a target's organization identifier, endpoint identifier and endpoint address. You can find these values by visiting the DSF FHIR server's web interface. In the top right corner, click the `Show Bookmarks` button, then select `Endpoint`. You will be taken to a list of all Endpoints available to the FHIR server. There are two ways of adding `targets` to the BPMN execution variables:
-#### 1. Adding the target in the message event implementation
-In your message event implementation (the class extending `AbstractTaskMessageSend`), you can override `AbstractTaskMessageSend#doExecute`, add your targets and then call the super-method.
-#### 2. Adding the target in a service task right before the message event
-This is the preferred method of this tutorial but both methods will work perfectly fine. For our use cases, we usually prefer this one since there is enough complexity to warrant putting it into a separate BPMN [Service Task](../bpmn/service-tasks.md).
+Setting a target for a message event requires a `Target` object. Creating this object requires the target's organization identifier, endpoint identifier, and endpoint address. These values can be obtained from the DSF FHIR server's web interface or by querying the FHIR server via an instance of `FhirWebserviceClient`. By clicking the `Show Bookmarks` button in the top right corner and selecting `Endpoint`, a list of all Endpoints available to the FHIR server will be displayed. Instances of `FhirWebserviceClient` can be accessed via the [process plugin API](../dsf/process-plugin-api.md).
+Targets should be added in a [Service Task](../bpmn/service-tasks.md) before a [Message Event](../bpmn/messaging.md). A `Variables` instance provides helper methods to set targets in a [Service Task's](../bpmn/service-tasks.md) `doExecute` method.
-In both cases you can access methods to create and set `targets` through the `Variables` instance.
+## Related Topics
+[Process Plugin API](../dsf/process-plugin-api.md), [Message Correlation](../dsf/message-correlation.md), [Target and Targets](../dsf/target-and-targets.md)
diff --git a/docs/src/process-development/api-v1/guides/starting-a-process-via-task-resources.md b/docs/src/process-development/api-v1/guides/starting-a-process-via-task-resources.md
index baa36a7bb..aaf7287fd 100644
--- a/docs/src/process-development/api-v1/guides/starting-a-process-via-task-resources.md
+++ b/docs/src/process-development/api-v1/guides/starting-a-process-via-task-resources.md
@@ -3,20 +3,19 @@ title: Starting a Process via Task Resources
icon: creative
---
-### Starting a Process via Task Resources
+## Starting a Process via Task Resources
-To start a BPMN process, you need to create new a [Task](../fhir/task.md) resource in the DSF FHIR server by sending an HTTP request according to the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html). Specifically, you need to [create](https://www.hl7.org/fhir/R4/http.html#create)
-a resource for the first time. Also, remember that the [Task](../fhir/task.md) resource you are sending needs to comply to the [Task](../fhir/task.md) profile of the process you want to start and the [ActivityDefinition's](../fhir/activitydefinition.md) authorization rules.
+To start a BPMN process, a new [Task](../fhir/task.md) resource must be created in the DSF FHIR server by sending an HTTP request in accordance with the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html). Specifically, a [create](https://www.hl7.org/fhir/R4/http.html#create) operation is required to generate the resource for the first time. The [Task](../fhir/task.md) resource being sent must conform to the [Task](../fhir/task.md) profile of the intended process and adhere to the [ActivityDefinition's](../fhir/activitydefinition.md) authorization rules.
There are two major ways of making this HTTP request:
1. Using cURL
2. Using the DSF FHIR server's web interface
-#### Using cURL
-In order to use cURL, you will have to create an appropriate [Task](../fhir/task.md) resource to post to the DSF FHIR server. There already is a file called `example-task.xml` located in `tutorial-process/src/main/resources/fhir`. You can use this as your starting point. You can try to follow [this guide](../guides/creating-task-resources-based-on-a-definition.md), or you can check the solution branches for this file if you need ideas on how to fill it out properly.
+### Using cURL
+To use cURL, an appropriate [Task](../fhir/task.md) resource must be created and posted to the DSF FHIR server. There is a guide on [creating Task Resources based on a StructureDefinition](../guides/creating-task-resources-based-on-a-definition.md). A file named `example-task.xml` is available in `tutorial-process/src/main/resources/fhir` in the [DSF Process Tutorial](https://github.com/datasharingframework/dsf-process-tutorial) and can serve as a starting point. The [solution branches of the tutorial](https://github.com/datasharingframework/dsf-process-tutorial/blob/solutions/exercise-1/tutorial-process/src/main/resources/fhir/Task/task-start-dic-process.xml) can be consulted for a full example.
-Below are some cURL command skeletons. Replace all <>-Placeholders with appropriate values. Host name depends on the instance you want to address.
+Below is a cURL command skeleton. All <>-Placeholders should be replaced with appropriate values. Host name depends on the instance that should be addressed.
-##### Linux:
+#### Linux:
```shell
curl https:///fhir/Task \
--cacert \
@@ -26,18 +25,12 @@ curl https:///fhir/Task \
-H "Accept: application/fhir+xml" \
-d @
```
-##### Windows CMD:
-```shell
-curl https:///fhir/Task ^
---cacert ^
---cert :password ^
---key ^
--H "Content-Type: application/fhir+xml" ^
--H "Accept: application/fhir+xml" ^
--d @
-```
-*This may throw an error depending on which version of cURL Windows is using. If this is the case for you after making sure you entered everything correctly, you can try using Git's version of cURL instead by adding it to the very top of your system's PATH environment variable. Git's cURL is usually situated in C:\Program Files\Git\mingw64\bin.*
-#### Using the DSF FHIR Server's Web Interface
+### Using the DSF FHIR Server's Web Interface
+
+When accessing the web interface of a DSF FHIR server instance (e.g. https://instance-name/fhir), the DSF FHIR server can be queried using the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html) to return a list of all [Draft Task Resources](../dsf/draft-task-resources.md). These [Task](../fhir/task.md) resources serve as templates for instantiating [Task](../fhir/task.md) resources that initiate BPMN processes. Instead of performing the query manually, a predefined bookmark can be used to navigate to the query URL. A list of bookmarks is available in the top right corner of the web interface. Selecting the bookmark referencing `?_sort=_profile,identifier&status=draft` under the `Task` section will display the list of all [Draft Task Resources](../dsf/draft-task-resources.md). From this list, the desired resource to start the BPMN process can be selected. A detailed view of the resource will be shown, allowing the specification of any necessary [Task Input Parameters](../fhir/task.md#task-input-parameters). If all required information is provided correctly, the process can be initiated by clicking `Start Process`.
+
+For [Draft Task Resources](../dsf/draft-task-resources.md) to be available, they must be included in the mapping for the BPMN process ID in `ProcessPluginDefinition#getFhirResourcesByProcessId`. Additional information can be found in [the Process Plugin Definition](../dsf/process-plugin-definition.md).
-When visiting the web interface of a DSF FHIR server instance (e.g. https://instance-name/fhir), you can query the DSF FHIR server using the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html) to return a list of all [Draft Task Resources](../dsf/draft-task-resources.md). These [Task](../fhir/task.md) resources act like a template you can use to instantiate [Task](../fhir/task.md) resources which start BPMN processes. Instead of querying the DSF FHIR server manually, you can use a predefined bookmark to navigate to the query URL. You can find a list of Bookmarks in the top right corner of the web interface. Simply select the bookmark referencing `?_sort=_profile,identifier&status=draft` under the `Task` section, and you will be taken to the list of all [Draft Task Resources](../dsf/draft-task-resources.md). Once there, you can select the one which starts your BPMN process. It will take you to a detailed view of the resource where you will also have the chance to fill any [Task Input Parameters](../fhir/task.md#task-input-parameters) you might need to specify. If everything is filled out correctly, you may start your process by clicking `Start Process`. Keep in mind that, for [Draft Task Resources](../dsf/draft-task-resources.md) to be available, you need to include them in your mapping for your BPMN process ID in `ProcessPluginDefinition#getFhirResourcesByProcessId`. Take a look at [the Process Plugin Definition](../dsf/process-plugin-definition.md) if you need a reminder.
\ No newline at end of file
+## Related Topics
+[Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v1/guides/user-tasks-in-the-dsf.md b/docs/src/process-development/api-v1/guides/user-tasks-in-the-dsf.md
index 3c987de8a..c13bee63b 100644
--- a/docs/src/process-development/api-v1/guides/user-tasks-in-the-dsf.md
+++ b/docs/src/process-development/api-v1/guides/user-tasks-in-the-dsf.md
@@ -5,11 +5,17 @@ icon: creative
### User Tasks in the DSF
-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 according to a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) you provided in the [User Task's](../bpmn/user-tasks.md) `Forms` field when the process execution reaches the [User Task](../bpmn/user-tasks.md). The `Forms` field needs to have a type of `Embedded or External Task Forms` with the `Form key` being the url of your [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource needs to be put in the `src/main/resources/fhir/Questionnaire` directory. The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can now be answered by locating the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) in the DSF FHIR server UI through `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress`. After filling out the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) and submitting it, the process execution will continue with the next BPMN element after the [User Task](../bpmn/user-tasks.md) and the updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will be available through the [Process Plugin Api's](../dsf/process-plugin-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
+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.
-You also have the option 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 allows you to manipulate the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) before it is posted to the DSF FHIR server. You do this by extending the `DefaultUserTaskListener` class which provides overrides to interact with the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html). Notice that dynamically changing the `item.text` value of an item in a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) (that is **NOT** of type `display`) is not allowed. For that, you would have to change the `item.text` value of the corresponding [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource as well. Instead, you should have an item of type `display` above the item whose text should change dynamically, like in the template, and change its `item.text` value. In this case, you may also leave out `item.text` element of the item below the display item.
+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()`.
+
+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).
+
+Dynamically changing the `item.text` value of an item in a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) (if the item is **not** of type `display`) is not permitted. To change text dynamically, the `item.text` value of the corresponding [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource must also be updated. As an alternative, an item of type `display` can be placed above the item requiring dynamic text, and its `item.text` value can be modified instead, as shown in the template. In this case, the `item.text` element of the item below the display item may be omitted.
+
+
+Below is a template for a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The placeholder `questionnaire-name` should be replaced with the actual name of the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html), and the file should be named accordingly. The items `business-key` and `user-task-id` are required by the DSF and must always be included. Additional items can be added to the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) as needed.
-Below you can find a template for a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. Replace `questionnaire-name` with the name of your [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and have the file be named the same. The items `business-key` and `user-task-id` are required by the DSF and are always included. You can then add any amount of items of your choosing to the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html).
### Questionnaire Template
```xml
@@ -54,4 +60,7 @@ Below you can find a template for a [Questionnaire](https://www.hl7.org/fhir/R4/
-```
\ No newline at end of file
+```
+
+## Related Topics
+[Questionnaire and QuestionnaireResponse](../fhir/questionnaire-and-questionnaireresponse.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v1/index.md b/docs/src/process-development/api-v1/index.md
deleted file mode 100644
index 436fda63f..000000000
--- a/docs/src/process-development/api-v1/index.md
+++ /dev/null
@@ -1,47 +0,0 @@
----
-title: API v1
-icon: code
----
-
-## BPMN
-- [Conditions](bpmn/conditions.md)
-- [Gateways](bpmn/gateways.md)
-- [Messaging](bpmn/messaging.md)
-- [Sequence Flow](bpmn/sequence-flow.md)
-- [Service Tasks](bpmn/service-tasks.md)
-- [Timer Intermediate Catching Events](bpmn/timer-intermediate-catching-events.md)
-
-## FHIR
-- [ActivityDefinition](fhir/activitydefinition.md)
-- [Codesystem](fhir/codesystem.md)
-- [Task](fhir/task.md)
-- [ValueSet](fhir/valueset.md)
-
-## DSF
-- [BPMN Process Execution](dsf/bpmn-process-execution.md)
-- [BPMN Process Variables](dsf/bpmn-process-variables.md)
-- [Draft Task Resources](dsf/draft-task-resources.md)
-- [Environment Variables](dsf/environment-variables.md)
-- [Message Correlation](dsf/message-correlation.md)
-- [Message Delegates](dsf/message-delegates.md)
-- [Organization Identifiers](dsf/organization-identifiers.md)
-- [Process Plugin API](dsf/process-plugin-api.md)
-- [Process Plugin Definition](dsf/process-plugin-definition.md)
-- [Read Access Tag](dsf/read-access-tag.md)
-- [Requester and Recipient](dsf/requester-and-recipient.md)
-- [Service Delegates](dsf/service-delegates.md)
-- [Spring Framework Integration](dsf/spring-framework-integration.md)
-- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md)
-
-## Guides
-- [Accessing BPMN Process Variables](guides/accessing-bpmn-process-variables.md)
-- [Accessing Task Resources During Execution](guides/accessing-task-resources-during-execution.md)
-- [Adding Task Input Parameters to Task Profiles](guides/adding-task-input-parameters-to-task-profiles.md)
-- [Configuring Read Access Tags](guides/configuring-read-access-tags.md)
-- [Creating ActivityDefinitions](guides/creating-activity-definitions.md)
-- [Creating CodeSystems for DSF Processes](guides/creating-codesystems-for-dsf-processes.md)
-- [Creating Task Resources Based on a Definition](guides/creating-task-resources-based-on-a-definition.md)
-- [Creating ValueSets for DSF Processes](guides/creating-valuesets-for-dsf-processes.md)
-- [Managing Multiple Incoming Messages and Missing Messages](guides/managing-mutiple-incoming-messages-and-missing-messages.md)
-- [Setting Targets for Message Events](guides/setting-targets-for-message-events.md)
-- [Starting a Process via Task Resources](guides/starting-a-process-via-task-resources.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/bpmn/conditions.md b/docs/src/process-development/api-v2/bpmn/conditions.md
index 41447df07..e4680fc81 100644
--- a/docs/src/process-development/api-v2/bpmn/conditions.md
+++ b/docs/src/process-development/api-v2/bpmn/conditions.md
@@ -3,6 +3,7 @@ title: Conditions
icon: creative
---
-### Conditions
+## Conditions
+
+BPMN elements can have a property attached to them which either executes a script or evaluates an expression in order to make a decision. The most common example of this is the [Sequence Flow](./sequence-flow.md) elements following an [Exclusive Gateway](./gateways.md). Each [Sequence Flow](./sequence-flow.md) element will have a condition attached to decide which flow should be pursued. The [Camunda Modeler](https://camunda.com/download/modeler/) distinguishes the two types in the `Type` attribute of the `Condition` tab in a BPMN element. Camunda comes with a GraalVM JavaScript engine but can be extended with other types of scripting engines. See the Camunda documentation on [scripting](https://docs.camunda.org/manual/latest/user-guide/process-engine/scripting/) for more details. Expressions are short boolean evaluations and have the following syntax: `${expression}`. An example of a simple expression would be a condition like `var = true`. For this to work during BPMN process execution, the variable that is used for the boolean condition must be available in the BPMN process variables before the [Sequence Flow](sequence-flow.md) reaches the evaluation of the expression. You can learn more advanced features of Expressions [here](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/).
-[Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) allow you to change the behaviour of BPMN processes during execution. There are two ways you are able to add decision logic to Conditions. The [Camunda Modeler](https://camunda.com/download/modeler/) refers to them as `Type`. You can find them in the ``Condition`` tab of certain BPMN elements. The first one is `Script`. This allows you to add arbitrary complexity to your decisions logic and is rarely used for process plugins. The more common Type is `Expression`. Expressions have the following syntax: `${expression}`. An example of a simple expression would be a boolean condition like `var == true`. For this to work during BPMN process execution, the variable you want to use for the boolean condition must be available in the BPMN process variables before [Sequence Flow](sequence-flow.md) reaches the evaluation of the expression. You can learn more advanced features of Expressions [here](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/).
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/bpmn/gateways.md b/docs/src/process-development/api-v2/bpmn/gateways.md
index 630b26ae0..4c0726281 100644
--- a/docs/src/process-development/api-v2/bpmn/gateways.md
+++ b/docs/src/process-development/api-v2/bpmn/gateways.md
@@ -3,14 +3,18 @@ title: Gateways
icon: creative
---
-### Gateways
+## Gateways
-[Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/) allow you to control the [Sequence Flow](sequence-flow.md). Different types of gateways are useful for different scenarios.
+[Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/) allow modelling of decision-based and concurrent workflows. [Exclusive Gateways](#exclusive-gateways) model a decision where one flow gets pursued over other flows. [Event-based Gateways](#event-based-gateways) also model a decision, but are based on events. [Parallel Gateways](#parallel-gateways) model concurrency.
-#### Exclusive Gateways
+### Exclusive Gateways
-[Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) allow you to decide which [Sequence Flow](sequence-flow.md) should be followed based on [conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions). [Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) are not part of the [Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) themselves. You set them through the sequence flow exiting the [Exclusive Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/). In the [Camunda Modeler](https://camunda.com/download/modeler/), you can add conditions to [Sequence Flow](sequence-flow.md) by selecting a [Sequence Flow](sequence-flow.md) and opening the `Condition` tab. You can find more information on how to use Conditions [here](conditions.md).
+[Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) decide which one out of multiple [Sequence Flow](sequence-flow.md) should be followed based on [conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions). [Conditions](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#conditions) are not part of the [Exclusive Gateways](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/) themselves. They are set through the sequence flow exiting the [Exclusive Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/exclusive-gateway/). In the [Camunda Modeler](https://camunda.com/download/modeler/), conditions can be added to [Sequence Flows](sequence-flow.md) by selecting a [Sequence Flow](sequence-flow.md) and opening the `Condition` tab. More information on how to use Conditions can be found in [Conditions](conditions.md).
-#### Event-based Gateway
+### Event-based Gateways
-The [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) allows you model scenarios where you are expecting one out of a number of events to occur.
\ No newline at end of file
+The [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) models a decision in the workflow. But instead of [conditions](./conditions.md), the [Event-based Gateway](https://docs.camunda.org/manual/7.21/reference/bpmn20/gateways/event-based-gateway/) uses the triggering of an event to decide which [Sequence Flow](sequence-flow.md) to pursue.
+
+### Parallel Gateways
+
+[Parallel Gateways](https://docs.camunda.org/manual/latest/reference/bpmn20/gateways/parallel-gateway/) model concurrent workflows. Their outgoing flows can be joined together again with another [Parallel Gateway](https://docs.camunda.org/manual/latest/reference/bpmn20/gateways/parallel-gateway/). This makes process execution wait for both flows to arrive at the gateway before continuing.
diff --git a/docs/src/process-development/api-v2/bpmn/messaging.md b/docs/src/process-development/api-v2/bpmn/messaging.md
index 97d05703b..10657a006 100644
--- a/docs/src/process-development/api-v2/bpmn/messaging.md
+++ b/docs/src/process-development/api-v2/bpmn/messaging.md
@@ -4,21 +4,21 @@ icon: creative
---
-### Messaging
+## Messaging
-In order to enable communication with other lanes, pools or even entirely separate processes you need to be able to exchange information. In BPMN, you can use [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) to model this information exchange. Modeling communication with [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) in the same diagram uses Message Flow. Message Flow is typically represented by a dashed line arrow between BPMN elements with a black (send) or white (receive) envelope icon. The following BPMN collaboration diagram shows message exchange between two processes.
+Enabling communication with other lanes, pools or even entirely separate processes requires the ability to exchange information. In BPMN, [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) are used to model this information exchange. Modeling communication with [Message Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/) in the same diagram uses Message Flow. Message Flow is typically represented by a dashed line arrow between BPMN elements with a black (send) or white (receive) envelope icon. The following BPMN collaboration diagram shows message exchange between two processes.
-#### Message Start Event
+### Message Start Event
-[Message Start Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) allow a BPMN process to be started by an incoming message. In the DSF, all BPMN processes are started via messages. Therefore, you will have to include a [Message Start Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) at the beginning of all of your BPMN models.
+[Message Start Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) allow a BPMN process to be started by an incoming message. In the DSF, all BPMN processes are started via messages. Therefore, a [Message Start Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-start-event) has to be included at the beginning of all of your BPMN models.
-#### Message Intermediate Throwing Event
+### Message Intermediate Throwing Event
[Message Intermediate Throwing Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-throwing-event) are used to send messages during process execution.
-#### Message Intermediate Catching Event
-[Message Intermediate Catching Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-catching-event) serve as the counterpart to [Message Intermediate Throwing Events](messaging.md#message-intermediate-throwing-event). Use them whenever you expect to receive a message from another process or organization during execution.
+### Message Intermediate Catching Event
+[Message Intermediate Catching Events](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-intermediate-catching-event) serve as the counterpart to [Message Intermediate Throwing Events](messaging.md#message-intermediate-throwing-event). Use them whenever it is expected to receive a message from another process or organization during execution.
-#### Message End Event
+### Message End Event
The [Message End Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/message-events/#message-end-event) will stop the execution of a BPMN process and finish by sending a message.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/bpmn/sequence-flow.md b/docs/src/process-development/api-v2/bpmn/sequence-flow.md
index 3650cc635..2a248406d 100644
--- a/docs/src/process-development/api-v2/bpmn/sequence-flow.md
+++ b/docs/src/process-development/api-v2/bpmn/sequence-flow.md
@@ -3,5 +3,5 @@ title: Sequence Flow
icon: creative
---
-### Sequence Flow
+## Sequence Flow
BPMN 2.0 calls the continuous arrows connecting the BPMN elements in BPMN models, Sequence Flow. Sequence Flow exits one BPMN element and points at the next BPMN element to be processed.
diff --git a/docs/src/process-development/api-v2/bpmn/service-tasks.md b/docs/src/process-development/api-v2/bpmn/service-tasks.md
index ebe8ad3c9..4128d5a2e 100644
--- a/docs/src/process-development/api-v2/bpmn/service-tasks.md
+++ b/docs/src/process-development/api-v2/bpmn/service-tasks.md
@@ -3,6 +3,6 @@ title: Service Tasks
icon: creative
---
-### Service Tasks
+## Service Tasks
-One of the most common types of BPMN Tasks used for modeling DSF processes is the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/). They are different from regular BPMN Tasks in that they offer the ability to link an implementation to the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/) which can be called and executed by a BPMN engine. The BPE (Business Process Engine) server of the DSF leverages this engine to execute your BPMN processes.
\ No newline at end of file
+One of the most common types of BPMN Tasks used for modeling DSF processes is the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/). They are different from regular BPMN Tasks in that they offer the ability to link an implementation to the [Service Task](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/service-task/) which can be called and executed by a BPMN engine. The BPE (Business Process Engine) server of the DSF leverages this engine to execute BPMN processes.
diff --git a/docs/src/process-development/api-v2/bpmn/timer-intermediate-catching-events.md b/docs/src/process-development/api-v2/bpmn/timer-intermediate-catching-events.md
index 49ab4a8fc..ff19cb3a8 100644
--- a/docs/src/process-development/api-v2/bpmn/timer-intermediate-catching-events.md
+++ b/docs/src/process-development/api-v2/bpmn/timer-intermediate-catching-events.md
@@ -3,6 +3,6 @@ title: Timer Intermediate Catching Events
icon: creative
---
-### Timer Intermediate Catching Events
+## Timer Intermediate Catching Events
-A [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event) allows you to model stopwatch behavior. A timer is started once the BPMN execution arrives at the event. The duration until the timer runs out is specified using the [ISO 8601 Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations) format. Examples can be found [here](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#time-duration). After running out, the BPMN process executes the [Sequence Flow](sequence-flow.md) following the [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event).
\ No newline at end of file
+A [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event) allows for modelling stopwatch behavior. A timer is started once the BPMN execution arrives at the event. The duration until the timer runs out is specified using the [ISO 8601 Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations) format. Examples can be found [here](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#time-duration). After running out, the BPMN process executes the [Sequence Flow](sequence-flow.md) following the [Timer Intermediate Catching Event](https://docs.camunda.org/manual/7.21/reference/bpmn20/events/timer-events/#timer-intermediate-catching-event).
diff --git a/docs/src/process-development/api-v2/bpmn/user-tasks.md b/docs/src/process-development/api-v2/bpmn/user-tasks.md
index 8dda98d17..a34f257f7 100644
--- a/docs/src/process-development/api-v2/bpmn/user-tasks.md
+++ b/docs/src/process-development/api-v2/bpmn/user-tasks.md
@@ -3,6 +3,6 @@ title: User Tasks
icon: creative
---
-### User Tasks
+## User Tasks
-User Tasks define a process step that requires some kind of human interaction. Usually this is done by providing some kind of form the user can fill out. The Camunda Modeler allows to configure these forms as either a propriatary format called [Camunda Forms](https://docs.camunda.io/docs/guides/utilizing-forms/) or custom forms called `Embedded or External Task Forms`. The DSF uses such `External Task Forms` in the form of [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [Questionnaire Response](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources. This mechanism is further expanded upon in [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
\ No newline at end of file
+User Tasks define a process step that requires some kind of human interaction. Usually this is done by providing some kind of form the user can fill out. The Camunda Modeler allows to configure these forms as either a proprietary format called [Camunda Forms](https://docs.camunda.io/docs/guides/utilizing-forms/) or custom forms called `Embedded or External Task Forms`. The DSF uses such `External Task Forms` in the form of [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [Questionnaire Response](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources. This mechanism is further expanded upon in [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
diff --git a/docs/src/process-development/api-v2/concept.md b/docs/src/process-development/api-v2/concept.md
index f983d5e66..02af1c12f 100644
--- a/docs/src/process-development/api-v2/concept.md
+++ b/docs/src/process-development/api-v2/concept.md
@@ -31,6 +31,7 @@ icon: info
- [Requester and Recipient](dsf/requester-and-recipient.md)
- [Service Delegates](dsf/service-delegates.md)
- [Spring Framework Integration](dsf/spring-framework-integration.md)
+- [Target and Targets](dsf/target-and-targets.md)
- [Versions, Placeholders and URLs](dsf/versions-placeholders-urls.md)
## Guides
diff --git a/docs/src/process-development/api-v2/dsf/bpmn-process-execution.md b/docs/src/process-development/api-v2/dsf/bpmn-process-execution.md
index f711532c9..d6c0277c5 100644
--- a/docs/src/process-development/api-v2/dsf/bpmn-process-execution.md
+++ b/docs/src/process-development/api-v2/dsf/bpmn-process-execution.md
@@ -3,6 +3,6 @@ title: BPMN Process Execution
icon: creative
---
-### BPMN Process Execution
+## BPMN Process Execution
-The BPMN process execution is the in-memory representation of a running BPMN process. BPMN processes have their executions structured as a tree hierarchy. Each BPMN process starts with the [process instance](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-engine-concepts/#process-instances) as its root level execution. If, for example, this root execution reaches a parallel gateway with two paths, it would spawn two child executions under itself for them to process all tasks along their paths on their own. Executions can access all the BPMN elements from the BPMN model as well as the [BPMN process variables](bpmn-process-variables.md). You have access to this representation in your Java code through the `execution` parameter when overriding certain methods in [Service](service-delegates.md) / [Message](message-delegates.md) Delegates like `execute` or `getAdditionalInputParameters` through the `variables` parameter.
\ No newline at end of file
+The BPMN process execution is the in-memory representation of a running BPMN process. BPMN processes have their executions structured as a tree hierarchy. Each BPMN process starts with the [process instance](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-engine-concepts/#process-instances) as its root level execution. If, for example, this root execution reaches a parallel gateway with two paths, it would spawn two child executions under itself for them to process all tasks along their paths on their own. Executions can access all the BPMN elements from the BPMN model as well as the [BPMN process variables](bpmn-process-variables.md). Limited access to this representation in the Java code is provided through the `variables` parameter when overriding certain methods in [Service](service-delegates.md) / [Message](message-delegates.md) Delegates like `execute` or `getAdditionalInputParameters`.
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/dsf/bpmn-process-variables.md b/docs/src/process-development/api-v2/dsf/bpmn-process-variables.md
index 6170e1b1e..cd2baf68e 100644
--- a/docs/src/process-development/api-v2/dsf/bpmn-process-variables.md
+++ b/docs/src/process-development/api-v2/dsf/bpmn-process-variables.md
@@ -3,8 +3,8 @@ title: BPMN Process Variables
icon: creative
---
-### BPMN Process Variables
+## BPMN Process Variables
BPMN process variables hold additional information which has to be available during BPMN process execution. Variables can be directly related to BPMN elements like the boolean value for [Conditions](../bpmn/conditions.md), but do not have to be. BPMN process variables are stored as key-value pairs with the key being the variable name. They are accessible during the entirety of the execution to all [Service](service-delegates.md) / [Message](message-delegates.md) Delegates.
-You can learn how to access to the BPMN process variables [here](../guides/accessing-bpmn-process-variables.md).
\ No newline at end of file
+More information on how to access to the BPMN process variables is found in the guide on accessing [BPMN process variables](../guides/accessing-bpmn-process-variables.md).
diff --git a/docs/src/process-development/api-v2/dsf/draft-task-resources.md b/docs/src/process-development/api-v2/dsf/draft-task-resources.md
index c1bcaa28c..c8ed0e4f4 100644
--- a/docs/src/process-development/api-v2/dsf/draft-task-resources.md
+++ b/docs/src/process-development/api-v2/dsf/draft-task-resources.md
@@ -3,9 +3,9 @@ title: Draft Task Resources
icon: creative
---
-### Draft Task Resources
+## Draft Task Resources
-[Task](../fhir/task.md) resources with status `draft` are used to create the DSF FHIR server's functionality of starting processes via its web interface. They are stored in `.../tutorial-process/src/main/resources/fhir/Task`. Compared to regular [Task](../fhir/task.md) resources used to start BPMN processes, this type of [Task](../fhir/task.md) resource requires the status `draft` instead the usual `requested`. It also replaces the value for `authoredOn` with the placeholder `#{date}`, the values of organization identifiers with the placeholder `#{organization}` and all instances of version numbers with `#{version}`. Additionally, it requires setting the `Task.identifier` element. It should look something like this:
+[Task](../fhir/task.md) resources with status `draft` are used to create the DSF FHIR server's functionality of starting processes via its web interface. They are stored in `.../tutorial-process/src/main/resources/fhir/Task`. Compared to regular [Task](../fhir/task.md) resources used to start BPMN processes, this type of [Task](../fhir/task.md) resource requires the status `draft` instead of the usual `requested`. It also replaces the value for `authoredOn` with the placeholder `#{date}`, the values of organization identifiers with the placeholder `#{organization}` and all instances of version numbers with `#{version}`. Additionally, it requires setting the `Task.identifier` element. It should look something like this:
```xml
@@ -14,8 +14,8 @@ icon: creative
```
`processKey` should be the same one used in [URLs](versions-placeholders-urls.md#urls).
-`task-name` can be any String you wish to identify this task with. E.g. you can use the file name of the Draft Task.
+`task-name` can be any String this task should be identified with. E.g. you can use the file name of the Draft Task.
-For a complete example you can take a look at the Draft Task Resource in one of the solution branches and compare it to the one needed for cURL. The [Task](../fhir/task.md) resource created for cURL can be found at `.../tutorial-process/src/main/resources/example-task.xml`.
+A complete example for a Draft Task Resource can be found in the [Ping Pong Process Plugin](https://github.com/datasharingframework/dsf-process-ping-pong/blob/main/src/main/resources/fhir/Task/dsf-task-start-ping.xml).
-You might also want to check out [this guide](../guides/creating-task-resources-based-on-a-definition.md) if you do not know how to create [Task](../fhir/task.md) resources in general.
\ No newline at end of file
+There is also a [guide for creating task resources based on a StructureDefinition](../guides/creating-task-resources-based-on-a-definition.md) if more information on how to create [Task](../fhir/task.md) resources is required.
diff --git a/docs/src/process-development/api-v2/dsf/environment-variables.md b/docs/src/process-development/api-v2/dsf/environment-variables.md
index fcea6697c..4f0b5bd7e 100644
--- a/docs/src/process-development/api-v2/dsf/environment-variables.md
+++ b/docs/src/process-development/api-v2/dsf/environment-variables.md
@@ -3,8 +3,8 @@ title: Environment Variables
icon: creative
---
-### Environment Variables
+## Environment Variables
-Environment variables offer a way to make configuration data available at the start of a [BPMN process execution](bpmn-process-execution.md). They are the same for all running process instances. They can be defined by adding a member variable with the [Spring-Framework @Value](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-value-annotations) annotation to the configuration class `TutorialConfig`. The value of the annotation uses the `${..}` notation and follows the form `${some.property:defaultValue}`, where each dot in the property name corresponds to an underscore in the equivalent environment variable. Environment variables are always written upper-case. The property `some.property` therefore corresponds to the environment variable `SOME_PROPERTY`.
+Environment variables offer a way to make configuration data available at the start of a [BPMN process execution](bpmn-process-execution.md). They are the same for all running process instances. They can be defined by adding a member variable with the [Spring-Framework @Value](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-value-annotations) annotation to any Spring managed bean. For the DSF, the most prominent are classes annotated with [`@Configuration`](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html). The value of the annotation uses the `${..}` notation and follows the form `${some.property:defaultValue}`, where each dot in the property name corresponds to an underscore in the equivalent environment variable. Environment variables are always written upper-case. The property `some.property` therefore corresponds to the environment variable `SOME_PROPERTY`.
-The DSF provides a feature to automatically generate documentation of environment variables during the Maven build process. You can use the `@ProcessDocumentation` annotation to automatically generate Markdown documentation for all fields with this annotation. You simply have to add [dsf-tools-documentation-generator](https://mvnrepository.com/artifact/dev.dsf/dsf-tools-documentation-generator) as a maven plugin. You can take a look at the `pom.xml` for the `tutorial-process` submodule [here](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/pom.xml) to see how you can add it to your own project. Keep in mind to point the `` field to the package you want documentation for.
\ No newline at end of file
+The DSF provides a feature to automatically generate documentation of environment variables during the Maven build process. The `@ProcessDocumentation` annotation can be used to automatically generate Markdown documentation for all fields with this annotation. This requires adding [dsf-tools-documentation-generator](https://mvnrepository.com/artifact/dev.dsf/dsf-tools-documentation-generator) as a maven plugin. There is an example `pom.xml` for the `tutorial-process` submodule located on [GitHub](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/pom.xml) which uses the maven plugin. The `` field has to point to the package where documentation is desired.
diff --git a/docs/src/process-development/api-v2/dsf/message-correlation.md b/docs/src/process-development/api-v2/dsf/message-correlation.md
index 23b18e3e3..2c7ba5a10 100644
--- a/docs/src/process-development/api-v2/dsf/message-correlation.md
+++ b/docs/src/process-development/api-v2/dsf/message-correlation.md
@@ -3,8 +3,8 @@ title: Message Correlation
icon: creative
---
-### Message Correlation
+## Message Correlation
-In order for messages to be able to be sent back and forth between organizations with potentially multiple of the same process plugin instances running at the same time and still arriving at the correct process instance, we need some mechanism to map messages to their rightful process instance. This mechanism is called Message Correlation and requires attaching a unique identifier to every process instance. This identifier is called the `business-key`. The `business-key` will get attached to every outgoing message automatically.
+In order for messages to be able to be sent back and forth between organizations with potentially multiple of the same process plugin instances running at the same time and still arriving at the correct process instance, some mechanism is needed to map messages to their rightful process instance. This mechanism is called Message Correlation and requires attaching a unique identifier to every process instance. This identifier is called the `business-key`. The `business-key` will get attached to every outgoing message automatically.
-It is possible that the `business-key` is insufficient to map messages to the correct process instance. This happens when you use subprocesses in your BPMN model which all expect messages to be sent to them, not the parent process. To solve this issue, [Task](../fhir/task.md) resources also come with an [Input Parameter](../fhir/task.md#task-input-parameters) called `correlation-key`. This is a secondary identifier you can attach to all messages if you need them to arrive at a specific subprocess. You can learn more about how `correlation-keys` are used by studying the [Ping-Pong Process](https://github.com/datasharingframework/dsf-process-ping-pong).
\ No newline at end of file
+It is possible that the `business-key` is insufficient to map messages to the correct process instance. This happens during subprocesses in your BPMN model which all expect messages to be sent to them, not the parent process. To solve this issue, [Task](../fhir/task.md) resources also come with an [Input Parameter](../fhir/task.md#task-input-parameters) called `correlation-key`. This is a secondary identifier that has to be attached to all messages in order for them to arrive at a specific subprocess. This is done when creating [targets](../dsf/target-and-targets.md#targets) for outgoing messages and requires setting the `correlation-key` as a local variable using the constant `BpmnExecutionVariables.CORRELATION_KEY` before a message is received in the subprocess.
diff --git a/docs/src/process-development/api-v2/dsf/message-delegates.md b/docs/src/process-development/api-v2/dsf/message-delegates.md
index 61a1a06f1..f5021e4d9 100644
--- a/docs/src/process-development/api-v2/dsf/message-delegates.md
+++ b/docs/src/process-development/api-v2/dsf/message-delegates.md
@@ -3,13 +3,17 @@ title: Message Delegates
icon: creative
---
-### Message Delegates
+## Message Delegates
-Message Delegates are the Java representation of the [Message Events](../bpmn/messaging.md) in your BPMN model. You link a Message Delegate to a certain [Message Event](../bpmn/messaging.md) by selecting the Message Event in the [Camunda Modeler](https://camunda.com/download/modeler/) and adding a Java class to the `Implementation` field. Make sure you use the fully qualified class name. Like this:
+Message Delegates are the Java representation of the [Message Events](../bpmn/messaging.md) in a BPMN model. Message Delegates are linked to a certain [Message Event](../bpmn/messaging.md) by selecting the Message Event 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. For example:
```
-org.package.myClass
+org.package.MyClass
```
-You will only need Message Delegates for [Message Send Events](../bpmn/messaging.md). Incoming messages will be resolved to the correct [BPMN process execution](bpmn-process-execution.md) automatically using [Message Correlation](message-correlation.md) and the message inputs will be added to that execution's [process variables](bpmn-process-variables.md).
+Message Delegates are only needed for [Message Send Events](../bpmn/messaging.md). Incoming messages will be resolved to the correct [BPMN process execution](bpmn-process-execution.md) automatically using [Message Correlation](message-correlation.md) and the message inputs will be added to that execution's [process variables](bpmn-process-variables.md).
-To make a Message Delegate for [Message Send Events](../bpmn/messaging.md), your Java class needs to extend `AbstractTaskMessageSend`. Most of the time, you will not be adding any processing logic to your Message Delegates, therefore you usually won't be overwriting the `doExecute` method like with [Service Delegates](service-delegates.md). Instead, you most likely want to aggregate the information you processed in earlier steps and attach it to a message. For this you need to overwrite the `getAdditionalInputParamters` method. The DSF translates BPMN messages into FHIR [Task](../fhir/task.md) resources to execute the communication modeled by your BPMN diagrams. The information you are sending to another BPMN process is specified in the Task.input elements a.k.a. [Input Parameters](../fhir/task.md#task-input-parameters), hence the name of the method. The constructor of your delegate class should also forward a `ProcessPluginApi` instance to its superclass constructor. You can learn more about the `ProcessPluginApi` [here](process-plugin-api.md).
+To make a Message Delegate for [Message Send Events](../bpmn/messaging.md), the Java class needs to implement the interface `MessageSendTask`. Most of the time, there will not be any processing logic inside Message Delegates, therefore the `execute` method will not be overridden like with [Service Delegates](../dsf/service-delegates.md). Although there might be cases where this is necessary. Instead, Message Delegates should be used to aggregate previously computed data and attach it to the message. This is done by overriding the `getAdditionalInputParamters` method. The DSF translates BPMN messages into FHIR [Task](../fhir/task.md) resources to execute the communication modeled in BPMN diagrams. The information being sent to another BPMN process is specified in the Task.input elements a.k.a. [Input Parameters](../fhir/task.md#task-input-parameters), hence the name of the method.
+
+
+## Related Topics
+[Messaging](../bpmn/messaging.md), [Input Parameters](../fhir/task.md#task-input-parameters), [Adding Input Parameter to Task Profiles](../guides/adding-task-input-parameters-to-task-profiles.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/dsf/organization-identifiers.md b/docs/src/process-development/api-v2/dsf/organization-identifiers.md
index 691a551d8..dfb78a204 100644
--- a/docs/src/process-development/api-v2/dsf/organization-identifiers.md
+++ b/docs/src/process-development/api-v2/dsf/organization-identifiers.md
@@ -3,8 +3,11 @@ title: Organization Identifiers
icon: creative
---
-### Organization Identifiers
-DSF FHIR server instances always have something called an `organization identifer`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is configured as an [environment variable](https://dsf.dev/operations/latest/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). You can make a GET request to `https://domain/fhir/Organization` to get a list of all organizations for the DSF FHIR server instance running under `domain`. The results will also include the `organization identifier` of each organization.
+## Organization Identifiers
+DSF FHIR server instances can configure an `organization identifier`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is set as an [environment variable](https://dsf.dev/stable/maintain/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). A GET request to `https://domain/fhir/Organization` will return a list of all organizations for the DSF FHIR server instance running under `domain`. The results will also include the `organization identifier` of each organization.
-#### Organization Identifiers in Task Resources
-[Task](../fhir/task.md) resources require you to reference an organization via its identifier as the `Task.requester` and `Task.restriction.recipient` elements. The exact values for these elements depend on the [ActivityDefinition](../fhir/activitydefinition.md) the [Task](../fhir/task.md) resource should conform to. As a general rule, you will want to put the identifier of your own organization as the `Task.requester` and `Task.restriction.recipient` elements for [Task](../fhir/task.md) resources which initially start processes. All other cases depend on the context of the message being sent during process execution.
\ No newline at end of file
+### Organization Identifiers in Task Resources
+[Task](../fhir/task.md) resources require a reference to an organization via its identifier as the `Task.requester` and `Task.restriction.recipient` elements. The exact values for these elements depend on the [ActivityDefinition](../fhir/activitydefinition.md) the [Task](../fhir/task.md) resource should conform to. As a general rule, the identifier of your own organization should be used as the `Task.requester` and `Task.restriction.recipient` elements for [Task](../fhir/task.md) resources which initially start processes. All other cases depend on the context of the message being sent during process execution. An easy way to generalize this in [Draft Task Resources](draft-task-resources.md) is to use the `#{organization}` [placeholder](versions-placeholders-urls.md#placeholders).
+
+## Related Topics
+[Allow-List](https://dsf.dev/intro/info/allowList.html), [ActivityDefinition](../fhir/activitydefinition.md), [Environment Variables](environment-variables.md), [Requester and Recipient](requester-and-recipient.md), [Task](../fhir/task.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/dsf/process-plugin-api.md b/docs/src/process-development/api-v2/dsf/process-plugin-api.md
index 5d1381a5a..60f968aaf 100644
--- a/docs/src/process-development/api-v2/dsf/process-plugin-api.md
+++ b/docs/src/process-development/api-v2/dsf/process-plugin-api.md
@@ -3,9 +3,9 @@ title: Process Plugin API
icon: creative
---
-### Process Plugin API v1 Maven Module
+## Process Plugin API Maven Module
-The [DSF Process Plugin API module](https://mvnrepository.com/artifact/dev.dsf/dsf-bpe-process-api-v1) consists of a set of utility classes designed to provide easy access to solutions for process plugin use cases. This includes for example the `Variables` class, which provides access to the [BPMN process variables](bpmn-process-variables.md).
+The [DSF Process Plugin API module](https://central.sonatype.com/artifact/dev.dsf/dsf-bpe-process-api-v2) consists of a set of utility classes designed to provide easy access to common solutions for process plugin use cases which would otherwise require lots of boilerplate code. An example is the `Variables` class, which provides access to the [BPMN process variables](bpmn-process-variables.md).
Maven Dependency:
@@ -13,20 +13,28 @@ Maven Dependency:
dev.dsf
- dsf-bpe-process-api-v1
+ dsf-bpe-process-api-v2${dsf.version}provided
```
-#### Process Plugin Api
-When creating [Service Delegates](service-delegates.md) or [Message Delegates](message-delegates.md) you wil notice that you need to provide a constructor which expects a `ProcessPluginApi` object and forward it to the superclasses' constructor.
-This API instance provides a variety of utility classes:
-- `ProxyConfig`**:** forward proxy configuration
-- `EndpointProvider`**:** access to Endpoint resources
-- `FhirContext`**:** HAPI FHIR Context for parsing/serializing
-- `FhirWebserviceClientProvider`**:** Webservice client to access DSF FHIR server
-- `MailService`**:** for sending automatic E-Mails (if configured)
-- `OrganizationProvider`**:** access to Organization resources
-- `Variables`**:** access to BPMN execution variables
\ No newline at end of file
+### Process Plugin Api
+[Service Delegates](service-delegates.md) or [Message Delegates](message-delegates.md) expose a `ProcessPluginApi` instance when overriding their `execute` and `getAdditionalInputParameters` methods. This API instance provides the following utility classes:
+- `FhirClientProvider`**:** Provides access to a generic, configurable FHIR web client. Used for connections to FHIR servers that are not the DSF FHIR server.
+- `DsfClientProvider`**:** Provides access to preconfigured FHIR web client to access DSF FHIR server including utility methods.
+- `TaskHelper`**:** Provides utility methods to interact with Task resource. Namely, Input and Output Parameters.
+- `FhirContext`**:** Provides access to the FHIR context.
+- `EndpointProvider`**:** Provides utility methods to interact with Endpoint resources.
+- `MailService`**:** Provides methods to use the DSF's e-mail functionality.
+- `ObjectMapper`**:** Provides access to an ObjectMapper instance to perform e.g. JSON-serialization.
+- `OrganizationProvider`**:** Provides utility methods to interact with Organization resources.
+- `OidcClientProvider`**:** Provides utility methods for OIDC functionality.
+- `ProcessAuthorizationHelper`**:** Provides utility methods to interact with process authorization in [ActivityDefinitions](../fhir/activitydefinition.md).
+- `ProxyConfig`**:** Allows you to retrieve information about the DSF proxy.
+- `QuestionnaireResponseHelper`**:** Provides utility methods to interact with [QuestionnaireResponse](../fhir/questionnaire-and-questionnaireresponse.md) resources.
+- `ReadAccessHelper`**:** Provides utility methods to modify a resource's [read access tag](read-access-tag.md).
+
+## Related Topics
+[Service Delegates](service-delegates.md), [Message Delegates](message-delegates.md)
diff --git a/docs/src/process-development/api-v2/dsf/process-plugin-definition.md b/docs/src/process-development/api-v2/dsf/process-plugin-definition.md
index a13bdbe26..498ae2514 100644
--- a/docs/src/process-development/api-v2/dsf/process-plugin-definition.md
+++ b/docs/src/process-development/api-v2/dsf/process-plugin-definition.md
@@ -3,14 +3,17 @@ title: Process Plugin Definition
icon: creative
---
-### Process Plugin Definition
+## Process Plugin Definition
-In order for the DSF BPE server to load your plugin you need to provide it with the following information:
+In order for the DSF BPE server to load a plugin properly, it needs to provide the following information in what is called the process plugin definition:
* A plugin [version](versions-placeholders-urls.md#version-pattern)
* A release date
* A plugin name
* The BPMN model files
-* The FHIR resources grouped by BPMN process ID. Your plugin may have any number of BPMN models. Each has their own BPMN process ID and FHIR resources specific to that BPMN process (think [Task](../fhir/task.md) resources needed for messages specific to that BPMN model)
-* The Class holding your [Spring Framework Configuration](spring-framework-integration.md)
+* The FHIR resources grouped by BPMN process ID. A plugin may have any number of BPMN models. Each has their own BPMN process ID and FHIR resources specific to that BPMN process (like [Task](../fhir/task.md) resources needed for messages specific to that BPMN model)
+* The Class holding a [Spring Framework Configuration](spring-framework-integration.md)
-You will provide this information by implementing the `dev.dsf.bpe.ProcessPluginDefinition` interface. The DSF BPE server then searches for classes implementing this interface using the Java [ServiceLoader](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ServiceLoader.html) mechanism. Therefore, you will have to register your interface implementation in the `src/main/resources/META-INF/services/dev.dsf.bpe.ProcessPluginDefinition` file. For this tutorial, the class implementing the `ProcessPluginDefinition` interface, `TutorialProcessPluginDefinition`, has already been added to the file. You can use it as a reference for later when you want to create your own plugin.
\ No newline at end of file
+To provide this information, one of the classes in the process plugin has to implement the `dev.dsf.bpe.ProcessPluginDefinition` interface. The DSF BPE server then searches for classes implementing this interface using the Java [ServiceLoader](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ServiceLoader.html) mechanism. Therefore, the class also needs to be registered in the `src/main/resources/META-INF/services/dev.dsf.bpe.ProcessPluginDefinition` file. An example of this can be found in the [process plugin tutorial](https://github.com/datasharingframework/dsf-process-tutorial/).
+
+## Related Topics
+[Spring Integration](spring-framework-integration.md), [Versions, Placeholders and URLs](versions-placeholders-urls.md)
diff --git a/docs/src/process-development/api-v2/dsf/read-access-tag.md b/docs/src/process-development/api-v2/dsf/read-access-tag.md
index 47a02b2c1..90aad4ced 100644
--- a/docs/src/process-development/api-v2/dsf/read-access-tag.md
+++ b/docs/src/process-development/api-v2/dsf/read-access-tag.md
@@ -3,9 +3,9 @@ title: Read Access Tag
icon: creative
---
-### Read Access Tag
+## Read Access Tag
-Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/task.md)) to the DSF FHIR server unless it is your own organization. By default, the same applies to reading FHIR resources (again except [Task](../fhir/task.md)). But since the DSF is often used to offer medical data in form of FHIR resources, you will find yourself wanting other organizations to be allowed to read the resources you are offering. The `Resource.meta.tag` element is used define access rules for all FHIR resources in the DSF, with the exception of [Task](../fhir/task.md) resources. We will explain the reason for this exception shortly. For example, allowing read access for all organizations, you would use the following `system` and `code` in your FHIR resource:
+Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/task.md)) to the DSF FHIR server unless it is the organization running the instance, which is [configurable](https://dsf.dev/operations/latest/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). By default, the same applies to reading FHIR resources (again except [Task](../fhir/task.md)). But since the DSF is often used to offer medical data in form of FHIR resources, other organizations should be allowed to read some of the resources on the DSF FHIR server. The `Resource.meta.tag` element is used define access rules for all FHIR resources in the DSF, with the exception of [Task](../fhir/task.md) resources. For example, allowing read access for all organizations would use the following `system` and `code` in your FHIR resource:
```xml
@@ -15,8 +15,11 @@ Axiomatically, nobody is allowed to write FHIR resources (except [Task](../fhir/
```
-You can find all codes for the Read Access Tag in its [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).
+All codes for the Read Access Tag can be found in its [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).
-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.
+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 a plugin's [ActivityDefinitions](../fhir/activitydefinition.md). Therefore, no `read-access-tag` is needed.
-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).
+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. More information on that can be found in the [guide on configuring the Read Access Tag](../guides/configuring-read-access-tags.md).
+
+## Related Topics
+[Configuring Read Access Tags](../guides/configuring-read-access-tags.md)
diff --git a/docs/src/process-development/api-v2/dsf/requester-and-recipient.md b/docs/src/process-development/api-v2/dsf/requester-and-recipient.md
index 8407bb318..0aa1a7e9d 100644
--- a/docs/src/process-development/api-v2/dsf/requester-and-recipient.md
+++ b/docs/src/process-development/api-v2/dsf/requester-and-recipient.md
@@ -3,11 +3,11 @@ title: Requester and Recipient
icon: creative
---
-### Requester and Recipient Elements
+## Requester and Recipient Elements
-Below you will find a set of examples for each Coding used by `requester` and `recipient` elements from 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). CodeSystems referenced in the examples can be found [here](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem). Use this collection as a reference point when creating your own [ActivityDefinitions](../fhir/activitydefinition.md).
+Below is a set of examples for each Coding used by `requester` and `recipient` elements from 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). CodeSystems referenced in the examples can be found [here](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem). This collection aims to provide a reference point when creating [ActivityDefinitions](../fhir/activitydefinition.md).
-#### Requester
+### Requester
The `requester` element uses one of the following Codings:
```xml
@@ -21,7 +21,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local All
+#### Local All
```xml
@@ -31,7 +31,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local All Practitioner
+#### Local All Practitioner
```xml
@@ -47,7 +47,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Organization
+#### Local Organization
```xml
@@ -63,7 +63,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Organization Practitioner
+#### Local Organization Practitioner
```xml
@@ -87,7 +87,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Parent Organization Role
+#### Local Parent Organization Role
```xml
@@ -111,7 +111,7 @@ The `requester` element uses one of the following Codings:
```
-##### Local Parent Organization Role Practitioner
+#### Local Parent Organization Role Practitioner
```xml
@@ -141,7 +141,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote All
+#### Remote All
```xml
@@ -151,7 +151,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote Organization
+#### Remote Organization
```xml
@@ -167,7 +167,7 @@ The `requester` element uses one of the following Codings:
```
-##### Remote Parent Organization Role
+#### Remote Parent Organization Role
```xml
@@ -191,7 +191,7 @@ The `requester` element uses one of the following Codings:
```
-#### Recipient
+### Recipient
The `recipeint` element uses one of the following Codings:
```xml
@@ -199,7 +199,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local All
+#### Local All
```xml
@@ -209,7 +209,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local Organization
+#### Local Organization
```xml
@@ -225,7 +225,7 @@ The `recipeint` element uses one of the following Codings:
```
-##### Local Parent Organization Role
+#### Local Parent Organization Role
```xml
@@ -248,3 +248,7 @@ The `recipeint` element uses one of the following Codings:
```
+
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md)
diff --git a/docs/src/process-development/api-v2/dsf/service-delegates.md b/docs/src/process-development/api-v2/dsf/service-delegates.md
index 278b51e34..bc6d24f9a 100644
--- a/docs/src/process-development/api-v2/dsf/service-delegates.md
+++ b/docs/src/process-development/api-v2/dsf/service-delegates.md
@@ -3,10 +3,13 @@ title: Service Delegates
icon: creative
---
-### Service Delegates
+## Service Delegates
-Service Delegates are the Java representation of the [Service Tasks](../bpmn/service-tasks.md) in your BPMN model. You link a Service Delegate 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. Make sure you use the fully qualified class name. Like this:
+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:
```
-org.package.myClass
+org.package.MyClass
```
-All that is left is for your Java class to extend `AbstractServiceDelegate` and override the `doExecute` method. This is the place where you can put your actual business logic. The method will be called when the [BPMN process execution](bpmn-process-execution.md) arrives at the [Service Task](../bpmn/service-tasks.md) your Service Delegate is linked to. The constructor of your delegate class should also forward a `ProcessPluginApi` instance to its superclass constructor. You can learn more about the `ProcessPluginApi` [here](process-plugin-api.md).
\ No newline at end of file
+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.
+
+## Related Topics
+[BPMN Process Execution](../dsf/bpmn-process-execution.md), [Message Delegates](message-delegates.md), [Service Tasks](../bpmn/service-tasks.md)
diff --git a/docs/src/process-development/api-v2/dsf/spring-framework-integration.md b/docs/src/process-development/api-v2/dsf/spring-framework-integration.md
index 55f96f342..f4abaea72 100644
--- a/docs/src/process-development/api-v2/dsf/spring-framework-integration.md
+++ b/docs/src/process-development/api-v2/dsf/spring-framework-integration.md
@@ -3,12 +3,74 @@ title: Spring Framework Integration
icon: creative
---
-### Spring Framework Integration
+## Spring Framework Integration
-Since the DSF also employs the use of the [Spring Framework](https://spring.io/projects/spring-framework) you will also have to provide some Spring functionality. When deployed, every process plugin exists in its own [Spring context](https://docs.spring.io/spring-framework/reference/core/beans/introduction.html). To make the process plugin work, you have to provide [Spring Beans](https://docs.spring.io/spring-framework/reference/core/beans/definition.html) with `prototype` [scope](https://docs.spring.io/spring-framework/reference/core/beans/factory-scopes.html) for all classes which either extend or implement the following classes/interfaces (as of version 1.4.0):
-- `AbstractTaskMessageSend`
-- `AbstractServiceDelegate`
+The DSF uses some of the [Spring Framework's](https://spring.io/projects/spring-framework) functionality. When deployed, every process plugin exists in its own [Spring context](https://docs.spring.io/spring-framework/reference/core/beans/introduction.html). Process plugins require [Spring Beans](https://docs.spring.io/spring-framework/reference/core/beans/definition.html) with `prototype` [scope](https://docs.spring.io/spring-framework/reference/core/beans/factory-scopes.html) for all classes which either extend or implement the following classes/interfaces:
+- `Activity`
- `DefaultUserTaskListener`
-- `ProcessPluginDeploymentStateListener`
+- `ExecutionListener`
+- `MessageActivity`
+- `MessageEndEvent`
+- `MessageIntermediateThrowEvent`
+- `MessageSendTask`
+- `ServiceTask`
+- `UserTaskListener`
-A [Spring-Framework configuration class](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java-basic-concepts) located in `spring/config` is expected to provide the Spring Beans. For this tutorial, the `TutorialConfig` class will take this role. If you are unfamiliar with the Spring Framework, you might want to check out the chapter [Java-based Container Configuration](https://docs.spring.io/spring-framework/reference/core/beans/java.html) of the Spring Framework documentation, specifically the topics [Using the @Bean Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/bean-annotation.html) and [Using the @Configuration Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html).
\ No newline at end of file
+A [Spring-Framework configuration class](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java-basic-concepts) located in the `spring/config` directory is expected to provide the Spring Beans. If you are unfamiliar with the Spring Framework, you can find more information in [Java-based Container Configuration](https://docs.spring.io/spring-framework/reference/core/beans/java.html) of the Spring Framework documentation, specifically the topics [Using the @Bean Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/bean-annotation.html) and [Using the @Configuration Annotation](https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html).
+
+Below is an example of a Spring configuration class:
+```java
+@Configuration
+public class TutorialConfig
+{
+ @Value("${dev.dsf.process.tutorial.loggingEnabled:false}")
+ @ProcessDocumentation(description = "Set to true to enable logging", required = false, processNames = PROCESS_NAME_FULL_DIC)
+ private boolean loggingEnabled; //environment variable
+
+ @Value("${dev.dsf.process.tutorial.userVote:false}")
+ @ProcessDocumentation(description = "Set to true to enable users to vote", required = false, processNames = PROCESS_NAME_FULL_VOTING_PROCESS)
+ private boolean userVote; //environment variable
+
+ //register classes with default constructor as prototype beans
+ @Bean
+ public static ActivityPrototypeBeanCreator activityPrototypeBeanCreator()
+ {
+ return new ActivityPrototypeBeanCreator(HelloCosMessage.class, CosTask.class, HelloHrpMessage.class,
+ HrpTask.class, GoodbyeDicMessage.class, StartVotingProcess.class, SelectTargets.class, StartVote.class,
+ SaveUserVote.class, AutomatedVote.class, PrepareReturnVote.class, ReturnVote.class,
+ SaveVotingResult.class, SaveTimeoutResult.class, AggregateResults.class);
+ }
+
+ //register classes with custom constructor as prototype beans
+ @Bean
+ @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
+ public DicTask dicTask()
+ {
+ return new DicTask(loggingEnabled);
+ }
+
+ @Bean
+ @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
+ public DecideWhetherUserVote decideWhetherUserVote()
+ {
+ return new DecideWhetherUserVote(userVote);
+ }
+
+ @Bean
+ @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
+ public UserVoteListener userVoteListener()
+ {
+ return new UserVoteListener();
+ }
+
+ @Bean
+ @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
+ public SetCorrelationKeyListener setCorrelationKeyListener()
+ {
+ return new SetCorrelationKeyListener();
+ }
+}
+```
+
+## Related Topics
+[Environment Variables](environment-variables.md), [Message Delegates](message-delegates.md), [Service Delegates](service-delegates.md)
diff --git a/docs/src/process-development/api-v2/dsf/target-and-targets.md b/docs/src/process-development/api-v2/dsf/target-and-targets.md
new file mode 100644
index 000000000..8b8df62db
--- /dev/null
+++ b/docs/src/process-development/api-v2/dsf/target-and-targets.md
@@ -0,0 +1,19 @@
+---
+title: Target and Targets
+icon: creative
+---
+
+## Target
+
+A target is a container for all information necessary to send messages to other DSF instances. This information includes:
+- **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`.
+- **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`.
+- **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.
+- **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).
+
+## Targets
+
+Targets is a container class for a collection of [Target](#target) objects. It also provides utility methods for manipulating the underlying collection.
+
+## Related Topics
+[Message Correlation](message-correlation.md), [Setting Targets for Message Events](../guides/setting-targets-for-message-events.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/dsf/versions-placeholders-urls.md b/docs/src/process-development/api-v2/dsf/versions-placeholders-urls.md
index 0381ec629..1fb0ecf0c 100644
--- a/docs/src/process-development/api-v2/dsf/versions-placeholders-urls.md
+++ b/docs/src/process-development/api-v2/dsf/versions-placeholders-urls.md
@@ -3,9 +3,9 @@ title: Versions, Placeholders and URLs
icon: creative
---
-### Versions, Placeholders and URLs
+## Versions, Placeholders and URLs
-#### Version Pattern
+### Version Pattern
Process plugin versions have to obey the pattern:
```
@@ -14,25 +14,28 @@ Process plugin versions have to obey the pattern:
The first two numbers (`1.2`) are used in FHIR resources and signal changes which break compatibility with previous process versions. For example, altering FHIR resources usually results in a breaking change. The latter two (`3.4`) signal changes which do not break compatibility with previous process versions. Specifically, the 4th number is reserved for bug-fixes and the 3rd number includes all other non-breaking changes.
-#### Placeholders
+### Placeholders
To avoid specifying the version and release date in multiple files, the placeholders `#{version}` and `#{date}` can be used within FHIR resources and BPMN models. They are replaced with the values returned by the methods `ProcessPluginDefinition#getResourceVersion` and `ProcessPluginDefinition#getReleaseDate` respectively during deployment of a process plugin by the DSF BPE server. There is also a placeholder for the organization the DSF instance is running in: `#{organization}`, typically use in [Draft Task Resources](draft-task-resources.md).
-#### URLs
+### URLs
-BPMN models have an ID call process definition key. The BPMN process definition key needs to be specified following the pattern:
+BPMN models have an ID called process definition key. The BPMN process definition key needs to be specified following the pattern:
```
^[-a-zA-Z0-9]+_[-a-zA-Z0-9]+$ Example: domainorg_processKey
```
-In addition, the BPMN model needs to specify a version. You should be using the ``#{version}`` [placeholder](#placeholders) for this as well. The DSF will also reference this process in URL form in FHIR resources:
+In addition, the BPMN model needs to specify a version. The `#{version}` [placeholder](#placeholders) should be used for this as well. The DSF will also reference this process in URL form in FHIR resources:
```
http://domain.org/bpe/Process/processKey|1.2
```
-As you can see, the version in the URL ``|1.2`` only uses the resource version and omits the code base version. As mentioned in [Version Pattern](#version-pattern), this means that only changes to the first two version numbers are significant to signal compatibility when communicating with other process plugin instances. The process definition key and URL are also related to each other. The DSF will try to match BPMN models to FHIR resources by transforming the URL into a process definition key. That is why it is important you obey the pattern above.
+The version in the URL `|1.2` only uses the resource version and omits the code base version. As mentioned in [Version Pattern](#version-pattern), this means that only changes to the first two version numbers are significant to signal compatibility when communicating with other process plugin instances. The process definition key and URL are also related to each other. The DSF will try to match BPMN models to FHIR resources by transforming the URL into a process definition key. That is why it is mandatory to follow the pattern above.
-You will use the above URL as your instantiatesCanonical value for [Task](../fhir/task.md) profile definitions as well as references to [Task](../fhir/task.md) profiles in other resources. You will also use it as the URL value for your [ActivityDefinitions](../fhir/activitydefinition.md). In this case though, you have to split up the URL into two parts. You will separate the version (``|1.2``) from the URL and use it as a value for the `ActivityDefinition.version` element. Since it refers to the plugin's resource version, you should also use the `#{version}` [placeholder](#placeholders) here instead. Going by the example from above, you will be left with a URL that looks like this:
+The above URL will be used as the instantiatesCanonical value for [Task](../fhir/task.md) profile definitions as well as references to [Task](../fhir/task.md) profiles in other resources. It is also used as the URL value for [ActivityDefinitions](../fhir/activitydefinition.md). In this case though, the URL has to be split into two parts. The version (`|1.2`) needs to be separated from the URL and used as a value for the `ActivityDefinition.version` element. Since it refers to the plugin's resource version, the `#{version}` [placeholder](#placeholders) should be used here instead. Going by the example from above, the final URL looks like this:
```
http://domain.org/bpe/Process/processKey
```
-This will be the value for your `ActivityDefinition.url` element with `#{version}` as the value for your `ActivityDefinition.version` element.
\ No newline at end of file
+This will be the value for the `ActivityDefinition.url` element with `#{version}` as the value for the `ActivityDefinition.version` element.
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md), [Process Plugin Definition](process-plugin-definition.md)
diff --git a/docs/src/process-development/api-v2/fhir/activitydefinition.md b/docs/src/process-development/api-v2/fhir/activitydefinition.md
index 5cd27ca91..ae4e64c9a 100644
--- a/docs/src/process-development/api-v2/fhir/activitydefinition.md
+++ b/docs/src/process-development/api-v2/fhir/activitydefinition.md
@@ -3,7 +3,7 @@ title: ActivityDefinition
icon: creative
---
-### ActivityDefinition
+## ActivityDefinition
[ActivityDefinitions](http://hl7.org/fhir/R4/activitydefinition.html) are used by the DSF to advertise which processes are available at any given instance and who is allowed to request and who is allowed to execute a process. The DSF defined elements for this purpose in 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.
@@ -16,8 +16,9 @@ The most important elements in ActivityDefinitions are:
The `message-name` element contains the name of the [BPMN message start event](../bpmn/messaging.md#message-start-event) or [BPMN message intermediate catching event](../bpmn/messaging.md#message-intermediate-catching-event) which expects a [Task](task.md) resource complying to the profile defined by `task-profile`.
-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.
+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. A list of examples for all possible `requester` and `recipient` elements is located [here](../dsf/requester-and-recipient.md).
-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).
+Creating [ActivityDefinitions](activitydefinition.md) is part of developing a process plugin. Readers fluent in understanding XML FHIR definitions and translating them into resources may 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 they are located in one of [these folders](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir). There is also the guide on [creating ActivityDefinitions](../guides/creating-activity-definitions.md) for more in-depth information.
-You can also find examples for all possible `requester` and `recipient` elements [here](../dsf/requester-and-recipient.md).
\ No newline at end of file
+## Related Topics
+[Requester and Recipient](../dsf/requester-and-recipient.md), [Read Access Tag](../dsf/read-access-tag.md), [Task](task.md)
diff --git a/docs/src/process-development/api-v2/fhir/codesystem.md b/docs/src/process-development/api-v2/fhir/codesystem.md
index e40a365f2..ec31894dd 100644
--- a/docs/src/process-development/api-v2/fhir/codesystem.md
+++ b/docs/src/process-development/api-v2/fhir/codesystem.md
@@ -3,10 +3,13 @@ title: CodeSystem
icon: creative
---
-### CodeSystem
+## CodeSystem
-[CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) usually represent a set of concepts which can be assigned to a code (think LOINC). If you want to use a Code in a resource, you will usually include them in a [ValueSet](valueset.md).
+[CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) usually represent a set of concepts which can be assigned to a code (think LOINC). Using a Code in a resource requires them to be included in a [ValueSet](valueset.md).
Plugin development for the DSF requires the use of [CodeSystems](https://www.hl7.org/fhir/R4/codesystem.html) in two major ways:
1. Using existing [DSF CodeSystems](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem) in other FHIR resources like 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).
-2. Creating your own CodeSystem to add additional [Input Parameters](task.md#task-input-parameters) to your [Task](task.md) profiles.
\ No newline at end of file
+2. Creating custom CodeSystem to add additional [Input Parameters](task.md#task-input-parameters) to [Task](task.md) profiles.
+
+## Related Topics
+[ActivityDefinition](activitydefinition.md), [Task](task.md), [ValueSet](valueset.md)
diff --git a/docs/src/process-development/api-v2/fhir/index.md b/docs/src/process-development/api-v2/fhir/index.md
index 47e4a6cda..f09084455 100644
--- a/docs/src/process-development/api-v2/fhir/index.md
+++ b/docs/src/process-development/api-v2/fhir/index.md
@@ -4,10 +4,11 @@ icon: creative
---
## Introduction
-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).
+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. They can be found in the official [DSF GitHub repository](https://github.com/datasharingframework/dsf/tree/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir).
## Details
- [ActivityDefinition](activitydefinition.md)
- [CodeSystem](codesystem.md)
+- [Questionnaire and QuestionnaireResponse](questionnaire-and-questionnaireresponse.md)
- [Task](task.md)
- [ValueSet](valueset.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/fhir/questionnaire-and-questionnaireresponse.md b/docs/src/process-development/api-v2/fhir/questionnaire-and-questionnaireresponse.md
new file mode 100644
index 000000000..8dfdc4944
--- /dev/null
+++ b/docs/src/process-development/api-v2/fhir/questionnaire-and-questionnaireresponse.md
@@ -0,0 +1,11 @@
+---
+title: Questionnaire and QuestionnaireResponse
+icon: creative
+---
+
+## Questionnaire and QuestionnaireResponse
+
+[Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) resources are used by the DSF to implement the user interaction required in [User Tasks](../bpmn/user-tasks.md). Whenever a [User Task](../bpmn/user-tasks.md) is processed, the DSF will create a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) response resource on the DSF FHIR server. This [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) is based on a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource that is provided by the process plugin. This mechanism is described in more detail in the topic on [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md).
+
+## Related Topics
+[User Tasks](../bpmn/user-tasks.md), [User Tasks in the DSF](../guides/user-tasks-in-the-dsf.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/fhir/task.md b/docs/src/process-development/api-v2/fhir/task.md
index a647fc46c..53503e18c 100644
--- a/docs/src/process-development/api-v2/fhir/task.md
+++ b/docs/src/process-development/api-v2/fhir/task.md
@@ -3,17 +3,18 @@ title: Task
icon: creative
---
-### Task
+## Task
-The [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource enables the DSF's distributed communication. Whenever a BPMN process instance communicates with a different process instance, the DSF will create a Task resource based on parameters you set in the BPMN model and during execution. It will then automatically send the Task resource to the recipient to start or continue whatever process the Task resource referred to. All Task resources used in the DSF derive from the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). This profile includes a splicing for `Task.input` with three additional [Input Parameters](task.md#task-input-parameters):
+The [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource enables the DSF's distributed communication. Whenever a BPMN process instance communicates with a different process instance, the DSF will create a Task resource based on parameters set in the BPMN model and during execution. It will then automatically send the Task resource to the recipient to start or continue whatever process the Task resource referred to. All Task resources used in the DSF derive from the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). This profile includes a splicing for `Task.input` with three additional [Input Parameters](task.md#task-input-parameters):
- `message-name`
- `business-key`
- `correlation-key`
-When creating your own plugin, you will want to create your own profiles based on the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml).
+When creating a process plugin, it is usually necessary to create new profiles based on the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) and put them into `src/resources/fhir/StructureDefinition`.
-#### Task Input Parameters
+### Task Input Parameters
-Task Input Parameters allow you to add additional information to [Task](task.md#task) resources. For example, if your particular data exchange requires additional medical data, you would add a slice to your Task profile in the same way the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) adds slices to the original [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource. Notice that this also requires creating a [CodeSystem](codesystem.md) and including it in a [ValueSet](valueset.md) to be able to use it in the Task resource.
+Task Input Parameters allow adding additional information to [Task](task.md#task) resources. For example, if a particular data exchange requires additional medical data, one would add a slice to the Task profile in the same way the [dsf-task-base](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml) adds slices to the original [FHIR Task](https://www.hl7.org/fhir/R4/task.html) resource. It is import to know that this also requires creating a [CodeSystem](codesystem.md) and including it in a [ValueSet](valueset.md) to be able to use it in the Task resource.
-If these instructions are insufficient you can check out the guide on [how to add Task Input Parameters](../guides/adding-task-input-parameters-to-task-profiles.md).
\ No newline at end of file
+## Related Topics
+[ActivityDefinition](activitydefinition.md), [Adding Task Input Parameter to Task Profiles](../guides/adding-task-input-parameters-to-task-profiles.md)
diff --git a/docs/src/process-development/api-v2/fhir/valueset.md b/docs/src/process-development/api-v2/fhir/valueset.md
index 6be03a3fb..e980c4cf3 100644
--- a/docs/src/process-development/api-v2/fhir/valueset.md
+++ b/docs/src/process-development/api-v2/fhir/valueset.md
@@ -3,8 +3,11 @@ title: ValueSet
icon: creative
---
-### ValueSet
+## ValueSet
[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) bind codes from [CodeSystems](codesystem.md) to coded elements like `code`, `Coding` or `CodeableConcept`.
-[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) are mostly needed to use the [Concepts](https://www.hl7.org/fhir/R4/codesystem-definitions.html#CodeSystem.concept) from [CodeSystems](codesystem.md) in your [Task](task.md) profiles.
\ No newline at end of file
+[ValueSets](https://www.hl7.org/fhir/R4/valueset.html) are mostly needed to use the [Concepts](https://www.hl7.org/fhir/R4/codesystem-definitions.html#CodeSystem.concept) from [CodeSystems](codesystem.md) in [Task](task.md) profiles.
+
+## Related Topics
+[CodeSystem](codesystem.md), [Task](task.md)
diff --git a/docs/src/process-development/api-v2/guides/accessing-bpmn-process-variables.md b/docs/src/process-development/api-v2/guides/accessing-bpmn-process-variables.md
index f03bee5d0..2c809593c 100644
--- a/docs/src/process-development/api-v2/guides/accessing-bpmn-process-variables.md
+++ b/docs/src/process-development/api-v2/guides/accessing-bpmn-process-variables.md
@@ -3,8 +3,12 @@ title: Accessing BPMN Process Variables
icon: creative
---
-### Accessing BPMN Process Variables
+## Accessing BPMN Process Variables
-After creating a [Service Delegate](../dsf/service-delegates.md) or [Message Delegate](../dsf/message-delegates.md), you might want to retrieve data from or store data in the [BPMN process variables](../dsf/bpmn-process-variables.md). You can achieve this either through the [BPMN process execution](../dsf/bpmn-process-execution.md) or via the `Variables` class. *It is very much recommended to use the latter method*.
+Access to retrieve data from or store data in the [BPMN process variables](../dsf/bpmn-process-variables.md) can be acquired via the `Variables` class. An instance is usually available when overriding methods in [Service Delegates](../dsf/service-delegates.md) and [Message Delegates](../dsf/message-delegates.md). If an instance is missing in a place where it should be accessible, please [let us know](https://dsf.dev/community/contribute/).
-The `Variables` class provides lots of utility methods to read or write certain types of [BPMN process variables](../dsf/bpmn-process-variables.md). If for some reason you need to fall back on the [BPMN process execution](../dsf/bpmn-process-execution.md) to solve your problem, we would like to learn how the current API of the `Variables` class is limiting you. Contact us, and we might turn it into a feature request ([Contribute](https://dsf.dev/stable/contribute)).
+The `Variables` class provides lots of utility methods to read or write certain types
+of [BPMN process variables](../dsf/bpmn-process-variables.md). If the methods provided by the `Variables` class are insufficient to solve a problem, we would like to learn in what way the current API of the `Variables` class is limiting. Again, please [let us know](https://dsf.dev/community/contribute/).
+
+## Related Topics
+[BPMN Process Variables](../dsf/bpmn-process-variables.md), [Message Delegates](../dsf/message-delegates.md), [Service Delegates](../dsf/service-delegates.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/guides/accessing-task-resources-during-execution.md b/docs/src/process-development/api-v2/guides/accessing-task-resources-during-execution.md
index 196e16381..f5cbf1e50 100644
--- a/docs/src/process-development/api-v2/guides/accessing-task-resources-during-execution.md
+++ b/docs/src/process-development/api-v2/guides/accessing-task-resources-during-execution.md
@@ -3,10 +3,14 @@ title: Accessing Task Resources During Execution
icon: creative
---
-### Accessing Task Resources During Execution
+## Accessing Task Resources During Execution
-If you want access to the [Task](../fhir/task.md) resources in your [Service](../dsf/service-delegates.md) / [Message](../dsf/message-delegates.md) Delegates, the `Variables` class will provide methods which return certain kinds of [Task](../fhir/task.md) resources. The most commonly used ones are the start [Task](../fhir/task.md), referring to the [Task](../fhir/task.md) / [Message Start Event](../bpmn/messaging.md#message-start-event) responsible for starting the process, and the latest [Task](../fhir/task.md), referring to most recently received [Task](../fhir/task.md) / Message.
-In principle, this is sufficient to access all information in a [Task](../fhir/task.md) resource, since you have the [Task](../fhir/task.md) resource's Java object, but very cumbersome.
-Instead of navigating the [Task](../fhir/task.md) resource's element tree, you should first try to use the [ProcessPluginApi's](../dsf/process-plugin-api.md) `TaskHelper` in conjunction with the method above. The `TaskHelper` class offers specific methods related to [Task](../fhir/task.md) resources.
-The most common use case for this is retrieving data from a [Task's](../fhir/task.md) [Input Parameter](../fhir/task.md#task-input-parameters) or creating a new [Input Parameter](../fhir/task.md#task-input-parameters) for a [Message Delegate's](../dsf/message-delegates.md) `getAdditionalInputParameters` method. When retrieving data from a [Task's](../fhir/task.md) Input Parameter you first have to get to the [Input Parameter](../fhir/task.md#task-input-parameters) you are looking to extract data from. You can use one of the `TaskHelper's` getters for [Input Parameters](../fhir/task.md#task-input-parameters) to find the right one. The methods will try to match the provided [CodeSystem](../fhir/codesystem.md) and Code to any [Input Parameter](../fhir/task.md#task-input-parameters) of the provided [Task](../fhir/task.md) resource. Depending on the method you chose you will for example receive all matches or just the first one.
-To create new [Input Parameters](../fhir/task.md#task-input-parameters) to attach to a [Task](../fhir/task.md) resource, you may invoke the `TaskHelper#createInput` method. This is most often used when overriding the `getAdditionalInputParamters` method of you [Message Delegate](../dsf/message-delegates.md).
\ No newline at end of file
+Access to the [Task](../fhir/task.md) resources in [Service](../dsf/service-delegates.md) / [Message](../dsf/message-delegates.md) Delegates is provided by the `Variables` class. It comes with methods which return certain kinds of [Task](../fhir/task.md) resources. The most commonly used ones are the start [Task](../fhir/task.md), referring to the [Task](../fhir/task.md) / [Message Start Event](../bpmn/messaging.md#message-start-event) responsible for starting the process, and the latest [Task](../fhir/task.md), referring to most recently received [Task](../fhir/task.md) / Message.
+In principle, this is sufficient to access all information in a [Task](../fhir/task.md) resource, since there is access to the full in-memory representation of the [Task](../fhir/task.md) resource. This however can be very cumbersome to use and produces a lot of boilerplate when traversing the resource tree to access certain common elements.
+Instead of navigating the [Task](../fhir/task.md) resource's element tree, it is recommended to use the [ProcessPluginApi's](../dsf/process-plugin-api.md) `TaskHelper` in conjunction with the method above. The `TaskHelper` class offers specific methods related to [Task](../fhir/task.md) resources.
+The most common use case for this is retrieving data from a [Task's](../fhir/task.md) [Input Parameter](../fhir/task.md#task-input-parameters) or creating a new [Input Parameter](../fhir/task.md#task-input-parameters) for a [Message Delegate's](../dsf/message-delegates.md) `getAdditionalInputParameters` method. When retrieving data from a [Task's](../fhir/task.md) Input Parameter one first has to get to the [Input Parameter](../fhir/task.md#task-input-parameters) one is looking to extract data from. The `TaskHelper's` getters for [Input Parameters](../fhir/task.md#task-input-parameters) are useful to find the right one. The methods will try to match the provided [CodeSystem](../fhir/codesystem.md) and Code to any [Input Parameter](../fhir/task.md#task-input-parameters) of the provided [Task](../fhir/task.md) resource. Depending on the method it is possible to receive all matches or just the first one.
+To create new [Input Parameters](../fhir/task.md#task-input-parameters) to attach to a [Task](../fhir/task.md) resource, one may invoke the `TaskHelper#createInput` method. This is most often used when overriding the `getAdditionalInputParameters` method of a [Message Delegate](../dsf/message-delegates.md).
+
+
+## Related Topics
+[Accessing BPMN Process Variables](accessing-bpmn-process-variables.md), [Message Delegates](../dsf/message-delegates.md), [Service Delegates](../dsf/service-delegates.md), [Task](../fhir/task.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/guides/adding-task-input-parameters-to-task-profiles.md b/docs/src/process-development/api-v2/guides/adding-task-input-parameters-to-task-profiles.md
index 7a625d5f4..1480ee8f8 100644
--- a/docs/src/process-development/api-v2/guides/adding-task-input-parameters-to-task-profiles.md
+++ b/docs/src/process-development/api-v2/guides/adding-task-input-parameters-to-task-profiles.md
@@ -3,13 +3,13 @@ title: Adding Task Input Parameters to Task Profiles
icon: creative
---
-### Adding Task Input Parameters to Task Profiles
+## Adding Task Input Parameters to Task Profiles
-When adding a new [Input Parameter](../fhir/task.md#task-input-parameters) to a [Task](../fhir/task.md) profile, you are essentially adding a new slice to `Task.input`. [Slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) is part of [profiling](https://www.hl7.org/fhir/R4/profiling.html) in FHIR. Profiling lets you create your own FHIR definitions based on pre-existing FHIR definitions. A slicing defines constraints on element lists like `Task.input` e.g. by only allowing the elements to be of certain types.
-For example, you might have a list of fruits in a `FruitBasket` resource. Constraining that list to only include fruits of type `Apple`, `Banana` and `Orange` would be considered [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing).
-This guide will not cover how slicing works in general, only for the case presented by the DSF FHIR resource context. Our goal will be to add a new [Input Parameter](../fhir/task.md#task-input-parameters) of type `example-input` to the `task-start-dic-process.xml` profile which will be used to submit `integer` values to our `dicProcess`.
+When adding a new [Input Parameter](../fhir/task.md#task-input-parameters) to a [Task](../fhir/task.md) profile, a new slice is added to `Task.input`. [Slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) is part of [profiling](https://www.hl7.org/fhir/R4/profiling.html) in FHIR. Profiling lets you create your own FHIR definitions based on pre-existing FHIR definitions. A slicing defines constraints on element lists like `Task.input` e.g. by only allowing the elements to be of certain types.
+For example, there might be a list of fruits in a `FruitBasket` resource. Constraining that list to only include fruits of type `Apple`, `Banana` and `Orange` would be considered [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing).
+This guide will not cover how slicing works in general, only for the case presented by the DSF FHIR resource context. The goal will be to add a new [Input Parameter](../fhir/task.md#task-input-parameters) of type `example-input` to the `task-start-dic-process.xml` profile which will be used to submit `integer` values to a process called `dicProcess`.
-Let us start out by adding a slice to `task-start-dic-process.xml`. Since there is already a slicing defined on `Task.input` by `task-start-dic-process.xml`'s `baseDefinition`, we have to check out this resource first. As a part of the [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement, slicing also uses [Element Definitions](https://www.hl7.org/fhir/R4/elementdefinition.html).
+As a first step, a slice to `task-start-dic-process.xml` is added. Since there is already a slicing defined on `Task.input` by `task-start-dic-process.xml`'s `baseDefinition`, this resource has to be looked at first. As a part of the [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement, slicing also uses [Element Definitions](https://www.hl7.org/fhir/R4/elementdefinition.html).
The slicing for `Task.input` is defined in this part of the `baseDefinition`:
```xml
@@ -33,9 +33,9 @@ The slicing for `Task.input` is defined in this part of the `baseDefinition`:
```
*The resource can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml)*
-We will only need to take a look at the `discrimitator` tag for now. Discriminators define the elements a FHIR processor needs to distinguish slices by. In our case, a processor would look at the values for `type.coding.system` and `type.coding.code` to determine which slice this element belongs to. The discriminator type `value` implies that `type.coding.system` and `type.coding.code` have to be present in all slices and need to have a fixed value. You can learn more about discriminators [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator).
+First look at the `discriminator` tag. Discriminators define the elements a FHIR processor needs to distinguish slices by. In this case, a processor would look at the values for `type.coding.system` and `type.coding.code` to determine which slice this element belongs to. The discriminator type `value` implies that `type.coding.system` and `type.coding.code` have to be present in all slices and need to have a fixed value. There is more information about discriminators in the [official FHIR documentation](https://www.hl7.org/fhir/R4/profiling.html#discriminator).
-Let us revisit `task-start-dic-process.xml` and start adding a slice called `example-input` to it:
+Now revisit `task-start-dic-process.xml` and start adding a slice called `example-input` to it:
```xml
...
@@ -52,9 +52,9 @@ Let us revisit `task-start-dic-process.xml` and start adding a slice called `exa
```
*Irrelevant elements for this guide are hidden by ... placeholders.*
-We have now defined a slice on `Task.input` with the name and id of `example-input` and cardinality of `1..1`. You might want a different cardinality for your use case. We recommend you also take a look at the documentation for [ElementDefinition.id](https://www.hl7.org/fhir/R4/elementdefinition.html#id) and [ElementDefinition.path](https://www.hl7.org/fhir/R4/elementdefinition.html#path). They explain how to create the proper values for these elements. Cardinality is also part of the [element definition](https://www.hl7.org/fhir/R4/elementdefinition.html) hierarchy (see [ElementDefinition.min](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.min) and [ElementDefinition.max](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.max)).
+There is now a slice defined on `Task.input` with the name and id of `example-input` and cardinality of `1..1`. The name and cardinality depend on the use case. It is recommended to also take a look at the documentation for [ElementDefinition.id](https://www.hl7.org/fhir/R4/elementdefinition.html#id) and [ElementDefinition.path](https://www.hl7.org/fhir/R4/elementdefinition.html#path). They explain how to create the proper values for these elements. Cardinality is also part of the [element definition](https://www.hl7.org/fhir/R4/elementdefinition.html) hierarchy (see [ElementDefinition.min](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.min) and [ElementDefinition.max](https://www.hl7.org/fhir/R4/elementdefinition-definitions.html#ElementDefinition.max)).
-Next up, we need to define the binding for `Task.input:example-input.type`. Because `Task.input.type` is a `CodeableConcept` which uses codings from a [ValueSet](../fhir/valueset.md), the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires us to use `required` as the binding strength:
+Next up is the binding for `Task.input:example-input.type`. Because `Task.input.type` is a `CodeableConcept` which uses codings from a [ValueSet](../fhir/valueset.md), the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires the use of `required` as the binding strength:
```xml
...
@@ -76,9 +76,9 @@ Next up, we need to define the binding for `Task.input:example-input.type`. Beca
```
-As you can see, we referenced a [ValueSet](../fhir/valueset.md) in this binding. When adding an actual slice for your use case, you will have to reference an existing [ValueSet](../fhir/valueset.md) resource or create a new one. A guide on how to create them can be found [here](../guides/creating-valuesets-for-dsf-processes.md).
+The binding now references a [ValueSet](../fhir/valueset.md). Moving beyond this example will require referencing an existing [ValueSet](../fhir/valueset.md) resource or create a new one. A guide on how to create them can be found [here](../guides/creating-valuesets-for-dsf-processes.md).
-Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires `Task.input.coding.code` and `Task.input.coding.system` to be present, we will make `Task.input.coding` mandatory as well:
+Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminator) requires `Task.input.coding.code` and `Task.input.coding.system` to be present, `Task.input.coding` will be marked as mandatory as well:
```xml
...
@@ -105,7 +105,7 @@ Since the [discriminator](https://www.hl7.org/fhir/R4/profiling.html#discriminat
```
-In the beginning we mentioned how `Task.input.type.coding.system` and `Task.input.type.coding.code` have to use fixed values. Here is how we accomplish this:
+The beginning mentioned how `Task.input.type.coding.system` and `Task.input.type.coding.code` have to use fixed values. Here is how this is accomplished:
```xml
@@ -142,9 +142,9 @@ In the beginning we mentioned how `Task.input.type.coding.system` and `Task.inpu
```
-*Notice that we also made the two elements mandatory because they are required by the discriminator.*
+*Notice the two new elements were marked as mandatory because they are required by the discriminator.*
-For the `type.coding.system` element we referenced a [CodeSystem](../fhir/codesystem.md). The `type.coding.code` element uses a code from this [CodeSystem](../fhir/codesystem.md) called `example-input`. This is the mechanism by which you actually "name" your [Input Parameter](../fhir/task.md#task-input-parameters). The `type.coding.code` value will identify your [Input Parameter](../fhir/task.md#task-input-parameters) when you use it in an actual [Task](../fhir/task.md#task-input-parameters) resource. Here is how this would look like:
+The `type.coding.system` element references a [CodeSystem](../fhir/codesystem.md). The `type.coding.code` element uses a code from this [CodeSystem](../fhir/codesystem.md) called `example-input`. This is the mechanism by which [Input Parameter](../fhir/task.md#task-input-parameters) are "named". The `type.coding.code` value will identify the [Input Parameter](../fhir/task.md#task-input-parameters) when it is used in an actual [Task](../fhir/task.md#task-input-parameters) resource. Here is how this would look like:
```xml
@@ -161,9 +161,9 @@ For the `type.coding.system` element we referenced a [CodeSystem](../fhir/codesy
```
-When adding an actual slice for your use case, you will also need to reference an existing [CodeSystem](../fhir/codesystem.md) resource or create a new one to reference. A guide on how to create them can be found [here](../guides/creating-codesystems-for-dsf-processes.md).
+Adding a slice in a different use case will also require to reference an existing [CodeSystem](../fhir/codesystem.md) resource or create a new one to reference. A guide on how to create them can be found [here](../guides/creating-codesystems-for-dsf-processes.md).
-`Task.input.value[x]` is the actual value you will submit using your Input Parameter. You can make it any of [these](https://www.hl7.org/fhir/R4/datatypes.html#open) data types. This is because `Type.input.value[x]` refers to `*` instead of any particular type in its [definition](https://www.hl7.org/fhir/R4/task-definitions.html#Task.input.value_x_). Let us define it as an `integer` type`:
+`Task.input.value[x]` is the actual value submitted when using the Input Parameter. They may be any of [these](https://www.hl7.org/fhir/R4/datatypes.html#open) data types. This is because `Type.input.value[x]` refers to `*` instead of any particular type in its [definition](https://www.hl7.org/fhir/R4/task-definitions.html#Task.input.value_x_). In this case, let it be an `integer` type`:
```xml
@@ -207,4 +207,7 @@ When adding an actual slice for your use case, you will also need to reference a
```
-Now we have a new Input Parameter of type `example-input` which accepts any `integer` as its value.
+There is now a new Input Parameter of type `example-input` which accepts any `integer` as its value.
+
+## Related Topics
+[Creating CodeSystems for DSF processes](creating-codesystems-for-dsf-processes.md), [Creating ValueSets for DSF processes](creating-valuesets-for-dsf-processes.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v2/guides/configuring-read-access-tags.md b/docs/src/process-development/api-v2/guides/configuring-read-access-tags.md
index 404f2286e..7ac655e5a 100644
--- a/docs/src/process-development/api-v2/guides/configuring-read-access-tags.md
+++ b/docs/src/process-development/api-v2/guides/configuring-read-access-tags.md
@@ -3,9 +3,9 @@ title: Configuring Read Access Tags
icon: creative
---
-### Configuring Read Access Tags
+## Configuring Read Access Tags
-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:
+Before starting to configure anything, it is advised 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:
```xml
...
@@ -44,7 +44,7 @@ The codes `LOCAL` and `ALL` are trivial. Their [Read Access Tag](../dsf/read-acc
```
-Let us try to configure a Read Access Tag whose code uses an extension. We will choose `ROLE` for this example. We start out the same way as before:
+Now to configure a Read Access Tag whose code uses an extension. This example will use the code `ROLE`. It starts out the same way as before:
```xml
@@ -56,7 +56,7 @@ Let us try to configure a Read Access Tag whose code uses an extension. We will
The `definition` element of the `ROLE` code references an extension called [dsf-extension-read-access-parent-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-read-access-parent-organization-role-1.0.0.xml).
-The most important part of it is the `differential` statement. It uses [element definitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to describe how we need to implement the extension:
+The most important part of it is the `differential` statement. It uses [element definitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to describe how the extensions needs to be implemented:
```xml
...
@@ -142,7 +142,7 @@ All extensions for the [Read Access Tag](../dsf/read-access-tag.md) CodeSystem a
```
-That is why the first element we are adding to `meta.tag` is an `extension` element:
+That is why the first element to be added to `meta.tag` is an `extension` element:
```xml
@@ -155,7 +155,7 @@ That is why the first element we are adding to `meta.tag` is an `extension` elem
```
-We will now go through the `differential` statement one element at a time, starting at the top:
+Now to process the `differential` statement one element at a time, starting at the top:
```xml
...
@@ -175,7 +175,7 @@ We will now go through the `differential` statement one element at a time, start
```
-It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for the `Extension.extension` element, meaning we are dealing with a nested extension. The `discriminator` element tells us that slices will be identified by the value of their `url` attribute. A `rules` element with value `open` means other types of slices may be added later on e.g. when creating a profile. We do not have to add any elements from here to the `meta.tag.extension` element. Next up is the first slice called `parentOrganization`:
+It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for the `Extension.extension` element, meaning this is a nested extension. The `discriminator` element defines that slices will be identified by the value of their `url` attribute. A `rules` element with value `open` means other types of slices may be added later on e.g. when creating a profile. This element is not added to the `meta.tag.extension` element it only serves the purpose of defining the `discriminator`. Next up is the first slice called `parentOrganization`:
```xml
@@ -213,7 +213,7 @@ It defines a [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for t
```
-The first element defines a slice called `parentOrganization` on the `Extension.extension` element with cardinality `1..1`. The second element defines the url attribute of the `parentOrganization` slice to be fixed to the value `parent-organization`. With this information we can add the next element to `meta.tag`. Since it is defined on `Extension.extension` we will add it to `meta.tag.extension.extension` like this:
+The first element defines a slice called `parentOrganization` on the `Extension.extension` element with cardinality `1..1`. The second element defines the url attribute of the `parentOrganization` slice to be fixed to the value `parent-organization`. With this information the next element can be added to `meta.tag`. Since it is defined on `Extension.extension` it will be added it to `meta.tag.extension.extension` like this:
```xml
@@ -228,7 +228,7 @@ The first element defines a slice called `parentOrganization` on the `Extension.
```
-After that, it defines `parentOrganization.value[x]` to occur at least once and have a type of `Identifier`. To turn this into an element to add to `meta.tag.extension.extension` we have to replace `[x]` with our code in `value[x].type`, which in this case is `Identifier`. It is important to note, that should the value in the code element be lowercase, you will have make it uppercase before replacement. In our case this means we will have a `meta.tag.extension.extension.valueIdentifier` element:
+After that, it defines `parentOrganization.value[x]` to occur at least once and have a type of `Identifier`. To turn this into an element to add to `meta.tag.extension.extension` requires replacing `[x]` with the code in `value[x].type`, which in this case is `Identifier`. It is important to note, that `value[x]` should be camel cased after replacement. This means there will be a `meta.tag.extension.extension.valueIdentifier` element:
```xml
@@ -245,7 +245,7 @@ After that, it defines `parentOrganization.value[x]` to occur at least once and
```
-The last two elements define a `system` element with a fixed value and `value` element we can fill in on our own, since it does not have any constraints applied. Notice that the element definition still uses `value[x].system` and `value[x].value`. The replacement mentioned earlier does not happen in the element definition, but since `value[x]` is defined to have the type `Identifier` it is inferred that we mean to reference `Identifier.system` and `Identifier.value`. We will choose an arbitrary `Idenfier` value, but you should be using an actual organization identifier depending on who you want to allow read access to the resource.
+The last two elements define a `system` element with a fixed value and `value` element that can be freely set, since it does not have any constraints applied. Notice that the element definition still uses `value[x].system` and `value[x].value`. The replacement mentioned earlier does not happen in the element definition, but since `value[x]` is defined to have the type `Identifier`, it is inferred that `Identifier.system` and `Identifier.value` are referenced. The example will use an arbitrary `Identifier` value, but real application should be using an actual organization identifier depending on which organization has read access to the resource.
```xml
@@ -300,7 +300,7 @@ Next is the slice is called `organizationRole`:
```
-Like with `parentOrganization`, we will add an extension element to `meta.tag.extension` with the fixed url value defined above:
+Like with `parentOrganization`, an extension element to `meta.tag.extension` is added with the fixed url value defined above:
```xml
@@ -321,7 +321,7 @@ Like with `parentOrganization`, we will add an extension element to `meta.tag.ex
```
-Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` type. This means we will add a `valueCoding` element to the extension:
+Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` type. This the next element to add will be `valueCoding`:
```xml
@@ -344,7 +344,7 @@ Instead of `Identifier`, the `value[x]` element is now defined as a `Coding` typ
```
-A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF has a CodeSystem called [dsf-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-organization-role-1.0.0.xml). Before creating your own CodeSystem, it is worth taking a look at it to see if an appropriate role already exists for your organization. For demonstration purposes, we will be using the `DIC` role:
+A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF has a CodeSystem called [dsf-organization-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-organization-role-1.0.0.xml). Before creating new CodeSystems, it is worth taking a look at it to see if an appropriate role already exists for an organization. The example will be using the `DIC` role:
```xml
@@ -368,7 +368,7 @@ A `Coding` has to belong to some [CodeSystem](../fhir/codesystem.md). The DSF ha
```
-Now we only have two elements left in the `differential` statement:
+Now there is only two elements left in the `differential` statement:
```xml
@@ -387,7 +387,7 @@ Now we only have two elements left in the `differential` statement:
```
-The `Extension.url` element tells us to add a url attribute to `meta.tag.extension`. The last element makes it so we must not add a `meta.tag.extension.value[x]` element. This leaves us with this final Read Access Tag:
+The `Extension.url` element requires a url attribute to be added to `meta.tag.extension`. The last element defines that there must not be a `meta.tag.extension.value[x]` element. This results in this final Read Access Tag:
```xml
@@ -412,4 +412,5 @@ The `Extension.url` element tells us to add a url attribute to `meta.tag.extensi
```
-You can follow the same method to configure the other types of Read Access Tags as well.
\ No newline at end of file
+## Related Topics
+[Read Access Tag](../dsf/read-access-tag.md)
diff --git a/docs/src/process-development/api-v2/guides/creating-activity-definitions.md b/docs/src/process-development/api-v2/guides/creating-activity-definitions.md
index 163d47032..fe296007b 100644
--- a/docs/src/process-development/api-v2/guides/creating-activity-definitions.md
+++ b/docs/src/process-development/api-v2/guides/creating-activity-definitions.md
@@ -3,9 +3,9 @@ title: Creating ActivityDefinitions
icon: creative
---
-### Creating ActivityDefinitions
+## Creating ActivityDefinitions
-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.
+This guide will explain 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 a process plugin.
It is divided into steps for each of the main components of ActivityDefinitions:
1. Read Access Tag
2. Extension: process authorization
@@ -14,17 +14,17 @@ It is divided into steps for each of the main components of ActivityDefinitions:
*Regular elements* are all elements not part of the first 3 main components.
-*We will assume you know how to translate [ElementDefinitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to actual elements in a FHIR resource. If you do not, you might want to check out the guide on [creating Task resources](../guides/creating-task-resources-based-on-a-definition.md) first.*
+*This guide assumes the reader knows how to translate [ElementDefinitions](https://www.hl7.org/fhir/R4/elementdefinition.html) to actual elements in a FHIR resource. If not, the guide on [creating Task resources](../guides/creating-task-resources-based-on-a-definition.md) includes explanations for this.*
-#### 1. Read Access Tag
-Let us start out with an empty [ActivityDefinition](../fhir/activitydefinition.md):
+### 1. Read Access Tag
+Start out with an empty [ActivityDefinition](../fhir/activitydefinition.md):
```xml
```
-The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/read-access-tag.md). It describes who is allowed to read this resource through the DSF FHIR server's REST API. You can learn more complex configurations of the [Read Access Tag](../dsf/read-access-tag.md) in [this guide](../dsf/read-access-tag.md). In this case, we will allow read access to everyone:
+The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/read-access-tag.md). It describes who is allowed to read this resource through the DSF FHIR server's REST API. More complex configurations of the [Read Access Tag](../dsf/read-access-tag.md) are explained in [this guide](../dsf/read-access-tag.md). For this example, everyone will be allowed to read the resource:
```xml
@@ -37,8 +37,8 @@ The first element in DSF FHIR resources is always the [Read Access Tag](../dsf/r
```
-#### 2. Extension: Process Authorization
-This part of your ActivityDefinition will tell the DSF who is allowed to request and receive messages ([Task](../fhir/task.md) resources) for your BPMN process. If your plugin contains more than one BPMN process, you will have to create one [ActivityDefinition](../fhir/activitydefinition.md) for each BPMN process. It is important to note that you need to include authorization rules for **ALL** messages received in your BPMN process. This includes the message starting your BPMN process initially. You can find the extension [here](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). Let us continue by adding the [extension element](http://hl7.org/fhir/R4/extensibility.html#extension) with the correct URL. You can get the value for the URL from the `Extension.url` element:
+### 2. Extension: Process Authorization
+This part of the ActivityDefinition will tell the DSF who is allowed to request and receive messages ([Task](../fhir/task.md) resources) for BPMN process. If the plugin contains more than one BPMN process, there will have to be one [ActivityDefinition](../fhir/activitydefinition.md) for each BPMN process. It is important to note that authorization rules need to be included for **ALL** messages received in the BPMN process. This includes the messages starting the BPMN process initially. The extension containing all possible rules is found [here](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). Next up is adding the [extension element](http://hl7.org/fhir/R4/extensibility.html#extension) with the correct URL. The value for the URL is found in the `Extension.url` element:
```xml
...
@@ -47,7 +47,7 @@ This part of your ActivityDefinition will tell the DSF who is allowed to request
```
-*Elements not relevant to the current component are hidden with ... to increase readability.*
+*Elements not relevant to the current component are hidden with `...` to increase readability.*
The [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statement starts by defining the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) for the `Extension.extension` element:
@@ -74,9 +74,9 @@ The [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot) statemen
```
-The above states that whenever this extension is used in a profile, the profile needs to include this extension at least once (``). The [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension` tells us that elements of this [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) are identified by the value of their URL (``), which is always the case for extensions, and that other extensions can be added to the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) (``). Since there is a [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension`, we are dealing with a nested extension.
+The above states that whenever this extension is used in a profile, the profile needs to include this extension at least once (``). The [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension` defines that elements of this [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) are identified by the value of their URL (``), which is always the case for extensions, and that other extensions can be added to the [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) (``). Since there is a [slicing](https://www.hl7.org/fhir/R4/profiling.html#snapshot) on `Extension.extension`, this is a nested extension.
-After these initial element definitions come the elements relevant for your process plugin. The first one is the `message-name` slice:
+After these initial element definitions come the elements relevant for the process plugin. The first one is the `message-name` slice:
```xml
...
@@ -104,17 +104,17 @@ After these initial element definitions come the elements relevant for your proc
```
-This section tells us that we need to include exactly one extension element from the `message-name` slice in our [ActivityDefinition](../fhir/activitydefinition.md). The extension element will have a URL value of `message-name`. If you remember the `discriminator` configuration, this URL value identifies the element to belong to the `message-name` slice on `Extension.extension`. Lastly, the extension element includes a `valueString` element. In case you are wondering how `value[x]` turned into `valueString`, FHIR does not allow using `value[x]` as actual element. The value in `value[x]` is always strictly bound to some kind of type. FHIR uses the `value[x].type.code` value to determine this type and replaces `[x]` with an uppercase version of `element.type.code`. This results in the following extension element we will add to our [ActivityDefinition](../fhir/activitydefinition.md):
+This section defines that there has to be exactly one extension element from the `message-name` slice in the [ActivityDefinition](../fhir/activitydefinition.md). The extension element will have a URL value of `message-name`. This URL value identifies the element to belong to the `message-name` slice on `Extension.extension`, in accordance with the `discriminator`. Lastly, the extension element includes a `valueString` element. FHIR does not allow using `value[x]` as actual element. The value in `value[x]` is always strictly bound to some kind of type. FHIR uses the `value[x].type.code` value to determine this type and replaces `[x]` with an uppercase version of `element.type.code`. This results in the following extension element:
```xml
```
-For your use case, you have to replace `myMessage` with the name of the [BPMN message event](../bpmn/messaging.md) that is expecting this message.
+`myMessage` will have to be replaced with the name of the [BPMN message event](../bpmn/messaging.md) in a BPMN process that is expecting this message.
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -161,7 +161,7 @@ The next slice is called `task-profile`:
```
-This section has almost the same structure as `message-name`. The only difference is the value for `value[x].type.code`. This means that instead of `valueString`, we will have to use a `valueCanonical` element for `task-profile.value[x]`. Canonical values referring to [Task](../fhir/task.md) profiles in ActivityDefinitions have to conform to the rules outlined by the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls). From the definition above, we will create the following extension element and add it to our [ActivityDefinition](../fhir/activitydefinition.md):
+This section has almost the same structure as `message-name`. The only difference is the value for `value[x].type.code`. This means that instead of `valueString`, it requires using a `valueCanonical` element for `task-profile.value[x]`. Canonical values referring to [Task](../fhir/task.md) profiles in ActivityDefinitions have to conform to the rules outlined by the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls). From the definition above, the following extension element is created and added to the [ActivityDefinition](../fhir/activitydefinition.md):
```xml
@@ -169,7 +169,7 @@ This section has almost the same structure as `message-name`. The only differenc
```
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -230,7 +230,7 @@ The next slice is `requester`:
```
-Instead of a `string` or `canonical` type for `value[x]` we now have a `Coding` type. See the [FHIR documentation on Codings](https://www.hl7.org/fhir/R4/datatypes.html#Coding) for more in-depth information. `Codings` are elements which contain, among other things, a `code` and the `system` the code belongs to. In the same way we transformed `value[x]` into `valueString` or `valueCanonical` before, we will also have to turn `value[x]` into `valueCoding`. To use `Codings` in `valueCoding` elements, they are usually bound to the element through a [ValueSet](../fhir/valueset.md). This is the responsibility of the `binding` element. You can also see that `value[x].type.profile` lists a number of profiles. Instead of defining the elements in the same file, they were defined in different files for better readability. Depending on your use case, you have to pick one of the profiles.
+Instead of a `string` or `canonical` type for `value[x]` there now is a `Coding` type. See the [FHIR documentation on Codings](https://www.hl7.org/fhir/R4/datatypes.html#Coding) for more in-depth information. `Codings` are elements which contain, among other things, a `code` and the `system` the code belongs to. In the same way `value[x]` transformed into `valueString` or `valueCanonical` before, `value[x]` will be transformed into `valueCoding`. To use `Codings` in `valueCoding` elements, they are usually bound to the element through a [ValueSet](../fhir/valueset.md). This is the responsibility of the `binding` element. There is also a list of `value[x].type.profile` elements referencing other [StructureDefinitions](https://www.hl7.org/fhir/R4/structuredefinition.html). Instead of defining the elements in the same file, they were defined in different files for better readability. The use case decides which one to pick.
Here is what they mean:
- `local-all`: All local requests will be allowed. Local requests are identified by matching the requester's certificate to a thumbprint which was internally marked by the DSF FHIR server as belonging to a local organization.
- `local-organization`: All local requests made from an organization with a specific `organization-identifier` will be allowed.
@@ -238,11 +238,11 @@ Here is what they mean:
- `remote` versions of the above rules work the same but the requester's certificate is instead required to match a thumbprint marked as a remote organization.
- `practitioner` suffixes all work the same. They include the same rules as their prefixes but now additionally require the requester to match a certain `practitioner-role`. A list of them
can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml). This allows
- for more granularity when defining authorization rules within an organization and can be integrated into local user management via [OpenID Connect](https://dsf.dev/operations/latest/fhir/access-control.html).
+ for more granularity when defining authorization rules within an organization and can be integrated into local user management via [OpenID Connect](https://dsf.dev/stable/maintain/fhir/access-control.html).
-As you can see, there are no `practitioner` versions of `remote` authorization rules. From the perspective of the receiving DSF instance, remote requests are always issued by an organization. They do not hold any information about the local user management of the requesting organization. You can also find examples of all Codings from above [here](../dsf/requester-and-recipient.md).
+There are no `practitioner` versions of `remote` authorization rules. From the perspective of the receiving DSF instance, remote requests are always issued by an organization. They do not hold any information about the local user management of the requesting organization. Examples of all Codings from above can be found [here](../dsf/requester-and-recipient.md).
-It is also good to keep in mind that you are allowed to add any number of `requester` elements into your [ActivityDefinition](../fhir/activitydefinition.md). Let us start out by adding a `requester` element like we did for previous elements:
+It is also good to keep in mind that any number of `requester` elements may be added to an [ActivityDefinition](../fhir/activitydefinition.md). Start out by adding a `requester` element like previous extensions:
```xml
@@ -252,7 +252,7 @@ It is also good to keep in mind that you are allowed to add any number of `reque
```
-We now have to look at the elements that are defined in one of the profiles to fill in the remaining elements since they are not defined by the `requester` extension. For demonstration purposes, we will choose the [dsf-coding-process-authorization-local-organization-practitioner](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-practitioner-1.0.0.xml) profile. Since all elements listed in the [Coding definition](https://www.hl7.org/fhir/R4/datatypes.html#codesystem) are optional, we only have to look at the `differential` element from the profile we just selected:
+The remaining element definitions are found in one of the profiles. This example will use the [dsf-coding-process-authorization-local-organization-practitioner](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-practitioner-1.0.0.xml) profile. Since all elements listed in the [Coding definition](https://www.hl7.org/fhir/R4/datatypes.html#codesystem) are optional, only the `differential` elements from the profile are relevant:
```xml
@@ -288,7 +288,7 @@ We now have to look at the elements that are defined in one of the profiles to f
```
-It defines an extension called `organization-practitioner` which is identified through its url attribute. Again, the extension is only referenced, its location is in a different file. You can find it [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-process-authorization-organization-practitioner-1.0.0.xml). Let us look at its `differential` element in the extension file to see how we need to populate the extension:
+It defines an extension called `organization-practitioner` which is identified through its url attribute. Again, the extension is only referenced, its location is in a [different file](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-extension-process-authorization-organization-practitioner-1.0.0.xml). Below is its `differential` element in order to see how the extension needs to be populated:
```xml
@@ -368,16 +368,16 @@ It defines an extension called `organization-practitioner` which is identified t
```
-This extension does not reference any other files. This means we reached the "deepest" level. So now we can start working our way back up again from here, by translating this definition into actual extension elements, then inserting it into the Coding we selected, translating the rest of the element definitions from the Coding resource and adding everything to our [ActivityDefinition](../fhir/activitydefinition.md).
+This extension does not reference any other files. This means this is the "deepest" level. The process can now proceed by translating this definition into actual extension elements, inserting it into the selected Coding, translating the remaining element definitions from the Coding resource, and incorporating all components into the [ActivityDefinition](../fhir/activitydefinition.md).
-We will start with the `Extension.url` element, since the `Extension` element is the parent element for all slices on the `Extension.extension` elements:
+Start with the `Extension.url` element, since the `Extension` element is the parent element for all slices on the `Extension.extension` elements:
```xml
```
-Next, we will add the `organization` slice:
+Next, add the `organization` slice:
```xml
@@ -388,7 +388,7 @@ Next, we will add the `organization` slice:
```
-Finally, we will add the `practitionerRole` slice:
+Finally, add the `practitionerRole` slice:
```xml
@@ -407,9 +407,9 @@ Finally, we will add the `practitionerRole` slice:
```
-Notice that there is no `binding` element specified for `practitionerRole.value[x]`. This is intentional. In the example we used a code from the [dsf-practitioner-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml) CodeSystem. This CodeSystem includes a standard set of codes which are often sufficient for DSF use cases. You can freely add other CodeSystems if you find these codes do not apply for your use case. The code you set here can be used in the [DSF role config](https://dsf.dev/operations/latest/fhir/access-control.html) to allow certain users with this `practitioner-role` to send requests.
+There is no `binding` element specified for `practitionerRole.value[x]`. This is intentional. The example used a code from the [dsf-practitioner-role](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/CodeSystem/dsf-practitioner-role-1.0.0.xml) CodeSystem. This CodeSystem includes a standard set of codes which are often sufficient for DSF use cases. Other/new CodeSystems if may be added if these codes do not apply for a given use case. The code set here can be used in the [DSF role config](https://dsf.dev/stable/maintain/fhir/access-control.html) to allow certain users with this `practitioner-role` to send requests.
-Working our way back up to the Coding we selected, we will now add the extension we just created as the `Coding.extension:organization-practitioner` element:
+Now add the extension as the `Coding.extension:organization-practitioner` element:
```xml
@@ -430,7 +430,7 @@ Working our way back up to the Coding we selected, we will now add the extension
```
-Now might be a good time to look at the [differential](#coding-differential) from the Coding again. Our next elements to be added are `Coding.system` and `Coding.code`:
+Look at the [differential](#coding-differential) from the Coding again. The next elements to be added are `Coding.system` and `Coding.code`:
```xml
@@ -453,10 +453,10 @@ Now might be a good time to look at the [differential](#coding-differential) fro
```
-Now we are finished with the `requester` extension and can add it to our [ActivityDefinition](../fhir/activitydefinition.md) under 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).
+The `requester` extension is now finished and can be added it to the [ActivityDefinition](../fhir/activitydefinition.md) under 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).
-This is how your ActivityDefinition should look like so far
+This is how the ActivityDefinition should look like so far
```xml
@@ -498,7 +498,7 @@ Now we are finished with the `requester` extension and can add it to our [Activi
```
-Now we are back to looking at 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) again. The last slice for this extension is `recipient`:
+Back to looking at 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) again. The last slice for this extension is `recipient`:
```xml
...
@@ -532,10 +532,10 @@ Now we are back to looking at the [dsf-extension-process-authorization](https://
```
-The `recipient` will decide which DSF instance is allowed to process that message. That is the reason why you will not find any Codings for `remote` or `practitioner` here. For `requester`, we already decided that we will only allow users with a certain role from our own (local) organization to send this message. So now we will only allow the DSF instance run by that same local organization to process the message. The right Coding for this job is the [coding-process-authorization-local-organization](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-1.0.0.xml). The configuration of a local requester and local receiver is often used for the message that starts up the first BPMN process of the plugin. The process of adding the `recipient` slice is the exact same as it is for `requester`. You can follow the steps for the `requester` slice again but just use a different Coding.
+The `recipient` will decide which DSF instance is allowed to process that message. That is the reason why there are no Codings for `remote` or `practitioner` here. For `requester`, it was decided to only allow users with a certain role from a local organization to send this message. The message should now also only be processable by that same local organization. The right Coding for this job is the [coding-process-authorization-local-organization](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-coding-process-authorization-local-organization-1.0.0.xml). The configuration of a local requester and local receiver is often used for the message that starts up the first BPMN process of the plugin. The process of adding the `recipient` slice is the exact same as it is for `requester`. It's possible to follow the same steps for the `requester` slice again but using a different Coding.
-Using the Coding we just decided on, this is how your ActivityDefinition should look like
+This is how the ActivityDefinition should look like
```xml
@@ -589,7 +589,7 @@ The `recipient` will decide which DSF instance is allowed to process that messag
```
-The last element defined in the [process authorization extension](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) is `Extension.url`. But since we added this element at the very beginning of the working through the extension, we are finished with it here.
+The last element defined in the [process authorization extension](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) is `Extension.url`. This was already added at the very beginning of the working through the extension, so there is nothing more to add.
#### 3. BPE Managed Elements
@@ -597,11 +597,11 @@ Some elements of [ActivityDefinitions](../fhir/activitydefinition.md) are manage
The following elements are managed by the DSF BPE:
- `ActivityDefinition.version` should use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{version}`
-- `ActivityDefinition.date` is not required, but should you decide to include it, use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{date}`
+- `ActivityDefinition.date` is not required, but if it is included, it should use the [placeholder](../dsf/versions-placeholders-urls.md#placeholders) `#{date}`
- `ActivityDefinition.status` must have a value of `unknown`
-Your ActivityDefinition should now look like this
+The ActivityDefinition should now look like this
```xml
@@ -661,10 +661,10 @@ The following elements are managed by the DSF BPE:
```
-#### 4. Regular Elements
+### 4. Regular Elements
-The only required elements in this set are `ActivityDefinition.url` and `ActivityDefinition.kind`. Check out the documentation on [URLs](../dsf/versions-placeholders-urls.md#urls) on how to choose the correct value for `ActivityDefinition.url`. `ActivityDefinition.kind` must have the value `Task`.
-All other elements can technically be omitted. Still, we recommend you include the following elements:
+The only required elements in this set are `ActivityDefinition.url` and `ActivityDefinition.kind`. `ActivityDefinition.url` expects a certain format. This is explained in detail in the [documentation on URLs](../dsf/versions-placeholders-urls.md#urls). `ActivityDefinition.kind` must have the value `Task`.
+All other elements can technically be omitted. Still, the following elements are recommended to be populated:
- `AcitivityDefinition.name`
- `AcitivityDefinition.title`
- `AcitivityDefinition.subtitle`
@@ -674,7 +674,7 @@ All other elements can technically be omitted. Still, we recommend you include t
- `AcitivityDefinition.description`
-Your finished ActivityDefinition should now look something like this
+The finished ActivityDefinition should now look something like this
```xml
@@ -747,4 +747,7 @@ All other elements can technically be omitted. Still, we recommend you include t
```
-
\ No newline at end of file
+
+
+## Related Topics
+[ActivityDefinition](../fhir/activitydefinition.md), [Creating CodeSystems for DSF Processes](creating-codesystems-for-dsf-processes.md), [Creating ValueSets for DSF Processes](creating-valuesets-for-dsf-processes.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v2/guides/creating-codesystems-for-dsf-processes.md b/docs/src/process-development/api-v2/guides/creating-codesystems-for-dsf-processes.md
index 5ab6d87f1..c6e45e0d0 100644
--- a/docs/src/process-development/api-v2/guides/creating-codesystems-for-dsf-processes.md
+++ b/docs/src/process-development/api-v2/guides/creating-codesystems-for-dsf-processes.md
@@ -3,9 +3,9 @@ title: Creating CodeSystems for DSF Processes
icon: creative
---
-### Creating CodeSystems for DSF Processes
+## Creating CodeSystems for DSF Processes
-You might find yourself in a situation where you need to create a [CodeSystem](../fhir/codesystem.md). For example, when defining the type of an [Input Parameter](../fhir/task.md#task-input-parameters). [CodeSystems](../fhir/codesystem.md) for the DSF differ from regular [CodeSystems](../fhir/codesystem.md) in that some element's values are managed by the DSF BPE server. You can use the following XML as a template:
+Sometimes it is necessary to create custom [CodeSystem](../fhir/codesystem.md) resources. For example, when defining the type of an [Input Parameter](../fhir/task.md#task-input-parameters). [CodeSystems](../fhir/codesystem.md) for the DSF differ from regular [CodeSystems](../fhir/codesystem.md) in that some element's values are managed by the DSF BPE server. The following template can be populated with custom values:
```xml
@@ -37,6 +37,9 @@ You might find yourself in a situation where you need to create a [CodeSystem](.
```
-Replace dummy values with appropriate values of your own. Do not change elements managed by the DSF BPE server. You can add as many codes as you like by defining more `concept` elements.
+Dummy values should be replaced with appropriate values. Elements managed by the DSF BPE server should not be changed. More codes can be added by defining more `concept` elements.
-The DSF BPE server will read your [CodeSystem](../fhir/codesystem.md) from `tutorial-process/src/main/resources/fhir/CodeSystem`.
\ No newline at end of file
+When building a plugin, the [CodeSystem](../fhir/codesystem.md) is expected to be in `src/main/resources/fhir/CodeSystem` of the Java project.
+
+## Related Topics
+[Adding Task Input Parameters to Task Profiles](adding-task-input-parameters-to-task-profiles.md), [CodeSystem](../fhir/codesystem.md), [Creating ValueSets for DSF processes](creating-valuesets-for-dsf-processes.md), [ValueSet](../fhir/valueset.md)
diff --git a/docs/src/process-development/api-v2/guides/creating-task-resources-based-on-a-definition.md b/docs/src/process-development/api-v2/guides/creating-task-resources-based-on-a-definition.md
index 6306ab128..34a1c0092 100644
--- a/docs/src/process-development/api-v2/guides/creating-task-resources-based-on-a-definition.md
+++ b/docs/src/process-development/api-v2/guides/creating-task-resources-based-on-a-definition.md
@@ -3,27 +3,29 @@ title: Creating Task Resources Based on a Definition
icon: creative
---
-### Creating Task Resources Based on a Definition
+## Creating Task Resources Based on a Definition
-This short guide should help you understand how you can create [Task](../fhir/task.md) resources for use in [Starting A Process Via Task Resources](../guides/starting-a-process-via-task-resources.md). We will employ the use of the free version of [Forge](https://simplifier.net/forge?utm_source=firely-forge) to help with visualization. You are invited to create a free account and follow along, but we will include screenshots of relevant views either way. Remember that the free version of Forge [must not be used commercially](https://simplifier.net/pricing). As an example, we will create a [Task](../fhir/task.md) resource from the `task-start-dic-process.xml` profile.
+This short guide provides an overview of how to create [Task](../fhir/task.md) resources for use in [Starting A Process Via Task Resources](../guides/starting-a-process-via-task-resources.md). The free version of [Forge](https://simplifier.net/forge?utm_source=firely-forge) is used to support visualization. A free account can be created to follow the process directly; however, screenshots of relevant views are included for reference. Note that the free version of Forge [must not be used commercially](https://simplifier.net/pricing). As an example, a [Task](../fhir/task.md) resource based on the [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) profile is created.
-#### 1st Step: Removing Placeholders
-`task-start-dic-process.xml` includes placeholders for the `version` and `date` elements. For the duration of this guide, you can either remove or comment these elements, so Forge does not try to perform type checking on them, which would result in an error and Forge not loading the file.
-#### 2nd Step: Differential Chain
-If the resource profile is only available as a [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot), like in our case, we will want to aggregate the changes made to the base resource (in this case [Task](../fhir/task.md)) by all profiles to make it more readable. To do this, we first need all the profiles involved. We already have `task-start-dic-process.xml` in our `StructureDefinition` folder. It lists a resource called `task-base` in its `baseDefinition` element. This resource is part of the DSF and can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). Put it into the `StructureDefinition` folder. Since `task-base` has the original FHIR Task as its `baseDefinition` element, we are done with this chain. In forge, you should now be able to open the `StructureDefinition` folder and select the `task-start-dic-process.xml` profile. It should look something like this:
+### 1st Step: Removing Placeholders
+[`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) includes placeholders for the `version` and `date` elements. For the purpose of this guide, these elements can either be removed or commented out to prevent Forge from performing type checking on them, which would otherwise result in an error and cause Forge to not load the file.
+
+### 2nd Step: Differential Chain
+If the resource profile is only available as a [differential](https://www.hl7.org/fhir/R4/profiling.html#snapshot), as in this case, it is helpful to aggregate the changes made to the base resource (in this case [Task](../fhir/task.md)) by all profiles to improve readability. To accomplish this, all relevant profiles are required. The [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) file is already present. This file lists a resource called `task-base` in its `baseDefinition` element. The `task-base` resource is part of the DSF and can be found [here](https://github.com/datasharingframework/dsf/blob/main/dsf-fhir/dsf-fhir-validation/src/main/resources/fhir/StructureDefinition/dsf-task-base-1.0.0.xml). It should also be placed in the same folder as [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml). Since `task-base` uses the original FHIR Task as its `baseDefinition` element, no additional resources are needed to complete this chain. In Forge, opening the folder containing both resources and selecting the [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) profile should display a view similar to the following:
+
-#### 3rd Step: Building the Task Resource
-We will now go through each element one by one and include it into our [Task](../fhir/task.md) resource, provided it is mandatory (cardinality at least `1..1`) according to the profile. It is important that you not use any placeholders like `#{version}` for resources not read by the DSF BPE server. This is the case if we want a [Task](../fhir/task.md) resource for use with [cURL](../guides/starting-a-process-via-task-resources.md#using-curl). But, placeholders should be used in [Draft Task Resources](../dsf/draft-task-resources.md) instead of actual values wherever possible, since those are read by the DSF BPE server. This guide will create a [Task](../fhir/task.md) resource without placeholders. We will start out with the base element for all [Task](../fhir/task.md) resources:
+### 3rd Step: Building the Task Resource
+Each element will now be reviewed and included in the [Task](../fhir/task.md) resource if it is mandatory (cardinality of at least `1..1`) according to the profile. Placeholders such as `#{version}` must not be used for resources that are not read by the DSF BPE server. This applies when creating a [Task](../fhir/task.md) resource intended for use with [cURL](../guides/starting-a-process-via-task-resources.md#using-curl). In contrast, placeholders should be used in [Draft Task Resources](../dsf/draft-task-resources.md) instead of actual values wherever possible, as these resources are read by the DSF BPE server. This guide demonstrates the creation of a [Task](../fhir/task.md) resource without placeholders, beginning with the base element required for all [Task](../fhir/task.md) resources:
```xml
```
-Before we start adding any elements listed in Forge's element tree, we have to include the `Task.meta.profile` element. Its requirement cannot be seen here which is why we mention it specifically. This is the only instance you will not see it in the element tree. It should look like this:
+Before adding any elements listed in Forge's element tree, the `Task.meta.profile` element must be included. Its requirement is not visible in the element tree, which is why it is mentioned explicitly. This is the only instance where it does not appear in the element tree. It should look like this:
```xml
@@ -32,7 +34,7 @@ Before we start adding any elements listed in Forge's element tree, we have to i
```
-The first element which can be found in the element tree is the `instantiatesCanonical` element. To add it, we will create an XML element with the same name and the value according to [URLs](../dsf/versions-placeholders-urls.md#urls):
+The first element listed in the element tree is the `instantiatesCanonical` element. To add this element, an XML element with the same name should be created, using a value as specified in [URLs](../dsf/versions-placeholders-urls.md#urls):
```xml
@@ -43,7 +45,7 @@ The first element which can be found in the element tree is the `instantiatesCan
```
We can continue this process for all primitive elements like these. Just make sure you pay attention to use the correct data type (e.g. proper coding value for elements with `coding` type).
-By now your [Task](../fhir/task.md) resources should look something like this:
+The [Task](../fhir/task.md) resource should look something like this:
Suggested solution
@@ -60,11 +62,11 @@ By now your [Task](../fhir/task.md) resources should look something like this:
```
-Let us look at a more complex element like the `requester` element:
+Now a more complex element like the `requester` element:
-We will start the same way we started with primitive elements, by adding the `requester` element:
+The beginning is the same as primitive elements, adding the `requester` element:
```xml
@@ -80,7 +82,7 @@ We will start the same way we started with primitive elements, by adding the `re
```
-Then, we will add primitive elements to `requester` like we did before for `Task`:
+Then, primitive elements are added to `requester` like before for `Task`:
```xml
@@ -97,7 +99,7 @@ Then, we will add primitive elements to `requester` like we did before for `Task
```
*Important to note here that the value for the `status` will always be `requested` for Tasks being posted using cURL and the `type` element for `requester` and `recipient` will always have the value `Organization` in the DSF context.*
-Next, we will add the `identifier` element and its primitive sub-elements just like we started out doing it for the `requester` element. The `identifier.value` in this case will be `dic.dsf.test`. To understand why, take a look at the topic on [organization identifiers](../dsf/organization-identifiers.md):
+Next, the `identifier` element and its primitive sub-elements are added just like before. The `identifier.value` in this case will be `dic.dsf.test`. To understand why, take a look at the topic on [organization identifiers](../dsf/organization-identifiers.md):
```xml
@@ -116,9 +118,9 @@ Next, we will add the `identifier` element and its primitive sub-elements just l
```
-*Notice that `requester.identifier.system` has a `Fixed value` annotation. You can see what the value is supposed to be by clicking on the `system` element in Forge or looking at the XML for the right Task profile. The right side will have all information about that element, including the actual value for `Fixed value`.*
+*The `requester.identifier.system` has a `Fixed value` annotation. Clicking on the `system` element in Forge or looking at the XML for the right Task profile reveals what the value is supposed to be. The right side will have all information about that element, including the actual value for `Fixed value`.*
-You should now be able to fill out all elements in your [Task](../fhir/task.md) resource until you reach the [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for `Task.input`. Your [Task](../fhir/task.md) resource should look something like this:
+Filling out all elements in the [Task](../fhir/task.md) resource is now the same until the [slicing](https://www.hl7.org/fhir/R4/profiling.html#slicing) for `Task.input`. The [Task](../fhir/task.md) resource should look something like this:
Suggested solution
@@ -152,11 +154,11 @@ You should now be able to fill out all elements in your [Task](../fhir/task.md)
-[Slicings](https://www.hl7.org/fhir/R4/profiling.html#slicing) are a bit different from regular elements. Let us look at the slice `message-name`:
+[Slicings](https://www.hl7.org/fhir/R4/profiling.html#slicing) are a bit different from regular elements. Starting with the slice `message-name`:
-If we were to continue including slices to the [Task](../fhir/task.md) resource like we did so far, we would add a `message-name` element to our XML like this:
+Including slices to the [Task](../fhir/task.md) resource like previous element would add a `message-name` element to our XML like this:
```xml
@@ -169,7 +171,7 @@ If we were to continue including slices to the [Task](../fhir/task.md) resource
```
-This approach however, would not work. FHIR processors do not use the name of the slice to map entries in your [Task](../fhir/task.md) resource to the correct slice. They use [discriminators](https://www.hl7.org/fhir/R4/profiling.html#discriminator). Discriminators define the elements a processor needs to distinguish slices by. You can see how the discriminator is configured by selecting the `input` element in Forge. In our case, a processor would look at the values for `input.type.coding.system` and `input.type.coding.code` to determine which slice this element belongs to. This only works because `input.type.coding.system` and `input.type.coding.code` are present in all slices and have a `Fixed value`. You can learn more about discriminators [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator). All this means is that we effectively ignore the name of the slice as an element and start adding elements like we did before:
+This approach however, would not work. FHIR processors do not use the name of the slice to map entries in your [Task](../fhir/task.md) resource to the correct slice. They use [discriminators](https://www.hl7.org/fhir/R4/profiling.html#discriminator). Discriminators define the elements a processor needs to distinguish slices by. The discriminator configuration can be seen by selecting the `input` element in Forge. In this case, a processor would look at the values for `input.type.coding.system` and `input.type.coding.code` to determine which slice this element belongs to. This only works because `input.type.coding.system` and `input.type.coding.code` are present in all slices and have a `Fixed value`. More about discriminators can be read [here](https://www.hl7.org/fhir/R4/profiling.html#discriminator). This means effectively ignoring the name of the slice as an element and start adding elements like before:
```xml
@@ -186,7 +188,7 @@ This approach however, would not work. FHIR processors do not use the name of th
```
-Now you should be able to add all remaining mandatory elements to your [Task](../fhir/task.md) resource on your own. In the end, it should look something like this:
+This covers all ways of adding elements. Adding the remaining elements is left as an exercise. In the end, it should look something like this:
Suggested solution
@@ -228,4 +230,7 @@ Now you should be able to add all remaining mandatory elements to your [Task](..
```
-**Do not forget to restore the version and date placeholders in `task-start-dic-process.xml`!**
\ No newline at end of file
+**Do not forget to restore the version and date placeholders in [`task-start-dic-process.xml`](https://github.com/datasharingframework/dsf-process-tutorial/blob/main/tutorial-process/src/main/resources/fhir/StructureDefinition/task-start-dic-process.xml) when reusing the resource in a process plugin!**
+
+## Related Topics
+[Draft Task Resources](../dsf/draft-task-resources.md), [Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v2/guides/creating-valuesets-for-dsf-processes.md b/docs/src/process-development/api-v2/guides/creating-valuesets-for-dsf-processes.md
index f273196ec..69f7744db 100644
--- a/docs/src/process-development/api-v2/guides/creating-valuesets-for-dsf-processes.md
+++ b/docs/src/process-development/api-v2/guides/creating-valuesets-for-dsf-processes.md
@@ -3,10 +3,10 @@ title: Creating ValueSets for DSF Processes
icon: creative
---
-### Creating ValueSets for DSF Processes
+## Creating ValueSets for DSF Processes
+
+In some cases, it may be necessary to create a [ValueSet](../fhir/valueset.md). For example, when adding [Input Parameters](../fhir/task.md#task-input-parameters) to DSF [Task](../fhir/task.md) resources, a [ValueSet](../fhir/valueset.md) resource must also be referenced in the binding for `Task.input.type` to define the type of the [Input Parameter](../fhir/task.md#task-input-parameters). [ValueSets](../fhir/valueset.md) for the DSF differ from regular [ValueSets](../fhir/valueset.md) in that certain element values are managed by the DSF BPE server. The following template can be used for a [ValueSet](../fhir/valueset.md):
-You might find yourself in the situation where you need to create a [ValueSet](../fhir/valueset.md). For example, when adding [Input Parameters](../fhir/task.md#task-input-parameters) to DSF [Task](../fhir/task.md) resources, you will also have to reference a [ValueSet](../fhir/valueset.md) resource in your binding for `Task.input.type` to be able to set the type of your [Input Parameter](../fhir/task.md#task-input-parameters). [ValueSets](../fhir/valueset.md) for the DSF differ from regular [ValueSets](../fhir/valueset.md) in that some element's values are managed by the DSF BPE server. You can use the following template for your
-[ValueSet](../fhir/valueset.md):
```xml
@@ -36,7 +36,7 @@ You might find yourself in the situation where you need to create a [ValueSet](.
```
-Replace dummy values with appropriate values of your own. Do not change elements managed by the DSF BPE server. The `compose` element defines the codes included in this [ValueSet](../fhir/valueset.md). It holds at least one `include` element. Each `include` element refers to a [CodeSystem](../fhir/codesystem.md) and contains a list of `concept` elements which in turn contain the actual `code` element. Using one code from `my-code-system` and one code from `my-other-code-system` would result in the following `compose` element:
+Dummy values should be replaced with appropriate, context-specific values. Elements managed by the DSF BPE server must not be modified. The `compose` element defines the codes included in this [ValueSet](../fhir/valueset.md) and contains at least one `include` element. Each `include` element references a [CodeSystem](../fhir/codesystem.md) and includes a list of `concept` elements, each containing an individual `code` element. The use of one code from `my-code-system` and one code from `my-other-code-system` results in the following `compose` element:
```xml
...
@@ -58,6 +58,7 @@ Replace dummy values with appropriate values of your own. Do not change elements
```
-The DSF BPE server will read your [ValueSet](../fhir/valueset.md) from `tutorial-process/src/main/resources/fhir/ValueSet`.
+When building a plugin, the [ValueSet](../fhir/valueset.md) is expected to be in `src/main/resources/fhir/CodeSystem` of the Java project.
-You might also want to check out [this guide](../guides/creating-codesystems-for-dsf-processes.md) on how to create [CodeSystems](../fhir/codesystem.md).
\ No newline at end of file
+## Related Topics
+[CodeSystem](../fhir/codesystem.md), [Creating CodeSystems for DSF processes](creating-codesystems-for-dsf-processes.md), [ValueSet](../fhir/valueset.md)
diff --git a/docs/src/process-development/api-v2/guides/managing-mutiple-incoming-messages-and-missing-messages.md b/docs/src/process-development/api-v2/guides/managing-mutiple-incoming-messages-and-missing-messages.md
index a0c8f6120..a0cf72993 100644
--- a/docs/src/process-development/api-v2/guides/managing-mutiple-incoming-messages-and-missing-messages.md
+++ b/docs/src/process-development/api-v2/guides/managing-mutiple-incoming-messages-and-missing-messages.md
@@ -3,16 +3,20 @@ title: Managing Multiple Incoming Messages and Missing Messages
icon: creative
---
-### Managing Multiple Incoming Messages and Missing Messages
+## Managing Multiple Incoming Messages and Missing Messages
If an already running process instance is waiting for a message from another organization, the corresponding FHIR [Task](../fhir/task.md) may never arrive. Either because the other organization decides to never send the message or because some technical problem prohibits the [Task](../fhir/task.md) resource from being posted to the DSF FHIR server. This would result in stale process instances that never finish.
-At the same time, you might also expect to receive one out of a number of different message types at once.
+At the same time, it might also be expected to receive one out of a number of different message types at once.
-In order to solve both problems we can add an [Event Based Gateway](../bpmn/gateways.md#event-based-gateway) to the process waiting for a response and then either handle a [Task](../fhir/task.md) resource with the response and finish the process in a success state or trigger a [Timer Intermediate Catching Event](../bpmn/timer-intermediate-catching-events.md) after a defined wait period and finish the process in an error state. The following BPMN collaboration diagram shows how the process at the first organization would look like if we wanted to react to multiple different messages or missing messages:
+An [Event Based Gateway](../bpmn/gateways.md#event-based-gateway) can be used to solve both problems by adding it to the process waiting for a response and then either handling a [Task](../fhir/task.md) resource with the response and finish the process in a success state or triggering a [Timer Intermediate Catching Event](../bpmn/timer-intermediate-catching-events.md) after a defined wait period and finish the process in an error state. The following BPMN collaboration diagram shows how the process at the first organization would look like if we wanted to react to multiple different messages or missing messages:
+
+
+## Related Topics
+[Gateways](../bpmn/gateways.md), [Message Correlation](../dsf/message-correlation.md), [Message Delegates](../dsf/message-delegates.md)
\ No newline at end of file
diff --git a/docs/src/process-development/api-v2/guides/setting-targets-for-message-events.md b/docs/src/process-development/api-v2/guides/setting-targets-for-message-events.md
index 68db0b1e0..6d4156962 100644
--- a/docs/src/process-development/api-v2/guides/setting-targets-for-message-events.md
+++ b/docs/src/process-development/api-v2/guides/setting-targets-for-message-events.md
@@ -3,12 +3,10 @@ title: Setting Targets for Message Events
icon: creative
---
-### Setting Targets for Message Events
+## Setting Targets for Message Events
-Setting a target for a message event requires a `Target` object. To create one, you require a target's organization identifier, endpoint identifier and endpoint address. You can find these values by visiting the DSF FHIR server's web interface. In the top right corner, click the `Show Bookmarks` button, then select `Endpoint`. You will be taken to a list of all Endpoints available to the FHIR server. There are two ways of adding `targets` to the BPMN execution variables:
-#### 1. Adding the target in the message event implementation
-In your message event implementation (the class extending `AbstractTaskMessageSend`), you can override `AbstractTaskMessageSend#doExecute`, add your targets and then call the super-method.
-#### 2. Adding the target in a service task right before the message event
-This is the preferred method of this tutorial but both methods will work perfectly fine. For our use cases, we usually prefer this one since there is enough complexity to warrant putting it into a separate BPMN [Service Task](../bpmn/service-tasks.md).
+Setting a target for a message event requires a `Target` object. Creating this object requires the target's organization identifier, endpoint identifier, and endpoint address. These values can be obtained from the DSF FHIR server's web interface or by querying the FHIR server via an instance of `DsfClient` or a `generic FHIR client`. By clicking the `Show Bookmarks` button in the top right corner and selecting `Endpoint`, a list of all Endpoints available to the FHIR server will be displayed. Instances of `DsfClient` or a `generic FHIR client` can be accessed via the [process plugin API](../dsf/process-plugin-api.md).
+Targets should be added in a [Service Task](../bpmn/service-tasks.md) before a [Message Event](../bpmn/messaging.md). A `Variables` instance provides helper methods to set targets in a [Service Task's](../bpmn/service-tasks.md) `execute` method.
-In both cases you can access methods to create and set `targets` through the `Variables` instance.
+## Related Topics
+[Process Plugin API](../dsf/process-plugin-api.md), [Message Correlation](../dsf/message-correlation.md), [Target and Targets](../dsf/target-and-targets.md)
diff --git a/docs/src/process-development/api-v2/guides/starting-a-process-via-task-resources.md b/docs/src/process-development/api-v2/guides/starting-a-process-via-task-resources.md
index baa36a7bb..aaf7287fd 100644
--- a/docs/src/process-development/api-v2/guides/starting-a-process-via-task-resources.md
+++ b/docs/src/process-development/api-v2/guides/starting-a-process-via-task-resources.md
@@ -3,20 +3,19 @@ title: Starting a Process via Task Resources
icon: creative
---
-### Starting a Process via Task Resources
+## Starting a Process via Task Resources
-To start a BPMN process, you need to create new a [Task](../fhir/task.md) resource in the DSF FHIR server by sending an HTTP request according to the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html). Specifically, you need to [create](https://www.hl7.org/fhir/R4/http.html#create)
-a resource for the first time. Also, remember that the [Task](../fhir/task.md) resource you are sending needs to comply to the [Task](../fhir/task.md) profile of the process you want to start and the [ActivityDefinition's](../fhir/activitydefinition.md) authorization rules.
+To start a BPMN process, a new [Task](../fhir/task.md) resource must be created in the DSF FHIR server by sending an HTTP request in accordance with the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html). Specifically, a [create](https://www.hl7.org/fhir/R4/http.html#create) operation is required to generate the resource for the first time. The [Task](../fhir/task.md) resource being sent must conform to the [Task](../fhir/task.md) profile of the intended process and adhere to the [ActivityDefinition's](../fhir/activitydefinition.md) authorization rules.
There are two major ways of making this HTTP request:
1. Using cURL
2. Using the DSF FHIR server's web interface
-#### Using cURL
-In order to use cURL, you will have to create an appropriate [Task](../fhir/task.md) resource to post to the DSF FHIR server. There already is a file called `example-task.xml` located in `tutorial-process/src/main/resources/fhir`. You can use this as your starting point. You can try to follow [this guide](../guides/creating-task-resources-based-on-a-definition.md), or you can check the solution branches for this file if you need ideas on how to fill it out properly.
+### Using cURL
+To use cURL, an appropriate [Task](../fhir/task.md) resource must be created and posted to the DSF FHIR server. There is a guide on [creating Task Resources based on a StructureDefinition](../guides/creating-task-resources-based-on-a-definition.md). A file named `example-task.xml` is available in `tutorial-process/src/main/resources/fhir` in the [DSF Process Tutorial](https://github.com/datasharingframework/dsf-process-tutorial) and can serve as a starting point. The [solution branches of the tutorial](https://github.com/datasharingframework/dsf-process-tutorial/blob/solutions/exercise-1/tutorial-process/src/main/resources/fhir/Task/task-start-dic-process.xml) can be consulted for a full example.
-Below are some cURL command skeletons. Replace all <>-Placeholders with appropriate values. Host name depends on the instance you want to address.
+Below is a cURL command skeleton. All <>-Placeholders should be replaced with appropriate values. Host name depends on the instance that should be addressed.
-##### Linux:
+#### Linux:
```shell
curl https:///fhir/Task \
--cacert \
@@ -26,18 +25,12 @@ curl https:///fhir/Task \
-H "Accept: application/fhir+xml" \
-d @
```
-##### Windows CMD:
-```shell
-curl https:///fhir/Task ^
---cacert ^
---cert :password ^
---key ^
--H "Content-Type: application/fhir+xml" ^
--H "Accept: application/fhir+xml" ^
--d @
-```
-*This may throw an error depending on which version of cURL Windows is using. If this is the case for you after making sure you entered everything correctly, you can try using Git's version of cURL instead by adding it to the very top of your system's PATH environment variable. Git's cURL is usually situated in C:\Program Files\Git\mingw64\bin.*
-#### Using the DSF FHIR Server's Web Interface
+### Using the DSF FHIR Server's Web Interface
+
+When accessing the web interface of a DSF FHIR server instance (e.g. https://instance-name/fhir), the DSF FHIR server can be queried using the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html) to return a list of all [Draft Task Resources](../dsf/draft-task-resources.md). These [Task](../fhir/task.md) resources serve as templates for instantiating [Task](../fhir/task.md) resources that initiate BPMN processes. Instead of performing the query manually, a predefined bookmark can be used to navigate to the query URL. A list of bookmarks is available in the top right corner of the web interface. Selecting the bookmark referencing `?_sort=_profile,identifier&status=draft` under the `Task` section will display the list of all [Draft Task Resources](../dsf/draft-task-resources.md). From this list, the desired resource to start the BPMN process can be selected. A detailed view of the resource will be shown, allowing the specification of any necessary [Task Input Parameters](../fhir/task.md#task-input-parameters). If all required information is provided correctly, the process can be initiated by clicking `Start Process`.
+
+For [Draft Task Resources](../dsf/draft-task-resources.md) to be available, they must be included in the mapping for the BPMN process ID in `ProcessPluginDefinition#getFhirResourcesByProcessId`. Additional information can be found in [the Process Plugin Definition](../dsf/process-plugin-definition.md).
-When visiting the web interface of a DSF FHIR server instance (e.g. https://instance-name/fhir), you can query the DSF FHIR server using the [FHIR RESTful API](https://www.hl7.org/fhir/R4/http.html) to return a list of all [Draft Task Resources](../dsf/draft-task-resources.md). These [Task](../fhir/task.md) resources act like a template you can use to instantiate [Task](../fhir/task.md) resources which start BPMN processes. Instead of querying the DSF FHIR server manually, you can use a predefined bookmark to navigate to the query URL. You can find a list of Bookmarks in the top right corner of the web interface. Simply select the bookmark referencing `?_sort=_profile,identifier&status=draft` under the `Task` section, and you will be taken to the list of all [Draft Task Resources](../dsf/draft-task-resources.md). Once there, you can select the one which starts your BPMN process. It will take you to a detailed view of the resource where you will also have the chance to fill any [Task Input Parameters](../fhir/task.md#task-input-parameters) you might need to specify. If everything is filled out correctly, you may start your process by clicking `Start Process`. Keep in mind that, for [Draft Task Resources](../dsf/draft-task-resources.md) to be available, you need to include them in your mapping for your BPMN process ID in `ProcessPluginDefinition#getFhirResourcesByProcessId`. Take a look at [the Process Plugin Definition](../dsf/process-plugin-definition.md) if you need a reminder.
\ No newline at end of file
+## Related Topics
+[Task](../fhir/task.md)
diff --git a/docs/src/process-development/api-v2/guides/user-tasks-in-the-dsf.md b/docs/src/process-development/api-v2/guides/user-tasks-in-the-dsf.md
index 3c987de8a..c13bee63b 100644
--- a/docs/src/process-development/api-v2/guides/user-tasks-in-the-dsf.md
+++ b/docs/src/process-development/api-v2/guides/user-tasks-in-the-dsf.md
@@ -5,11 +5,17 @@ icon: creative
### User Tasks in the DSF
-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 according to a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) you provided in the [User Task's](../bpmn/user-tasks.md) `Forms` field when the process execution reaches the [User Task](../bpmn/user-tasks.md). The `Forms` field needs to have a type of `Embedded or External Task Forms` with the `Form key` being the url of your [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource needs to be put in the `src/main/resources/fhir/Questionnaire` directory. The generated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) can now be answered by locating the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) in the DSF FHIR server UI through `https://your.dsf.fhir.server/fhir/QuestionnaireResponse?_sort=-_lastUpdated&status=in-progress`. After filling out the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) and submitting it, the process execution will continue with the next BPMN element after the [User Task](../bpmn/user-tasks.md) and the updated [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) will be available through the [Process Plugin Api's](../dsf/process-plugin-api.md) `Variables` instance by calling `getLatestReceivedQuestionnaireResponse()`.
+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.
-You also have the option 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 allows you to manipulate the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) before it is posted to the DSF FHIR server. You do this by extending the `DefaultUserTaskListener` class which provides overrides to interact with the [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html). Notice that dynamically changing the `item.text` value of an item in a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) (that is **NOT** of type `display`) is not allowed. For that, you would have to change the `item.text` value of the corresponding [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource as well. Instead, you should have an item of type `display` above the item whose text should change dynamically, like in the template, and change its `item.text` value. In this case, you may also leave out `item.text` element of the item below the display item.
+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()`.
+
+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).
+
+Dynamically changing the `item.text` value of an item in a [QuestionnaireResponse](https://www.hl7.org/fhir/R4/questionnaireresponse.html) (if the item is **not** of type `display`) is not permitted. To change text dynamically, the `item.text` value of the corresponding [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource must also be updated. As an alternative, an item of type `display` can be placed above the item requiring dynamic text, and its `item.text` value can be modified instead, as shown in the template. In this case, the `item.text` element of the item below the display item may be omitted.
+
+
+Below is a template for a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. The placeholder `questionnaire-name` should be replaced with the actual name of the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html), and the file should be named accordingly. The items `business-key` and `user-task-id` are required by the DSF and must always be included. Additional items can be added to the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) as needed.
-Below you can find a template for a [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) resource. Replace `questionnaire-name` with the name of your [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html) and have the file be named the same. The items `business-key` and `user-task-id` are required by the DSF and are always included. You can then add any amount of items of your choosing to the [Questionnaire](https://www.hl7.org/fhir/R4/questionnaire.html).
### Questionnaire Template
```xml
@@ -54,4 +60,7 @@ Below you can find a template for a [Questionnaire](https://www.hl7.org/fhir/R4/
-```
\ No newline at end of file
+```
+
+## Related Topics
+[Questionnaire and QuestionnaireResponse](../fhir/questionnaire-and-questionnaireresponse.md)
\ No newline at end of file
diff --git a/docs/src/s/connection-refused.md b/docs/src/s/connection-refused.md
new file mode 100644
index 000000000..430733123
--- /dev/null
+++ b/docs/src/s/connection-refused.md
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/src/s/connection-timeout.md b/docs/src/s/connection-timeout.md
new file mode 100644
index 000000000..0bf792197
--- /dev/null
+++ b/docs/src/s/connection-timeout.md
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/src/s/error-http.md b/docs/src/s/error-http.md
new file mode 100644
index 000000000..eafe21f8f
--- /dev/null
+++ b/docs/src/s/error-http.md
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/src/s/error-ssl.md b/docs/src/s/error-ssl.md
new file mode 100644
index 000000000..81a550c66
--- /dev/null
+++ b/docs/src/s/error-ssl.md
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/src/s/read-timeout.md b/docs/src/s/read-timeout.md
new file mode 100644
index 000000000..3db57d51d
--- /dev/null
+++ b/docs/src/s/read-timeout.md
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/src/s/unknown-host.md b/docs/src/s/unknown-host.md
new file mode 100644
index 000000000..1f5a46177
--- /dev/null
+++ b/docs/src/s/unknown-host.md
@@ -0,0 +1,2 @@
+
+
![" + messages.linkIcon +"](" + pathtoroot + "link.svg){kind=small}
