Capture App Screenshot

*The "Capture App Screenshot" trigger allows app builders to capture a screenshot of the Player app and save it as an Image URL datatype. *

In this article, you will learn:

• How to use the Capture App Screenshot Trigger
• Limitations and Watch-Outs for Capture App Screenshot Trigger

This feature was built to help users capture error logs or capture records in a readable state.

How To

In any Trigger, you can use the action Capture App Screenshot to generate an image of the current step view.
You can then:

• Save the image to a variable
• Save it to a Table Record
• Include it in an email or completion

Best Practices

• The Player window must be maximized when taking the screenshot for the best quality of the screenshot.
• The dimensions of the app or step must align with the form factor of the device so that certain floating elements such as “Show message” and “Show error” triggers fall within the active area of the app and are captured in the screenshot.
• Bind the trigger to a button instead of automatically triggering on step enter or app start. Leverage the operator to invoke the trigger once the step has fully loaded including custom widgets as the trigger cannot detect when the user defined logic within a custom widget is done loading.
• Use the trigger sparingly and as an augmentation to other captured data. Images are hard to work with as you need sophisticated tools to process and retrieve information from Images.

Caveats

• The resolution and quality of the image depends on the size of the Player Window.
  • The Image will be a representation of the pixels drawn on the screen of the device. If the Player window is very small, the captured screenshot will be of poor quality. For best results, the Player window should be maximized.
• Only contents within the active area of the app will be recorded.
  • Extra dark blue background will not be part of the screenshot
  • If the height of the window is too large compared to the width, the “Show message” and “Show Error” triggers will not be captured in the screenshot as they would render on the bottom of the window and lie outside the active region of the app.

* For best results, the size of the app or step must align with the size and orientation of the device running player and the Player window must be maximized.

• Screenshot waits for certain assets such as images to finish loading.
  • If there are assets that have not yet fully loaded when the trigger is executed, the trigger waits for the assets to load before capturing the screenshot.
    Note: Assets within custom widgets are excluded from the loading state deduction.

Use Cases

You can use "Capture App Screenshot" to:

1. Record error logs for improvements to troubleshooting.
2. Capture information inputted by an operator in an extremely readable manner.