...

Our User Guide describes basic information about the installation and configuration of our Connector step by step. Furthermore, you can find here a summary about of the basic functioning of our Connector. Of course, the admin users also have many options for setting up Connector according to their needs.

...

3.1.1 Installation from Atlassian Marketplace

• Search for the application USU Service Management Connector for Jira in the Atlassian Marketplace. Our Connector has server and cloud hosting type versionversions. Please select the cloud version.

...

• Download and install the connector.

• Input license key.

• Successful The successful installation contains a new Setting page of our Connector where you can find generated InterfaceKey in the Default Interface.

• The InterfaceKey is used for coupling to communication with USU Service Management Interface Actions. Image The image below demonstrate demonstrates the right installation. . The key has to be globally unique.

3.1.2 Manual installation via Manage Apps Administration

• Login into Jira as Administrator (or user with Administrator´s permissions).

• Go to Jira Administration – Apps and select Manage Apps.

• Click the Upload app button and paste the Descriptor URL of our Connector (which will be provided by the Vendor). 

Example: https://marketplace.atlassian.com/files/1.2.1-AC/artifact/descriptor/513ce61e-c05d-4728-b013-9fadbd0be955/atlassian-connect.json?access-token=ae1a62d6

...

• If the button Upload app is missing on your screen, check the Settings of UPM. Both conditions have to be checked.

...

• Get started working with USU Service Management Connector for Jira.

...

• Successful The successful installation contains a new Setting page of our Connector where you can find generated InterfaceKey in the Default Interface. The InterfaceKey is used for coupling to USU Service Management Interface Actions. Image The image below demonstrate demonstrates the right installation. 

3.2 USU Service Management Package (Valuemation)

...

4.1 Configuration of USU Service Management

4.1.1 Add SIT_InterfaceTransactionStart Webservice to

...

Interface Handling

• Open the catalog Web Service Clients, then select Interface Handling to configurateconfigure. It is necessary to add the new Web Service SIT_InterfaceTransactionStart. 

...

• The Generic Interface and Interface Actions in USU must have names in these this format:

  SIT_USU_Atlassian_Connector_Cloud_InterfaceKey.

  • E.g.: SIT_USU_Atlassian_Connector_Cloud_InterfaceKey.

• Copy the generated InterfaceKey from the Settings page of our Connector in Jira (see the section 3.1.1/3.1.2).

• You can either create the Interface and Interface Actions manually by using Copy action from the context menu or use the Workflow SIT_CopyInterface. 

• Workflow SIT_CopyInterface:

  • Select the Generic interface what that you want to change.

  • Paste InterfaceKey from the Jira Plugin Settings. 

...

• A New newly created Generic Interface appears in the list of Generic Interfaces.

...

• Manual Creation of Copy Generic Interface:

  • Click on the Interface with the right button of the mouse and select Copy. 

...

• Paste the generated InterfaceKey at the of the Interface name.

...

• Copy Generic Interface Source/Target System SIT_USU_Atlassian_Connector_Cloud, or if you used the SIT_CopyInterface Workflow, it will be done automatically.

• Create Generic Interface Source/Target Systems is the same as were demonstrated in section 4.1.1.

• Copy the generated InterfaceKey from the Settings page of our Connector.

...

• Copy the Actions. If you used the SIT_CopyInterface Workflow, it will be done automatically.

• Create Generic Interface Actions is the same as were demonstrated in section 4.1.1.

• Copy the generated InterfaceKey from the Settings page of our Connector.

...

4.2 Configuration of Jira Plugin 

It is necessary for the well-behaving of our plugin to configurate configure some basic parts. Firstly create (invite) a new Jira User (Technical User – our example of the Technical User is named SITJIRAINTEGRATION) for communication between Jira and USU. Then set up properly Jira Plugin Settings page. 

...

• Go to User Management Administration.

• Inivite Invite a new user for communication between Jira and USU Service Management.

• The created Technical User has to have access to the Jira Software Application and these permissions minimally (for a default installation of Jira, this corresponds to the Basic role):

  • Browse Projects

  • Create Issues

  • Edit Issues

  • Transition Issues

  • Add Comments

  • Edit Own Comments

  • Create Attachments

  • Delete Own Attachments

...

4.2.2 Creation and Configuration of Jira Custom Fields

Other Another small part for good functioning is to create two Custom Fields in Jira for receiving USU Ticket Number and USU Link  (name them as you wish). We recommend to use using the Short text (plain text only)  type for USU Ticket Number and the Paragraph (support rich text) type for USU Link. 

(Jira documentation – Create a Custom field)

The USU Link, which comes from USU Service Management to Jira Custom Field, can be displayed better in Jira Custom Field. It needs  needs to change the Jira Custom Field configuration. 

...

• View of the USU Link should look like the image below after this change. 

...

4.2.3 Configuration of Jira Plugin Interface

The Connector supports OAuth2 or Basic Authorization. On the Interface Tab, you can configure the connection to USU Service Management. Follow the instructions below on how to set up Jira Plugin Interface. It is possible to create another Interfacesinterface. But you have to create InterfaceKey for a new interfaces manually.

...

• USU URL –the link of USU where should be our plugin connected. 

...

It is possible to create more interfaces than one. Click “+ Create an Interface” button and configure another one. Bare in mind it is necessary to create InterfaceKey manually for another Interface.

...

4.3 WebHooks

4.3.1 Application WebHooks (Dynamic Webhooks)

4.3.1.1 Create Jira WebHook (authorized by app itself)

• Specify Issue criteria (JQL filter).

• Select related Issue events.

• Press the Create WebHook button.

Note that only a subset of JQL and WebHook events is supported for now.

• Registration restrictions – A maximum of 100 WebHooks

...

• per app is allowed.

4.4 Event Mapping

Event to Generic Interface Action mapping:

...

Default Values for Generic Interface Actions:

* interfaceyKey  - identifies the certain interface.

...

• Send a Jira Issue data to USU Service Management (Valuemation), where the new Ticket will be created.

• Send back USU Ticket number and USU Ticket link to Jira Issue.

• Sending comments from Jira to USU and from USU to Jira.

• Sending Attachments from Jira to USU.

• Creating more interfaces which can be active in the same time.

4.

...

7 Scenario configuration

Create Ticket in USM (Jira → USM)

1. Create new Status in Jira wf

   Image Added

2. Set status event to Issue created

   Image Added

3. Create webhook in Connector app settings

   Image Added

5 Use Cases

5.1 Use Case 1: Create new Issue in Jira

...