Configuring the "Associate with Jira Issue" button with the Associate Endpoint

This guide walks you through the process of configuring the Jira Associate Button, enabling Salesforce users to associate Jira issues directly from Salesforce Object pages.

Creating an "Associate with Jira Issue" button allows synchronization of fields between a Jira Issue and an associated Salesforce Object. Making changes on one end will be reflected on the other.

If you would prefer to create a button that links (as opposed to associates) to a Jira Issue to a Salesforce Object, please read Configuring the "Link to Jira Issue" Button.

(warning) The button can only be used for the Jira project that is associated with the same Mapping because different Mappings will have different parameters appended to the Endpoint URL.

What's the difference between linking and associating?

Associating a Jira Issue with a Salesforce Object will allow synchronization of fields on both ends. Making changes in a Jira Issue will be reflected in the associated Salesforce Object, and vice versa.

Linking a Jira Issue with a Salesforce Object merely allows retrieval of data in a read-only state. Making changes on one end will not be reflected on the other end.

Please ensure that you have chosen the right method of connecting Jira to Salesforce that suits your needs.

Guide

    1. You will need to get the correct Jira URL first by copying the URL for the "Associate" Endpoint from the Configure Mappings screen.
       
    2. Go to > Setup.



    3. Search for "Object Manager" then click on the Object Manager menu item.



    4. Choose the object that you want to create a button in.
      In our example, we will use Case.


       
    5. Choose Buttons, Actions, and Links.



    6. You will be taken to a listing of the standard buttons and links associated with the object.
      Underneath this is a list of custom buttons and links.
      Click New.



    7. A form will appear for you to enter the details of the new button.
       

      Label

      Associate with Jira Issue

      Name

      Associate_with_Jira_Issue (this is auto-populated when you add a new label)

      Display Type

      Detail Page Button

      Behaviour

      Display in new window

      Content Source

      URL

      You are free to enter your own text for the the Label, but for this example we will call it "Associate with Jira Issue".



    8. Under the fields, you will see a large text input field.
      In this text input field, insert the URL from step 1.
      e.g., http://localhost:7800/plugins/servlet/customware/connector/issue/1/Case/associate.action?id={!Case.Id}


       
    9. Click Save.
      A pop-up will warn you that this button "will not be displayed to users until you add it to the page layout", which is what we will do next.
       
    10. Now look for Case Page Layouts and click it.



    11. A list of page layouts for the object will be listed.
      In this example, we want to modify the default Case page layout, which is called Case Layout.
      Go to the pull down menu and choose Edit.



    12. An interactive editor will appear for the object page layout.
      At the top will be a section of the items you can add to your layout, at the bottom is the page layout where you can drag and drop the item to.
      You should see also that at the top of the layout where it says Case Detail are sections for Standard and Custom Buttons.
      We want to add our new button into the Custom Buttons section.
      First, click on the Buttons area of the top section.



    13. Find your new Associate with Jira Issue button (or whatever you labelled it as) in the list and drag and drop it into the Custom Buttons section of the page layout.



    14. Click Save at the top left of the upper section.



    15. You will be taken back to the object page layout listing.
      To verify your changes, go to an object in the instance and check that the page now has your new button.
      If it does not, please check you modified the correct page layout.

    1. You will need to get the correct Jira URL first by copying the URL from the "Associate" Endpoint and replacing the bolded section of the URL with the correct syntax for your object.
       
    2. Go to Salesforce and log in as an administrator.
       
    3. Click on Setup.



    4. Expand the Customize menu under App Setup on the left hand menu.
      This should open up all the objects in your Salesforce instance.



    5. Expand the object that you want to want to add a button for creating Jira issues from.
      In our example we will use Case.
       
    6. Under the object menu you'll see a Buttons, Links, And Actions link.
      Click this.



    7. You will be taken to a listing of the standard buttons and links associated with the object.
      Underneath this list is a list of custom buttons and links.
      Click New Button or Link.



    8. A form will appear for you to enter the details of the new button.
      Fill it out as per below. You are free to choose the "Label" of the button, but for this example we will call it "Associate with Jira Issue":
       

      Label

      Associate with Jira Issue

      Name

      Associate_with_Jira_Issue (this is auto-populated when you add a new label)

      Display Type

      Detail Page Button

      Behaviour

      Display in new window

      Content Source

      URL


      You are free to enter your own text for the the Label, but for this example we will call it "Associate with Jira Issue".



    9. Under the fields, you will see a large text input field.
      In this text input field, insert the URL from step 1.
      e.g., http://localhost:6250/plugins/servlet/customware/connector/issue/3/Case/associate.action?id={!Case.Id})


       
    10. Click Save.
      A pop-up will warn you that this button "will not be displayed to users until you add it to the page layout", which is what we will do next.
       
    11. On the left hand menu, under your object menu, look for the item Page Layouts.
      Click this.



    12. A similar listing of page layouts for the object will be listed as for the buttons page.
      In this example, we want to modify the default Case page layout, which is called Case Layout.
      Click on the Edit link under the Actions column of the layout.



    13. An interactive editor will appear for the object page layout.
      At the top will be a section of the items you can add to your layout, at the bottom is the page layout where you can drag and drop the item to.
      You should see also that at the top of the layout where it says Case Detail are sections for Standard and Custom Buttons.
      We want to add our new button into the Custom Buttons section.
      First, click on the Buttons area of the top section.



    14. Find your new Associate with Jira Issue button (or whatever you labelled it as) in the list and drag and drop it into the Custom Buttons section of the page layout.



    15. Click Save at the top left of the upper section.



    16. You will be taken back to the object page layout listing.
      To verify your changes, go to an object in the instance and check that the page now has your new button.
      If it does not, please check that you modified the correct page layout.

    Notes

    To associate a Salesforce object with a Jira issue, you must have a project mapping in Jira associated with the desired project in Salesforce:

    1. Go to Cog Icon  > Projects.

    2. Under the Project list, click the desired project name.

    3. In the sidebar, click Project Mappings.

    4. Now select the desired Mapping Scheme then click Associate.