kaldesai commented on code in PR #558:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/558#discussion_r1512302716
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/newsletter-subscription-example.adoc:
##########
@@ -0,0 +1,264 @@
+= Newsletter Subscription example in {product_name}
+
+:compat-mode!:
+// Metadata:
+:description: Newsletter subscription example in Serverless Workflow
+:keywords: kogito, workflow, serverless
+:flow_newsletter_subscription_url:
{kogito_sw_examples_url}/serverless-workflow-newsletter-subscription
+
+This example demonstrates a few features powered by the {product_name}
following the Serverless Workflow specification including:
+
+* REST Services calls via OpenAPI definitions
+* Pause and resume of a given workflow instance
+* Consuming and producing CloudEvents
+
+In a Knative environment, the services involved in this use case can be scaled
to zero and resume from the exact stage it was, saving cluster resources in the
process.
+
+The figure below illustrates the overall architecture of this use case.
+
+image::use-cases/newsletter-subscription/architecture.png[Architecture]
+
+. Once a new subscription request comes, the flow will evaluate if it's not
already subscribed.
+. If not, it will attempt to subscribe the new user and wait for the
confirmation.
+. Once a new event containing the confirmation arrives, the flow will resume
and subscribe the new user.
+. Subscriptions that are not confirmed during a configured period of time, are
considered timed-out and are automatically removed from the system.
+. By the end, a new event containing the details of the subscription is
broadcasted in the environment, so other actors can react upon it.
+
+Here we have the Newsletter Subscription workflow:
+
+.newsletter-subscription-flow workflow
+image::use-cases/newsletter-subscription/newsletter-subscription-flow.png[Workflow]
+
+.Newsletter subscription flow workflow definition
+[source,json]
+----
+{
+ "id": "subscription_flow",
+ "dataInputSchema": "subscription-schema.json",
+ "specVersion": "0.8",
+ "version": "1.0",
+ "start": "VerifyEmail",
+ "events": [
+ {
+ "kind": "produced",
+ "type": "new.subscription",
+ "name": "NewSubscriptionEvent"
+ },
+ {
+ "kind": "consumed",
+ "type": "confirm.subscription",
+ "name": "ConfirmSubscriptionEvent"
+ }
+ ],
+ "functions": [
+ {
+ "name": "subscribeToNewsletter",
+ "operation": "specs/subscription-service.yaml#subscribe"
+ },
+ {
+ "name": "confirmSubscription",
+ "operation": "specs/subscription-service.yaml#confirm"
+ },
+ {
+ "name": "deleteSubscription",
+ "operation": "specs/subscription-service.yaml#delete"
+ },
+ {
+ "name": "verifyEmail",
+ "operation": "specs/subscription-service.yaml#verify"
+ }
+ ],
+ "states": [
+ {
+ "name": "VerifyEmail",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "verifyEmail",
+ "arguments": {
+ "email": "${ .email }"
+ }
+ }
+ }
+ ],
+ "transition": {
+ "nextState": "ExitIfEmailExists"
+ }
+ },
+ {
+ "name": "ExitIfEmailExists",
+ "type": "switch",
+ "dataConditions": [
+ {
+ "condition": "${ .emailExists == true }",
+ "transition": {
+ "nextState": "NoSubscription"
+ }
+ },
+ {
+ "condition": "${ .emailExists == false }",
+ "transition": {
+ "nextState": "SubscribeAndWaitForConfirmation"
+ }
+ }
+ ]
+ },
+ {
+ "name": "SubscribeAndWaitForConfirmation",
+ "type": "callback",
+ "action": {
+ "functionRef": {
+ "refName": "subscribeToNewsletter",
+ "arguments": {
+ "email": "${ .email }",
+ "id": "$WORKFLOW.instanceId",
+ "name": "${ .name }"
+ }
+ }
+ },
+ "eventRef": "ConfirmSubscriptionEvent",
+ "transition": {
+ "nextState": "CheckConfirmation"
+ },
+ "timeouts": {
+ "eventTimeout": "PT3M"
+ }
+ },
+ {
+ "name" : "CheckConfirmation",
+ "type" : "switch",
+ "dataConditions": [
+ {
+ "condition": "${ .confirmed == true }",
+ "transition": "ConfirmSubscription"
+ }
+ ],
+ "defaultCondition": {
+ "transition": "DeleteSubscription"
+ }
+ },
+ {
+ "name": "ConfirmSubscription",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "confirmSubscription",
+ "arguments": {
+ "email": "${ .email }",
+ "id": "$WORKFLOW.instanceId",
+ "name": "${ .name }"
+ }
+ }
+ }
+ ],
+ "end": {
+ "produceEvents": [
+ {
+ "eventRef": "NewSubscriptionEvent"
+ }
+ ],
+ "terminate": true
+ }
+ },
+ {
+ "name": "DeleteSubscription",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "deleteSubscription",
+ "arguments": {
+ "id": "$WORKFLOW.instanceId"
+ }
+ }
+ }
+ ],
+ "end": true
+ },
+ {
+ "name": "NoSubscription",
+ "type": "inject",
+ "data": {
+ "subscribed": true
+ },
+ "end": true
+ }
+ ]
+}
+----
+
+The newsletter-subscription example involves two services:
+
+* Newsletter subscription application. It allows to create new subscriptions
and runs the workflow.
+* Newsletter subscription Backend. It allows to see the pending and the
approved subscriptions
Review Comment:
```suggestion
* Newsletter subscription Backend. It allows you to see the pending and
approved subscriptions
```
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/newsletter-subscription-example.adoc:
##########
@@ -0,0 +1,264 @@
+= Newsletter Subscription example in {product_name}
+
+:compat-mode!:
+// Metadata:
+:description: Newsletter subscription example in Serverless Workflow
+:keywords: kogito, workflow, serverless
+:flow_newsletter_subscription_url:
{kogito_sw_examples_url}/serverless-workflow-newsletter-subscription
+
+This example demonstrates a few features powered by the {product_name}
following the Serverless Workflow specification including:
+
+* REST Services calls via OpenAPI definitions
+* Pause and resume of a given workflow instance
+* Consuming and producing CloudEvents
+
+In a Knative environment, the services involved in this use case can be scaled
to zero and resume from the exact stage it was, saving cluster resources in the
process.
+
+The figure below illustrates the overall architecture of this use case.
+
+image::use-cases/newsletter-subscription/architecture.png[Architecture]
+
+. Once a new subscription request comes, the flow will evaluate if it's not
already subscribed.
+. If not, it will attempt to subscribe the new user and wait for the
confirmation.
+. Once a new event containing the confirmation arrives, the flow will resume
and subscribe the new user.
+. Subscriptions that are not confirmed during a configured period of time, are
considered timed-out and are automatically removed from the system.
+. By the end, a new event containing the details of the subscription is
broadcasted in the environment, so other actors can react upon it.
+
+Here we have the Newsletter Subscription workflow:
+
+.newsletter-subscription-flow workflow
+image::use-cases/newsletter-subscription/newsletter-subscription-flow.png[Workflow]
+
+.Newsletter subscription flow workflow definition
+[source,json]
+----
+{
+ "id": "subscription_flow",
+ "dataInputSchema": "subscription-schema.json",
+ "specVersion": "0.8",
+ "version": "1.0",
+ "start": "VerifyEmail",
+ "events": [
+ {
+ "kind": "produced",
+ "type": "new.subscription",
+ "name": "NewSubscriptionEvent"
+ },
+ {
+ "kind": "consumed",
+ "type": "confirm.subscription",
+ "name": "ConfirmSubscriptionEvent"
+ }
+ ],
+ "functions": [
+ {
+ "name": "subscribeToNewsletter",
+ "operation": "specs/subscription-service.yaml#subscribe"
+ },
+ {
+ "name": "confirmSubscription",
+ "operation": "specs/subscription-service.yaml#confirm"
+ },
+ {
+ "name": "deleteSubscription",
+ "operation": "specs/subscription-service.yaml#delete"
+ },
+ {
+ "name": "verifyEmail",
+ "operation": "specs/subscription-service.yaml#verify"
+ }
+ ],
+ "states": [
+ {
+ "name": "VerifyEmail",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "verifyEmail",
+ "arguments": {
+ "email": "${ .email }"
+ }
+ }
+ }
+ ],
+ "transition": {
+ "nextState": "ExitIfEmailExists"
+ }
+ },
+ {
+ "name": "ExitIfEmailExists",
+ "type": "switch",
+ "dataConditions": [
+ {
+ "condition": "${ .emailExists == true }",
+ "transition": {
+ "nextState": "NoSubscription"
+ }
+ },
+ {
+ "condition": "${ .emailExists == false }",
+ "transition": {
+ "nextState": "SubscribeAndWaitForConfirmation"
+ }
+ }
+ ]
+ },
+ {
+ "name": "SubscribeAndWaitForConfirmation",
+ "type": "callback",
+ "action": {
+ "functionRef": {
+ "refName": "subscribeToNewsletter",
+ "arguments": {
+ "email": "${ .email }",
+ "id": "$WORKFLOW.instanceId",
+ "name": "${ .name }"
+ }
+ }
+ },
+ "eventRef": "ConfirmSubscriptionEvent",
+ "transition": {
+ "nextState": "CheckConfirmation"
+ },
+ "timeouts": {
+ "eventTimeout": "PT3M"
+ }
+ },
+ {
+ "name" : "CheckConfirmation",
+ "type" : "switch",
+ "dataConditions": [
+ {
+ "condition": "${ .confirmed == true }",
+ "transition": "ConfirmSubscription"
+ }
+ ],
+ "defaultCondition": {
+ "transition": "DeleteSubscription"
+ }
+ },
+ {
+ "name": "ConfirmSubscription",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "confirmSubscription",
+ "arguments": {
+ "email": "${ .email }",
+ "id": "$WORKFLOW.instanceId",
+ "name": "${ .name }"
+ }
+ }
+ }
+ ],
+ "end": {
+ "produceEvents": [
+ {
+ "eventRef": "NewSubscriptionEvent"
+ }
+ ],
+ "terminate": true
+ }
+ },
+ {
+ "name": "DeleteSubscription",
+ "type": "operation",
+ "actions": [
+ {
+ "functionRef": {
+ "refName": "deleteSubscription",
+ "arguments": {
+ "id": "$WORKFLOW.instanceId"
+ }
+ }
+ }
+ ],
+ "end": true
+ },
+ {
+ "name": "NoSubscription",
+ "type": "inject",
+ "data": {
+ "subscribed": true
+ },
+ "end": true
+ }
+ ]
+}
+----
+
+The newsletter-subscription example involves two services:
+
+* Newsletter subscription application. It allows to create new subscriptions
and runs the workflow.
+* Newsletter subscription Backend. It allows to see the pending and the
approved subscriptions
+
+Both services provide specific user interface to allow to track what's going
on with the subscriptions
Review Comment:
```suggestion
Both services provide specific user interfaces to allow to track what's
going on with the subscriptions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
