Jira Connector Example¶

The Jira REST API enables you to interact with Jira programmatically. The WSO2 JIRA Connector allows you to access the REST resources available in Jira Cloud API Version v2 from an integration sequence.

What you'll build¶

This example explains how to use the JIRA Connector to create an issue and read it.

You will use two HTTP API resources, which are createIssue and getIssue.

Calling insert operation

/createIssue: The user sends the request payload with the issue details (the project info, summary, description and the issue type). This request is sent to the integration runtime by invoking the Jira API. It creates the issue in the corresponding Jira account.
/getIssue: The user sends the request payload, which includes the issue id or key (that should be obtained from the createIssue API resource) and other parameters (fields and expand).

If you do not want to configure this yourself, you can simply get the project and run it.

Configure the connector in WSO2 Integration Studio¶

Follow these steps to set up the Integration Project and the Connector Exporter Project.

Open WSO2 Integration Studio and create an Integration Project.
Right-click the project that you created and click on Add or Remove Connector -> Add Connector. You will get directed to the WSO2 Connector Store.
Search for the specific connector required for your integration scenario and download it to the workspace.
Click Finish, and your Integration Project is ready. The downloaded connector is displayed on the side palette with its operations.
You can drag and drop the operations to the design canvas and build your integration logic.
Right click on the created Integration Project and select New -> Rest API to create the REST API.

Creating the Integration Logic¶

Right click on the created Integration Project and select, -> New -> Rest API to create the REST API.
Provide the API name as jiraAPI and the API context as /jira. You can go to the source view of the XML configuration file of the API and copy the following configuration.

<?xml version="1.0" encoding="UTF-8"?>
<api context="/jira" name="jiraAPI" xmlns="http://ws.apache.org/ns/synapse">
    <resource methods="POST" uri-template="/createIssue">
        <inSequence>
            <jira.init>
                    <username>****</username>
                    <password>****</password>
                    <uri>https://<site-url>/jira</uri>
            </jira.init>
            <jira.createIssue>
                <issueFields>{$ctx:issueFields}</issueFields>
            </jira.createIssue>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </resource>
    <resource methods="POST" uri-template="/getIssue">
        <inSequence>
            <jira.init>
                    <username>****</username>
                    <password>****</password>
                    <uri>https://<site-url>/jira</uri>
            </jira.init>
            <jira.getIssue>
                <issueIdOrKey>{$ctx:id}</issueIdOrKey>
            </jira.getIssue>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </resource>
</api>

Exporting Integration Logic as a CApp¶

CApp (Carbon Application) is the deployable artifact on the integration runtime. Let us see how we can export integration logic we developed into a CApp along with the connector.

Creating Connector Exporter Project¶

To bundle a Connector into a CApp, a Connector Exporter Project is required.

Navigate to File -> New -> Other -> WSO2 -> Extensions -> Project Types -> Connector Exporter Project.
Enter a name for the Connector Exporter Project.
In the next screen select, Specify the parent from workspace and select the specific Integration Project you created from the dropdown.
Now you need to add the Connector to Connector Exporter Project that you just created. Right-click the Connector Exporter Project and select, New -> Add Remove Connectors -> Add Connector -> Add from Workspace -> Connector
Once you are directed to the workspace, it displays all the connectors that exist in the workspace. You can select the relevant connector and click Ok.

Creating a Composite Application Project ¶

To export the Integration Project as a CApp, a Composite Application Project needs to be created. Usually, when an Integration project is created, this project can be created as part of that project by Integration Studio. If not, you can specifically create it by navigating to File -> New -> Other -> WSO2 -> Distribution -> Composite Application Project.

Exporting the Composite Application Project¶

Right-click the Composite Application Project and click Export Composite Application Project.
Select an Export Destination where you want to save the .car file.
In the next Create a deployable CAR file screen, select both the created Integration Project and the Connector Exporter Project to save and click Finish. The CApp is created at the specified location provided at the previous step.

Get the project¶

You can download the ZIP file and extract the contents to get the project code.

Deployment¶

Follow these steps to deploy the exported CApp in the integration runtime.

Deploying on Micro Integrator

You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server. Micro Integrator will be started and the composite application will be deployed.

You can further refer the application deployed through the CLI tool. See the instructions on managing integrations from the CLI.

Click here for instructions on deploying on WSO2 Enterprise Integrator 6

You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server.
WSO2 EI server starts and you can login to the Management Console https://localhost:9443/carbon/ URL. Provide login credentials. The default credentials will be admin/admin.
You can see that the API is deployed under the API section.

Testing¶

Create Issue Operation¶

Create a file named createIssue.json with the following payload:

{
    "issueFields":{
        "fields": {
            "project":{
                "key": "<project-key>"
            },
            "summary": "For Testing",
            "description": "Test issue",
            "issuetype": {
                "id": "6"
            }
        }
    }
}

Invoke the API using the following curl command.

Info

The Curl application can be downloaded from here.

curl -H "Content-Type: application/json" --request POST --data @createIssue.json http://localhost:8290/jira/createIssue

Expected Response : You should get a response as given below and the data will be added to the database.

{
    "id": "340135",
    "key": "<project-key>-3400",
    "self": "https://<site-url>/jira/rest/api/2/issue/340135"
}

Read Issue Operation¶

Create a file named getIssue.json with the following payload:
```
{
    "id": "<project-key>-3400"
}
```

Invoke the API using the curl command shown below.