The AODocs Jira Connector lets you run Jira queries from your AODocs document and import the Jira data into a spreadsheet attached to your document.
Note: The AODocs Jira Connector is available only:
– for Google users
– in Document Management libraries using Google Drive
– as a US instance; there is currently no EU instance – learn more: What are AODocs instances?
In this article:
Automatically generated table of contents
Prerequisite: send information to AODocs
To set up the AODocs Jira Connector, send us your:
- domain name
- Jira instance name
Tip: Find your Jira instance name in the URL you use to access Jira. For example: .
- (optionally) the email address of a Google group containing the users on your domain who will be administrators of the AODocs Jira Connector — members of the administrator group can create and manage rules
Important: If you don't provide an administrator group, all users on your domain will be able to create and manage rules.
Set up your AODocs library
1. Create a workflow with a state that will let users run the Jira query and import the Jira information. In our example, it is called "Trigger Jira query".
2. Create properties that you want to map to Jira fields.
You can map only String type properties to Jira fields. For example:
- for dates, enter a date into a String property using either of these formats:
YYYY/MM/DD or YYYY-MM-DD
- for people, enter the name recognized by Jira into a String property
In our example, we created the following properties:
- "Project name" with the value "UL628"
- "Project owner" with the value "Alice"
The Jira query will find all tickets in the project UL628 with the reporter Alice. Learn more about mapping Jira fields and AODocs properties.
3. If required, create a string property called "Import from JIRA". When you run Jira queries from AODocs documents the value of this property is filled with "Success" or "Fail", allowing you to check the status of the operation.
Important: Make sure you use the exact property name as indicated and respect upper and lower case.
4. Create a document with an attached Google spreadsheet.
2. Click the Add new rule button.
3. Under Define a name, enter a name for your rule.
4. Click Next.
5. Enter the name of your AODocs library and choose a document class.
Note: You can create only one rule per document class.
6. Click Next.
7. Select the workflow state to trigger the import. When your document enters this workflow state, the Jira query is triggered and your spreadsheet is updated with information from Jira.
In our example, users perform the workflow action "Run Jira query" in the state "Project kick-off". During the transition to the workflow state "Project defined", the query recovers data from Jira and updates the spreadsheet.
In our example, the Jira query will find all tickets in the project UL628 with the reporter Alice. Learn more: Set up your AODocs library.
9. Click Next.
10. Select the Jira ticket fields to import into the spreadsheet. Each Jira ticket field will be a column in the spreadsheet.
Note: The list of Jira ticket fields you can import into the spreadsheet is currently limited to:
– Affect version
– Fix version
– Issue type
– Issue ID
– Issue title
– Release name
If you want to add custom Jira fields such as Epic name, contact your Sales representative or send an email to firstname.lastname@example.org.
11. Click Save rule.
Your setup is now complete. Learn more about the end user experience: Trigger Jira queries from your AODocs document.
1. Click Edit rule next to the required rule in the AODocs Jira Connector dashboard.
2. You can edit all fields except the name of the rule, the library and the document class.
3. Click Save rule.