Skip to main content
Version: 2.0.0

How to Use - Functional & Technical Details

Functional Flow (End-to-End Task Lifecycle)

SETUP TIME
1. Configure System Master -> 2. Configure Scheduler
3. Upload YAML Configs -> 4. Verify Connectivity

RUNTIME (Automated)
5. Scheduler Pulls Tasks -> 6. JSON Flattened & Mapped
7. Batch Upserted to DB -> 8. Cache Evicted in ITM

RUNTIME (User)
9. User Sees Tasks in ITM -> 10. Claims/Reviews Task
11. Takes Action -> 12. Action Sent to Source System
13. Audit Recorded -> 14. Cache Evicted

MONITORING
15. Check Job Logs -> 16. Review Audit Trail -> 17. Debug Issues

Technical Usage - API Call Sequence

Setup a New Source System Connection

1. POST /system-schedule/config
2. POST /v1/yaml/upload
3. POST /v1/yaml/upload
4. POST /worknet/composite-api/parser/runJob
5. GET /system-schedule/lastRunOn

Process Tasks

1. (Automated) Scheduler pulls tasks -> Tasks appear in ITM
2. POST /task/actions
3. (Automated) Cache eviction -> ITM refreshes
4. (Automated) Notification

DocuSign Signing

1. POST /worknet/composite-api/parser/signUrl -> Get signing URL
2. User redirected to DocuSign -> Signs document
3. (Automated) Task status updated -> Task marked completed

Integration Points

IntegrationDirectionWhenAPI/Method
ITM (Task Center)OutboundAfter action/syncPOST /cacheEvict/evictForUserList
FlowableOutboundTask actionsFlowable custom API (complete/claim/release)
SAP BTP/SCPOutboundTask actionsScpActionUtil.actionOnTask()
SAP S4/ECCOutboundTask actionsComposite API (action config YAML)
SAP AribaOutboundTask syncAribaBlockingAPIService.triggerAPI()
SAP ConcurOutboundTask syncComposite API (scheduler)
SuccessFactorsOutboundTask syncComposite API (scheduler)
DocuSignOutboundSigning URLComposite API + JWT assertion
SalesforceOutboundTask actionsComposite API + JWT assertion
WorkAccessOutboundAuth + groupsREST API calls
MessagingOutboundNotificationsPOST /v1/notification/*
Config ServerInboundStartupSpring Cloud Config

Connector Configs (UI Module)

WorkNet includes a Connector Configs module in the CherryWork UI that provides a visual interface for managing source system connections, schedulers, and configurations.

Overview

The Connector Configs module is used to:

  • View all source systems connected to WorkNet
  • Manage schedulers running under each system
  • View and edit DB structure configuration (column mappings)
  • Monitor job execution history and status
Connector Configs (Main Page)
|
|- Lists all connected systems
|
|- Click a System (e.g., SCP)
| |
| |- Shows all schedulers under that system
| |
| '- Click on a Scheduler
| |
| |- DB Structure Config (view/edit JSON-to-DB mapping)
| '- Job Run History (start/end/duration/count/status/errors)

What Each Screen Shows

System List (Main Page)

ColumnDescription
System IDUnique identifier (e.g., SCP, Flowable, DocuSign)
System NameDisplay name
StatusActive / Inactive
Number of SchedulersCount of configured schedulers

Scheduler List (Per System)

ColumnDescription
Scheduler IDUnique scheduler identifier
Process NameWorkflow/process being synced
Cron ExpressionSchedule frequency
Last RunTimestamp of last execution
StatusRunning / Completed / Failed

DB Structure Config (Per Scheduler)

DB ColumnJSON PathTable
TASK_IDgetTasks./idCW_ITM_WN_TASKS
STATUSgetTasks./statusCW_ITM_WN_TASKS
OWNER_IDgetTasks./recipientUsersCW_ITM_WN_TASK_OWNERS

Administrators can:

  • View current mapping
  • Edit JSON paths
  • Add/remove column mappings
  • Save changes (updates YAML configuration)

Job Run History (Per Scheduler)

ColumnDescription
Job IDUnique execution ID
Start TimeWhen the job started
End TimeWhen the job completed
DurationTime taken (milliseconds)
Record CountNumber of tasks processed
StatusCompleted / Failed / Running
MessageSuccess message or error details

How Connector Configs Relates to YAML Files

UI ElementUnderlying YAML/Config
System listSystem Master table + dbYaml/dbYamlFile.yaml
Scheduler listSystemSchedularConfigDo table
DB Structure Config view/editdbStructureConfig/{fileName}.yaml
Job run historyCW_ITM_JOB_LOG table
Scheduler cron expressionSystemSchedularConfigDo.cronExpression

Typical Admin Workflow via Connector Configs

1. Open Connector Configs -> see all systems
2. Click SCP -> see schedulers
3. Click scheduler
4. Verify DB Structure Config mapping
5. Edit mapping if needed -> Save
6. Check Job Run History
7. If failed -> inspect error -> fix config -> rerun

How to Use WorkNet

Viewing Your Tasks

  1. Open the CherryWork Task Center (ITM).
  2. You'll see all tasks across all connected systems in one inbox.
  3. Tasks can be filtered by system, status, process type, etc.
  4. Each task shows: title, source system, status, creation date, and priority.

Task Actions

ActionWhat it DoesWhen to Use
ApproveAccepts the task/request and moves the process forwardWhen you agree with the request
RejectDeclines the task/requestWhen you disagree or the request is invalid
ClaimTakes personal ownership of a group taskWhen a task is assigned to your group and you want to work on it
ReleaseReturns a claimed task back to the group poolWhen you can no longer work on a claimed task
ForwardReassigns the task to a different person or groupWhen someone else should handle this task
Send BackReturns the task to the previous step/personWhen additional information or corrections are needed
ResubmitResubmits a task that was sent backWhen you've made the corrections requested
Cancel ProcessStops the entire processWhen the request is no longer needed

Working on a Task (Step by Step)

  1. Find the task in your inbox.
  2. Claim it (if it's assigned to a group) — this prevents others from working on it simultaneously.
  3. Review the details — task attributes, attachments, history.
  4. Take action — click Approve, Reject, or another action button.
  5. Add comments (optional) — explain your decision.
  6. The system automatically:
    • Updates the task status in WorkNet.
    • Sends the action back to the source system (SAP, Flowable, etc.).
    • Notifies relevant users.
    • Routes to the next step (if applicable).