Skip to content

CAP-PFM-INT-021Reuse validated action and workflow recipes

Markdown

CAP-PFM-INT-021

Reuse validated action and workflow recipes

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

KindCapabilityProduct areaPlatformModuleIntegration access, customer extensions and shared workflow configurationRevision1

Read atservices-platform ad3f6a65macroservice-libraries 54536a44

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Saved recipes contain actions that pass configuration validation.
Surfaces
api
Intent sources
services-platform:docs/proposals/application-processes-and-workflow-actions/14-decisions.md#D-03services-platform:docs/proposals/application-processes-and-workflow-actions/14-decisions.md#D-08

Controls

24 controls apply, from the corpus control catalogue.

TC-AVL-004 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-IAM-001 TC-IAM-006 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.workflow-actions.registry-readapitenant
platform.workflow-actions.templates-manageapitenant

Business Rules

5 rules, 5 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Lists place Rhythm’s eight shipped action recipes and six workflow recipes first, identify them as shipped and refuse customer edits or deletion.
policyapi, servicetest
02must prove
Proposed
Recipe saves validate every action against active enabled registry types, host and trigger restrictions, current contract version, settings schema and configurator permissions, with workflow stages also checked against their contract.
validationservicetest
03must prove
Proposed
Customer recipe identifiers are unique within the workspace, cannot use Rhythm’s reserved prefix and require the read version on replacement.
validationservicetest
services-platform:modules/workflow-actions/tests/integration/services/persistence/action-templates.integration.spec.js#refuses an id in Rhythm’s own prefix, which the configuration-id grammar reserves (400)
04must prove
Proposed
A recipe is copied into its using definition, so later template edits do not change that definition.
policyservicedocumented
services-platform:docs/workflow-actions/README.md#Workflow actions: Platform's part of the Workflow Action Engine
05must prove
Proposed
Registry read permits recipe reads and templates manage permits creating, replacing or deleting workspace recipes.
permissionapiobserved

Scenarios

IdGivenWhenThenProvenance
01A workspace adopts a valid action recipe into a definition.An administrator changes the reusable recipe.The definition keeps its copied settings.documented
services-platform:docs/workflow-actions/README.md#Workflow actions: Platform's part of the Workflow Action Engine

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.