Search this space

Live demo

Want to see a live demo and learn what this Connector can do? Join our jam sessions!

Page tree

If you are looking for documentation for the new Salesforce & JIRA Cloud Connector, click here.

Skip to end of metadata
Go to start of metadata

Introduction


This guide will walk you through the process of configuring a link to a JIRA Issue Button.

Creating a button for linking a single or multiple Salesforce object to a JIRA issue(s) is very similar to configuring a Create JIRA Issue button. This button will provide a link or links in a JIRA issue to one or many Salesforce objects in Salesforce, but changes made on one end will not be reflected on the other.

If you would prefer to create a button that associates to a JIRA Issue to a Salesforce Object, please read Configuring the "Associate with JIRA Issue" Button.

Initial Steps


  1. In JIRA a custom field is needed to be created of either Remote Object Link or Multi Remote Object Link.

    1. If you want to link a single Salesforce object to a JIRA issue choose Remote Object Link
    2. If more than one object, choose Multi Remote Object Link.
    After the creation of this custom field, take note of the custom field ID as this will be used in the next step.
  2. Next is to configure the custom field of which Object type it is to be linked with in Salesforce, e.g.: Case, Account, etc.
    In the custom fields listing, choose the custom field created and choose Configure. Next click on the Edit Configurations link.



  3. The next screen will let you choose the Remote System connection and Remote Object Type.
    Choose the Remote System the Salesforce Connection you wish to use.
    Next choose the Object Type in Salesforce and then Save.
  4. On the Mappings section in the Administration under the Cloud Connectors you will need to get the correct JIRA URL first by copying the URL from the "Link" Endpoint and replacing the bolded section of the URL with the correct syntax for your object and the custom field ID created in the first step.



Configuring the "Link to Jira" button


    1. Go to > Setup.



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



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


       
    4. Choose Buttons, Actions, and Links.



    5. 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.



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

      Label

      Link to JIRA

      Name

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

      Display Type

      Detail Page Button

      Behaviour

      Display in new window

      Content Source

      URL




    7. Under the fields, you will see a large text input field.
      In this text input field, insert the URL you obtained from performing Initial Steps.
      e.g.:
      http://localhost:6390/plugins/servlet/customware/connector/issue/9/Case/link.action?id={!Case.Id}&customfieldid={!Remote Object Link}
      OR
      http://localhost:6390/plugins/servlet/customware/connector/issue/9/Case/link.action?id={!Case.Id}&customfieldid={!Multi Remote Object Link Custom Field Id}



    8. 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.

    9. Now look for Case Page Layouts and click it.



    10. 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.



    11. 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.



    12. Find your new Link to JIRA button (or whatever you labelled it as) in the list and drag and drop it into the Custom Buttons section of the page layout.



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



    14. 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. Go to Salesforce and log in as an administrator.

    2. Click on Setup.



    3. Expand the Customize menu under Build on the left hand menu.
      This should open up all the objects in your Salesforce instance.



    4. Expand the object that you want to create a button in.
      In our example, we will use Cases.
    5. Under the object menu, click on Buttons, Links, and Actions.



    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 Button or Link.

    7. For the button form, fill out as per below:

      Label

      Link to JIRA

      Name

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

      Display Type

      Detail Page Button

      Behaviour

      Display in new window

      Content Source

      URL




    8. Under the fields, you will see a large text input field.
      In this text input field, insert the URL from step 4.
      e.g.:
      http://localhost:6390/plugins/servlet/customware/connector/issue/9/Case/link.action?id={!Case.Id}&customfieldid={!Remote Object Link}
      OR
      http://localhost:6390/plugins/servlet/customware/connector/issue/9/Case/link.action?id={!Case.Id}&customfieldid={!Multi Remote Object Link Custom Field 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. In the sidebar, under your object menu, look for the item Page Layouts and click it.



    11. 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.

    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 Link to JIRA 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.

    Page Contents

    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.com that suits your needs.

    Note

    The Salesforce.com 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.

    Where do I find the Custom Field ID?

    1. Go to Cog Icon > Issues
    2. In the sidebar, under Fields, click Custom Fields
    3. Choose your desired custom field, then click on the pull-down menu on the right, and click Configure
    4. Now look at the address bar at the top.
      At the end of the URL, you should see something similar to this:
      "customFieldId=xxxx",
      where xxxx is your Custom Field ID.
    • No labels