Note: This support article refers to the historical 1.0 version of the Aha! integration with Jira.
- If you are using the new 2.0 version of our Jira integration or would like to learn more about the new framework, reference this article.
- If you are looking for details about custom field mapping for 2.0, see "Integration field mapping (integrations 2.0)."
Jira component or custom field mapping (One-way)
Aha! enables you to map custom fields from Aha! to Components and other fields in Jira. In both cases, the integration is one-way from Aha! to Jira. This means that changes in Jira will not be reflected back to Aha!
Mapping to Jira components
Since Jira restricts the values that these fields can take, you must ensure all of the following conditions are met:
- Configure the custom field in Aha! to only allow values that are valid for your Jira configuration.
- The field can be named anything but its type must be Predefined tags field.
- The tag values must exactly correspond to the possible Component values that are configured in Jira.
- For each feature or requirement you want to send to Jira, make sure at least one component is chosen. If you do not choose a component that is required in Jira, you may receive an error: Remote error for ‘create_feature’: Data not accepted: components: Component/s is required.
Mapping non-component custom fields to Jira
The process for mapping custom Aha! fields to default or custom fields in Jira is the same as above except you may use the other custom fields (not only Predefined tags field). Also, linking Aha! custom fields to Jira custom fields does provide a two-way sync. Ensure that the values in each field match those that are in Jira. For example, if you may only select one value in Jira, you will set up a custom field as Pre-defined choice list type.
Steps to set up a mapping of fields in Aha! to Jira fields
- Set up the custom fields in Aha!
- Go to your Integration configuration page in Aha! and click Load project data to trigger a refresh of available Jira fields to which you can map.
- Add a field mapping between the custom field you created and the Component field in Jira.
- Test by sending a feature with the custom field values selected to Jira via the More options button.
Considerations for Jira sprints
It is common to attempt to map a custom field in Aha! to the Jira sprint field. However, the sprint field is key to the operation of Jira. Changing the sprint affects a number of things. The Jira UI is able to display the sprint in a friendly way, but the API does not support translating the internal representation into a form that is useful to external systems. Unfortunately, this means that Aha! and other external systems cannot integrate.