Capture Screenshots

Set up automated screenshots

Configure app logins, protect sensitive data, and test screenshot access as a workspace Admin.

Set up automated screenshots

Automated screenshots let Pageloop sign in to your app and capture screens for documentation. You supply an app account and instructions; Pageloop opens a hosted browser session as that account. The account's permissions determine which screens Pageloop can reach.

You must be a workspace Admin. These steps apply when Settings shows Automated screenshots under Capture.

Choose an account and protect your data

Create a dedicated app account for documentation rather than sharing your personal login. Give the account only the permissions needed for the screens you want to document. Your Pageloop Admin role does not mean the app account also needs administrator access. Prefer a staging or demo environment with representative, non-sensitive data when possible.

The account must support email and password sign-in. Google sign-in, SSO, and one-time codes are not supported. Pageloop signs in only on the app's own address; a flow that redirects to a different sign-in origin will fail. Use an HTTPS app address reachable by the hosted browser, not localhost or an IP address.

Pageloop stores the credentials encrypted. The saved password is not returned to the settings page. Enter credentials only in Email and Password, not in the app URL or free-text instructions.

Before allowing documentation runs to use the login, configure its Capture Rules:

  • Never Visit blocks paths that Pageloop must not open. For example, /billing/* covers /billing and its descendants. Enter paths, not full URLs, and omit query strings and fragments.
  • Hide personal data covers emails, avatars, and fields marked for privacy before an image is saved. This is on by default. It does not promise to hide every sensitive value or every person's name; use safe sample data and review the captured images.
  • Rules describes what Pageloop may and may not do after sign-in. For example: “Do not submit forms or click Delete, Remove, or Pay.” Keep the app account's permissions restricted as well as writing rules.

Add and save a login

  1. Open the Account menu in the top bar and select Settings.

  2. Under Capture, select Automated screenshots.

  3. Select Add a login to open New login.

  4. Enter Name to identify the app or environment, such as “Staging”. Optionally enter Role to describe the view, such as “Viewer”. The role label describes the account; it does not grant permissions in your app.

  5. Complete the sign-in fields:

    FieldWhat to enter
    App URLYour app's full HTTPS address.
    Login PageThe path to the login form, such as /login.
    Land OnAn optional path that a successful sign-in should reach, such as /app/home.
    Email and PasswordThe dedicated app account's credentials.
    InstructionsSteps Pageloop needs to reach the password form or complete sign-in, such as choosing email sign-in first, selecting a workspace, or dismissing a consent screen.
  6. Select Save and test login. Pageloop saves the login and starts a fresh sign-in test. A new login stays off until the test passes; passing turns it on automatically.

  7. Select the saved login, open Capture Rules, configure the protections described above, and select Save changes. Avoid starting documentation runs until these rules are saved.

You can save separate logins for different environments or app roles, up to five per workspace. Select a login in the Logins list to manage it.

Update a saved login

Use Sign In to edit its address, credentials, or instructions. Leave Password blank to keep the stored password. Select Save and test after changing sign-in details: saving clears the saved session, switches the login off, and starts another test before the login can be used again.

Changes to identity labels or capture rules use Save changes. Unsaved edits are not used by Test Login. Use the login's On/Off switch to stop captures from that account without deleting its configuration.

Test access and read the result

For a saved login, select Test Login. The test performs a fresh sign-in rather than relying on a saved session. Watch the four stages in the dialog:

  1. Reach the app address.
  2. Sign in with the saved account.
  3. Follow your instructions, or fill the login form when no instructions are supplied.
  4. Reach Land On, if configured, or confirm that Pageloop got past the login page.

Pageloop got in means sign-in succeeded and the login is ready to capture. The login turns on, and its status reads Verified. Later documentation runs can reuse the saved session; if the session expires, Pageloop signs in again.

Test Login checks access, not the finished screenshot. It does not verify that every screen needed for an article is available or produce a documentation image to review. After the login passes, request an article through Write an article and specify the screen, environment, and account view you want captured. Review the proposed images in Inbox before approving the documentation.

Open the login's Activity tab to see test results and documentation runs. A run's screenshot count shows images taken; the changed count shows images added or replaced in its proposed changes. Follow the run title to inspect its result. A capture count alone does not mean an image was included in an article or published.

Fix a failed test or capture

Read the failed stage and explanation rather than changing credentials for every error. Fix the instructions opens Sign In with the instructions field ready to edit; other fields may need correction too.

Result or symptomWhat to fix
Could not find a password form, or tried five steps without reaching oneCheck Login Page. Describe how to select email sign-in or reach the password field in Instructions. Do not substitute an unsupported SSO or one-time-code flow.
Sign-in left the app's addressUse an email/password flow on the same origin as App URL. Instructions cannot authorize sign-in on another origin.
Submitted the form but stayed on the login pageVerify the app account's email and password and check the expected Land On path. Save corrected sign-in details and retest.
Invalid address or could not reach the appCheck App URL, HTTPS, app availability, and whether the hosted browser can reach the environment.
Test ran out of time or could not startRead the explanation. Wait for an existing test or the indicated retry period, then retry. A timeout or browser-service failure does not by itself mean the credentials are wrong.
Test stopped because the login changedFinish saving the intended settings, then run Test Login again. The superseded result is discarded.
Test is taking longer than expectedCheck the login's Activity later; the dialog can stop waiting before the worker finishes.
Login passes, but a documentation run cannot capture the intended screenCheck that the app account has access, the screen exists in the selected environment, and Never Visit or Rules does not prohibit the requested task. Inspect any Browsing blocked explanation in Activity. Do not remove a necessary security restriction just to obtain an image.

A confirmed sign-in failure switches the login off and shows Sign-in failed. Correct the saved settings and pass Test Login to restore it. Infrastructure errors such as timeouts are recorded on the test but do not automatically mark a working login's credentials as failed. If failures persist after checking the app and retrying, share the result and failed stage with your Pageloop contact, not the password.