Portal Community

Integration Map

Core

Flow Studio

HIL nodes in workflows create tasks in WorkDesk. The HILTaskSyncService watches for new Process_HILTasks records and routes them to the correct actor's inbox. WorkDesk responses resume workflow execution.

Forms

Atlas Forms

FormRenderer from @bizfirstai/player-components-react is embedded in WorkDesk form task cards. The formId comes from the Flow Studio HIL node configuration. initialValues are injected from the workflow's data context.

AI

Octopus

The Octopus ChatWidget can be embedded per-page in WorkDesk. Agents help employees understand and complete HIL tasks. The agent receives task context (type, description, formId) as conversation seed data.

Real-time

EdgeStream

WorkDesk subscribes to notifications.{userId} and tasks.{userId} EdgeStream topics. Push events update the notification bell badge, inbox badge, and task list in real time — no polling.

Apps

App Studio

WorkDesk can host App Studio applications in its main content area. The WorkDeskShell acts as a container — App Studio apps appear as additional navigation items alongside the four core sections.

Auth

Passport

Passport provides SSO for WorkDesk. All API requests carry a Passport-issued JWT. The actorId and tenantId in the token are used for all data scoping in the WorkDesk backend.

Data Flow: HIL Task Lifecycle

1

Flow Studio Workflow Reaches HIL Node

Process Engine suspends the execution and writes a record to Process_HILTasks with actorId, type, formId, and executionId.

2

HILTaskSyncService Routes Task

WorkDesk's HILTaskSyncService detects the new record (via database trigger or message queue), creates a WorkDesk task entry, and publishes an EdgeStream event to tasks.{userId}.

3

Employee Receives Real-Time Notification

WorkDesk's EdgeStream subscription fires. The notification bell badge increments. The inbox task count updates. A notification is added to the panel.

4

Employee Acts on Task

Employee opens the task. For form tasks, Atlas Forms' FormRenderer renders the form inline. Employee fills fields or selects Approve/Reject and submits.

5

Workflow Resumes

WorkDesk POSTs the response to POST /api/executions/{executionId}/resume. Process Engine receives the response, updates the HIL node output, and continues workflow execution from the next node.

Integration Reference

ProductIntegration MechanismDirectionGuide
Flow StudioProcess_HILTasks table + /resume APIBidirectionalGuide7_Integration › 02-flow-studio.html
Atlas FormsFormRenderer React componentWorkDesk consumesGuide7_Integration › 01-atlas-forms.html
OctopusChatWidget embedded per-pageWorkDesk embedsGuide7_Integration › 03-octopus.html
EdgeStreamTopic subscriptions via useSubscriptionWorkDesk subscribesGuide7_Integration › 05-edgestream.html
App StudioWorkDeskShell iFrame / micro-frontendWorkDesk hostsGuide7_Integration › 04-app-studio.html
PassportJWT bearer token — all API requestsWorkDesk consumesGuide7_Integration › 06-passport.html