On this page:
|
Who can use this information
...
Follow these instructions if you’re an app vendor, developer, or Jira user integrating a Jira Server or DC app with Configuration Manager for Jira (CMJ) through the Service Provider Interface.
...
On this page:
...
API
...
reference
If you need more technical information on the latest SPI packages and interfaces, follow the link to read the complete API reference.
Integrate your server app with the Server SPI
The SPI for Jira Server/DC is a set of REST interfaces implemented by server apps and invoked by Configuration Manager for Jira/Cloud Migration Tool during migration when app data is found.
...
Initial setup of the Server Service Provider Interface (SPI).
Implement app-specific REST endpoints of the Server SPI.
Step 1: Initial SPI setup
This part aims to guide you through the initial setup of the Service Provider Interface (SPI).
...
Increment the version when you need new features of the SPI. This will ensure compatibility with a large set of Configuration Manager releases, as older releases come with an older version of the SPI. There is no need to compile to a newer version unless you need some new features, as the SPI is backward compatible.
| Warning |
|---|
DynamicImport-Package Usage |
...
Important Make sure that DynamicImport-Package is used instead of Import-Package. Otherwise, the SPI-related packages may not be correctly resolved at runtime. If building with Atlassian SDK 8.0.0+, you also need to add the instruction “!com.botronsoft.cmj.spi.*” to Import-Package. |
Step 2: Implement app-specific SPI endpoints
Next, implement the SPI Endpoints from the list below for the types of configurations your app includes. For example, if your app deals with workflows or modifying workflows in Jira, you will need to implement the Workflows SPI Endpoints.
Server SPI
...
endpoints
Custom
...
fields
Custom fields with specific configuration configurations provided by the app.:
Workflows
Custom conditions, validators, and post-functions , provided by the app.:
Project
...
configuration and
...
data
App configuration attached to a project.
App
...
data
App data which is not attached to a Jira object (project, custom field, workflow, etc.). Use this endpoint when the app data does not fit any of the boundaries of existing Jira objects and extend standard Jira functions.
...
| Tip |
|---|
ScriptRunner example The ScriptRunner app provides functions such as:
This The Jira application development platform does not categorize and guide this type of app functionality is not categorized and guided by the Jira application development platform. Yet, the App Data SPI endpoint provides the tools to move such configuration configurations between different Jira instances. |
Dashboards
Custom dashboard gadgets provided by the app.:
App’s Global Configuration
The global configuration of the app, not specific to any project or other Jira object.:
License
The Configuration Manager SPI is licensed under the Creative Commons license (CC BY 4.0)