Jira Software integrations with Lucid make it quick and easy to insert Lucidchart or Lucidspark diagrams directly into Jira issues. This provides collaborators with quick access to all the information they need directly from a Jira issue.
Plan availability: Team and Enterprise.
- Available on FedRAMP accounts.
- Embedding Lucid diagrams in Jira Data Center is available in the FedRAMP environment, but embedding in Jira Cloud isn't.
- Read the Lucid Plans article for more information about what is available on your account or the Upgrade your Lucid account article for instructions to upgrade.
For admins: Install Lucid integrations in Jira
Before any users can add Lucid documents to issues in Jira Cloud or Jira Data Center, an admin needs to install the appropriate Lucid app. You will need both Jira and Lucid admin permissions to complete the following steps. Once you have completed the installation, all users on your Team or Enterprise account will be able to use this integration.
To install the Lucidchart or Lucidspark app for Jira Cloud or Data Center, follow these steps:
- Log in to your Jira Software instance.
- Navigate to the Atlassian Marketplace.
- Search “Lucid".
-
Select the correct integration.
- For Lucidchart, select Lucidchart Diagrams Connector for Jira.
- For Lucidspark, select Lucidspark Boards Connector for Jira.
- Click Install.
- Select Accept & Install.
- Click Configure in the confirmation dialog that appears directly after installation to be directed to the plug-in configuration page.
- Follow the prompts to link your Jira account to your Lucid account.
If you are on a Lucid FedRAMP environment, you must adjust the environment so the app functions properly. To do so, follow these steps after you’ve completed the installation instructions above:
-
Navigate to the plug-in configuration page.
- After the Lucidchart or Lucidspark app has been installed, this can be found in the left-hand menu of the “Manage apps” page in Jira.
-
Adjust the URL to get to the environment settings:
- If you are using the Lucidchart app, replace “/LucidConfig.jspa” in the URL with “/EnvironmentConfigChart.jspa”.
- If you are using the Lucidspark app, replace “/LucidsparkConfig.jspa” with “/EnvironmentConfigSpark.jspa”.
-
Select the “lucidgov.app” option.
Using Lucid for Jira Cloud
Add a Lucid document
After an admin has installed the integration, any user on their account can follow these steps to insert a Lucidchart or Lucidspark diagram into a Jira issue in Jira Cloud:
- Open a Jira issue.
-
In the menu underneath the issue name, select the attachment icon.
- For Lucidchart, click Attach Lucidchart Diagram.
- For Lucidspark, click Attach Lucidspark Board.
- If the document you are adding is in a repository, you need to open that repository before moving to the next step. Click Repositories from the navigation on the left side, then select the specific repository.
- Select a Lucid document thumbnail.
- Click Open document.
The document will now be added as an attachment on your Jira issue.
Note: We don’t support embedding Lucid documents on Jira dashboards.
Edit, refresh, or delete a document
Hover your cursor over the Lucidspark board or Lucidchart diagram in Jira and choose one of the following icons in the bottom-left corner to:
- Refresh icon: Update the board to the latest version. When edits are made directly in Lucid, the attached version doesn’t update automatically.
- Pencil icon: Edit the board from within the Jira issue, if you have editing permissions. After making edits, click the X in the top-right corner to return to Jira.
- Trash can icon: Delete the attached Lucid document from the Jira issue.
Note: Using the trash icon only removes the attachment from the Jira issue but doesn’t delete the diagram from Lucid’s website.
Using Lucid for Jira Data Center
Add a Lucid document
After an admin has installed the integration, any user on their account can follow these steps to insert a Lucidchart or Lucidspark document into a Jira issue in Jira Data Center:
- Open a Jira issue.
-
Select the More dropdown menu at the top of the issue and select the appropriate insert option.
- For Lucidchart, click Insert Lucidchart Diagram.
- For Lucidspark, click Insert Lucidspark Board.
- If the document you are adding is in a repository, you need to open that repository before moving to the next step. Click Repositories from the navigation on the left side, then select the specific repository.
- Select a Lucid document thumbnail.
- Click Insert.
Edit, refresh, or delete a document
The screenshot below is specific to a Lucidchart diagram, but the options discussed in this section apply to Lucidspark boards as well.
Any Lucid documents attached to a Jira issue will appear on the right side. Select from the following options beneath the Lucid thumbnail:
- Edit: Open the diagram in the Lucid editor. When you are finished editing, click Back to Jira in the upper-right corner to return to Jira Software. Your diagram will be automatically added or updated.
- Remove: Delete the attached Lucid document from the Jira issue.
- Fullscreen: View the Lucid document in a larger frame. From this frame, you can zoom in and out and navigate around the canvas. If the document has multiple pages, you can also navigate between the additional pages.
Note: The “Remove” option removes the thumbnail from the Jira issue, but doesn’t delete the diagram from Lucid’s website.
FAQ
What do I do if I am stuck in a login loop?
If you are attempting to sign into Lucid for the Jira add-on but you continuously get put in a loop of signing in, this behavior is typically due to 3rd party cookies being disabled for your browser. Please enable 3rd party cookies and try again. The Troubleshooting: Enable third-party cookies article has information on how to do this.
If I migrate Jira instances, will my previously inserted Lucid documents still render in Jira?
No. If you migrate to a new Jira instance you will need to reinsert your diagrams in the new instance for them to display.
This is needed in order to have the URL associated with that diagram point to your new instance, rather than your old one. This will allow them to display correctly in the frame.
Can I embed a Lucid document onto a Jira dashboard?
No. Lucid documents can only be embedded in a Jira issue, not on dashboards.
What do I do if my Lucid diagrams are not appearing correctly in Jira?
If your Lucidchart or Lucidspark attachments aren’t showing up on a Jira issue and you see the error message below, inform your account admin.
This issue is related to the configuration of fields in your Jira account. An admin can resolve this issue by marking the attachments field as visible within your field configuration.
Give feedback on this article
Have feedback about this article? Tell us about your experience here.