Rhythm 2.0 Specifications

Appearance

CAP-PFM-INT-003Adopt an integration with reviewed access

Markdown

CAP-PFM-INT-003

Adopt an integration with reviewed access

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-INT-01
Exercised by
FAS-PFM-INT-01-01, FAS-PFM-INT-01-02, FAS-PFM-INT-01-03, FAS-PFM-INT-01-04, FAS-PFM-INT-01-05
Key concepts
CON-PFM-INT-001
Actors
ACT-PFM-017, ACT-PFM-018, ACT-PFM-006
Journeys
JNY-PFM-INT-001, JNY-PFM-INT-002
Depends on
CAP-PFM-INT-002
Related
CAP-PFM-INT-004, CAP-PFM-INT-014, CAP-PFM-INT-006
Proved by
ATS-PFM-INT-003

Implementation

Executable suites
TST-PFM-INT-151, TST-PFM-INT-347, TST-PFM-INT-350, TST-PFM-INT-487, TST-PFM-INT-491, TST-PFM-INT-505, TST-PFM-INT-522, TST-PFM-INT-531, TST-PFM-INT-539, TST-PFM-INT-550, TST-PFM-INT-551, TST-PFM-INT-553, TST-PFM-INT-581

KindCapabilityProduct areaPlatformModuleIntegration access, customer extensions and shared workflow configurationRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Adopt an integration with reviewed access ​

Purpose ​

Administrators establish the workspace’s use of an integration with explicitly reviewed access and settings.

How It Works ​

An administrator reviews the provider’s requested access and supplies its installation settings. Rhythm saves a workspace installation for subsequent account connections. Staff can revisit those choices and see when a newer edit makes their open copy stale. Suspension provides a pause for the whole installation. Resume distinguishes that pause from a connection suspended separately. Uninstallation requires the administrator to deal with remaining connections first. The retained record explains the earlier adoption even after use ends. Access restoration within a declaration is implemented, although the recorded narrow-only decision leaves its intended boundary unresolved. The product should settle that boundary before treating the observed edit behaviour as approved.

Relationships ​

  • Requires explore the integrations available to a workspace to supply the prerequisite configuration or operation.
  • Connects with maintain a verified provider account connection through shared integration records.
  • Connects with deliver subscribed rhythm changes to integrations through shared integration records.
  • Connects with recognize integration problems and trace changes through shared integration records.

The Formal Contract

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

Outcomes
The saved installation reflects the administrator’s choices within the declared access.Installation suspension blocks use, and removal ends its subscriptions.
Surfaces
consoleapi
Intent sources
services-platform:docs/milestones/INTG-M1-find-install-connect.md#D4services-platform:docs/milestones/INTG-M1-find-install-connect.md#D7services-platform:docs/milestones/INTG-M1-find-install-connect.md#D11services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S03services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S04services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S13services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S17

Controls

35 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-002 TC-IAM-004 TC-IAM-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-SEC-001 TC-SEC-002 TC-SEC-003 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.integrations.manageapitenant
platform.integrations.readapitenant
platform.integrations.manageconsoletenant

Business Rules

