fbpx
Application Administration

Managing OAuth Consumers

Enterprise Tester uses OAuth to securely share data from Enterprise Tester with other applications including Jira and Confluence. OAuth is used to share Portlets from the Enterprise Tester dashboards with dashboards in JIRA and Confluence.

Configuring OAuth for a Jira / Confluence Consumer

From the Admin tab, double-click on OAuth Consumers to view all existing consumers. Alternatively, you can right-click on OAuth Consumers and select View Consumers.

To add a Consumer such as Jira or Confluence:

  1. Click on Add from the tool bar.
  2. The Edit Consumer screen will open.
  3. For Jira and Confluence the fields that are required to be completed are:

    a. Name
    b. Consumer Key
    c. Public Key

    You can find these details from the Jira or Confluence Consumer Information screen in your instance of Jira or Confluence, which can be found in the following locations:

    http://servername/JIRA/plugins/servlet/oauth/view-consumer-info
    http://servername/confluence/plugins/servlet/oauth/view-consumer-info

    An example of the Jira Consumer Information screen is displayed below:

  4. Once you have added and saved your Consumer information in Enterprise Tester, it will now accept connections from the Jira / Confluence server. All connections can be managed from this screen.

To add gadgets from Enterprise Tester in Jira or Confluence, please refer to the articles Alternative method to add Gadgets to Confluence and Alternative method to add Gadgets to Jira.

Application Administration

Alternative method to add Gadgets to Confluence

Gadget subscriptions in Jira  and Confluence are recommended when adding Enterprise Tester gadgets to Jira and Confluence. However, there are alternative methods available:

This feature is not compatible with On Demand instances of Confluence and Jira.

  1. To add Confluence Gadgets log in to your instance of Confluence and select the Browse Menu, Confluence Admin.
  2. Click the “External Gadgets” link on the left-hand side of the screen.

    In the External Gadgets screen, you will be able to add a new Gadget.  Paste the URL you have already copied from the Enterprise Tester portlet to the clipboard and click ‘Add’.
  3. Go to your Confluence dashboard or page and click the “Insert/Edit Macro” button
  4. Click the “External Content” link. You should see your gadget displayed.
  5. Click on the gadget.  The Insert Macro screen should be displayed.  Click the “Insert” button.
  6. The gadget link will display on your dashboard/page, “Save” your changes.
  7. If you used Shared Authorization, the gadget will now display on your dashboard.
  8. If you used Individual Authorization, the gadget link should now display on your Confluence dashboard or page but will not be authorized. Click on the “Click here to approve access now” link.

    If you are currently logged into Enterprise Tester the authorization screen will appear.  If you are not logged into Enterprise Tester you will need to log in first, then the authorization screen will appear.
  9. Clicking “Allow” or “Deny” here will close the window and refresh the gadget – if you clicked “Deny” an error will be displayed in Confluence gadget indicating access has been denied. If you clicked “Allow” you should see the gadget in Confluence refresh to display the correct content.
  10. Gadget now displays the portlet content from Enterprise Tester within Confluence.
Application Administration

Alternative methods of adding gadgets to Jira and Confluence

Gadget subscriptions in Jira and Confluence are recommended when adding Enterprise Tester gadgets to Jira and Confluence. However, there are alternative methods available:

Note

This feature is not compatible with On Demand instances of Jira and Confluence.

 

  1. Create your dashboard and gadgets in Enterprise Tester as required.
  2. In the gadget you wish to share, click the drawing pin icon in the portlet title bar.

  3. The gadget URL dialog appears.
  4. Select the relevant authorization method as per below:

    Note

    For Jira 6.3+ you must use Shared Authorization.

     

Shared Authorization

The option pre-authorizes the gadget and will display for all users on the Jira Dashboard or Confluence page.

Individual Authorization

  • Select the Individual Authorization tab.
  • click on Copy to clipboard to copy the URL.
  • If you choose the Individual Authorization, when you add the gadget to Jira or Confluence all other users will need to authorize the gadget to view it.

  • To add the gadget to JIRA, follow the help topic Alternative method to add Gadgets to JIRA.
  • To add the gadget to Confluence, follow the help topic Alternative method to add Gadgets to Confluence.
  • Access can also be revoked from this screen or from the User menu, select Manage OAuth Tokens.

Application Administration

Adding Gadgets to Confluence

Enterprise Tester supports the ability to add dashboard gadgets to Confluence, providing the ability to share information from Enterprise Tester with the wider organization.

Confluence can subscribe to Enterprise Tester gadgets at Organization level or for a specific Dashboard.

Note

This feature is not compatible with On Demand instances of Jira and Confluence.

  1. Create your dashboard and gadgets in Enterprise Tester as required.
  2. If sharing is required at an Organisation level;
    – Navigate to the Edit Organisation Page in the Enterprise Tester Admin tab.
    – Copy the Organisation Subscription link.


    If sharing is required at an Organisation level;
    – Navigate to Manage Dashboards via the Dashboard menu
    – Highlight the Dashboard to be shared.
    – Click the Copy gadget URL to clipboard button on the toolbar

  3. To add an Enterprise Tester subscription to Confluence, login to Confluence. Navigate to External Gadgets in Confluence Administration > General Configuration.

  4. Click on the Gadget Feeds tab

  5. Paste the Organisation or Dashboard URL as required and click on Add. Administration functions are now complete.

  6. General users in Enterprise Tester can now go to the gadget that needs to be shared, click on the drawing pin icon in the gadget title bar.

  7. Select the Shared Authorization tab and click on the Share button.

  8. Go to your Confluence page and click the “Insert/Edit Macro” button.

  9. Click the “External Content” link. You should see your gadget displayed.

  10. The gadget link will display on your dashboard/page, “Save” your changes.

  11. Your shared gadget will now display on your dashboard.