Release notes¶
Upcoming release¶
7.6.0¶
Library RPA.Outlook.Application: Fix
ActiveDocument
bug when closing OutlookLibrary RPA.Email.ImapSmtp: Convert non-literal values in
List Messages
response to stringsLibrary RPA.Desktop.Windows: Add keyword
Set Automation Speed
7.5.0¶
Library RPA.Email.Exchange:
Fix sub folder bug with
Move Messages
Add keyword
Save Attachments
Add
criterion
parameter toList Messages
for filteringAdd
save_dir
parameter toList Messages
for saving attachmentsAdd more details into returned messages
Library RPA.Database:
Fix bug with
Call Stored Procedure
Hide details of
Connect To Database
from Robot Framework logs
7.4.2¶
Library RPA.Email.ImapSmtp: Fix errors in server folder handling
Library RPA.Desktop: Use correct default application when opening files on Windows
Fix integer handling in
Notebook Print
core keyword
7.4.1¶
Library RPA.Outlook.Application: Fix HTML email body issue
7.4.0¶
Library RPA.Browser.Selenium:
Add parameter
user_agent
for keywordsOpen Available Browser
andOpen Chrome Browser
Add keyword
Execute CDP
to execute Chrome DevTools Protocol commands
Fix issues with Windows library imports on Python 3.9
7.3.0¶
Library RPA.Desktop.Windows:
Open File
performs theOpen Dialog
call only if windowtitle is givenExpose
timeout
parameter forOpen File
keyword
Library RPA.Browser.Selenium:
Keyword
Open Available Browser
now prints table of attempts to Notebooks on error
Library RPA.JSON: Add optional default for fetching values
7.2.0¶
Library RPA.Desktop.Windows:
Add keyword
Refresh Window
to support element re-evaluation when UI changesImprove
Restore Dialog
keywordAdd experimental support for combined locators like
name:element1 and type:Button
Add window title wildcard support for keywords starting applications and
Open Dialog
Fix
Quit Application
error when using process id to quitAdd
focus
parameter toMouse Click
keywordAdd
legacy
andobject
attributes to element dictionaryFix
Wait For Element
error when asserting number of elements to waitFix
Open File
by adding parameters to control window it opensFix
Connect By Handle
parameter type to int
Library RPA.Desktop.OperatingSystem: Add keyword
Process ID Exists
Library RPA.Browser.Selenium:
Add keyword
Print to PDF
Increase headless Chrome window size
Library RPA.PDF:
Add possibility to get textboxes (text and its coordinates) with keyword
Get Text From PDF
Add possibility to set anchor to point or area for keyword
Get Value From Anchor
7.1.1¶
Library Desktop.Windows:
Fix Open Executable error not taking control of the window
Address window resizing issue with Open Dialog
7.1.0¶
New library Crypto for common hashing and encryption operations
Library Cloud.Google: Improve help and error messages for
rpa-google-oauth
toolLibrary Desktop: Handle locators with whitespace, allow using return values as arguments
Library Dialogs: Throw error if user closes browser, add timeout to response
Library Excel.Application:
Expose
header
argument inCreate Worksheet
Fix issues with worksheet access in keywords
Deprecate argument
tabname
in keywordAdd new sheet
Add more helpful error messages
Library FileSystem: Add keyword for reading file owner
Constrain version of
comtypes
dependency to fix issue with Windows DLLs
7.0.5¶
Fix issue with pip resolving incompatible chardet version
7.0.4¶
Library Desktop.Windows: Remove library destructor actions
7.0.3¶
Library Desktop.Windows: Fix possible COM exception when gathering elements from a window
7.0.2¶
Library Cloud.Google: Remove unnecessary log message
7.0.1¶
Library Cloud.Google: Fix how authentication scopes are initialized
7.0.0¶
Library Desktop:
Add initial version of OCR support
Add syntax for locator chaining
Add built-in buffer time between keyboard/mouse inputs
Add built-in wait period for all locators, instead of failing immediately
Add preview images for matched locators in Robot Framework log
Library Cloud.Google:
Add support for Apps Script service
Add support for Drive service
Library Desktop.Windows: Add more properties into dictionary returned by
Get Window List
Library Email.ImapSmtp:
Add keyword
Move Messages
Add source folder parameter to
List Messages
Add limit to
Delete Messages
Add keywords to add/remove labels from GMail messages
Add keyword
Do Message Actions
for performing custom set of actions on selected messages
RPA.Browser libraries
RPA.Browser.Playwright has been added, enabling use of playwright based robotframework-browser library
RPA.Browser was moved to RPA.Browser.Selenium, and the old import RPA.Browser is kept as deprecated alias for now
Library Tables: Correctly handle empty fields when filtering
6.7.3¶
Fix issue with pip resolving incompatible chardet version
6.7.2¶
Add
docutils
as dependency to fix robotframework-lsp support
6.7.1¶
Library Desktop: Fix moving mouse to image template
6.7.0¶
Library Excel.Files:
Add keyword for inserting images to worksheets
Fix off-by-one issue with
Find Empty Row
return value
Library Desktop:
Store screenshots in unique path by default, embed preview in logs
Resolve image templates correctly with different working directories
Library Excel.Application:
Add keyword
Find First Available Cell
to return free cellKeyword
Open Workbook
will set first worksheet active by default
Library PDF: Fix error when parsing figures in the document
Library Database: Add support for
pymssql
database module
6.6.0¶
Library Tables: Add various helper keywords:
Merge Tables
for merging tables, with an optional shared keyFind Table Rows
for finding rows with a specific column valueSet Row As Column Names
for setting an existing row as header
Library Browser: Add keyword
Highlight Elements
for highlighting elements that match a selectorLibrary RPA.Desktop: Fix macOS coordinate scaling when using image template locators
Remove dependency to
python-evdev
on Linux
6.5.0¶
Library Excel.Application: Fix for finding first available row.
Add missing variables for Robot Framework library scope and documentation format
Add more verbose library docstrings in general
6.4.0¶
Library Browser: Add
Set Download Directory
keywordLibrary Cloud.AWS: Add keywords for Textract asynchronous operations regarding document analysis and text detection
Library Dialogs: Default value support for input text element (pull request #70)
Library Desktop.Windows:
Mouse Click
keyword supports now also element dictionary as target locator
6.3.1¶
Library Desktop.Windows: Add parameter to
Get Element
to prevent opening dialog
6.3.0¶
Library Desktop: Image template confidence changed to logarithmic scale
Library HTTP: Directory support for download target
Reduce logging in keyboard emulation keywords, e.g.
Send Keys
, to prevent accidentally logging sensitive information
6.2.0¶
Library Desktop.Windows: Add timeout parameter for keywords
Open From Search
andOpen Using Run Dialog
6.1.0¶
New library JSON for manipulating JSON objects
6.0.2¶
Library Desktop:
Library scope changed to global
Obey default image locator confidence
6.0.1¶
Library Desktop: Fix case handling with default locator
6.0.0¶
Library FileSystem: Replace
force
arguments withmissing_ok
to match python APILibrary Desktop: Initial release of new cross-platform desktop automation library
Library Dialogs: Add library initialization arguments to change server port and form stylesheet
Library Robocloud.Items: Remove invalid assert on file overwrite
Library Browser:
Add new option to allow missing elements with status keywords such as
Is Element Visible
Set Chrome argument
disable-dev-shm-usage
by default in all environments
5.3.3¶
Library Images: Fix duplicate region matches, timeout option
Library Robocloud.Items: Allow saving files with FileAdapter
5.3.2¶
Library Robocloud.Items: Fix relative path inputs, always return absolute paths.
5.3.1¶
Library Robocloud.Items: Fix accessing unsaved files from items
Library Tables: Fix creating empty table with predefined columns
Library Database: Fix
Query
keyword bug when SELECT result is empty
5.3.0¶
Library Robocloud.Items: Support for files in work items
Library Dialogs: Type hinting and documentation updates
Library Images: Raise error when timeout has been reached
5.2.0¶
New library Dialogs which allows getting input from the user via HTML forms
5.1.0¶
Library Browser: Add keyword
Get Browser Capabilities
Library Cloud.Google: Add Google Sheets service support
5.0.0¶
Library Database:
Drop dependency robotframework-databaselibrary
Some of the old keywords do not exist anymore and some new keywords have been added (NOTE. backwards compatibility breaking change)
Library PDF: Keywords
Template HTML To PDF
andHTML To PDF
will now create directory structure and overwrite existing file by default.Library Images: Remove
Save Format
option fromTake Screenshot
andCrop Image
keywords. Change screenshotting library frompyscreenshot
tomss
.
4.2.0¶
Library Browser:
Add keywords
Does Alert Contain
andDoes Alert Not Contain
Fix
Screenshot
to explicitly callNotebook Image
to insert images into notebook when that is available
Library Robocloud.Items: Allow NoneType as default for variables
4.1.0¶
Library Browser: Add keyword
Open User Browser
which opens URL with user’s default browser. Allows using browser’s existing cache. To control this browser see keywordAttach Chrome Browser
or useDesktop.Windows
library to control the browser
4.0.0¶
Library Browser: Change keyword
Screenshot
to embed Base64 image string into log and save same Base 64 string to a file as png image (NOTE. backwards compatibility breaking change)Library Desktop.Windows:
Fix Windows backend handling to be consistent within a library
New keyword
Set Windows Backend
3.0.0¶
Upgrade
Robot Framework
to 3.2.2Upgrade
pyscreenshot
to 2.2Library Email.ImapSmtp:
Add keyword examples (documentation)
Change
List Messages
to return list of dictionaries containing message attributes. In addition there is attribute Has-Attachments for each message (NOTE. backwards compatibility breaking change)Add keyword
Save Attachment
which can be used save attachments from a message. Can be used when looping through messages received byList Messages
Library Desktop.Windows:
Add keyword examples (documentation)
Add keyword
Get Text
. Returns dictionary of possible values due to many implementation methodsAdd parameter empty_field to keyword
Type Into
which will empty field before typing into a fieldAdd keyword
Wait For Element
which will search for element with timeoutAdd more information about started app instances into application list
Library Desktop.OperatingSystem:
Add keyword examples (documentation)
Add keyword
Kill Process By PID
to terminate process using its identifier
Library Browser:
Add keyword examples (documentation)
Add proxy parameter for keywords
Open Available Browser
andOpen Chrome Browser
. Works only for Chrome at the moment
2.7.0¶
Desktop.Windows: Fix window dialog handling in
Open Executable
keywordNew Archive library for ZIP and TAR operations
core.notebook: Add parameter count to control row output from keyword
Notebook Table
2.6.0¶
Browser: Do not EMBED screenshots when in notebook run mode
Excel.Application: Add keyword
Read From Cells
RobotLogListener: Add keyword
Mute Run On Failure
to mute SeleniumLibrary’srun_on_failure
behaviourEmail.ImapSmtp: Fix filetype issue when adding attachments to emails
Tables and Excel.Files: Move table trimming actions from Excel.Files library to Tables library. Added parameter
trim
to Tables keywordCreate Table
which is by default FalsePDF: Fix input field setting and saving to PDF
2.5.1¶
Browser: Fix missing default argument
2.5.0¶
Browser:
Attempt fallback browser if webdriver unpacking fails
Attempt to use webdriver from PATH
Add option to define Chrome profile path and name
Add option to define Chrome profile preferences
Add keyword to attach to existing Chrome instance
Add keyword for waiting and clicking elements
Disable Chrome’s password manager prompts
Robocloud.Items: Allow empty list (or otherwise falsy value) as raw payload
Desktop.Windows:
Add keyword
Type Into
Remove confusing placeholder keyword(s)
Excel/Word/Outlook.Application: Use early binding to ensure constants exist
Tables: Fix issues with invalid internal method calls
Email.ImapSmtp:
Use given IMAP port
Fix confusing error message if TLS not supported
2.4.0¶
Browser: Add alias support for
Open Available Browser
Browser: Fix indexing issues with multiple
chromedriver
instancesBrowser: Reduce superfluous logging from keywords
Robocloud.Items: Add keywords for reading and writing full payloads
2.3.0¶
New FTP library, which interacts with FTP servers
Use RPA.core.notebook* library to output data into Jupyter Notebook (in Robocode Lab especially). Support added to keywords in the following libraries: **Browser, FTP, HTTP, Images, PDF, Twitter, Tables and Robocloud.Items
Browser sets default screenshot directory to EMBED which means that when using keywords
Capture Page Screenshot
orCapture Element Screenshot
without filename argument the image is embedded into log.html as Base64 image
2.2.0¶
Robocloud.Secrets: Add support for Robocloud end-to-end encryption
FileSystem: Add
exist_ok
argument forCreate directory
keywordTasks: Fix support for FAIL status in schema actions
Tasks: Allow inlining execution graph in log (enabled by default)
Excel.Files: Always fallback to legacy mode on error
Tables: Fix manual override for CSV dialect, document arguments
Desktop.Windows: Attach to windows more reliably, and show helpful message on error
2.1.0¶
FileSystem: Fix keyword
Normalize Path
to match built-in library, and add new keywordAbsolute Path
for previous functionality.PDF: Fix keyword
Template HTML To PDF
to handle HTML content from non-English Chrome browser.PDF: Add keyword
HTML To PDF
which takes HTML content as string parameter.Email.Exchange: Fix
Authorize
when autodiscover is set to False. Add missing parameters to keyword.New Notifier library, which allows using notification services like Slack, Gmail, Pushover etc.
2.0.1¶
Browser: Fix for regression in Chrome’s Webdriver version handling
Email.ImapSmtp: Fix how IMAP server is initialized
Fix for issue with missing files when upgrading from version 1.x
2.0.0¶
NOTE: Changes to Email.ImapSmtp and Email.Exchange are backwards compatibility breaking changes.
Browser: Added support for locator aliases
Browser: Upgrade
SeleniumTestability
plugin to 1.1.0 versionBrowser: Remove “..controlled by automated..” infobar by default when using Chrome
Email.ImapSmtp library initialization parameter port split to smtp_port and imap_port (breaks backwards compatibility)
Email.ImapSmtp: Add keywords for folder management and marking messages as read/unread and flag/unflag
Email.Exchange library keyword
list_messages
parameter order changed - new order folder_name, count (breaks backwards compatibility)Email.Exchange: Add keywords for folder management
Email.Exchange: Add keywords
Wait For Message
andMove Messages
Core functionality separated into
rpaframework-core
package
1.4.0¶
Robocloud.Items: Add keywords for listing and deleting variables
Windows: Add keyword
Get Window List
Windows: Fix keywords
Connect By PID
andConnect By Handle
1.3.0¶
New features for Browser library
Set headless mode with environment variable
RPA_HEADLESS_MODE=1
New boolean returning keywords like
Is Element Visible
andDoes Page Contain
New keyword
Get Element Status
to get 4 different element states in a dictionaryAdded plugin
SeleniumTestability
which can be enabled withLibrary RPA.Browser use_testability
In total 40 new keywords
OperatingSystem: Improve error messages on keywords restricted to specific operating systems
1.2.1¶
Cloud libraries: Fix
use_robocloud_vault
to support alsoFileSecrets
1.2.0¶
Add support for Robocloud Vault for the following libraries:
Cloud.AWS
Cloud.Azure
Cloud.Google
Images: Automatically convert points/regions from strings
Outlook.Application: Add keyword
Wait For Message
1.1.0¶
New Tasks library, which allows using flow control between tasks
New Cloud.Azure library, which supports following Azure APIs:
Text Analytics
Face
Computer Vision
Speech
Cloud.AWS: Fix parameters and return options for keywords
Detect Document Text
andAnalyze Document
1.0.4¶
Excel.Files: Add keyword for setting cell values
Excel.Files: Mitigate compatibility issues with file extensions
1.0.3¶
Excel.Files: Fixed double close issue with workbooks
Excel.Files: Ignoring columns with empty header
Tables: Improved handling of non-string columns
1.0.2¶
msoffice: Fix. Call close document only on Word documents
Browser: Fix Geckodriver downloading version based on Chrome version
Thank you https://github.com/mdp for providing fix for the msoffice
1.0.1¶
Tables: Added keywords
Get table slice
andRename table columns
Excel.Files: Fixed various issues with appending data to empty worksheet
Outlook: Fix attachment handling
1.0.0¶
MAJOR change. Package has been renamed to
rpaframework
. The old PyPI package will continue to work for a while (not receiving updates anymore), but it will be removed before official GA launch in the beginning of July.
0.11.0¶
Cloud.Google: Added as optional package, needs to be installed with
pip install rpa-framework[google]
Support for services:
Google Cloud Natural Language
Google Cloud Speech to Text
Google Cloud Storage
Google Cloud Text to Speech
Google Cloud Translation
Google Cloud Video Intelligence
Google Cloud Vision
Excel.Files: Minor documentation update
0.10.1¶
Email.Exchange: Fix parameter handling for kw
send_message
0.10.0¶
Email.Exchange: Add support for
HTML
content,attachments
, and inlineimages
Email.ImapSmtp: Allow sending inline images - parameter
images
for kwSend Message
HTTP: Return response of
Download
keyword (including content)Cloud.AWS: Due to
boto3
dependency size, library requirespip install rpa-framework[aws]
to use
0.9.3¶
New library: Cloud.AWS, supporting following services:
Comprehend
S3
SQS
Textract
Tables: Add keyword
Get table dimensions
, allow setting arbitrary cell valueNew library: Twitter
0.9.2¶
Updated Robot Framework to 3.2.1
0.9.1¶
Email.ImapStmp: Fix attachment handling for kw
Send Message
Excel.Application: Add keyword
Run Macro
PDF: Add keywords:
Parse PDF
Get input fields
Update field values
Set field value
Set anchor to element
Get value from anchor
Add image to PDF
Save PDF
Dump PDF as XML
0.9.0¶
Tables:
Note: This change is backwards incompatible
Removed limitation of column names being valid Python identifiers
Default iteration method changed to dictionaries instead of namedtuples
Keywords that return rows or columns now harmonized to return them in dictionary format by default, with option to use lists
Table head/tail keywords changed to return new Table instance
Added keyword for trimming extra whitespace from column names
Excel.Files: Trim column names in addition to rows
0.8.7¶
OperatingSystem: psutils dependency marked as Windows only because it has wheel files only for Windows
0.8.6¶
HTTP:
Add keyword
Download
Add
overwrite
option toHTTP Get
FileSystem:
Fix string interpolation in error messages
Add
force
option for file removal keywordsAdd
overwrite
option for file create keywords
Tables: Add keyword
Trim empty rows
Excel.Files:
Add keyword
Read worksheet as table
Auto-convert integer values in .xls worksheets
0.8.5¶
PDF: Add
Encrypt PDF
andAdd Pages To Source PDF
keywords.Windows: Add aliases for element locators, for better Robocode Lab compatibility
HTTP: Add keyword
HTTP Get
Tables: Fix missing cell values for sanitized columns
0.8.4¶
Fix: PDF
Template HTML to PDF
keyword
0.8.3¶
Fix: Windows
drag_and_drop
keywordNew library: Netsuite
PDF: add new keywords
0.8.2¶
Windows: Add keyword for clicking image templates
Windows: Add keyword for drag and drop
0.8.1¶
Browser: Fix
Open Available Browser
kw parameter bug
0.8.0¶
New library: Salesforce
New library: Database
0.7.5¶
Email.ImapSmtp: Separate how IMAP and SMTP are handled in the library
Windows: Improve documentation for keys
Browser: Manage webdrivermanager download error
0.7.4¶
Browser: Restructure how driver downloads and logging are handled
0.7.3¶
Browser: Detect Chrome and chromedriver versions. Download driver if they differ
Images: Don’t template match same region multiple times
Tables:
Added new keywords:
Set table row
,Set table column
,Set table cell
Renamed keyword
Get cell value
toGet table cell
0.7.2¶
Browser: Store webdrivers in temporary directory
0.7.1¶
First public release of RPA Framework