The external system importer plugin module allows plugins to create importers for proprietary issue tracking systems, say, or to import issues from any type of system in some custom way.

Configuration

The root element for the external system importer plugin module is external-system-importer. It allows the following attributes for configuration:

Name	Description
name	The human-readable name of the plugin module.
i18n-name-key	The optional i18n key for the module name.
key	The unique identifier of the plugin module.
i18n-description-key	The i18n description string for this importer.
i18n-supported-versions-key	The optional i18n message to indicate the versions of Jira that this importer supports.
logo-module-key	The name of the web resource containing the graphics that you want to use for this importer. This value is made up of the fully qualified plugin key for this plugin (the group ID and artifact ID you entered when creating the project), plus the name attribute from the web resource module.
logo-file	The name of the logo file in the web resource element defined by `logo-module-key`.
class	The fully qualified importer class name.
weight	A numeric value that determines the position of this importer in the list of external importers, with lower numbered importers appearing earlier in the list. Built-in importers have weight values of 1 to 50. Feel free to experiment with the placement of the importer on the page by modifying this number. For example, making it 0 puts it second in the list, since there's already an importer with a weight of 0.

You can add multiple importers as long as they have distinct keys.

Configuration example

To register an importer, place the following code sample in atlassian-plugin.xml:

1
2
<external-system-importer
    name="SimpleCSVImporter"
    key="SimpleCSVImporterKey"
    i18n-description-key="com.example.plugins.tutorial.jira.csvimport.description"
    i18n-supported-versions-key="com.example.plugins.tutorial.jira.csvimport.versions"
    logo-module-key="com.example.plugins.tutorial.jira.csvimport.simple-csv-importer:graphics"
    logo-file="simplecsv.png"
    class="com.example.plugins.tutorial.jira.csvimport.SimpleCsvImporterController"
    weight="20" />

This configuration example is coming from Writing a custom importer using the Jira importers add-on. Refer to the tutorial for a complete example.