Skip to content

Latest commit

 

History

History
92 lines (73 loc) · 2.41 KB

README.md

File metadata and controls

92 lines (73 loc) · 2.41 KB
Raw

Javascript QuickStart Example

This repository contains sample applications that demonstrates the various features of Conductor Javascript SDK.

SDK Features

JS SDK for Conductor allows you to:

  1. Create workflow using Code
  2. Execute workflows
  3. Create workers for task execution and framework (TaskRunner) for executing workers and communicating with the server.
  4. Support for all the APIs such as
    1. Managing tasks (poll, update etc.),
    2. Managing workflows (start, pause, resume, terminate, get status, search etc.)
    3. Create and update workflow and task metadata
    4. User and event management

Running Example

Note Obtain KEY and SECRET from the playground or your Conductor server. Quick tutorial for playground

Export variables

export KEY=
export SECRET=
export CONDUCTOR_SERVER_URL=https://play.orkes.io/api

Run the main program

npm install
node src/main.js

Workflow

We create a simple 2-step workflow that fetches the user details and sends an email.

VisualCode
const getUserDetailsTask = simpleTask(GET_USER_INFO, GET_USER_INFO, {
userId: "${workflow.input.userId}",
});
const emailOrSmsTask = switchTask("emailorsms", "${workflow.input.notificationPref}", {
email: [
simpleTask(SEND_EMAIL, SEND_EMAIL, {
email: "${get_user_info.output.email}",
})
],
sms: [
simpleTask(SEND_SMS, SEND_SMS, {
phoneNumber: "${get_user_info.output.phoneNumber}",
})
],
});
const wf = workflow(COMPLEX_WORKFLOW_NAME, [
getUserDetailsTask,
emailOrSmsTask,
]);
wf.inputParameters = ['userId', 'notificationPref']

Worker

Workers are implemented as simple functions with sample implementation.
See workers.js for details.

Executing Workflows

There are two ways to execute a workflow:

  1. Synchronously - useful for short duration workflows that completes within a few second.
  2. Asynchronously - workflows that runs for longer period

Synchronous Workflow Execution

WorkflowExecutor#executeWorkflow(...)

Asynchronous Workflow Execution

WorkflowExecutor#startWorkflow(...)

See main.js for complete code sample of workflow execution.