High-Level overview.
StorYd Admins can create a connection to a Jira Server/DC instance. Once the StorYd Integration Plugin is installed on Jira, the connection can be initiated from the StorYd Application admin page. A Jira admin will then need to enable the connections from the Integration admin page, in Jira. Once enabled Users in the StorYd Application can define field mappings. This will map StorYd Epic fields to Jira fields. These mappings will be used to export StorYd Epic data into a Jira issue. Once a StorYd Epic is exported into Jira, It will create a link between the StorYd Epic and Jira issue.
Setting up a connection
Install the StorYd Integration Plugin. This can be found on the Atlassian Marketplace. Once the plugin is installed, navigate to the Managed Apps → Global Configuration (STORYD INTEGRATION).
In the Integration Configuration tab, enable the “Enable connection requests“. This setting allows integration connections to be initiated. This should be enabled while the connection to StorYd is being initialized but should be disabled once the connection has been initialized. This will prevent unwanted connection requests from StorYd servers.
Once this has been enabled navigate to the “Integration“ tab on the StorYd Application admin page. Click the plus icon to add a new integration.
In the popup select “Jira Server/Data-Center“ for the integration type, give the integration a relevant name (this can be changed later), enter the Jira base URL of your Jira instance (e.g. https://www.jira.examplecompany.com), and then click “ADD”.
Once added the popup will automatically close and you will see the integration that was created.
By default, the connection will be disabled in Jira after the connection is initiated. Navigate back to the Integration page in Jira Managed Apps → Global Configuration (STORYD INTEGRATION). Note, You will need to refresh this page if you already have it open. Once on this page, you should see a new Integration. This will display the Region, Company Domain, Company Name, and the enabled status, which by default will be disabled. Click the “Enabled” button to enable the integration.
Once enabled navigate back to the integration tab in the StorYd Application and click “Refresh Status”.
After the status has been refreshed, you should see the status change to “Connection is Active“.
At this point the connection is active and you can now perform integration actions. Since the connection has been initiated we can now disable the “Enable connection requests“ in Jira. Navigate back to the integration tab in Jira and disable this setting. This will prevent further unwanted connections request from being initiated and disabling this once the connection has been established is more secure.
Default User
When integration actions are performed, the Jira Integration Plugin will attempt to match users in Jira with the user who initiated the action (e.g. fetching available projects) based on the email address of users in both applications. If a matching user cannot be found the Plugin will use the “Default user”, this user can be set in the Integration Configuration page in Jira.
If the default user is empty and the Jira plugin cannot find a matching user in Jira, no information will be returned and there will be an error displayed in the StorYd application.
Creating a field mapping
Once the connection has been established admins and users can create field mappings. By default, only admins can create field mapping. Navigate to the integration tab on the StorYd Application admin page. For the integration you want to create a field mapping, select the menu icon, and then select “Field Mapping”.
This will open up a full-screen pop where Field mappings can be created.
Allowing none admin users to create and save mappings
On the admin Field Mapping popup, in the bottom left, there is a setting called “Allow users to create, edit and save mappings“, enabling this will allow all users to create and save field mapping from the Epic export page.
Defining a field mapping.
In the field mapping popup, once users select a Jira project and Issue type. A “Jira Field” field will be displayed, this is all the fields available for the selected project and Issue type. Jira fields selected and added in this field will be used in the mapping.
Some fields can be added multiple times to allow multiple StorYd Epic fields to be exported into a single Jira field e.g. description.
Once a Jira field has been added to the mapping, for each Jira field added users need to select what StorYd Epic field will map into a particular Jira field
