The following limitations and considerations apply when building Teamwork Graph connectors:
Only Forge apps: Only Forge apps, including Forge apps that use Connect modules, can add Teamwork Graph connectors to their app. Teamwork Graph connectors are not supported for Connect apps.
Jira-only support: Currently, Teamwork Graph connectors and consumption are only available for apps installed into Jira. This will also include apps that are compatible with multiple Atlassian apps (currently in EAP) with a Jira installation. This is a limitation of the current architecture, and we are working on making this more flexible in the future.
Apps that consume data from Teamwork Graph must be Run on Atlassian: Apps that consume data from Teamwork Graph (EAP coming soon) must be built as “Runs on Atlassian” Forge apps. This means all data access and processing occurs within Atlassian’s cloud infrastructure, and data cannot be sent or stored outside of Atlassian. This restriction is in place to help ensure data security and privacy for the information consumed from Teamwork Graph.
Support for ingestion or consumption: An app can either provide a Teamwork Graph connector or consume data from Teamwork Graph, but not both at the same time. As noted above, apps that consume data from Teamwork Graph must be Runs on Atlassian, while apps that ingest data into Teamwork Graph via a connector are ineligible for Runs on Atlassian status due to their connections outside of the Atlassian platform.
An existing Forge app, including Forge apps that still use Connect modules, can implement the
graph:connector module and start ingesting data into Teamwork Graph. However, if your existing app
has previously ingested DevOps entities into Jira Software, there are some additional considerations.
This applies to any apps that use any of the following modules:
| jiraConnect modules | Forge modules |
|---|---|
jiraDevelopmentTool | devops:developmentInfoProvider |
jiraBuildInfoProvider | devops:buildInfoProvider |
jiraDeploymentInfoProvider | devops:deploymentInfoProvider |
jiraFeatureFlagInfoProvider | devops:featureFlagInfoProvider |
jiraRemoteLinkInfoProvider | devops:remoteLinkInfoProvider |
jiraSecurityInfoProvider | devops:securityInfoProvider |
Configuring a Teamwork Graph connector requires a different admin experience. While admins may have connected your app for your existing DevOps use-cases, they will need to reconnect it through Atlassian Administration to enable the full Teamwork Graph connector experience.
DevOps data sent through Jira Software and Teamwork Graph are scoped separately. For example, if a
Deployment is sent and associated to a Jira work item via both APIs, then the Jira work item will
surface two deployments.
Functionality supported in the DevOps APIs are compatible with Teamwork Graph’s APIs. Therefore, we recommend you start sending data through Teamwork Graph instead.
Old data should not be re-ingested through Teamwork Graph as this will duplicate data in Jira Software experiences. If your app supports resyncing data, then the customer can disconnect and reconnect the app so that all new data flows through Teamwork Graph. Added
Rate this page: