{"ref":"artifact:cap-js-process","page":"/artifacts/cap-js-process","json":"/artifacts/cap-js-process.json","generated":"2026-10-26","drafted_with_ai":true,"entity":{"id":"cap-js-process","name":"@cap-js/process","artifact_type":"cds-plugin","ecosystem":"cap","domain":"integration-and-messaging","origin_ring":"sap-official","description":{"one_line":"Starts, cancels, suspends and resumes SAP Build Process Automation processes from a CAP service through entity annotations, or through a typed CDS service imported from the process definition.","short":"Starts and manages SAP Build Process Automation processes from CAP","what_it_solves":"Annotations on an entity start and change process instances as its data changes: `@bpm.process.start` fires on a CRUD event or a bound action and passes selected entity fields as process context, `@bpm.process.<cancel|resume|suspend>` acts on the instances carrying the entity's business key, and an `if` expression on any of them decides whether the operation runs. A process can also be imported as a typed CDS service with `cds import --from process`, which generates the lifecycle actions with input and output types taken from the process definition and validates the annotated inputs against it during `cds build`. The generic ProcessService that ships with the plugin works without a binding against [SAP Build Process Automation](artifact:btp-build-process-automation); the typed process service does not work locally, and the process import runs from the command line only."},"links":{"repo":"https://github.com/cap-js/process","npm":"https://www.npmjs.com/package/@cap-js/process"},"provenance":{"discovered_via":[{"source":"source:capire"}],"first_seen":"2026-09-27"},"compat":{"runtimes":["node"]},"type_properties":{"distribution":{"value":["npm"],"sources":[{"url":"https://github.com/cap-js/process","title":"@cap-js/process — README","checked":"2026-10-18","quote":"npm add @cap-js/process"}]}},"provides":[{"capability":"capability:workflow-integration","what_it_does":"Starts and manages SAP Build Process Automation processes from a CAP service.","sources":[{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README","checked":"2026-10-17","quote":"CAP Plugin to interact with SAP Build Process Automation to manage processes."}]}],"requires":[{"ref":"artifact:btp-build-process-automation","requirement":"conditional","role":"process-engine","condition":"Working against a real SAP Build Process Automation instance — hybrid mode, production, or a remote process import.","basis":"binding","for":"The processes the plugin starts and manages: a service instance is created and bound with `cds bind ProcessService`, and `cds import --from process --name` resolves those credentials to import a process as a typed CDS service. Without a binding, the annotation and programmatic approaches against the generic ProcessService still work.","sources":[{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Importing Processes as a Service","checked":"2026-10-17","quote":"The plugin allows you to import existing SAP Build Process Automation processes as CDS services. To do so, you first need to bind against an existing SAP Build Process Automation instance."},{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Programmatic Approach","checked":"2026-10-17","quote":"The approaches work only in hybrid mode (against a real SAP Build Process Automation instance), and in production."},{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Quickstart","checked":"2026-10-17","quote":"That's it — the annotation and programmatic approaches against the generic ProcessService work without any bindings against SAP Build Process Automation. No process import is required to get started."}]}],"connects":[{"ref":"artifact:btp-build-process-automation","kind":"data","direction":"outbound","condition":"A real SAP Build Process Automation instance is bound; when the application runs locally the generic ProcessService mimics the workflow with a business key taken from the request header.","for":"Starting process instances with entity fields as their context, cancelling, suspending and resuming instances that carry a business key, and reading instances, attributes and outputs — the generic ProcessService over the SAP Build Process Automation workflow API, the imported service over one process definition.","sources":[{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Binding against SAP Build Process Automation Instance","checked":"2026-10-17","quote":"To connect to a real SAP Build Process Automation instance, login to Cloud Foundry:"},{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Programmatic Approach","checked":"2026-10-17","quote":"The plugin provides two ways to interact with SAP Build Process Automation processes programmatically:"},{"url":"https://github.com/cap-js/process#readme","title":"cap-js/process — README, Generic ProcessService","checked":"2026-10-17","quote":"The generic `ProcessService` allows setting the business key to mimic the behavior of the real SAP Build Process Automation workflow. The business key in the header is only used when the application runs locally, so to avoid issues, the business key should be built the same way as in the actual process."}]}],"maintainers":["actor:cap-js"],"drafted_with_ai":true,"contributors":["actor:deblinasanyal","actor:kronprinz03","actor:kulliax","actor:sirsimon04","actor:tilwbr","actor:two-gee","actor:zeroggorich"]},"effective_normative_relations":[{"instrument":"instrument:sap-developer-license-3-2-cap","relation":"use-constrained-by","sections":["1","2","3"],"applies_when":"A cds-plugin is used with SAP CAP materials, or an artifact is explicitly identified as a CAP plugin or application.","note":"This is inherited applicability, not a licence verdict about the artifact itself. Review the agreement for the actual materials and use; an explicit artifact relationship to another revision takes precedence.","scope":{"kind":"artifact"},"sources":[{"url":"https://cap.cloud.sap/resources/license/developer-license-3_2_CAP.txt","title":"SAP Developer License Agreement 3.2 CAP","checked":"2026-09-16","quote":"documentation, plug-ins, templates, scripts and sample code, libraries, software development kits"}],"inherited_from":"cap-plugins-and-applications","relevant_capabilities":["agent-systems-access","async-processing","data-import-export","database-connectors","deployment","destinations","llm-integration","mcp-servers","plugin-authoring","replication","retrieval-augmented-generation","rfc-connectivity"]}],"readings":{"liveness":[{"label":"Maintenance","tier":"fair","evidence":"6 months since release"},{"label":"Continuity","tier":"good","evidence":"9 contributors, 3 publishers, org-owned"},{"label":"Repository","tier":"good","evidence":"pushed 2026-07, not archived"}],"compatibility":[{"label":"Declared for","tier":"good","evidence":">=9 — includes cds 10 and 9"},{"label":"Survived majors","tier":"poor","evidence":"no release since @sap/cds 10 shipped (July 2026)"},{"label":"Maintainer's CI","tier":"good","evidence":"CI green, 2026-05-12"}],"practice":[{"label":"Tests","tier":"good","evidence":"127 test files, npm test"},{"label":"Docs","tier":"good","evidence":"README 31 KB"},{"label":"Changelog","tier":"good","evidence":"CHANGELOG in the repo"}],"reach":[{"value":65,"unit":"installs/week"},{"value":5,"unit":"watching"}]},"signals":{"crawled_at":"2026-10-26","latest_version":"0.2.1","majors":{"0.0":{"version":"0.0.0","date":"2026-03-27"},"0.1":{"version":"0.1.0","date":"2026-03-27"},"0.2":{"version":"0.2.0","date":"2026-04-02"}},"license":"Apache-2.0","first_release":"2026-03-27","last_release":"2026-04-20","releases":5,"cadence_days":6,"maintainers":3,"repository":"git+https://github.com/cap-js/process.git","peer_cds":">=9","test_script":true,"types":false,"downloads_weekly":65,"stars":5,"forks":1,"open_issues":19,"archived":false,"pushed_at":"2026-07-23","license_spdx":"Apache-2.0","org_owned":true,"default_branch":"main","contributors":9,"tree_truncated":false,"test_files":127,"workflows":6,"other_ci":false,"readme_bytes":31318,"docs_files":0,"changelog":true,"license_file":true,"dts_files":2,"ci_status":"success","ci_run_at":"2026-05-12","ci_workflow":"CI","ci_event":"push","readme_path":"README.md","readme_sha":"0ed362a66b030fbbbdfb6418ac2264c28861178c","months_since_release":6,"dormant":false,"repository_directory":null,"dependencies":3,"node_engine":">=20.0.0","downloads_monthly":428,"created_at":"2026-02-04T15:26:04Z","open_prs":11,"first_commit":"2026-01-27","last_commit":"2026-05-12","commits":120,"repo_read":"2026-10-26"},"release_notes":{"license":"Apache-2.0","quotable":true,"source":{"kind":"repo","path":"CHANGELOG.md","ref":"main","url":"https://github.com/cap-js/process/blob/main/CHANGELOG.md"},"format":"keep-a-changelog","releases":[{"version":"0.2.1","date":"2026-04-20","date_source":"heading","heading":"Version 0.2.1 - 2026-04-20","url":"https://github.com/cap-js/process/blob/main/CHANGELOG.md#version-021---2026-04-20","sections":[{"kind":"fix","heading":"Fixed","items":1}],"hash":"d814a801d3bc286e"},{"version":"0.2.0","date":"2026-04-02","date_source":"heading","heading":"Version 0.2.0 - 2026-04-02","url":"https://github.com/cap-js/process/blob/main/CHANGELOG.md#version-020---2026-04-02","sections":[{"kind":"feature","heading":"Added","items":5}],"hash":"a4436b78d356a2bd"},{"version":"0.1.1","date":"2026-03-27","date_source":"heading","heading":"Version 0.1.1 - 2026-03-27","url":"https://github.com/cap-js/process/blob/main/CHANGELOG.md#version-011---2026-03-27","sections":[{"kind":"fix","heading":"Fixed","items":1}],"hash":"7d217d43c4e124f6"},{"version":"0.1.0","date":"2026-03-27","date_source":"heading","heading":"Version 0.1.0 - 2026-03-27","url":"https://github.com/cap-js/process/blob/main/CHANGELOG.md#version-010---2026-03-27","sections":[{"kind":"feature","heading":"Added","items":1}],"hash":"955492c926db47de"}],"versions":[{"version":"0.2.1","date":"2026-04-20"},{"version":"0.2.0","date":"2026-04-02"},{"version":"0.1.1","date":"2026-03-27"},{"version":"0.1.0","date":"2026-03-27"},{"version":"0.0.0","date":"2026-03-27","deprecated":"This release was a dummy release and should not be used"}],"crawled_at":"2026-10-25"},"edges":{"maintainers":[{"ref":"actor:cap-js","name":"SAP Cloud Application Programming Model","json":"/actors/cap-js.json"}],"contributors":[{"ref":"actor:kulliax","name":"ankul","json":"/actors/kulliax.json"},{"ref":"actor:zeroggorich","name":"David Gogrichiani","json":"/actors/zeroggorich.json"},{"ref":"actor:deblinasanyal","name":"DeblinaSanyal","json":"/actors/deblinasanyal.json"},{"ref":"actor:two-gee","name":"Gerrit","json":"/actors/two-gee.json"},{"ref":"actor:sirsimon04","name":"Simon Engel","json":"/actors/sirsimon04.json"},{"ref":"actor:tilwbr","name":"Til Weber","json":"/actors/tilwbr.json"},{"ref":"actor:kronprinz03","name":"Yannis Moser","json":"/actors/kronprinz03.json"}],"explained_by":[{"ref":"content:trigger-an-sbpa-workflow-from-cap-with-cap-js-process","name":"Trigger an SAP Build Process Automation Workflow from CAP Using the @cap-js/process Plugin","json":"/content/trigger-an-sbpa-workflow-from-cap-with-cap-js-process.json"}],"alternative_to_this":[],"needed_by":[],"available_via":[],"parts":[],"add_ons":[],"answered_through_parts":[]}}