List of Automation Helpers | Ranorex
Help CenterUser GuideHands-on application topics

List of Automation Helpers

This is a list of all Automation Helpers offered by Ranorex with instructions on how to use them. Need help adding the Automation Helpers library or updating it? Take a look at ⇢ this page.

In this chapter

    Modules

    The modules included in the Ranorex Automation Helpers can be added by dragging and dropping them from the module browser to your test suite. You can configure the modules in the data binding dialog.

     

    EmailModule

    Use this module to conveniently share and distribute your test results by e-mail.

    The following options are available:

    • Send e-mail on success and/or failure
    • Attach zipped and PDF report to e-mail

    Note that you need to specify the settings of your e-mail server for this module to work.

    ReportToPDFModule

    Use this module to automatically create a PDF version of the report that can be viewed by others who don’t have Ranorex Studio or Report Viewer installed.

    The PDF will be saved to your output folder after the test run has finished. The original report will also contain a link to the PDF file.

    If you want to convert existing reports to PDF, take a look at this blog page.

    CollectRetryErrorMessagesModule

    Test containers can be repeated on failure with the retry count option in the properties. When this is enabled and the test container initially fails but succeeds on a retry, then the report won’t show any of the related error messages. This module changes just that.

    Add it to a test container for which a retry count >= 1 is set. The module will then collect all error messages and add them to the report.

    User code methods

    The user code methods included in the Ranorex Automation Helpers can be accessed in the ⇢ user code library. Select the desired method, define the required strings, and confirm your selection.

    DragNDropLibrary

    DragAndDrop

    Picks the source element, drags it to the target element and drops it there.

    EmailLibrary

    SendEmail:

    Sends an e-mail. Note that you need to specify the settings of your e-mail server for this method to work

    FileLibrary

    AppendStringToExistingFile

    Opens an existing file and adds a new line of text at the end of it.

    CheckFilesExist

    Checks if files in a directory exist.

    DeleteFiles

    Deletes files.

    WaitForFile

    Repeatedly checks if files in a directory exist.

    WriteToFile

    Creates a log file containing a custom text in the output folder.

    PopupWatcherLibrary

    StartPopupWatcher

    Waits for a popup window to appear and clicks an element to close the window. Running popup watchers will use resources. Make sure to stop them when they are no longer needed.

    StopPopupWatcher

    Stops and removes an active popup watcher.

    StopAllPopupWatchers

    Stops all active popup watchers.

    StringLibrary

    ConcatStrings

    Concatenates two strings and returns the new string.

     

    SystemLibrary

    KillProcess

    Kills a process.

    StartTimer

    Starts a new timer.

    StopTimer

    Stops a timer.

    Validation Library

    CompareValues

    Compares two values.

    WebLibrary

    DownloadFile

    Downloads a file and stores it locally.