Atlassian Jira plugin

Visit our website to see the data that you can access if you use this plugin to add the data source to SquaredUp:

Atlassian Jira

Monitor the Projects, Releases and Issues from your Jira Software environment.

Only the Jira Cloud offering is supported by this data source.

How to add an Atlassian Jira data source

1. To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

2. Display Name:

   Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

3. Domain URL:

   The domain for your Atlassian instance in the format
   https://your-domain.atlassian.net

4. User Email Address:

   Enter the email address of your Atlassian user account. You need to have access to that user account since you need to create an API token with the same user you entered here (see next step).

   Here's how the email address (Atlassian user account) you use here influences which data will be returned:

   For Confluence data source: If the user account doesn't have access to a space, the space won't be returned. If the user account has read-only access to a space, you'll get the pages in that space.

   For the Jira data source: Even if the user account you use here has just read-only access to a project, the issues in that project will still be returned.

   For the Jira Service Management data source: If the user account doesn't have access to any Jira Service Management service desks, nothing will be returned by the data source.

5. API Token:

   Go to your Atlassian account, create an API token, and paste it in here. You can go directly to your Atlassian API tokens using this link: https://id.atlassian.com/manage-profile/security/api-tokens

   Note: You need to create the API token with the same user account you used for the User Email Address field.

   Tip: If you are using the Atlassian Confluence and the Atlassian Jira data source you can use the same token for both data sources.

6. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

   Restrict access to this data source

   The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

   By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

   Use the Restrict access to this data source dropdown to control who has access to the workspace:

   • By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.

   • Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.

   • If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.

   • At least one user or group must be given Full Control.

   • Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

   Data source access levels

   Access Level:

   Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
   Full Control	User can change the data source configuration, ACL, and delete the data source.

   See Access control for more information.

7. Click Add.

   You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the Jira data streams

What is a data stream?

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format. While creating a tile you can tweak data streams by grouping or aggregating specific columns. Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

• Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").

• A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

Data streams are installed with this data source.

How to create a data stream for this data source:

• Create a data stream using the configurable data stream see Creating a data stream using a configurable data stream

Creating a data stream using a configurable data stream

What is a configurable data stream?

A configurable data stream allows you to easily create new data streams specific to your needs, by entering information into a form, such as metric names or queries. Configurable data streams have a cog icon next to their name in the tile editor.

Any data stream you create can be edited by clicking the edit button (pencil) next to it in the tile editor, and also from Settings > Advanced > Data Streams.

JQL Query

This data stream calls the /rest/api/3/search endpoint, and allows you to enter a custom JQL query.

1. In the tile editor, filter by the Atlassian Jira data source, select JQL Query from the data stream list and then click Next.

2. Enter a JQL Query, for example:

   project={{key}}&updatedDate>='{{timeframe.startTime}}'

Supports mustache parameters

A mustache parameter is a dynamic value, the actual value will be inserted to replace the field in curly braces. For example, {{timeframe.start}} will insert the start time based on the timeframe configured within the tile, or {{name}} will insert the name of the object(s) in scope.

This data stream supplies scoped objects individually for mustache parameters. When there are multiple objects in scope this data source will send the query multiple times, once for each object. The results are then displayed together, for example in a single table.

You can use properties of objects and write them in between curly braces e.g {{name}} to use them as mustache parameters. Whenever you use mustache parameters, you need to use a scope of objects that contain the property you're referencing.

For example, if objects of type "host" have a property called name, you can use {{name}}. This will resolve {{name}} to the value of the name property of the different "host" objects used in the scope.

Timeframe

An additional timeframe object is also available for mustache syntax.

Available properties of the additional timeframe object are as follows:

Property	Description	Example
start	The start time of the timeframe in ISO format	2022-05-10T16:00:00.000Z
end	The end time of the timeframe in ISO format	2022-05-11T16:00:00.000Z
unixStart	The start time of the timeframe in Unix format (seconds)	1652198400
unixEnd	The end time of the timeframe in Unix format (seconds)	1652284800
interval	A fraction of the length of the timeframe in ISO interval format	PT15M
startDate	The start time of the timeframe in yyyy-MM-dd format	2022-05-10
endDate	The end time of the timeframe in yyyy-MM-dd format	2022-05-11
startTime	The start time of the timeframe in yyyy-MM-dd HH:mm format	2022-05-10 16:00
endTime	The end time of the timeframe in yyyy-MM-dd HH:mm format	2022-05-11 16:00