Manage Repository Items

Once items are part of your repository, you have several ways to edit and manage them. This article describes the available options.

Screencast: The screencast Manage repository items walks you through the concepts in this article.

Ranorex Studio assigns repository item names automatically based on what the corresponding UI elements are called within the tracked application. Sometimes, these names can be cryptic or too generic, making it hard to navigate the repository. You can rename repository items to make it clearer what they do.

1. Select the repository item and press F2
2. Rename the repository item and press Enter
3. The name of the repository item is changed
   

Tip: Use clear, descriptive names that reflect the element’s role. This makes large repositories easier to maintain.

Repository items can be copied, moved, and deleted as usual. However, moving and deleting can cause issues if:

• You move repository items across logical boundaries in the repository.
• You delete repository items that are linked to one or more actions.

Move across logical boundaries

Ranorex organizes repository items in logical groups called folders. A folder always contains references to UI elements that share the same base position in the UI. This concept is explained in detail in Structure repository items.

When you move a repository item from one folder to one with a different base path, you also alter the repository item’s base path. As a result, Ranorex likely is not able to find the UI element anymore, and any actions linked to this repository item will fail during test execution. Ranorex will ask you for confirmation when you attempt to move an item in such a way.

1. When you move a repository item from one folder to another with a different base path.
2. Ranorex displays a dialog explaining the consequences and asks you for confirmation.
   

Note: This only applies to app folders and rooted folders. Simple folders are not affected because they don’t have a base path.

Delete a linked repository item

When you delete a repository item that is linked to one or more actions, the actions will stop working. If you want to remove unused repository items, use the Cleanup function instead

1. Select a repository item and delete it.
2. The repository item is removed from the actions it was linked to. The actions won’t work anymore.
   

When a repository item is created, a screenshot of the corresponding UI element is also saved. It can be viewed in the repository. When the UI element changes in appearance, you may need to update it. 

The option Update screenshot allows you to do this quickly without having to retrack the UI element.

1. Update screenshot option: Right-click the repository item whose screenshot you want to update and click Update screenshot.
2. The screenshot: If the UI element can be found and is visible, the screenshot is updated.
3. Error message: If the path is invalid or the AUT is not running or not showing the element, an error message is displayed.

Sometimes it can be hard to determine exactly which UI element a repository item references. The Highlight element option helps you verify the link.

1. Right-click the desired repository item and click Highlight element.
   

2. The UI element is highlighted in the application for a few seconds with a blinking red frame
   

   Note: Ranorex may take a while to find the corresponding UI element. If the path is incorrect or the containing application hasn’t been started, Ranorex won’t be able to find the element.
    

This option is useful for image validations. Normally, when you record an image validation, the validation screenshot will be created automatically. However, you can also add the validation screenshot manually. You can also add several validation screenshots to a single repository item. This is useful when image-validating the same UI element in different states (for example, a traffic light status field). The option Add validation screenshot lets you do this.

1. Right-click the repository item and select Add validation screenshot.
2. A screenshot of the current state of the UI element is added to the corresponding repository item

Note: This option only works if the AUT is opened and the respective UI element is visible.

Save screenshot

Once a validation screenshot has been added to a repository item, you can save it to any destination on your system. To do so, right-click the screenshot and click Save screenshot.

Tip: You can then restore the saved screenshot using the image editor.

In large test projects, a repository item may be referenced in many modules and/or pieces of code. It can be useful to check where exactly the repository item is used before you make changes to it. The two context menu options, Find test module references and Find code references allow you to do so.

Find test module references

This option shows you all test modules where the repository item is referenced.

1. Right-click the desired repository item and select Find test module references.
2. The references appear in the search results at the bottom of Ranorex Studio.
   

Finding code references

This option shows you all code instances where the repository item is referenced.

1. Right-click the repository item, select Find code references, and select one of the two options.
2. The code references are displayed in the search results at the bottom of Ranorex Studio.
   

Each repository item also has a set of properties that can be configured in its Properties panel.

1. Right-click the desired repository item and select Properties.
2. The properties are open to the right of the repository.

List of properties