Page Comparison

Writing the Apex Class

This webservice can be called from within Apex Class. This example will guide you on how to call "create" API.

Before you write Apex code that calls remote URL, you have to allow salesforce to make a call to external server.

1. Log in to Salesforce.com.
2. Go to Your Name > Setup > Administration Setup > Security Controls > Remote Site Settings.
3. Add new remote site.
4. Enter the name of remote site.
5. Enter your JIRA URL in Remote Site URL, e.g.,: http://yourjiraurl.com/
6. Click Save.

Once you are done, you can start writing the code. Here are the steps to write a Salesforce Apex Class.

1. Log in to Salesforce.com.
2. Go to Setup > App Setup > Develop > Apex Classes > New

3. Paste this code into the field:
    

   Code Block
   language java
   global class JIRAConnectorWebserviceCalloutCreate { @future (callout=true) WebService static void createIssue(String baseUrl, String systemId, String objectType, String objectId, String projectKey, String issueType) { try { HttpRequest req = buildRequest(baseUrl, JIRA.username, JIRA.password, systemId, objectType, objectId, projectKey, issueType); JIRA.sendRequest(req); } catch(System.CalloutException e) { System.debug(e); } } // Constructs request needed to create a JIRA issue from provided parameters. @testVisible private static HttpRequest buildRequest(String baseUrl, String username, String password, String systemId, String objectType, String objectId, String projectKey, String issueType) { HttpRequest req = new HttpRequest(); String basicAuthHeader = JIRA.authHeader(username, password); String endpoint = getEndpoint(baseUrl, systemId, objectType, objectId); req.setHeader('Authorization', basicAuthHeader); req.setHeader('Content-Type','application/json'); req.setMethod('POST'); req.setEndpoint(endpoint); req.setBody('{"project":"' + projectKey + '", "issueType":"' + issueType + '"}'); return req; } // Creates the endpoint to create the issue from provided parameters. private static String getEndpoint(String baseUrl, String systemId, String objectType, String objectId) { return baseUrl + '/rest/customware/connector/1.0/' + systemId + '/' + objectType + '/' + objectId + '/issue/create.json'; } }

   Warning
   Copying the above code and pasting it directly into the field may result in additional, unwanted characters being included. To avoid this from happening, we recommend pasting the code into a text editor that accepts plain text (e.g. Notepad.exe) and then recopying it again before pasting it into the field.

4. Click Save.
    

The Usage of Written Class

Now that the class is ready to be used and it can be called in various ways including:

1. From within a Trigger.
2. From Create JIRA Issue button, as a replacement of Configuring a JIRA Issue Creation Button.

Trigger

Salesforce Trigger can be used to automate the creation of JIRA issue. It is event-based process similar to JIRA workflow, yet more flexible.

In this example, we want to automate JIRA issue creation when Case is created:

First, create custom profile called '"JIRA Agent'":

1. Log in to Salesforce.com.
2. Go to Setup > Administration Setup > Manage Users > Profiles > New Profile.
3. Choose 'Existing Profile' to be: Custom: Support Profile.
4. Fill in '"Profile Name' " with : JIRA Agent.

5. Click Save.
   

   Note
   title "CUSTOM: SUPPORT PROFILE" NOT AVAILABLE?
   Your version of Salesforce may not have the Custom: Support Profile option. If so, you can create a new profile or clone from any existing profile. But please make sure that the profile has Read, Edit and Create permissions for the relevant object.

    

Second, assign the created profile to specific user that will be used in JIRA Connector:

1. Go to Setup > Administration Setup > Manage Users > Users.
2. Create/Edit the user that is used as JIRA agent.
3. Use the created profile as profile of the user.

4. Click Save.
    

   Warning
   title WARNING
   Make sure that this user is used in the Application Links authentication in JIRA.

Third, add Trigger code to Case Trigger.

1. Write Apex Class as described above
2. Go to Setup > Application Setup > Customize > Cases > Triggers.

3. Create New Trigger and replace the code with:
    

   Code Block

   trigger CreateIssue on Case (after insert) { // Check whether current user is not JIRA agent so that we don't create an infinite loop. if (JIRA.currentUserIsNotJiraAgent()) { for (Case c : Trigger.new) { // Define parameters to be used in calling Apex Class String objectType ='CASE'; // Please change this according to the object type String objectId = c.id; String projectKey = 'SFDC'; String issueType = '1'; // Calls the actual callout to create the JIRA issue. JIRAConnectorWebserviceCalloutCreate.createIssue(JIRA.baseUrl, JIRA.systemId, objectType, objectId, projectKey, issueType); } } }

   Warning
   Copying the above code and pasting it directly into the field may result in additional, unwanted characters being included. To avoid this from happening, we recommend pasting the code into a text editor that accepts plain text (e.g. Notepad.exe) and then recopying it again before pasting it into the field.

   
   
   

4. Change the variables accordingly:
    

    

   Variables	Details
   objectType	Salesforce object that is used in Connection. In our example, it is Case
   objectId	The id of the object. It varies in every operation. Therefore, it should be object.id
   projectKey	Under which JIRA Project you want to create the issue.
   issueType	standard JIRA issue type values range from '1' to '4' . '1' is for Bug and so on

5. Click Save.
    

Now you are ready to use the trigger.
Try out:
Create  Try creating a Case in Salesforce as a normal user and check if the JIRA Issue is created.

Button

Other than using it as a trigger, you can use the written Apex APEX class for a JIRA Issue Creation button. Using this method, you can eliminate some processes, including:

1. The required Login log-in page
2. The prompt page of choosing Project and Issue type.

Step-By Step Guide:

1. Write Apex Class as in above

2. Then, you can follow the steps in Configuring JIRA Issue Creation Button to create a button, there are slight changes in Step 8:
    

   Label	Create JIRA Issue
   Name	Create_JIRA_Issue (this is auto-populated when you add a new label)
   Display Type	Detail Page Button
   Behaviour	Execute Javascript
   Content Source	On Click Javascript
   Content	Code Block {!REQUIRESCRIPT("/soap/ajax/29.0/connection.js")} {!REQUIRESCRIPT("/soap/ajax/29.0/apex.js")} sforce.apex.execute("JIRAConnectorWebserviceCalloutCreate","createIssue", {baseUrl:"http://jira.example.com", systemId: "1", objectType: "Case", objectId:"{!Case.Id}", projectKey:"SFDC", issueType:"1"}); window.alert("JIRA Issue should be created.");

3. Change the variables accordingly:
    

   Variables	Details
   baseUrl	Your JIRA URL
   systemId	Your system Id in Connection. You should check this in JIRA under Connection
   objectType	Salesforce object that is used in Connection. In our example, it is Case
   objectId	The id of the object. It varies in every operation. Therefore, it should be object.id
   projectKey	Under which JIRA Project you want to create the issue.
   issueType	standard JIRA issue type values range from '1' to '4' . '1' is for Bug and so on

Now you are ready to test:

1. Create a new Case in JIRA.
2. Click on Create JIRA Issue button.
3. Till you You should see the a pop up sayswindow: JIRA Issue should be created.
4. Check your JIRA if the issue is has been created.

Unit

Test code for this class

@isTest private class JIRAConnectorWebserviceCalloutCreateTest {

    // Tests createIssue method in JIRAConnectorWebserviceCalloutCreate.
    static testMethod void createIssueTest() {
        Test.startTest();
		Test.setMock(HttpCalloutMock.class, new MockHttpResponseJIRAConnector());
        JIRAConnectorWebserviceCalloutCreate.createIssue(TestFixture.baseUrl, TestFixture.systemId,
                TestFixture.objectType, TestFixture.objectId, TestFixture.projectKey, TestFixture.issueType);
        Test.stopTest();
    }

    // Tests buildRequest method in JIRAConnectorWebserviceCalloutCreate.
    static testMethod void buildRequestTest() {
        HttpRequest req = JIRAConnectorWebserviceCalloutCreate.buildRequest(TestFixture.baseUrl, TestFixture.username,
                TestFixture.password, TestFixture.systemId, TestFixture.objectType, TestFixture.objectId,
                TestFixture.projectKey, TestFixture.issueType);
        System.assertEquals(req.getMethod(), 'POST');
        System.assertEquals(req.getEndpoint(), 'http://jira.com/rest/customware/connector/1.0/1/Case/1/issue/create.json');
    }

}