Rhythm 2.0 Specifications

Appearance

CAP-PFM-INT-002Explore the integrations available to a workspace

Markdown

CAP-PFM-INT-002

Explore the integrations available to a workspace

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
Journeys
JNY-PFM-INT-001
Depends on
CAP-PFM-INT-001
Related
CAP-PFM-INT-003
Proved by
ATS-PFM-INT-002

Implementation

Executable suites
TST-PFM-INT-015, TST-PFM-INT-107, TST-PFM-INT-344, TST-PFM-INT-345, TST-PFM-INT-390, TST-PFM-INT-391, TST-PFM-INT-437, TST-PFM-INT-454, TST-PFM-INT-455, TST-PFM-INT-489, TST-PFM-INT-490, TST-PFM-INT-515, TST-PFM-INT-552

KindCapabilityProduct areaPlatformModuleIntegration access, customer extensions and shared workflow configurationRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Explore the integrations available to a workspace ​

Purpose ​

Staff compare the integrations available to their workspace before deciding which one to adopt.

How It Works ​

An administrator enters the Library through Configuration and opens the catalogue. Categories and capability choices help staff find an appropriate provider. Provider detail gives the information needed to review an installation rather than assume every listed service meets the need. Readers can inspect the same offer without being able to adopt it. A hidden provider looks absent to someone outside its audience. Existing installations remain accessible when the offer later changes. The product should make availability understandable without suggesting that a catalogue search removes an existing connection.

Relationships ​

  • Requires publish integration releases for eligible customers to supply the prerequisite configuration or operation.
  • Connects with adopt an integration with reviewed access 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 workspace finds precisely the integrations offered to it.Provider details explain supported jobs, requested access and available releases.
Surfaces
consoleapi
Intent sources
services-platform:docs/milestones/INTG-M1-find-install-connect.md#D3services-platform:docs/milestones/INTG-M1-find-install-connect.md#D4services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S01services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S02services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#A1

Controls

31 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AVL-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-CRY-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-IAM-003 TC-LOG-001 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-005 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.readapitenant
platform.integrations.readconsoletenant

Business Rules

7 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
The workspace catalogue includes active integrations with a published current release only where public availability, a restricted grant or Rhythm staff access permits them.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.md#D3
proved by ATS-PFM-INT-001-14, ATS-PFM-INT-002-01, TST-PFM-INT-344, TST-PFM-INT-515
policyservicetest
services-platform:modules/integrations/tests/integration/services/catalog/catalog.integration.spec.js#shows a restricted integration only to the tenant granted it
02must prove
Proposed
An integration hidden from the workspace is absent from its catalogue and returns not found at its direct address.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S02
proved by ATS-PFM-INT-002-02, TST-PFM-INT-345, TST-PFM-INT-437, TST-PFM-INT-515
policyapi, servicetest
services-platform:modules/integrations/tests/integration/services/catalog/catalog.integration.spec.js#answers no detail for an integration the tenant may not see
03must prove
Proposed
Provider detail presents the current release, capability contracts and feature meanings, requested access, and published or deprecated releases with their notes.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#INTG-M1-S01
proved by ATS-PFM-INT-002-03, TST-PFM-INT-015, TST-PFM-INT-107, TST-PFM-INT-515
policyapi, consoletest
services-platform:modules/integrations/tests/integration/services/catalog/catalog.integration.spec.js#answers the contracts the version implements, with their schemas and feature meanings
04
Proposed
Catalogue results support category and current-capability filters and paginate in integration-key order.
policyapi, servicetest
services-platform:modules/integrations/tests/integration/services/catalog/catalog.integration.spec.js#filters by a capability the current version implements
05must prove
Proposed
An availability reduction hides the catalogue offer while preserving reads of the workspace’s existing installation and connections.
proved by ATS-PFM-INT-002-04, ATS-PFM-INT-002-06, TST-PFM-INT-490, TST-PFM-INT-552
policyservicetest
services-platform:modules/integrations/tests/integration/services/installations/narrowed-availability.integration.spec.js#stays readable to the tenant that holds it: the installation, the connection and their lists answer, and the catalog entry stays hidden
06must prove
Proposed
Integration readers can inspect Library records without secrets or change controls; callers without integration rights see access denied and are refused by protected routes.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.md#D4
proved by ATS-PFM-INT-002-05, TST-PFM-INT-390, TST-PFM-INT-391, TST-PFM-INT-454, TST-PFM-INT-455, TST-PFM-INT-489
permissionapi, consoletest
react-console:lib/integrations/access.test.ts#shows a reader every screen, with no change control and no secret
07
Proposed
The Library is reached through Configuration, earlier integration addresses resolve to it, and unknown Library addresses show the console’s not-found page.
origin: services-platform:docs/milestones/INTG-M1-find-install-connect.plan.md#A1
policyconsoletest
react-console:acceptance/integrations/playwright/journeys/library/INT-ACC-0001.spec.ts#INT-ACC-0001

Scenarios

IdGivenWhenThenProvenance
01The test integration is the only publicly published offer.The administrator searches for Dummy in the catalogue.A single offer opens to the provider’s capabilities and requested access.test
react-console:acceptance/integrations/playwright/journeys/catalog/INT-ACC-0080.spec.ts#INT-ACC-0080
02An integration is offered only to a different customer.The administrator opens its direct address.The catalogue detail returns not found.test
react-console:acceptance/integrations/playwright/journeys/security/INT-ACC-0518.spec.ts#INT-ACC-0518

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