Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dfki docu fix #25

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Dfki docu fix #25

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c12ee7
fix serviceTypes, mandatory and optional inputs
VPoser Aug 22, 2018
aed7966
fix serviceTypes documentation (application)
VPoser Sep 10, 2018
974c893
fix serviceTypes documentation: sessionToken, statusBase64
VPoser Sep 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions infrastructure_overview/service_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ This method will be called to invoke your service.
| Parameter name | Optional | Description |
--- | --- | :--- |
| `sessionToken` | yes | Session token to be used throughout the workflow |
| `serviceID` | yes | The ID assigned to this service by the execution engine, provided automatically |
| `serviceID` | no | The ID assigned to this service by the execution engine, provided automatically |
| `extraParameters` | yes | Needs to be connected to the "extraParameters" workflow input |
| ... | | |
| `your parameters` | no | |
Expand All @@ -141,7 +141,7 @@ This method will be called to invoke your service.

| Parameter name | Optional | Description |
--- | --- | :--- |
| `status_base64` | no | The status of your workflow (`COMPLETED`, `UNCHANGED`, or a base64-encoded string) |
| `status_base64` | no | The status of your workflow (or a base64-encoded string) |
| ... | | |
| `your parameters` | no | |

Expand All @@ -167,7 +167,7 @@ instance of a service.

##### Outputs
The output parameters of this method have to be identical to the ones of the
`startServce` method, including `status_base64`.
`startServce` method, including `status_base64`, which may here have the values `COMPLETED`, `UNCHANGED`, or a base64-encoded string. The value 'UNCHANGED' may be used to signal the WFM that the service's status has not changed since the last request, whereby one can slighty reduce traffic and load for the WFM (especially for large status descriptions). In this case the WFM will simply forward the previous status to the portal.

#### `notifyService` method (optional)

Expand Down Expand Up @@ -250,17 +250,17 @@ This method will be called to invoke your service.

| Parameter name | Optional | Description |
--- | --- | :--- |
| `sessionToken` | yes | Session token to be used throughout the workflow |
| `serviceID` | yes | The ID assigned to this service by the execution engine, provided automatically |
| `extraParameters` | yes | Needs to be connected to the "extraParameters" workflow input |
| `sessionToken` | no | Session token to be used throughout the workflow |
rojsc marked this conversation as resolved.
Show resolved Hide resolved
| `serviceID` | no | The ID assigned to this service by the execution engine, provided automatically |
| `extraParameters` | no | Needs to be connected to the "extraParameters" workflow input |
| ... | | |
| `your parameters` | no | |

##### Outputs

| Parameter name | Optional | Description |
--- | --- | :--- |
| `status_base64` | no | The status of your workflow (`COMPLETED`, `UNCHANGED`, or a base64-encoded string) |
| `status_base64` | no | The status of your workflow (a base64-encoded string) |
rojsc marked this conversation as resolved.
Show resolved Hide resolved
| ... | | |
| `your parameters` | no | |

Expand All @@ -282,11 +282,13 @@ The name of the upper level tag (here, `ServiceOutputs`) may be arbitrary.

| Parameter name | Optional | Description |
--- | --- | :--- |
| `sessionToken` | no | Session token to be used throughout the workflow |
| `serviceID` | no | The ID assigned to this service by the execution engine, provided automatically |
| `xmlOutputs_base64` | no | Base64-encoded result parameters of your service |


The parameters provided through the parameter `xmlOutputs_base64` have to be identical to the ones of the
`startServce` method, including `status_base64`.
`startService` method, including `status_base64`, which may here have the values `COMPLETED`, `UNCHANGED`, or a base64-encoded string. The value 'UNCHANGED' may be used to signal the WFM that the service's status has not changed since the last request, whereby one can slighty reduce traffic and load for the WFM (especially for large status descriptions). In this case the WFM will simply forward the previous status to the portal.

##### Outputs

Expand Down