Contents
- Prerequisites and Installation
- Usage and Features Overview
- Device42 - Jira Service Desk / Jira Cloud ITSM Integration Interface Overview
- Creating or attaching a Jira issue from Device42 UI
- Linking an Issue to a Device42 CI
- Working with Device42 Assets in Jira Service Desk / Jira Cloud
- Customizing which assets sync - DOQL & sync settings
- Usage / feature highlights
Prerequisites and Installation
Integration Prerequisites
To use the Device42-Jira integration, users must have:
– Device42 v15.11.01+ virtual appliance, running, properly configured, and populated with CIs (to sync to Jira)
– Jira instance [ServiceDesk, or Cloud for this version], properly configured, with the Device42 plugin installed.
*This version of the integration is for Jira Service Desk / Cloud only. If you are looking to integration Device42 with a self-hosted version of Jira software, see the Device42-Jira ServiceDesk/Cloud integration page.
Configuring Device42
- You must be a Jira Administrator to install & configure the Device42 Jira Service Desk / Jira Cloud Addon.
- In the Device42 Menu, TOOLS → Settings → Global Settings → [External Integration Settings]:
- Input the URL of your Jira Service Desk / Jira Cloud instance: [ https://YOURURL.atlassian.net/ ] & select Jira Cloud as the integration “Type”.
- Head to the Global Settings Page Tools menu -> Settings -> Global Settings and scroll all the way to the bottom. Ensure all three required settings under heading “External Integration Settings” are correctly configured (D42 URL for SaaS apps, Company Name, and Email):
- Proceed to the next section (below) to complete Jira-side configuration & install the integration plugin!
Configuring Jira – Installing the integration plugin & configuring Jira Service Desk / Jira Cloud
From the Atlassian Marketplace – Locate the Device42 CMDB for Jira Service Desk.
- Click the yellow “Get it now” button in the upper right-hand corner of the Atlassian Marketplace listing for the Device42 – Jira Service Desk / Jira Cloud CMDB Integration.
- Log in using your Atlassian credentials and follow the on-screen instructions.
- Follow on screen prompts. The installation process is automatic after this point. Installation is complete.
[Alternate DEV MODE Installation – Special Circumstances ONLY] – If you were provided the plugin file:
-
- Go to “Add-ons” –> Manage Add Ons –> “Enable Development Mode” & Apply settings
- Next, from “Manage Add-ons” — Input the URL of the plugin:
For the new version of the integration, D42 15.11.01+, specify: https://connect.device42.net/static/Jira_assets_v3.json
For the previous version of the integration, below D42 15.11.01, specify:https://connect.device42.net/static/Jira_v2.json
- Choose “Upload”. The Device42 Cloud Add-on will be installed.
**Jira Cloud only (not required for Jira Service Desk) – Configure required fields in Jira Cloud
- Ensure the Linked Assets field is present on your default views for the integration to function as designed. “No Screens” is the default; Click the “Pencil” icon to edit and check all boxes under “custom fields” to enable the Linked Assets field:
Check ALL of the highlighted boxes to show the assets screen on Jira Service Desk:
NOTE: All field are required. If one or more is missing, you won’t be able to add an external integration from the TOOLS –> Integration menu.
Modifying, removing, or verifying installation of the Device42 – Jira Service Desk / Jira Cloud Plugin
- You can view and/or manage the plugin from the from the Administration menu. In Jira Service Desk (or other Jira software), head over to the “Add-ons” → “Manage add-ons”
- Choose the Device42 Plugin from the Atlassian Plugin Manager.
- Follow on-screen prompts. The removal process is automatic.
- Confirm you no longer see the plugin in your plugin list.
Usage and Features Overview
Device42 – Jira Service Desk / Jira Cloud ITSM Integration Interface Overview
Once the Device42 CMDB for Jira Service Desk integration has been installed, you will see a new entry for “Jira – Your Jira instance name” at the bottom of your Device42 Assets pages (e.g. “Jira – https://d42assets.atlassian.net” below):
- At the top of the integration ‘box’, you will see a list of linked Jira issues, the reporter, status, and other useful information about the linked issue.
- The bottom contains ‘control’ links – Using these links, you can create a brand new Jira ticket/issue, or can link an existing Jira issue. The red “X” at the right of each linked issue will remove that issue attachment from the Asset (but does *not* delete the issue from Jira).
Creating or attaching a Jira issue from Device42 UI
- Choose “Add Jira Issue” – You’ll see a “Select Project” Popup; autocomplete field- type project name & click “Select”
- You’ll now choose a Jira ‘issue type’ – choose the type (‘task’…) and ‘reporter’ is visible, but fixed by the Jira integration configuration.
- Add assignee, summary, description, and any attachments.
- Submit the issue; you’ll get a box confirming creation with the issue ID
- The new issue will now be attached to the CI
Linking an Issue to a Device42 CI
Linking an issue is as simple as choosing “Link to Jira Issue” and providing the Issue ID, which is then linked to the CI.
Working with Device42 Assets in Jira Service Desk / Jira Cloud
- View any linked issue in Jira Service Desk / Jira Cloud, and you’ll see “Device42 Objects” on the lower right. These are CI’s linked to the issue, and they themselves are links to the Device42 CI they concern:
- To link a new issue, open that issue and from the “asset” field, click “Add Asset”. Start typing the name of the Asset you would like to add, and it should be match against your partial entry. Click the asset of interest from the ‘results’, and it’s attached. Repeat to attach another:
- To unlink an issue, from the Jira Service Desk / Jira Cloud interface, click the Red X next to the CI you’d like to detach; choose “Unlink!” to confirm. The issue will no longer be linked.
Customizing which assets sync – DOQL & sync settings
Default syncs run daily at 2AM and sync “Devices” only. Users can customize what is synced by adding new Sync DOQL queries, customizing, or writing their own:
NOTE: When adding or modifying DOQL settings or queries, be **SURE** to reset the last synced time. Default queries are time-constrained and if not reset, newly selected categories will NOT sync!***
Usage / feature highlights
- Attach Device42 Assets directly to Jira Service Desk and/or Jira Cloud issues / tickets
- View Device42 Asset data natively from Jira Service Desk
- Create Jira Service Desk tickets and attach existing tickets right from the Device42 interface, from any Device / Asset (CI) details view
- See all Jira Service Desk issues associated with a particular Device or Asset CI
- Filter a set of Device42 Assets / Devices to display within the custom field of a specific project and/or custom field set
- Full control over which assets are available within Jira Service Desk – users may modify the default ‘saved DOQL query’ (the integration leverages Device42 Object Query Language), or can create their own completely custom DOQL