Setting up the Rally/Eyes integration

Eyes allows you to annotate any step image in a test result with one or more issue regions. How to do this is described in the article Add issue and remark regions to the step images.

Eyes also allows you to associate an issue region with either a Rally work item or a Jira issue (but not both). This article describes how a user with Eyes team rights can set up the Test Manager so that users can associate issue regions with Rally work items. Once the required setup is performed, you will see the option to create or link to a Rally issue in the Create issue dialog of the Test editor or Step editor. This is described in detail in the article Using the Eyes/Rally integration.


Typically Eyes users will continue to use Rally for their defect reporting workflow. The Eyes/Rally integration augments and extends this flow by providing easily accessed links between the Eyes step issue region and a Rally work item. When a Rally work item is created in Eyes, it is automatically populated with the Eyes information relating to the step:

A user with Eyes team admin rights defines which Rally project, work items and fields are set via Eyes and provides default values. Users that create new Rally work items via Eyes can override the default values using Eyes and create the link. Then, with a single click they can open the Rally UI to the linked work item and fill in any other work item specific details required.

Apart from providing the access and authorization information, the Eyes team admin sets up Rally usage by defining:

  • One or more projects the user can select when creating a new Rally item from an Eyes issues region.

  • The type of work item created for each project.

  • Default values for the work item compulsory fields.

  • Additional optional fields to set and their default values.

  • An option to update Rally when an issue is closed in Eyes.


To set up Rally integration with Eyes, you must have Eyes team admin rights. You will need to provide the obtain and provide the information in the table below as part of the integration process, so we recommend you obtain it before starting the configuration. Note in the 3rd column if the setting is per organization or per team. If the value is per organization then the sames value need to be set for all teams.

The URL of your Rally server   Per Organization
Your Rally API key

If not defined yet in your organization then obtain this value using the Rally create a new API keyfeature at You only need ALM WSAPI Read-only access.

Change the URL to reflect your Rally server name)

Eyes uses the Rally API key to fetch project, workspace metadata, and other non user specific information.

Per Organization
OAuth Client ID and Client Secret
  • If not defined yet in your organization then obtain this value using the Rally Create a new client feature at https://c/login/accounts/index.html#/clients .

    Change the in the URL to reflect your Rally server name).

  • Provide a Callback URL of

    Change the in the URL URL to reflect your Eyes server name.

  • Eyes uses the OAuth client ID and the secret to log in as the user and create the defect with its metadata.

Per Organization
A list of the Rally entities that you want to integrate with Eyes.
  • One or more project names

  • Which work item type you want to create (Defect or User Story)

  • Default values for all the compulsory fields

    List of non compulsory fields you want to set and their default values

Per team

Setup steps

To set up Rally integration with Eyes, take the following steps:

  1. Load the Admin page using the page selector. Select the Teams panel and click the row containing the team you want to configure. On the team configuration page, click on the Integrations tab and then click on the Rally integration section to expand it.
  2. Click on the Enabled toggle so that it is in the highlighted (right) state. A team can integrate with either Rally or Jira. If Jira integration is currently enabled for your team, a warning alert is displayed. You must disable Jira before enabling Rally by entering the Jira section on this page and setting the Enabled button to the disabled state.
  3. Click on the Rally server Set up server button and in the dialog that opens, enter your Rally server URL and API Key, then click the Done button.
  4. After the dialog closes, Eyes tries to connect to Rally using the information you provided. If an error occurs, Eyes will display an error dialog. Click Edit server setup to change the values entered previously.
  5. Click on the Set up OAuth button.
  6. In the dialog that opens, enter the Rally Client ID and Client secret and then click Done.
  7. Click on the Test setup configuration button. In the dialog that opens, enter your user name and password and the click Log in. Eyes tries to log in to Rally using this information.
  8. If the test is successful, then a tick is displayed next to the Test setup configuration button. If the login does not succeed, then an X appears next to the button. Click Edit authentication setup and enter the correct information.
  9. The rest of the integration defines the options that will be available to Eyes users when creating a Rally issue from Eyes. You can define options for each Rally project, and you can set specific options for particular Eyes applications Every Eyes test is associated with an application name and test name. These uniquely identify the test. The baseline for the test is based on these names along with the OS name, the Browser name and the viewport size..
  10. Define which Rally projects Eyes users can report defects to. For the first project, click on the Project name menu and select the Rally project you want to configure.
  11. Now set up that project as follows:
    • Select the Work item type to be associated with that project (only one such work item can be associated with each project).
    • The compulsory fields for the work item type you selected are displayed. Enter appropriate values for each field.
    • You can enable a field that updates Rally when an issue is closed in Eyes.

  12. If you want to add one or more of the optional fields defined for that work item, click Add another field, select the field from the Field name menu and enter the default value. Repeat this step until you have added all of the fields that you want added to the Rally entry when a work item is created from Eyes. The user creating the Rally work item will have an opportunity to change the default value, but a default value must be provided,
  13. If you want to set up another project, click Add another project and repeat the above process with the work items and fields as relevant.
  14. You can set this information on a per-application Every Eyes test is associated with an application name and test name. These uniquely identify the test. The baseline for the test is based on these names along with the OS name, the Browser name and the viewport size. basis by clicking on the menu labeled Applications specific settings. This shows all of the currently defined applications. Select the application you want to configure and then add projects, work items, and fields as described above.