Scan An Existing Application

The scanner is an accelerator for scanning existing web applications to quickly assemble and create page objects which can be consumed directly in your automation Framework.

Performing Your First Scan

  1. Install the browser extension in your Chrome web browser

    • Login to the portal you have registered with.

  • Navigate to the dashboard screen.

  • Click 'Install Recorder' and follow the link to the Chrome WebStore.

  • Follow the instructions to perform installation of the extension. Once it's complete you should see the extension available in the top right of the chrome browser.

2. Open the browser extension by clicking on the extension icon. At this point you should be asked to sign in.

3. Sign in to the browser extension with your credentials.

4. Select the workspace, project, and release you would like to connect into.

5. Perform your first application scan to automatically create page objects.

  • Make sure the extension is in scanning mode by flipping the switch to 'Object Builder' mode.

  • Hit the start button to begin.

  • Click on the elements you want to scan in your app. Notice they turn red as you click them. This indicates the object has been successfully detected by the scanner and registered.

  • Once you're finished, re-open the extension and hit 'Stop'. If you need to take a break from scanning or need to perform an interaction on the page (e.g. opening a sub-menu) you can click pause and then resume scanning on the desired objects.

6. Review scanned items by clicking the review button. Here, you can edit the identifiers chosen and even manually add your own scans for any objects that haven't been picked up by the scanner (this may happen for advanced user-interface types and actions).

7. Upload the scan to the portal.

  • Click the upload button.

  • Select where to create the page objects with the associated scanned elements into your workspace.

  • Also don't forget to name your creation. Note: you'll need to provide a unique name for the module or you'll be asked to perform a merge against an existing object (this is useful if you need to perform maintenance against an existing object).

Integrate The Page Object Code

  1. Navigate in to the location you uploaded the page object.

  2. Two files should be present. Firstly, a page object which contains the identifiers for the scanned objects. Secondly, an automation module which contains the physical implementation of the page object (in this case the associated java page object). Learn more about these files here.

3. Open the automation module (highlighted above).

4. Click the download button to retrieve and download the corresponding automation code for the module.

5. Place this code in your framework. Using the example framework (above) the page objects you should copy this .java file into the framework\src\main\java\Pages directory.


Compile to check the generated code is valid

It is useful to check your automation framework is up-to-date and compiling correctly. Within the automation framework directory you can perform a compilation at any time using the mvn clean package command