Application samples library

• Polyglot application: Showcases how Workflow Executions, written in different languages, can send messages to each other. Go, Java, PHP, and TypeScript SDKs are represented in this sample. It also shows how to properly propagate errors, including how to do so across Workflows written in different languages.

Go

• Hello world application template in Go: Provides a quick-start development app for users. This sample works in conjunction with the "Hello World!" from scratch tutorial in Go.

• Money transfer application template in Go: Provides a quick-start development app for users. It demonstrates a basic "money transfer" Workflow Definition and works in conjunction with the Run your first app tutorial in Go.

• Subscription-style Workflow Definition in Go: Demonstrates some of the patterns that could be implemented for a subscription-style business process.

• eCommerce application example in Go: Showcases a per-user shopping cart–style Workflow Definition that includes an API for adding and removing items from the cart as well as a web UI. This application sample works in conjunction with the eCommerce in Go tutorial.

• Go Samples repo

Java

• Hello world application template in Java: Provides a quick-start development app for users. Works in conjunction with the "Hello World!" from scratch tutorial in Java.

• Money transfer application template in Java: Provides a quick-start development app for users. It demonstrates a basic "money transfer" Workflow Definition and works in conjunction with the Run your first app tutorial in Java.

• Subscription-style Workflow Definition in Java: Demonstrates some of the patterns that could be implemented for a subscription-style business process.

Hello samples

• Hello: This sample includes a number of individual Workflows that can be executed independently. Each one demonstrates something specific.
  • HelloActivity: Demonstrates a Workflow Definition that executes a single Activity.
  • HelloActivityRetry: Demonstrates how to Retry an Activity Execution.
  • HelloActivityExclusiveChoice: Demonstrates how to execute Activities based on dynamic input.
  • HelloAsync: Demonstrates how to execute Activities asynchronously and wait for them using Promises.
  • HelloParallelActivity: Demonstrates how to execute multiple Activities in parallel, asynchronously, and wait for them using Promise.allOf.
  • HelloAsyncActivityCompletion: Demonstrates how to complete an Activity Execution asynchronously.
  • HelloAsyncLambda: Demonstrates how to execute part of a Workflow asynchronously in a separate task (thread).
  • HelloCancellationScope: Demonstrates how to explicitly cancel parts of a Workflow Execution.
  • HelloDetachedCancellationScope: Demonstrates how to execute cleanup code after a Workflow Execution has been explicitly cancelled.
  • HelloChild: Demonstrates how to execute a simple Child Workflow.
  • HelloCron: Demonstrates how to execute a Workflow according to a cron schedule.
  • HelloDynamic: Demonstrates how to use DynamicWorkflow and DynamicActivity interfaces.
  • HelloPeriodic: Demonstrates the use of the Continue-As-New feature.
  • HelloException: Demonstrates how to handle exception propagation and wrapping.
  • HelloLocalActivity: Demonstrates the use of a Local Activity.
  • HelloPolymorphicActivity: Demonstrates Activity Definitions that extend a common interface.
  • HelloQuery: Demonstrates how to Query the state of a Workflow Execution.
  • HelloSignal: Demonstrates how to send and handle a Signal.
  • HelloSaga: Demonstrates how to use the SAGA feature.
  • HelloSearchAttributes: Demonstrates how to add custom Search Attributes to Workflow Executions.
  • HelloSideEffect**: Demonstrates how to implement a Side Effect.

Scenario-based samples

• File Processing Sample: Demonstrates how to route tasks to specific Workers. This sample has a set of Activities that download a file, processes it, and uploads the result to a destination. Any Worker can execute the first Activity. However, the second and third Activities must be executed on the same host as the first one.

• Booking SAGA: Demonstrates Temporals take on the Camunda BPMN "trip booking" example.

• Money Transfer: Demonstrates the use of a dedicated Activity Worker.

• Money Batch: Demonstrates a situation where a single deposit should be initiated for multiple withdrawals. For example, a seller might want to be paid once per fixed number of transactions. This sample can be easily extended to perform a payment based on more complex criteria, such as at a specific time or an accumulated amount. The sample also demonstrates how to Signal the Workflow when it executes (Signal with start). If the Workflow is already executing, it just receives the Signal. If it is not executing, then the Workflow executes first, and then the Signal is delivered to it. Signal with start is a "lazy" way to execute Workflows when Signaling them.

• Customer Application Approval DSL: Demonstrates execution of a customer application approval workflow defined in a DSL (like JSON or YAML)

• Polling Services: Recommended implementation of an activity that needs to periodically poll an external resource waiting its successful completion

API demonstrations

• Updatable Timer: Demonstrates the use of a helper class which relies on Workflow.await to implement a blocking sleep that can be updated at any moment.

• Workflow Interceptor: Demonstrates how to create and register a simple Workflow Interceptor.

• List Workflows: Demonstrates the use of custom search attributes and ListWorkflowExecutionsRequest with custom queries.

• Payload Converter - CloudEvents: Demonstrates the use of a custom payload converter for CloudEvents.

• Payload Converter - Crypto: Demonstrates the use of a custom payload converter using jackson-json-crypto.

• Async Child Workflow: Demonstrates how to invoke a child workflow async, that can complete after parent workflow is already completed.

• Terminate Workflow: Demonstrates how to terminate a workflow using client API.

• Get Workflow Results Async: Demonstrates how to start and get workflow results in async manner.

• Per Activity Type Options: Demonstrates how to set per Activity type options.

SDK Metrics

• Set up SDK metrics: Demonstrates how to set up and scrape SDK metrics.

Tracing Support

• Set up OpenTracing and/or OpenTelemetry with Jaeger: Demonstrates how to set up OpenTracing and/or OpenTelemetry and view traces using Jaeger.

PHP

• Subscription-style Workflow Definition in PHP: Demonstrates some of the patterns that could be implemented for a subscription-style business process.

Beginner samples

The following samples demonstrate much of the basic functionality and capabilities of the SDK.

• SimpleActivity: Single Activity Workflow

• ActivityRetry: How to retry an Activity

• AsyncActivity: How to call Activities asynchronously and wait for them using Promises

• AsyncActivityCompletion: An asynchronous Activity implementation

• AsyncClosure: How to run part of a Workflow asynchronously as a separate Task (coroutine)

• CancellationScope: How to explicitly cancel parts of a Workflow

• Child: Example of a child Workflow

• Cron: A Workflow that is executed according to a cron schedule

• Periodic: A Workflow that executes some logic periodically

• Exception: Example of exception propagation and wrapping

• PolymorphicActivity: Activities that extend a common interface

• Query: Demonstrates how to Query the state of a single Workflow

• Signal: Example of sending and handling a Signal

• Saga: Example of SAGA pattern support

• SearchAttributes: Example of Custom search attributes that can be used to find Workflows using predicates

Advanced samples

The following samples demonstrate some of the more complex aspects associated with running Workflows with the SDK.

• FileProcessing: Demonstrates Task routing features.

• Booking SAGA: Demonstrates Temporal approach to a trip booking SAGA.

• Money Transfer: Basic money transfer example.

• MoneyBatch: Demonstrates a situation when a single deposit should be initiated for multiple withdrawals.

• Updatable Timer: Demonstrates the use of a helper class which relies on Workflow.await to implement a blocking sleep that can be updated at any moment.

• Subscription: Demonstrates a long-running process associated with a user ID. The process charges the user once every 30 days after a one month free trial period.