Jira Server (On-Premise)
You can use this extension guide to install and configure the Squadcast extension in JIRA Server (On-Premise) in order to automatically create issues in JIRA projects from Squadcast and vice versa. The status of the issues on JIRA and incidents in Squadcast will automatically be in sync.
A valid Squadcast cloud / On-Premise subscription on Pro Plan
You should have JIRA Server (On-Premise) version installed on your machine with a publicly accessible URL
A user account in JIRA Server with Administrator privileges
Base URL must be set in JIRA settings and it must be publicly accessible as mentioned above
Install the Squadcast Plugin from the Atlassian App Store
(1) Move over to the Extensions from the sidebar and choose to Integrate with JIRA Server.
(2) Now click on Configure to receive a token
(3) Copy the displayed token.
(4) Go to Manage Apps page on your JIRA Server Account from the Settings dropdown.
(5) Select the Squadcast Plugin from the User-installed apps. Click Configure.
(6) In the configuration page, paste the Squadcast token in the JIRA Integration Key text box. Then click Integrate.
(7) Move over to Squadcast and click on Test Connection. You will then receive a success message right below the text box. Post this, click on Next
(8) Select the Jira project in which issue needs to be created and select the issue type and click Next.
(9) Then map the Jira issue status to the available Squadcast statuses and click Next.
(10) Then select the mode in which you want to add an incident to Jira: Manually or Automatically. Now, there are 2 sections:
Add Services to Jira
JQL - Service Mapping
Add Services to Jira: If an incident is created for any service selected in this section, a corresponding Jira ticket would be created in the configured project having the configured issueType.
JQL - Service Mapping: If a ticket is created in Jira, then the mappings defined in this section would be iterated one-by-one and incident would be created for the service corresponding to the first JQL that evaluated to be true for that Jira ticket. If none of the JQL matched, then no incident would be created in Squadcast.
The issue must be in the same Jira project and be the same Jira Issue type. If you are using Jira Service Desk, incidents are created from JQL before automation rules are applied.
Make sure that the issue priority is enabled for issues in Jira in order to create incidents in Squadcast.
So, to summarize,
Add Services to Jira: Handles Jira ticket creation corresponding to incident creation in Squadcast.
JQL - Service Mapping: Handles Squadcast incident creation corresponding to ticket creation in Jira.
That’s it! Your JIRA Server Integration is good to go.
The statuses of the Squadcast Incident and JIRA Issue will be automatically synced as per the mapping configured.
Incidents in Squadcast created for issues in Jira using the Jira plugin will not have a status sync.
If the Squadcast incident reaches either Resolved or Suppressed status, the bidirectional status syncing will stop even if the issue is re-opened in JIRA, as these both are end states in Squadcast.
The default directory for user creation should be Jira Internal Directory. If the squadcast user gets created in any other directory apart from Jira Internal Directory, you will have to move the user to the Jira Internal Directory by following the steps below:1. Delete the squadcast user that was created post the integration.
2. Then, add a new user. The username should be squadcast and password should be the token that is available in step 2 here.
3. Kindly ensure that you have selected Jira Internal Directory from the dropdown while creating the user.
Usage of the Automatic and Manual Modes
If you have chosen the Automatic mode while configuring Jira Server then you need not do anything. Any incident triggered for the selected service will automatically create an issue in the selected Jira project with the configured issue type.
If the chosen mode is Manual, follow the below steps to create a issue in Jira.
(1) Open the incident in Squadcast and click on More Actions button.
(2) Select Jira Server action and click on Create a issue in Jira button.
An issue will be created in the selected Jira project with the configured issue type and this action will be recorded in the incident timeline with a hyperlink to the created Jira issue.
Similarly, if there was an error in creating a ticket in Jira, it will be reflected in the Incident Timeline.
Ensure to check the permissions associated with Squadcast user. To do this, go to System > Admin Helper > Permission Helper. Choose Squadcast in the User drop down and validate if permissions - Browse Project, Create Issue, Transition Issue, Resolve Issue exist. If not, then add these permissions to the user group that Squadcast user is a part of. This information can be checked under System > User Management.
Using tags to configure Jira project and issue priority
Currently to use multiple Jira projects your status mappings need to be the same for all your Jira projects. We will be using the status mapping you configured in the `Map Status` section of the configuration.
You can use tagging rules to map your issue priority and project by following the steps below :
(1) Create a tagging rule that helps you set the priority and configure Jira project for an incident in Squadcast by using the tags :
Issue Type Name
Now the Jira ticket will be created based on the tag values
The values of all the tags are case sensitive. Use the same case which has been used in Jira.
issuetypetags configured for a service in Squadcast will override your default Jira configurations for the same.
- Make sure to use both
issuetypetags for creating your issue in a project different from the mapped one. If both tags are not configured then it will use your default Jira configuration
Example of configuring the tags using tagging rules
issuetype for your configured service will override your mapped project and issuetype configuration for that particular service.
Also make sure to use both
issuetype tags for creating your issue in a project different from the mapped one.