Setup & Installation

Our app requires a Compass administrator to take action at some point in the setup process. Therefore, we strongly recommend involving the administrator from the start to ensure a seamless implementation of the JSM Assets for Compass app in your company or team.

Step 1: Install Compass App

Open

Install JSM Assets for Compass

Permission necessary: Compass Admin

Step 2: Configure App

Now that you installed our app on your Compass site, navigate to Apps > Manage your apps.

Open

After navigating to 'Manage your apps', you'll see all your apps you have installed on your current Compass site. Scroll down until you find the 'JSM Assets for Compass' app. After finding the app, click on the 'Configure' Button.

The Configuration Page allows you to set up the 'JSM Assets for Compass' app. As shown in the screenshot below, you 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 for Compass'. Your app is now tailored to your specific needs.

Step 4: Use the App

Explore your JSM Assets! Click the arrow next to "Apps" and select "JSM Assets" to access the Global Page displaying your configured assets.

Important: The 'JSM Assets' menu visibility is determined by your configuration settings.

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 'JSM Assets' Tab and its features, such as filtering, sorting, please visit the Jira App Documentation page.