Our app requires a Jira and Jira Servicemanagement Compass administrator to take action at some point in the setup process. Therefore, we strongly recommend involving booth administrators the administrator from the start to ensure a seamless implementation of the JSM Assets Owner for Jira Compass app in your company or team.
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Step 1: Install
...
Compass App
[Insert Pic of store page]
...
Install JSM Assets for Compass
Permission necessary: Jira Compass Admin
Step 2:
...
Before you can configure the app, you'll need an API token from your Jira Servicemanagement administrator (hereafter referred to as "JS administrator"). This token allows the app to securely access data from your Jira instance. To get started, the JS administrator should follow these steps:
Access Jira Settings: While logged in as the JS administrator, click the settings wheel icon in the top-right corner of the Jira header.
Open Account Settings: From the dropdown menu, select 'Atlassian account settings'. This opens the account settings in a new browser window or tab.
If you're logged in with multiple Atlassian accounts, you'll see a window asking you to select an account. Choose the Jira Service Management administrator account to proceed.
...
In your Atlassian account settings, you'll see a navigation bar at the top. Click on the Security tab to access your security settings. (See the image below for reference.)
...
On the Security page, scroll down to the 'API tokens' section. You'll find a link labeled 'Create and manage API tokens'. Click this link to proceed.
...
Click the 'Create API token' button. In the popup, give the token a descriptive name (e.g., 'Assets Owner for Jira'), then click Create. Copy the generated token (you'll see a 'API token copied to clipboard' message). Finally, click Done.
...
Important: After copying the API token, it's highly recommended to paste it into a temporary document (like Notepad on Windows or TextEdit on macOS). This is crucial because the token is only displayed once. After you close the window, you won't be able to get it again!
Note: If you do lose your token, you can easily revoke it and generate a new one by following these same steps.
...
Configure App
Now that you have your API token, let's return to your Jira instance. In a new browser tab or window, navigate to the Jira site where you installed 'Assets Owner for Jira'. Once you're there, access the Configuration Page by going installed our app on your Compass site, navigate to Apps > Manage your apps.
...
After navigating to 'Manage your apps', you'll see a sidebar on the left side of the screenall your apps you have installed on your current Compass site. Scroll down this sidebar until you find the 'JSM Assets Owner for JiraCompass' label. Underneath that labelapp. After finding the app, click on the 'ConfigurationConfigure' PageButton.
...
The Configuration Page allows you to set up the 'JSM Assets Owner for JiraCompass' app. As shown in the screenshot below, you 'll need to provide two pieces of information:
Email: Enter the email address of the Jira Servicemanagement Administrator account.
API Token: This unique token authorizes the app to access Jira's API. (If you haven't generated an API token yet, or if you've lost it, please refer to Step 2 for instructions on how to obtain it.)
...
After entering your credentials, the Configuration Page should look like the image below.
You have the option to change the Encryption String. This string is like a secret code used to protect your sensitive information (email, API token, and visibility settings). It's highly recommended to personalize this string to enhance security.
Note: For a detailed explanation of how your data is stored and secured, click here.
...
Note: Remember to save your configuration by clicking the 'Save Configuration' button before moving on.
Step 4: Configure Visibility Settings
Optional but Highly Recommended: While this step is optional, it's crucial for tailoring the app to your specific needs. Take a moment to configure these settings to ensure the app works exactly how you want it to.
...
Which groups are allowed/restricted to access “My Assets”
The first thing you'll see is a multi-select box where you can choose specific groups from your Atlassian instance. Use the 'Allow/Restrict' toggle to determine whether the selected groups should have access to the 'My Assets' menu or not.
Allow: The selected groups will be able to see the 'My Assets' menu.
Restrict: The selected groups will be prevented from seeing the 'My Assets' menu.
(See the image below for a visual representation.)
...
Which Asset-Schemas should be hidden from “My Assets”
The second multi-select box allows you to choose which Asset Schemas, from your Jira Servicemanagement instance, you want to exclude from the 'My Assets' menu. Any schema you select here will not be displayed in the 'My Assets' menu. This helps you filter out irrelevant schemas and keep the menu focused on the most important asset types.
(See the image below for a visual representation.)
...
Which Object-Types should be hidden from “My Assets”
Finally, you can fine-tune the 'My Assets' menu by selecting which Object Types to exclude for each Asset Schema.
Important: If you've already excluded an Asset Schema in the previous step, its corresponding Object Type selection will be grayed out, indicating that it's inactive. This visual cue helps you keep track of your choices.
(See the image below for a visual representation.)
...
have two sections:
Global Page AQL: In this section you can set the AQL for the global page.
Page Type Specific AQLs: Define specific AQL queries for every component and team. (Details follow in the next step.)
...
Step 3: Configure Page Type Specific AQLs
After clicking "Add New AQL", you'll see the screen shown below, where you can, first define an AQL, and then specify the target component and team pages. (This AQL will apply to all checked pages)
...
Upon successful configuration, the interface should match the following illustration. To persist these changes, click the "Save" button. (The save operation first validates the AQL and then saves it along side your selection)
...
If configured correctly, you will see a Success box, informing you that everything got successfully saved.
...
Note: Each component and team can have only one AQL applied. Therefore, already selected components/teams will not appear when creating a new AQL.
...
Congratulations! You've successfully configured 'JSM Assets Owner for JiraCompass'. Click the 'Save Configuration' button, and you're all set! Your app is now tailored to your specific needs.Important: After changing the group permissions (Allow/Restrict), you need to RELOAD your Jira instance for the changes to take effect. Other configuration changes will apply immediately without requiring a reload.
Step
...
4: Use the App
You're all set to explore your assets! Click on your profile picture in the top right corner of your Jira instance. A dropdown menu will appear, and you should see the 'My Assets' option waiting for you. Click on it to discover all the assets that are connected to youExplore your JSM Assets! Click the arrow next to "Apps" and select "JSM Assets" to access the Global Page displaying your configured assets.
Important: The 'My JSM Assets' menu visibility is determined by your configuration settings. Individual users will only see the menu if they have the necessary permissions. Double-check your configuration to ensure the menu appears for the intended users.
...
After clicking 'My Assets', you'll see a window listing your assets. This window displays all the assets that are connected to your Atlassian user account in any way. Remember that the assets shown here are filtered based on your visibility settings, so you'll only see what you're authorized to access.
...
...
This page displays all assets configured on the Configuration page for your global page.
...
To find Component and Team pages, click "Components" or "Teams" in the Compass header and select the desired component/team.
...
To access JSM Assets in the component/team view, click "JSM Assets" under the "Apps" label in the left sidebar.
...
You'll see a page similar to the global page, but displaying only the assets configured for that specific component/team.
...
This works for all components and teams the same. That's it! You've successfully installed, configured, and learned how the app works.
To learn more about the 'My JSM Assets' window Tab and its features, such as filtering, sorting, and exporting, please visit the Jira App Documentation page.