How‐to Run a Custom Flow Scan - GovTechSG/oobee-desktop GitHub Wiki

We will be going through steps to run a post-login accessibility scan on a digital service with Singpass login.

About Custom Flow

  1. It allow users to scan any page that is open in the Custom Flow session.
  2. Unlike the original Custom Flow, there is no record and replay step.
  3. You need to be running Oobee Desktop 0.10.0 or above.
  4. Please install Oobee by following the Installation Guide.

Steps to run

1. Choose Custom Flow

  • Launch Oobee Desktop and enter the starting page URL to scan.
  • Select "Advanced scan options" and choose "Custom flow" scan type.
  • You may customise other options such as to include / exclude screenshots in the report, etc.
  • Click Scan button.
  • Please note it may take a minute or so to load Custom Flow 2.0 the first time. Subsequent runs will load faster.

2. Navigate and Fill-in Forms on the Same Page

  • A new browser window will load with a horizontal bar at the top with "Scan this page" button.
  • You can drag the horizontal bar to the bottom of the screen if it blocks any elements on the top of your page.
  • Conduct all the actions you need on the current screen (e.g. fill-in forms).
  • Do not click on an action that will bring you to a different screen.

3. Click Scan this page

  • When you are confident you have done all actions on the current screen, click "Scan this page" button.
  • The horizontal bar will disappear and Oobee will run the accessibility scan on the current page. You may see the page scrolling up and down as screenshots are being captured.
  • Do not click on anything on the page until the horizontal bar with the "Scan this page" button re-appears.
  • The count of "Pages scanned" on the horizontal bar will increment by 1 each time a page is scanned.
  • You will also notice that Oobee scan progress screen will show a list of current pages scanned.

4. Navigate to new pages

  • You may now proceed with actions that will load a new screen.
  • Repeat steps 2 and 3 for each new screen by filling up any form fields and click "Scan this page" again.

5. Close the browser

  • When you are done or logged out of the digital service, close the browser.

6. Enter a Custom Flow Label

  • You will now be prompted to enter a label. This is a free text description for you to identify what you scanned in future.

7. Scan Completed

  • Oobee screen show the Scan completed screen.
  • Click View report to view your scan results.