Note: You are looking at a static snapshot of documentation related to Robot Framework automations. The most recent documentation is at https://robocorp.com/docs

Screenshot

Sets the directory where screenshots are saved.

Arguments

ArgumentTypeDefault value
pathnull

It is possible to use / as a path separator in all operating systems. Path to the old directory is returned.

The directory can also be set in importing.

Takes a screenshot in JPEG format and embeds it into the log file.

Arguments

ArgumentTypeDefault value
namescreenshot
width800px

Name of the file where the screenshot is stored is derived from the given name. If the name ends with extension .jpg or .jpeg, the screenshot will be stored with that exact name. Otherwise a unique name is created by adding an underscore, a running index and an extension to the name.

The name will be interpreted to be relative to the directory where the log file is written. It is also possible to use absolute paths. Using / as a path separator works in all operating systems.

width specifies the size of the screenshot in the log file.

Examples: (LOGDIR is determined automatically by the library)

Take Screenshot# LOGDIR/screenshot_1.jpg (index automatically incremented)
Take Screenshotmypic# LOGDIR/mypic_1.jpg (index automatically incremented)
Take Screenshot${TEMPDIR}/mypic# /tmp/mypic_1.jpg (index automatically incremented)
Take Screenshotpic.jpg# LOGDIR/pic.jpg (always uses this file)
Take Screenshotimages/login.jpg80%# Specify both name and width.
Take Screenshotwidth=550px# Specify only width.

The path where the screenshot is saved is returned.

Takes a screenshot and links it from the log file.

Arguments

ArgumentTypeDefault value
namescreenshot

This keyword is otherwise identical to Take Screenshot but the saved screenshot is not embedded into the log file. The screenshot is linked so it is nevertheless easily available.