Dashboard
Dashboard layout​
The main PactFlow screen has four functional areas.
1 - The list of all integrations is displayed on the left panel. Integration here is the pair of a consumer and provider that have a pact. Select an integration to have its details displayed in the center panel. The status icon (see table below) will be displayed for the verification result of latest pact.
2 - The details of the selected integration will be displayed here.
3 - You can filter the list of integrations here by either the Consumer or Provider name.
4 - If you have been assigned to a team, you can select them here. This will filter the list of integrations by the applications that belong to the team.
5 - The tabs at the top provide different views of the currently selected integration.
The Network Diagram will display a graph view of all the integrations that are reachable from the selected one.
The Matrix will display more details of all the pacts and verifications of the selected integration.
The Webhooks will display a list of triggered webhooks for the integration and logs.
6 - The settings (or cog) button will take you to all the setting screens. Here you'll be able to setup API tokens, webhooks, users and more.
7 - Displays the current logged in user and subscription status.
Status | Description |
---|---|
The pact has a successful verification published for it. | |
The latest verification for the pact had failed. | |
No verification result has been published for the pact. | |
A new version of the pact has been published since the last verification result was received. |
Version tag menus​
The blue and grey "pill" icons shown next to the consumer and provider version numbers on the Overview, Matrix and Pact pages represent tags that belong to the relevant application versions in PactFlow.
A blue pill indicates that this is the latest version that has a tag with that name. For example, the latest consumer version with a "main" tag.
![Latest version tag menu](/ui/tag-main-latest.png)
A grey pill indicates that there's a later application version that has the same tag.
![Not latest version tag menu](/ui/tag-main-not-latest.png)
Clicking on the tag pill icon will allow you to perform actions in the context of that application version tag.
Consumer version tags​
The consumer version tag has the following menu items.
Menu items​
Resources​
- Copy pact URL - Copies the URL of the latest pact with the given tag into the clipboard.
- Copy stub URL - Copies the URL of the stub created from the latest pact for the given tag.
- Copy badge URL - Copies the URL of the verification status badge for the latest pact for the given tag into the clipboard.
- Copy tag URL - Copies the URL of the application version tag into the clipboard.
- Copy tag name - Copies the name of the tag into the clipboard.
Delete​
- Delete all pacts with the given tag - Allows you to delete all pacts that belong to application versions with the given tag. This is only visible if the current user has the contract_data:bulk_delete permission.
Provider version tags​
Clicking on a tag pill for a provider version tag will make the following menu available.
Menu Items​
Resources​
- Copy tag URL - selecting this menu item will copy the URL of the application version tag into the clipboard.
- Copy tag name - selecting this menu item will copy the name of the tag into the clipboard.
Matrix​
The "Matrix" displays a table that shows the verification status of each combination of consumer and provider version from the selected integration.
Matrix Filters​
Filter the consumer versions and provider versions of the selected integration by version number, branch, environment or tag.
Note: The environment filter option will only be shown to users with the environment read or manage permission.