12 rules, 12 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
Installation requires an integration offered to the workspace and allows one installation per integration; attempts to install an existing enabled or suspended installation are refused without a second record.
proved by ATS-PFM-INT-002-06, ATS-PFM-INT-003-01, ATS-PFM-INT-003-12, TST-PFM-INT-505, TST-PFM-INT-551
validationservice, databasetest
services-platform:modules/integrations/tests/integration/services/installations/installation-lifecycle.integration.spec.js#refuses an integration installed already, and writes no second
02must prove
Proposed
Accepted capabilities, events, data fields and Rhythm permissions must fit the current integration declaration at installation and on edit; previously withdrawn declared access can be accepted again.
proved by ATS-PFM-INT-003-02, TST-PFM-INT-347, TST-PFM-INT-550, TST-PFM-INT-551, TST-PFM-INT-581
validationserviceobserved
services-platform:modules/integrations/services/installations/installation-lifecycle.ts:requireAcceptance
03must prove
Proposed
Installation settings are validated against the provider’s declared form on creation and change, with each problem identified and no invalid value saved.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S04
proved by ATS-PFM-INT-003-03, TST-PFM-INT-350, TST-PFM-INT-551, TST-PFM-INT-581
validationservice, consoletest
services-platform:modules/integrations/tests/integration/services/installations/installation-lifecycle.integration.spec.js#refuses settings the manifest’s schema refuses, and writes nothing
04must prove
Proposed
An installation edit must use the version read; a stale edit leaves the newer settings and acceptance untouched.
proved by ATS-PFM-INT-003-04, ATS-PFM-INT-003-12, TST-PFM-INT-551
validationservicetest
services-platform:modules/integrations/tests/integration/services/installations/installation-lifecycle.integration.spec.js#refuses a stale version and leaves the settings as they were
05must prove
Proposed
Withdrawing a capability blocks the next bound call before provider contact, and credential leases omit permissions the installation no longer accepts.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.md#D4
proved by ATS-PFM-INT-003-05, TST-PFM-INT-531, TST-PFM-INT-539
policyservicetest
services-platform:modules/integrations/tests/integration/services/executions/consent-narrowing.integration.spec.js#INT-ACC-0509 step 4: refuses the refund 409 binding_ineligible
06must prove
Proposed
Suspension requires a reason, pauses active and degraded connections, and resume restores only connections paused by that installation; repeated state changes are refused.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S13
proved by ATS-PFM-INT-003-06, ATS-PFM-INT-003-12, ATS-PFM-INT-003-13, TST-PFM-INT-551
lifecycleservicetest
services-platform:modules/integrations/tests/integration/services/installations/installation-lifecycle.integration.spec.js#suspends the active and degraded connections of the installation when it is suspended
07must prove
Proposed
An enabled or suspended installation can be uninstalled only after all its connections are disconnected; refusal identifies the remaining connections and successful removal preserves the installation record.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.md#D11
proved by ATS-PFM-INT-003-07, ATS-PFM-INT-003-12, TST-PFM-INT-151, TST-PFM-INT-487, TST-PFM-INT-522
lifecycleservicetest
services-platform:modules/integrations/tests/integration/services/connections/disconnect-discard-uninstall.integration.spec.js#is refused while a connection is not disconnected, naming each by id, name and status
08must prove
Proposed
Uninstalling deletes the installation’s subscriptions and prevents new deliveries for them.
proved by ATS-PFM-INT-003-08, ATS-PFM-INT-003-14, ATS-PFM-INT-014-08, ATS-PFM-INT-014-12, TST-PFM-INT-522
policyservicetest
services-platform:modules/integrations/tests/integration/services/connections/disconnect-discard-uninstall.integration.spec.js#removes every subscription of the installation with the uninstallation, and no other installation’s
09must prove
Proposed
Reinstallation reuses the uninstalled record, enables it with the new acceptance and records a reinstallation event.
proved by ATS-PFM-INT-003-12
lifecycleservicetest
services-platform:modules/integrations/tests/integration/services/installations/installation-lifecycle.integration.spec.js#installs again as the same row, enabled with the new acceptance, audited as a reinstallation
10must prove
Proposed
Accepted installation changes enter integration history and the security trail, including whether access widens; refused changes enter neither trail.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.md#D4
proved by ATS-PFM-INT-003-09, ATS-PFM-INT-003-15, TST-PFM-INT-550
invariantservicetest
services-platform:modules/integrations/tests/integration/services/installations/history-and-security-trail.integration.spec.js#writes the narrowing to the history and to the security trail
11must prove
Proposed
Workspace deletion purges that workspace’s integration records and removes protected history last, without touching another workspace’s records.
proved by ATS-PFM-INT-003-10, ATS-PFM-INT-003-16, ATS-PFM-INT-022-07, TST-PFM-INT-553
lifecycleservice, databasetest
services-platform:modules/integrations/tests/integration/services/maintenance/tenant-participant.integration.spec.js#leaves every table of the module empty of the tenant, the ones the application can delete included
12must prove
Proposed
A different workspace’s administrator is refused installation and connection reads and writes, including requests using known record identifiers.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S16
proved by ATS-PFM-INT-003-11, TST-PFM-INT-491, TST-PFM-INT-505
permissionapi, databasetest
services-platform:modules/integrations/tests/e2e/reader-access.e2e.spec.js#is refused every tenant route of this tenant, by id as by list (403)

Scenarios

IdGivenWhenThenProvenance
01A provider requests several payment capabilities.The administrator installs it with a reduced selection, then submits access outside the declaration.The reduced selection is retained and undeclared access is refused.test
react-console:acceptance/integrations/playwright/journeys/library/INT-ACC-0006.spec.ts#INT-ACC-0006
02Staff want to stop trusting an installed provider.They suspend it, disconnect its accounts and uninstall from suspended.Use pauses and removal succeeds after the connection prerequisites are satisfied.test
services-platform:modules/integrations/tests/e2e/disconnect-and-uninstall.e2e.spec.js#answers the uninstallation of a suspended installation 200 once every connection is disconnected

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.

Rhythm Software