AutoIt Wiki - User contributions [en]

WebDriver

2025-07-09T21:37:45Z

MLipok: /* References */ List of Chromium Command Line Switches - current source code

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]
** [https://github.com/Sven-Seyfert/au3webdriver-boilerplate The project "au3webdriver-boilerplate" - A quick entry point for the au3WebDriver project]
** [https://chromium.googlesource.com/chromium/src.git/+/refs/heads/master/chrome/common/chrome_switches.cc List of Chromium Command Line Switches - current source code]
** [https://peter.sh/experiments/chromium-command-line-switches/ List of Chromium Command Line Switches - a human readable docs]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2025-07-09T20:55:37Z

MLipok: /* References */ List of Chromium Command Line Switches

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]
** [https://github.com/Sven-Seyfert/au3webdriver-boilerplate The project "au3webdriver-boilerplate" - A quick entry point for the au3WebDriver project]
** [https://peter.sh/experiments/chromium-command-line-switches/ List of Chromium Command Line Switches]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2024-04-25T08:12:38Z

MLipok: /* References */ "au3webdriver-boilerplate"

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<small>(Last modified: 2023/09/09)<br></small>

<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]
** [https://github.com/Sven-Seyfert/au3webdriver-boilerplate The project "au3webdriver-boilerplate" - A quick entry point for the au3WebDriver project]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2024-04-25T08:12:05Z

MLipok: /* References */ "au3webdriver-boilerplate"

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<small>(Last modified: 2023/09/09)<br></small>

<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]
** [https://github.com/Sven-Seyfert/au3webdriver-boilerplate The project "au3webdriver-boilerplate" - A quick entry point for the au3WebDriver project. The intention is, give people a easy start with WebDriver for AutoIt.]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2024-04-25T08:10:33Z

MLipok: /* References */ added link to Sven-Seyfert "au3webdriver-boilerplate"

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<small>(Last modified: 2023/09/09)<br></small>

<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]
** [https://github.com/Sven-Seyfert/au3webdriver-boilerplate - The project "au3webdriver-boilerplate" can be used as quick entry point for the au3WebDriver project. The intention is, give people a easy start with WebDriver for AutoIt.]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-09-19T18:29:28Z

MLipok: /* FAQ */ 12. How to download PDF (or any other) file automatically?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<small>(Last modified: 2023/09/09)<br></small>

<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF (or any other) file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>

In order to preset autodowloading another file type you have to change it accordingly by providing your desired MIME type:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

specifically here:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-09-09T16:23:47Z

MLipok: /* Getting started example */ Getting started example - Last modified

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<small>(Last modified: 2023/09/09)<br></small>

<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-09-09T16:22:23Z

MLipok: /* Installation */ Getting started example

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Getting started example ==
<syntaxhighlight lang="autoit">
#include "wd_helper.au3"
#include "wd_capabilities.au3"

_Example()

Func _Example()
# REMARK
# This is not functional script
# It only shows the concept how to use WebDriver UDF

#Region ; initialize webdriver sesion

; you should take care about download/update dirver
If $IDYES = MsgBox($MB_YESNO + $MB_TOPMOST + $MB_ICONQUESTION + $MB_DEFBUTTON1, "Question", _
"Do you want to download/update driver ?") Then
_WD_UpdateDriver('chrome')
EndIf

; specify driver, port and other options
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')

; start the driver
_WD_Startup()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; create capabilites for session
_WD_CapabilitiesStartup()
_WD_CapabilitiesAdd('alwaysMatch', 'chrome')
_WD_CapabilitiesAdd('w3c', True)
_WD_CapabilitiesAdd('excludeSwitches', 'enable-automation')
Local $sCapabilities = _WD_CapabilitiesGet()

; create session with given Capabilities
Local $WD_SESSION = _WD_CreateSession($sCapabilities)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; initialize webdriver sesion

#Region ; do your's stuff

; navigate to some website
Local $sURL = '******'
_WD_Navigate($WD_SESSION, $sURL)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; wait for loading process ends
_WD_LoadWait($WD_SESSION, 1000)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; for example find element
Local $sXPath = "*****"
Local $sElement = _WD_FindElement($WD_SESSION, $_WD_LOCATOR_ByXPath, $sXPath)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; get element text
Local $sText = _WD_ElementAction($WD_SESSION, $sElement, 'text')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's
ConsoleWrite($sText & @CRLF)

; or click the element
_WD_ElementAction($WD_SESSION, $sElement, 'click')
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; do your's stuff

#Region ; Clean Up

; on the end session should be deleted
_WD_DeleteSession($WD_SESSION)
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

; and driver should be closed
_WD_Shutdown()
If @error Then Return SetError(@error, @extended, 0) ; always remember to check and handle error's

#EndRegion ; Clean Up

EndFunc ;==>_Example
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]

[[Category:Tutorials]]
[[Category:UDF]]

User Defined Functions

2023-07-29T08:37:04Z

MLipok: /* Contact and support */ added link to "AutoIt Projects and Collaboration"

== Introduction ==
===Preface===
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />

===Added in the past two years===
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

===Contact and support===
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum] or [https://www.autoitscript.com/forum/forum/49-autoit-projects-and-collaboration/ AutoIt Projects and Collaboration].<br />
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

User Defined Functions

2023-07-29T08:35:46Z

MLipok: /* Introduction */ reorder

== Introduction ==
===Preface===
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />

===Added in the past two years===
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

===Contact and support===
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum].<br />
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

User Defined Functions

2023-07-29T08:34:54Z

MLipok: added ===Contact and support=== to easily maintan this page

== Introduction ==
===Preface===
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />
===Contact and support===
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum].<br />
<br />

===Added in the past two years===
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

User Defined Functions

2023-07-29T08:32:55Z

MLipok: /* Introduction */ added ===Preface=== to easily maintain page

== Introduction ==
===Preface===
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum].<br />
<br />
===Added in the past two years===
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

User Defined Functions

2023-07-29T08:31:29Z

MLipok: /* Introduction */ added ===Added in the past two years=== to easily maintain page

== Introduction ==
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum].<br />
<br />
===Added in the past two years===
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

User Defined Functions

2023-07-29T08:30:03Z

MLipok: == Introduction == added to easily maintain header

== Introduction ==
This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (378 UDFs on 2023-07-27), but constantly supplemented.
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].

'''Note:'''<br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br />
<br />
'''When will an UDF be added to this list?'''<br>
It should meet all/most of the general requirements for UDFs as described [[UDF-spec|here]].<br>
In addition the following requirements should be met:
* '''Documentation''': So users can tell what the UDF is intended to do (''mandatory'')
* '''Examples''': So users can get an idea how to use the UDF. The more the better (''mandatory'')
* '''Operating''' systems: Should support the latest Microsoft OS (''mandatory'') plus as many predecessors as possible (''optional'')
* '''AutoIt''': Should support the latest version of AutoIt (''mandatory'') plus as many predecessors as possible (''optional'')
* '''Author''': The author should still be active on the forum so he can reply to questions (''optional'')
<br />
'''What to do when one of your UDFs is missing?'''<br />
Please send a [https://www.autoitscript.com/forum/messenger/compose/?to=7903 PM] to user water. Add a short description of the UDF and a link to your post in the [https://www.autoitscript.com/forum/forum/9-autoit-example-scripts/ Example Scripts forum].<br />
<br />
'''Added in the past two years'''<br />
{| class="wikitable"
|-
! Date !! Section !! Creator !! Description
|-
|2023-07-27 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
|-
|2023-07-27 || [[User_Defined_Functions#OpenOffice.2FLibreOffice|OpenOffice/LibreOffice]] || donnyh13 || [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer] - A huge list of functions for LibreOffice Writer.
|-
|2023-02-03 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || Starg || [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D] - Draw simple 3D graphics with GDI+.
|-
| 2023-01-21 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON] - Interacting with JSON data in AutoIt.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set] - Provides a set data type and brings the corresponding mathematical functions.
|-
| 2023-01-21 || [[User_Defined_Functions#Maths|Maths]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat] - Statistics for Autoit.
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing).
|-
| 2023-01-21 || [[User_Defined_Functions#Script_Coding.2FAnalyzing.2FDebugging|Script Coding/Analyzing/Debugging]] || AspirinJunkie || [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations] - Different ways of composing elements of a set.
|-
| 2023-01-04 || [[User_Defined_Functions#Sound|Sound]] || MattyD || [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI UDF] - Wrap of the Windows MIDI functions.
|-
| 2022-06-19 || [[User_Defined_Functions#Internet protocol suite|Internet protocol suite]] || Beege || [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64] - cURL UDF with x64 support.
|-
| 2022-05-24 || [[User_Defined_Functions#Controls|Controls]] || kurtykurtyboy || [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton] - Change colors of regular buttons.
|-
| 2022-04-25 || [[User_Defined_Functions#Social_Media_and_other_Website_API|Social Media and other Website API]] || Ascer || [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
|-
| 2022-02-22 || [[User_Defined_Functions#Files.2C_Databases_and_web_connections|Files, Databases and web connections]] || czardas || [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit] - Convert to and from CSV format.
|-
| 2022-02-11 || [[User_Defined_Functions#Inter_Process_Communications|Inter Process Communications]] || Nine || [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC] - Very fast interprocess communication that could be used between VBS or AutoIt.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || MrKm || [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace] - Convert Images to text with the OCRSpace API.
|-
| 2022-01-11 || [[User_Defined_Functions#Media|Media]] || Danyfirex || [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR] - Universal Windows Platform Optical Character Recognition API.
|-
| 2021-08-18 || [[User_Defined_Functions#Graphics_and_image|Graphics and image]] || smbape || [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+] - OpenCV UDF with support for OpenCV v4+.
|-
| 2021-08-04 || [[User_Defined_Functions#Windows|Windows]] || DonChunior || [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS] - Background Intelligent Transfer Service to download/upload files from/to HTTP web servers and SMB file shares.
|}
<br />

== Automation ==

===Browsers===
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.

===Microsoft Office===
Some features of Microsoft's Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required.<br><u>[[Known issues with Microsoft Office automation.|This page]]</u> is dedicated to identifying those issues, provide explanations and list solutions or workarounds.
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=204034 Microsoft Office Excel Pivot Tables (by SudeepJD)] - Create and Update Excel Pivot Tables and Charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (Items) (by water)] - Automate Microsoft Outlook Items. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=202451 Microsoft Office Outlook (GUI) (by water)] - Automate Microsoft Outlook GUI. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=197346 Microsoft Office Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint. Link to the [[Powerpoint|documentation]] pages.
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.

===OpenOffice/LibreOffice===
* [https://www.autoitscript.com/forum/index.php?showtopic=210514 LibreOffice Writer (by donnyh13)] - A huge list of functions for LibreOffice Writer.
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.

===Other Applications===
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory ([https://www.autoitscript.com/forum/files/file/355-ad-active-directory-udf/ Download]). Link to the [[Active_Directory_UDF_-_General|documentation]] pages.
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.

== Script Coding/Analyzing/Debugging ==
* [https://www.autoitscript.com/forum/index.php?showtopic=209528 ArrayCombinations (by AspirinJunkie)] - Different ways of composing elements of a set.
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.
* [https://www.autoitscript.com/forum/index.php?showtopic=209523 ArrayPlus (by AspirinJunkie)] - Functions for flexible Array handling (creating, extracting, rebuilding, sorting, filtering, finding, printing)
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables.
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=110379 AutoItObject (by ProgAndy and others)] - Brings the Object Orientation programming paradigm to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.
* [https://www.autoitscript.com/forum/index.php?showtopic=191488 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.
* [https://www.autoitscript.com/forum/index.php?showtopic=143167 GetOpt (by dany)] - Parse GNU and DOS style command line options similar to getopt().
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - Create a text log files.
* [https://www.autoitscript.com/forum/index.php?showtopic=202832 OnDebugMsgBox (by argumentum)] - Catch the dreaded "AutoIt Error" MsgBox and prettify or hide it.
* [https://www.autoitscript.com/forum/index.php?showtopic=209529 Set (by AspirinJunkie)] - Provides a set data type and brings the corresponding mathematical functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.

=== Inter Process Communications ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202485 AppInteract (by MrCreatoR)] - Reliably pass arrays or other types between processes.
* [https://www.autoitscript.com/forum/index.php?showtopic=205109 AutoItSharedData (by SEuBo)] - Create a shared data storage, a simple AutoItObject-Object, using AutoItObject_Internal.
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Event driven TCP/IP wrapper inspired by Socket.IO with focus on user friendliness and long term sustainability.
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).
* [https://www.autoitscript.com/forum/index.php?showtopic=202618 IPC Techniques through ROT Objects (by LarsJ)] - Implementing IRunningObjectTable Interface.
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.
* [https://www.autoitscript.com/forum/index.php?showtopic=204734 Overlapped Named Pipe IPC (by Nine)] - Very fast interprocess communication that could be used between VBS or AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organized Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.
* [https://www.autoitscript.com/forum/index.php?showtopic=202587 WCD IPC (by Nine)] - Framework for Inter Process Communication using Windows Messages WM_COPYDATA.

== Files, Databases and web connections ==
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=155748 CSVSplit (by czardas)] - Convert to and from CSV format.
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML (by FireFox)] - Work with SpreadsheetML (Open XML file formats).
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - Use MySQL Databases with AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=148232 _FileGetProperty (by BrewManNH)] - Retrieve properties of a file.
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL.
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - Brings the power and flexibility of jq (an open-source command-line based JSON processor) to AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=209502 JSON (by AspirinJunkie)] - Interacting with JSON data in AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - Generate JSON.
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system.
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - Built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 (by schoppet)] - Access the SOAP-Webservices of Sharepoint 2007/2010.
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).
* [https://www.autoitscript.com/forum/imndex.php?showtopic=209526 xlsxNative (by AspirinJunkie)] - Read and write xlsx files without excel.
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.

== Data compression ==
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files.
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.

== Encryption and hash ==
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode.
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script.
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.
* [https://www.autoitscript.com/forum/index.php?showtopic=203990 GDPR (by mLipok)] - Functions to encrypt/decrypt strings and files with the GDPR in mind.
* [https://www.autoitscript.com/forum/index.php?showtopic=95558 Hashes for files (by trancexx)] - Fast RC32, MD4, MD5, SHA1 calculation for big files.
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.

== GUI Additions ==
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).
* [https://www.autoitscript.com/forum/index.php?showtopic=197654 GuiFlatButton (by kurtykurtyboy)] - Change colors of regular buttons.
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - Allows you to skin your GUI using the Windows ''.MSstyles'' files.
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - Allows skinning of your GUI and to apply custom skins.

=== Controls ===
* [https://www.autoitscript.com/forum/index.php?showtopic=202529 BrowseForFolder (by MrCreatoR)] - Handle SHBrowseForFolderW with more options, such as multi selection (checkboxes), window position, controls text and more.
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - Sub classes the edit control and matches the current word through the Database & sets selection in accordance.
* [https://www.autoitscript.com/forum/index.php?showtopic=163939 Progressbar new style (by Muzaiyan)] - New styles for your progress bar.
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.

== Hardware ==
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).
* [https://www.autoitscript.com/forum/index.php?showtopic=154727 BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.
* [https://www.autoitscript.com/forum/index.php?showtopic=155674 CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=203207 MediaDevice (by Danyfirex)] - Transfer files to portable devices like phones, storages.
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...
* [https://www.autoitscript.com/forum/index.php?showtopic=189190 Serial port UDF / COM port UDF (by MazeM)] - Another UDF for the serial port. It is very similar to CommAPI using kernel32.dll, but all code is packed into a single file without any dependencies.
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.

== Information gathering ==
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.
* [https://www.autoitscript.com/forum/index.php?showtopic=151920 NetworkStatistics (by Ascend4nt)] - Network Interface Info, Statistics, and Traffic.
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.

== Internet protocol suite ==
* [https://www.autoitscript.com/forum/index.php?showtopic=207859 cURLX64 (by Beege)] - cURL UDF with x64 support.
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.
* [https://www.autoitscript.com/forum/index.php?showtopic=202895 HttpApi (by TheXman)] - HTTP Server API enables applications to communicate over HTTP without using MS Internet Information Server (IIS).
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.
* [https://www.autoitscript.com/forum/index.php?showtopic=181645 Winsock (by j0kky)] - Create client/server application using native winsock functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Windows Sockets API - Non-Blocking Transmission Control Protocol.

== Maths ==
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - Allows to perform fast matrix operations on large numerical data sets, and much more ....
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.
* [https://www.autoitscript.com/forum/index.php?showtopic=209527 Stat (by AspirinJunkie)] - Statistics for Autoit.
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().

== Media ==
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp functions for context-sensitive help from CHM (compiled HTML) files.
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=206133 OCRSpace (by MrKm)] - Convert Images to text with the OCRSpace API.
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=202621 QRCreator (by BugFix)] - Simple QR-code creation.
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.
* [https://www.autoitscript.com/forum/index.php?showtopic=207324 UWPOCR (by Danyfirex)] - Universal Windows Platform Optical Character Recognition API.

===Graphics and image===
* [https://www.autoitscript.com/forum/index.php?showtopic=202987 AutoYolo3 (by smartee)] - Real-Time Object Detection using YOLOv3 wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=86748 AVI writing udf (by monoceres)] - Create uncompressed avi's from bitmap files.
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=202663 GIF animation (by Nine)] - Fast cached GIF animation.
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - Read info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.
* [https://www.autoitscript.com/forum/files/file/471-image-search-udf Image Search (by VIP)] - Search for an image on the desktop.
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.
* [https://www.autoitscript.com/forum/index.php?showtopic=160732 OpenCV (by myliseJ)] - UDF for the OpenCV library.
* [https://www.autoitscript.com/forum/index.php?showtopic=206432 OpenCV v4+ (by smbape)] - OpenCV UDF with support for OpenCV v4+.
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files it also retrieves various Exif information.
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.
* [https://www.autoitscript.com/forum/index.php?showtopic=152950 S3D (by Starg)] - Draw simple 3D graphics with GDI+.

===Players===
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=203154 WMP - GUI Control (by SudeepJD)] - IE based WMP Control.

===Sound===
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=208116 MIDI (by MattyD)] - Wrap of the Windows MIDI functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.

== PDF ==
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.

== Security ==
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.

== Social Media and other Website API ==
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security.
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - Simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.
* [https://www.autoitscript.com/forum/index.php?showtopic=192391 oAuth (by Ascer)] - Open standard for access delegation, commonly used to grant websites or applications access to other websites.
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Manage Twitter.
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - Yahoo Weather API.
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.

== Windows ==
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.
* [https://www.autoitscript.com/forum/index.php?showtopic=206400 BITS (by DonChunior)] - Background Intelligent Transfer Service to download files from or upload files to HTTP web servers and SMB file shares.
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Manage local accounts.
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF. Link to the [[TaskScheduler|documentation pages]].
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS (by Kanashius)] - Used with SAPI Automation Object - text-to-speech (TTS) engine.
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - Manipulate Windows Image Files (.wim) without ImageX.exe.
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.

== Misc ==


* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.
* [https://www.autoitscript.com/forum/index.php?showtopic=199762 BlockInputEx (by Nine)] - Block all input coming from mouse and/or keyboard, without having an UAC warning displayed.
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx).
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF.
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.
[[Category:UDF]]

WebDriver

2023-07-17T21:10:50Z

MLipok: /* FAQ */ 1. How to connect to a running browser instance ++ Google Chrome

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post for FireFox] or [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/page/2/#comment-1505978 this post for Google Chrome].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-06-22T18:51:27Z

MLipok: /* References */ added link to github: Au3WebDriver-testing

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]
** [https://github.com/mlipok/Au3WebDriver-testing Au3WebDriver-testing - Some complex template for testing Au3WebDriver cases]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-03-23T14:18:57Z

MLipok: /* FAQ */ ..._WD_LocateElement()

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element location within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-03-23T14:17:27Z

MLipok: /* FAQ */ 18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....
* check in your browser if your locator (XPATH , CSSSelector) is valid
* check in your browser if your locator (XPATH , CSSSelector) find one or multiple instances of the element
* check in your browser if your locator (XPATH , CSSSelector) find element in different frame or if this is within #shadow-root
* use _WD_FrameList() to check if you have multiple even nested frames in website you are trying to automate
* use _WD_LocateElement() to check Element within multiple even nested frames
* use _WD_FrameEnter() to change frame to be able to use _WD_FindElement() in order to find element within desired frame

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-03-23T14:10:46Z

MLipok: /* FAQ */ 17. How to troubleshoot >> 18. How to troubleshoot

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ18">18. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ18">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-03-23T14:09:39Z

MLipok: /* FAQ */

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-03-23T14:09:03Z

MLipok: /* FAQ */ 17. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to troubleshoot when you can't locate the desired element using _WD_FindElement() ?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
When you encounter a problem locating an item with _WD_FindElement() you should follow this procedure:

WIP....

<syntaxhighlight lang="autoit">
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-02-19T23:43:06Z

MLipok: /* Tools */ ++Stylus

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])
* [https://github.com/openstyles/stylus Stylus] Stylus is a fork of Stylish for Chrome, also compatible with Firefox as a WebExtension

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2023-02-18T18:52:30Z

MLipok: /* FAQ */ 14. How to add browser/specific/vendor options to capabilities?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: Use _WD_CapabilitiesDefine() function like int the following example:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesDefine($_WD_CAPS_TYPES__SPECIFICVENDOR_ARRAY, 'NewCapabilityArray')
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]
[[Category:UDF]]

WebDriver

2022-12-26T20:36:46Z

MLipok: /* References */ WebDriver UDF (W3C compliant version) link fixed

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/208633-webdriver-udf-w3c-compliant-version-20221003/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-10-31T11:20:34Z

MLipok: /* FAQ */ 17. How to use devtools in browsers?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use devtools in browsers?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-10-31T11:19:33Z

MLipok: /* FAQ */ 17. How to use inspecting tools?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to use inspecting tools?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
** [https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s YouTube video: How to work with frames in Firefox?]
** [https://www.youtube.com/watch?v=TUpsyv9A9vU YouTube video: Inspecting a webpage's HTML using Developer Tools in Google Chrome]
** [https://www.youtube.com/watch?v=1l4xz1QQhew YouTube video: How to use Google Chrome Inspect Element tool]
** [https://www.youtube.com/watch?v=NRn70H8XOZc YouTube video: A Fun Way to Use the Inspect Tool in Chrome]
** [https://www.youtube.com/watch?v=f5pTCMPomuA YouTube video: How to use Inspect Element on disappearing items (hidden content) - Google Chrome Browser?]
** [https://www.youtube.com/watch?v=WfKG9C00giI YouTube video: How to Use the Google Chrome Inspect Tool]

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-10-31T10:53:17Z

MLipok: /* Tools */ Save Page WE URL

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for other browsers using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look at wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look at wd_demo.au3 script
|-
| _IE_VersionInfo || _WD_Option('version') ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file ([https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE for Firefox], [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-09-14T11:04:13Z

MLipok: /* Translate IE UDF to WebDriver */ _IEFrameGetCollection > _WD_FrameList

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FrameList || _WD_FrameList($sSession, True)
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-09-14T11:00:02Z

MLipok: /* Translate IE UDF to WebDriver */ _IEFormElementGetValue > _WD_ElementAction fixed

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to enable/disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to enable/disable logging into webdriver console?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
_WD_CapabilitiesAdd("excludeSwitches", "disable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-10T08:15:53Z

MLipok: /* References */ WebDriver UDF - Help & Support (III)

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/208640-webdriver-udf-help-support-iv/ WebDriver UDF - Help & Support (IV)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-08T07:49:52Z

MLipok: /* Translate IE UDF to WebDriver */ _IEErrorNotify

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || N/A || you can set debug level for example: $_WD_DEBUG = $_WD_DEBUG_Full
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-08T07:47:02Z

MLipok: /* Translate IE UDF to WebDriver */ _IEDocWriteHTML

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || _WD_ExecuteScript($s_Session, "document.open();document.write(" & $sHTML & ");document.close();") || https://stackoverflow.com/a/11984907/5314940
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-08T07:40:50Z

MLipok: /* Translate IE UDF to WebDriver */ _IEBodyWriteHTML

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || _WD_ExecuteScript($s_Session, "document.body.outerHTML='" & $sHTML & "'") ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-08T07:39:20Z

MLipok: /* Translate IE UDF to WebDriver */ _IEBodyReadText

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-08-08T07:38:34Z

MLipok: /* Translate IE UDF to WebDriver */ _IEBodyReadText

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.

; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || Local $sText = _WD_ExecuteScript($sSession, 'return document.body.innerText',Default,Default, $_WD_JSON_Value) ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-07-21T13:51:30Z

MLipok: /* FAQ */ How to work with frames in Firefox?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ17">17. How to work with frames in Firefox?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ17">
<div class="toccolours mw-collapsible-content">
Q: How to work with frames in Firefox?<br>
A: https://www.youtube.com/watch?v=Me9hjqd74m8&t=58s

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-06-10T07:30:29Z

MLipok: /* FAQ */

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]<br>
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]<br>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-06-10T07:29:49Z

MLipok: /* FAQ */ Locator strategies - selenium link

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]
A: Take a look on this link: [https://www.selenium.dev/documentation/webdriver/elements/locators/ Locator strategies]
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-06-08T11:24:35Z

MLipok: /* FAQ */ How can I check XPath and CSSSelector in the Browser?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://developer.chrome.com/docs/devtools/dom/ Get Started With Viewing And Changing The DOM]
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-06-03T16:11:01Z

MLipok: /* FAQ */ 12. How to download PDF file automatically? - suplemented

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
_WD_CapabilitiesAdd("prefs", "browser.download.alwaysOpenPanel", False)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-06-03T16:08:31Z

MLipok: /* FAQ */ 16. How to disable logging into webdriver console?

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ16">16. How to disable logging into webdriver console?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ16">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("excludeSwitches", "enable-logging")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]

WebDriver

2022-05-31T22:26:58Z

MLipok: /* Tools */

The W3C WebDriver API is a platform and language-neutral interface and wire protocol allowing programs or scripts to control the behavior of a web browser.

== Introduction ==

=== WebDriver API ===
WebDriver enables developers to create automated tests that simulate user interaction. This is different from JavaScript unit tests because WebDriver has access to functionality and information that JavaScript running in the browser doesn't, and it can more accurately simulate user events or OS-level events. WebDriver can also manage testing across multiple windows, tabs and webpages in a single test session.

=== WebDriver UDF ===
The WebDriver UDF allows to interact with any browser that supports the W3C WebDriver specifications. Supporting multiple browsers via the same code base is now possible with just a few configuration settings.

=== Requirements ===
<small>(Last modified: 2022/01/25)<br></small>

The following UDFs need to be installed - '''independent''' of the Browser you try to automate:
* [https://www.autoitscript.com/forum/topic/148114-a-non-strict-json-udf-jsmn JSON UDF (AutoIt)] by Ward and Jos
* [https://www.autoitscript.com/forum/topic/84133-winhttp-functions/ WinHTTP UDF (AutoIt)] by trancexx or [https://github.com/dragana-r/autoit-winhttp autoit-winhttp (GitHub)]
* [https://github.com/Danp2/au3WebDriver/releases/latest WebDriver UDF (GitHub)] by Danp2
One of the following Drivers needs to be installed - '''depending''' on the Browser type and version you try to automate:
{| class="wikitable"
|-
! Browser !! Download Link !! Comments
|-
| Chrome || [https://sites.google.com/chromium.org/driver/downloads Google] || Follow this [https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection link] to select the correct version depending on the Chrome version you run!
|-
| Edge || [https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ Microsoft] ||
|-
| Firefox || [https://github.com/mozilla/geckodriver/releases/latest GitHub] || Firefox version ≥ 60 is recommended<br>
'''Note:''' You must still have the Microsoft Visual Studio redistributable runtime installed on your system for the binary to run. This is a known bug in version 0.26 which the authors weren't able fix for this release.
|-
| Opera || [https://github.com/operasoftware/operachromiumdriver/releases/latest GitHub] || The versioning of OperaDriver matches the Chromium version on which Opera browser is based on.
|}

=== Limitations ===
<small>(Last modified: 2020/01/28)<br></small>
Not all WebDriver functions have been implemented by each browser. To check the status goto the corresponding website below:

* [https://chromium.googlesource.com/chromium/src/+/master/docs/chromedriver_status.md Chrome]
* [https://docs.microsoft.com/en-us/microsoft-edge/webdriver#w3c-webdriver-specification-supporthttpsw3cgithubiowebdriverwebdriver-spechtml Edge]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver/status Firefox]
* [https://github.com/operasoftware/operachromiumdriver Opera]: "''OperaChromiumDriver is a WebDriver implementation derived from ChromeDriver and adapted by Opera''". That's why I think it has at least the same limitations as ChromeDriver.

=== Big Picture ===
How the browser independent and browser dependent parts fit together:<br>

[[File:WebDriver.png|800px|||Big Picture - How everything fits together]]

=== Technical terms ===
<small>(Last modified: 2022/02/12)<br></small>

You will encounter the following technical terms when working with the WebDriver UDF.<br>
These terms are not unique to the UDF, so you will find just the general description in this section.
How to use these terms with the WebDriver UDF can be found in the FAQ.<br><br>

; CDP (Chrome DevTools Protocol) : Is a [https://chromedevtools.github.io/devtools-protocol/ protocol] that allows for tools to instrument, inspect, debug and profile Chromium, Chrome and other [https://en.wikipedia.org/wiki/Blink_(browser_engine) Blink]-based browsers.

; CSS Selector : Please see '''Selector'''.
; Locator Strategy : A Locator strategy describes the method to use to search elements. This includes Linktext, Partial Linktext, Tag Name, CSS selector, XPath selector.

; Marionette : Marionette is an automation driver for Mozilla’s Gecko engine. It can remotely control either the UI or the internal JavaScript of a Gecko platform, such as Firefox. It can control both the chrome (i.e. menus and functions) or the content (the webpage loaded inside the browsing context), giving a high level of control and ability to replicate user actions. In addition to performing actions on the browser, Marionette can also read the properties and attributes of the DOM.<br>Marionette consists of two parts: a server which takes requests and executes them in Gecko (the Marionette server ships with Firefox), and a client (the Marionette client ships with the GeckoDriver exe). The client sends commands to the server and the server executes the command inside the browser.<br>For details please [https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html visit this site].

; Selector : Selectors are patterns used to select the element(s) you want to process. They are used by <br>CSS (see [https://www.w3schools.com/css/css_selectors.asp this link for Beginners] or [https://www.w3.org/TR/CSS21/selector.html this link for Advanced)] and<br>[https://www.w3schools.com/xml/xpath_syntax.asp XPath] (see [https://www.w3schools.com/xml/xml_xpath.asp this link for Beginners] and [https://www.w3.org/TR/1999/REC-xpath-19991116/ this link for Advanced]).

; ShadowRoot : The ShadowRoot interface of the Shadow DOM API is the root node of a DOM sub tree that is rendered separately from a document's main DOM tree.<br>For details please [https://dom.spec.whatwg.org/#interface-shadowroot visit this site].

; XPath : XPath is a language for navigating in XML documents. XPath is a major element in the XSLT standard and includes over 200 built-in functions.

; XQuery : XQuery is a language for querying XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xquery.asp visit this site].

; XSLT : XSLT is a language for transforming XML documents.<br>For details please [https://www.w3schools.com/xml/xml_xslt.asp visit this site].

== Installation ==
<small>(Last modified: 2022/02/02)<br></small>

To automate your browser the following installation steps are needed:
* Download the files listed in section "[[WebDriver#Requirements|Requirements]]"
* Move the UDFs to a directory where SciTE and Autoit can find them:
** wd_Core.au3, wd_helper.au3 , wd_cdp.au3 , wd_capabilities.au3 from the WebDriver UDF
** Json.au3 and BinaryCall.au3 from the JSON UDF
** WinHttp.au3 and WinHttpConstants.au3 from the WinHttp UDF
* Move the browser dependent WebDriver to the same directory (with WD_Demo.au3):
** chromedriver.exe (Chrome)
** geckodriver.exe (Firefox)
** msedgedriver.exe (Edge - Chromium) or MicrosoftWebDriver.exe (Edge - EdgeHTML)
** or use "Update" option by choosing one of ComboBox option in WD_Demo.au3
* Run WD_Demo.au3 and select "DemoNavigation" to validate the installation.<br>The result (for Firefox) displayed in the DOS window should be similar to the following:
<syntaxhighlight lang="text">
1577745813519 geckodriver DEBUG Listening on 127.0.0.1:4444
1577745813744 webdriver::server DEBUG -> POST /session {"capabilities": {"alwaysMatch": {"browserName": "firefox", "acceptInsecureCerts":true}}}
1577745813746 geckodriver::capabilities DEBUG Trying to read firefox version from ini files
1577745813747 geckodriver::capabilities DEBUG Found version 71.0
1577745813757 mozrunner::runner INFO Running command: "C:\\Program Files\\Mozilla Firefox\\firefox.exe" "-marionette" "-foreground" "-no-remote" "-profile" "C:\\ ...
1577745813783 geckodriver::marionette DEBUG Waiting 60s to connect to browser on 127.0.0.1:55184
1577745817392 geckodriver::marionette DEBUG Connection to Marionette established on 127.0.0.1:55184.
1577745817464 webdriver::server DEBUG <- 200 OK {"value":{"sessionId":"925641bf-6c5d-4fe2-a985-02de9b1c7c74","capabilities":"acceptInsecureCerts":true,"browserName":"firefox", ...
</syntaxhighlight>

== Function reference ==
<small>(Last modified: 2021/12/09)<br></small>

The functions are now documented in the CHM help file that comes with the UDF.

== Capabilities ==
WebDriver capabilities are used to communicate the features supported by a given implementation. The local end may use capabilities to define which features it requires the remote end to satisfy when creating a new session. Likewise, the remote end uses capabilities to describe the full feature set for a session. <br>
Details can be found at [[WebDriver_Capabilities|WebDriver Capabilities (sub page)]].

== Browser related functionality ==
=== Google Chrome ===
ChromeDriver supports "Chrome DevTools Protocol" (CDP) commands (for an explanation of the term and related links please see the [[WebDriver#Used_Terms|Used Terms]] section).<br>
Details can be found in the CHM Help file that comes with the UDF.

=== Translate IE UDF to WebDriver ===
{{WIP}}
Internet Explorer is no longer supported by Microsoft. Therefore, it may be necessary to rewrite existing scripts for another browser using the WebDriver UDF.
Below you will find a mapping of the functions of the IE UDF to the functions of the WebDriver UDF.
{| class="wikitable"
|-
! IE function !! WebDriver function !! Comments
|-
| _IEAction || _WD_ElementAction + _WD_ElementActionEx ||
|-
| _IEAttach || _WD_Attach ||
_WD_Attach: '''Attach to''' existing browser '''tab'''.

Attaching to running browser instance/session is much more difficult. [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?tab=comments#comment-1498168 Examples can be found here].
|-
| _IEBodyReadHTML || _WD_GetSource ||
|-
| _IEBodyReadText || ||
|-
| _IEBodyWriteHTML || ||
|-
| _IECreate || _WD_CreateSession ||
|-
| _IECreateEmbedded || N/A ||
|-
| _IEDocGetObj || ||
|-
| _IEDocInsertHTML || ||
|-
| _IEDocInsertText || ||
|- || ||
|-
| _IEDocReadHTML || _WD_GetSource ||
|-
| _IEDocWriteHTML || ||
|-
| _IEErrorNotify || ||
|-
| _IEFormElementCheckBoxSelect || _WD_ElementActionEx || _WD_FindElement + _WD_ElementActionEx($sSession, $sElement, "check")
|-
| _IEFormElementGetCollection || _WD_FindElement ||
|-
| _IEFormElementGetObjByName || _WD_GetElementByName ||
|-
| _IEFormElementGetValue || _WD_ElementSelectAction || _WD_FindElement + _WD_ElementSelectAction($sSession, $sSelectElement, "value")
|-
| _IEFormElementOptionSelect || _WD_ElementSelectAction + _WD_ElementOptionSelect ||
|-
| _IEFormElementRadioSelect || _WD_ElementSelectAction ||
|-
| _IEFormElementSetValue || _WD_SetElementValue ||
|-
| _IEFormGetCollection || _WD_FindElement ||
|-
| _IEFormGetObjByName || _WD_GetElementByName ||
|-
| _IEFormImageClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEFormReset || ||
|-
| _IEFormSubmit || ||
|-
| _IEFrameGetCollection || _WD_FindElement + _WD_FrameEnter || You are not able to get all Frames at once.
You must get all that are available in current document context, then go to each frame and find all sub frames.
|-
| _IEFrameGetObjByName || _WD_GetElementByName + _WD_FrameEnter ||
|-
| _IEGetObjById || _WD_GetElementById ||
|-
| _IEGetObjByName || _WD_GetElementByName ||
|-
| _IEHeadInsertEventScript || ||
|-
| _IEImgClick || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IEImgGetCollection || _WD_FindElement ||
|-
| _IEIsFrameSet || ||
|-
| _IELinkClickByIndex || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, "click")
|-
| _IELinkClickByText || _WD_LinkClickByText ||
|-
| _IELinkGetCollection || _WD_FindElement ||
|-
| _IELoadWait || _WD_LoadWait ||
|-
| _IELoadWaitTimeout || _WD_SetTimeouts ||
|-
| _IENavigate || _WD_Navigate ||
|-
| _IEPropertyGet || _WD_ElementAction || _WD_FindElement + _WD_ElementAction($sSession, $sElement, 'property', 'nodeName')
|-
| _IEPropertySet || _WD_ExecuteScript || _WD_FindElement + ......
|-
| _IEQuit || _WD_DeleteSession ||
|-
| _IETableGetCollection || _WD_FindElement ||
|-
| _IETableWriteToArray || _WD_GetTable || _WD_FindElement + _WD_GetTable( ......
|-
| _IETagNameAllGetCollection || _WD_FindElement ||
|-
| _IETagNameGetCollection || _WD_FindElement ||
|-
| _IE_Example || N/A || Take a look on wd_demo.au3 script
|-
| _IE_Introduction || N/A || Take a look on wd_demo.au3 script
|-
| _IE_VersionInfo || $__WDVERSION ||
|}

== Troubleshooting ==
=== Debug the WebDriver setup ===
<small>(Last modified: 2020/07/06)<br></small>
==== WinHTTP UDF ====
Make sure that you are running at least version 1.6.4.2 (currently unreleased, but can be obtained [https://raw.githubusercontent.com/dragana-r/autoit-winhttp/master/WinHttp.au3 here]).
==== Chrome ====
<div class="usermessage mw-customtoggle-DebugChrome1">Chrome does not start and the DOS window for chromedriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugChrome1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Chrome and does not display the DOS window for chromedriver.<br>When you manually run the chromedriver in a DOS window you get message "[0.023][SEVERE]: CreatePlatformSocket() returned an error: An invalid argument was supplied."|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the chrome driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\chromedriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

==== Firefox ====
<div class="usermessage mw-customtoggle-DebugFirefox1">Firefox does not start and the DOS window for geckodriver does not get displayed</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-DebugFirefox1">
{| class="wikitable"
|-
! Problem !! Solution !! Reference
|-
| When running WD_Demo.au3 it does not start up Firefox and does not display the DOS window for geckodriver.<br>When you manually run the geckodriver in a DOS window you get message "geckodriver: error: An invalid argument was supplied. (os error 10022)"|| This could be caused by missing execution permission for the network drive. Please ask your IT admin for "Applocker" or "application directory whitelisting". <br>Or run the gecko driver from a local HDD and call _WD_Option to set the location of the webdriver executable. Example: _WD_Option("Driver", "C:\Local\WebDriver\geckodriver.exe") || [https://stackoverflow.com/questions/51056121/createplatformsocket-returned-an-error-an-invalid-argument-was-supplied-0x2 Stackoverflow]
|}
</div>

=== Debug your Script ===

== FAQ ==
<small>(Last modified: 2022/03/24)<br></small>

<div class="usermessage mw-customtoggle-FAQ1">1. How to connect to a running browser instance</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ1">
<div class="toccolours mw-collapsible-content">Q: How can I connect to a running browser instance?<br>A: That's described (for Firefox, but should work similar for other browsers) in [https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/?do=findComment&comment=1498168 this post].</div>
</div>

<div class="usermessage mw-customtoggle-FAQ2">2. How to hide the webdriver console</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ2">
<div class="toccolours mw-collapsible-content">Q: How can I hide the webdriver console?<br>A: The console can be completely hidden from the start by adding the following line near the beginning of your script:<br><syntaxhighlight lang="autoit">$_WD_DEBUG = $_WD_DEBUG_None ; You could also use $_WD_DEBUG_Error</syntaxhighlight>You can also control the visibility of the console with the function _WD_ConsoleVisible.</div>
</div>

<div class="usermessage mw-customtoggle-FAQ3">3. How to utilize an existing user profile</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ3">
<div class="toccolours mw-collapsible-content">Q: Can I use an existing user profile instead of the default behavior of using a new one?<br>A: This is controlled by your "capabilities" declaration, with each browser using a different method to implement. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args":["--user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Google\\Chrome\\User Data\\", "--profile-directory=Default"]}}}}'</syntaxhighlight>'''MS Edge'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"ms:edgeOptions": {"args": ["user-data-dir=C:\\Users\\' & @UserName & '\\AppData\\Local\\Microsoft\\Edge\\User Data\\", "profile-directory=Default"]}}}}'</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">
$sDesiredCapabilities = '{"capabilities":{"alwaysMatch": {"moz:firefoxOptions": {"args": ["-profile", "' & GetDefaultFFProfile() & '"],"log": {"level": "trace"}}}}}'

Func GetDefaultFFProfile()
Local $sDefault, $sProfilePath = ''

Local $sProfilesPath = StringReplace(@AppDataDir, '\', '/') & "/Mozilla/Firefox/"
Local $sFilename = $sProfilesPath & "profiles.ini"
Local $aSections = IniReadSectionNames ($sFilename)

If Not @error Then
For $i = 1 To $aSections[0]
$sDefault = IniRead($sFilename, $aSections[$i], 'Default', '0')

If $sDefault = '1' Then
$sProfilePath = $sProfilesPath & IniRead($sFilename, $aSections[$i], "Path", "")
ExitLoop
EndIf
Next
EndIf

Return $sProfilePath
EndFunc
</syntaxhighlight>You will also likely need to specify the marionette port:
<syntaxhighlight lang="autoit">_WD_Option('DriverParams', '--marionette-port 2828')</syntaxhighlight></div>
</div>

<div class="usermessage mw-customtoggle-FAQ4">4. How to specify location of browser executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ4">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch a browser installed in a non-standard location?<br>A: This is controlled by your "capabilities" declaration. Here are some examples:<br>
<br>'''Chrome'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "binary":"C:\\Path\\To\\Alternate\\Browser\\chrome.exe" }}}}'
</syntaxhighlight>'''Firefox'''<syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"desiredCapabilities":{"javascriptEnabled":true,"nativeEvents":true,"acceptInsecureCerts":true,"moz:firefoxOptions":{"binary":"C:\\Path\\To\\Alternate\\Browser\\firefox.exe"}}}'</syntaxhighlight>Alternate Firefox method:<br><syntaxhighlight lang="autoit">
_WD_Option('DriverParams', '--binary "C:\Program Files\Mozilla Firefox\firefox.exe" --log trace ')</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ5">5. How to maximize the browser window</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ5">
<div class="toccolours mw-collapsible-content">Q: Is it possible to maximize the browser window?<br>A: Simply call the following function:<syntaxhighlight lang="autoit">_WD_Window($sSession, "Maximize")
</syntaxhighlight>Make sure to call _WD_Window after the session has been created with _WD_CreateSession.</div></div>

<div class="usermessage mw-customtoggle-FAQ6">6. How to specify location of WebDriver executable</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ6">
<div class="toccolours mw-collapsible-content">Q: Is it possible to launch the WebDriver executable from a specific location?<br>A: This is controlled by function "_WD_Option". Example:
<br><syntaxhighlight lang="autoit">_WD_Option("Driver", "C:\local\WebDriver\WebDriver.exe")</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ7">7. How to retrieve the values of a drop-down list</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ7">
<div class="toccolours mw-collapsible-content">Q: How to retrieve the values of a drop-down list (<Select> tag)?<br>A1: Here's a simple way to do it:
<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$sText = _WD_ElementAction($sSession, $sElement, 'property', 'innerText')
$aOptions = StringSplit ( $sText, @LF, $STR_NOCOUNT)
_ArrayDisplay($aOptions)</syntaxhighlight>
'xxx' is the name of the drop-down list.
<br>A2: This can now be accomplished using the function _WD_ElementSelectAction:<br><syntaxhighlight lang="autoit">$sElement = _WD_FindElement($sSession, $_WD_LOCATOR_ByXPath, "//select[@name='xxx']")
$aOptions = _WD_ElementSelectAction ($sSession, $sElement, 'options')
_ArrayDisplay($aOptions)</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ8">8. How to run the browser in headless mode (hidden mode)</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ8">
<div class="toccolours mw-collapsible-content">Q: How do I run the browser in "headless" mode?<br>A: This is controlled by the Capabilities string that is passed to _WD_CreateSession. Example:
<br><syntaxhighlight lang="autoit">$sDesiredCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "args": ["--headless", "--allow-running-insecure-content"] }}}}' </syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ9">9. How to configure the UDF to call a user-defined Sleep function</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ9">
<div class="toccolours mw-collapsible-content">
Q: How to configure the UDF to call a user-defined Sleep function, and interact with _WD_WaitElement() and _WD_LoadWait() to make the script more responsive?
<br>
A: Try to use: _WD_Option("Sleep") . Example:
<br>
<syntaxhighlight lang="autoit">
#include <ButtonConstants.au3>
#include <GuiComboBoxEx.au3>
#include <GUIConstantsEx.au3>
#include <MsgBoxConstants.au3>
#include <WindowsConstants.au3>
#include "wd_helper.au3"

Global $idAbortTest
Global $WD_SESSION
_Example()

Func _Example()
SetupChrome()

; Create a GUI with various controls.
Local $hGUI = GUICreate("Example")
Local $idTest = GUICtrlCreateButton("Test", 10, 370, 85, 25)
$idAbortTest = GUICtrlCreateButton("Abort", 150, 370, 85, 25)

; Display the GUI.
GUISetState(@SW_SHOW, $hGUI)

ConsoleWrite("- TESTING" & @CRLF)

Local $sFilePath = _WriteTestHtml()

; Loop until the user exits.
While 1
Switch GUIGetMsg()
Case $idTest
_WD_Navigate($WD_SESSION, $sFilePath)
_WD_WaitElement($WD_SESSION, $_WD_LOCATOR_ByXPath, '//a[contains(text(),"TEST")]', 100, 30 * 1000) ; timeout = 50 seconds
ConsoleWrite("---> @error=" & @error & " @extended=" & @extended & _
" : after _WD_WaitElement()" & @CRLF)

Case $GUI_EVENT_CLOSE
ExitLoop

EndSwitch
WEnd

; Delete the previous GUI and all controls.
GUIDelete($hGUI)

EndFunc ;==>_Example

Func _My_Sleep($iDelay)
Local $hTimer = TimerInit() ; Begin the timer and store the handle in a variable.
Do
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ConsoleWrite("! USER EXIT" & @CRLF)
Exit
Case $idAbortTest
Return SetError($_WD_ERROR_UserAbort)
EndSwitch
Until TimerDiff($hTimer) > $iDelay
EndFunc ;==>_My_Sleep

Func _WriteTestHtml($sFilePath = @ScriptDir & "\TestFile.html")
FileDelete($sFilePath)
Local Const $sHtml = _
"<html lang='en'>" & @CRLF & _
" <head>" & @CRLF & _
" <meta charset='utf-8'>" & @CRLF & _
" <title>TESTING</title>" & @CRLF & _
" </head>" & @CRLF & _
" <body>" & @CRLF & _
" <div id='MyLink'>Waiting</div>" & @CRLF & _
" </body>" & @CRLF & _
" <script type='text/javascript'>" & @CRLF & _
" setTimeout(function()" & @CRLF & _
" {" & @CRLF & _
" // Delayed code in here" & @CRLF & _
" document.getElementById('MyLink').innerHTML='<a>TESTING</a>';" & @CRLF & _
" }, 20000); // 20000 = 20 seconds" & @CRLF & _
" </script>" & @CRLF & _
"</html>"
FileWrite($sFilePath, $sHtml)
Return "file:///" & StringReplace($sFilePath, "\", "/")
EndFunc ;==>_WriteTestHtml

Func SetupChrome()
_WD_Startup()
_WD_Option('Driver', 'chromedriver.exe')
_WD_Option('Port', 9515)
_WD_Option('HTTPTimeouts', True)
_WD_Option('DefaultTimeout', 40001)
_WD_Option('DriverParams', '--verbose --log-path="' & @ScriptDir & '\chrome.log"')
_WD_Option("Sleep", _My_Sleep)

Local $sCapabilities = '{"capabilities": {"alwaysMatch": {"goog:chromeOptions": {"w3c": true, "excludeSwitches": [ "enable-automation"]}}}}'
$WD_SESSION = _WD_CreateSession($sCapabilities)
_WD_Timeouts($WD_SESSION, 40002)
EndFunc ;==>SetupChrome
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ10">10. How to keep my WebDriver environment up-to-date</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ10">
<div class="toccolours mw-collapsible-content">
Q: How can I keep my WebDriver environment up-to-date?<br>
A: You have to check the following components:<p>
<b>WebDriver UDF:</b> Function _WD_IsLatestRelease compares local UDF version to latest release on Github. Returns True if the local UDF version is the latest, otherwise False. If you need to update the UDF you have to download it manually.<br>
<b>WebDriver Exe:</b> Function _WD_UpdateDriver checks or updates the Web Driver with newer version, if available.<br>
<b>Browser:</b> Function _WD_GetBrowserVersion returns the version number of the specified browser. If you need to update the Browser you have to download and install it by hand.<br>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ11">11. How to use "Locator strategy" and "Selectors"?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ11">
<div class="toccolours mw-collapsible-content">
Q: How to use "Locator strategies" and how to find "Selectors"?<br>
A: This UDF supports all locators defined in the Webdriver specifications. Below is a listing of predefined constants:<br>
{| class="wikitable"
|-
! Locator strategy !! Description how to use "Selector"
|-
| $_WD_LOCATOR_ByCSSSelector || CSS Selector string (see this [https://www.w3schools.com/css/css_selectors.asp site]). In CSS, pattern matching rules determine which style rules apply to elements in the HTML DOM document tree.
|-
| $_WD_LOCATOR_ByXPath || XPath string (see this [https://www.w3schools.com/xml/xml_xpath.asp site]). XPath is a language for addressing parts of an XML document.
|-
| $_WD_LOCATOR_ByLinkText || String with exact text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByPartialLinkText || String with partial text of <a> element, which should be used to locate the proper <a> element.
|-
| $_WD_LOCATOR_ByTagName || String that matches the desired element tag name, for example "button" is tag name of this element: <button name="ClickMe">
|}
<br>
Q: How can I check XPath and CSSSelector in the Browser?<br>
A: '''Work in progress....'''<br>
A: Take a look on this link: [https://testerlive.wordpress.com/2016/07/02/how-to-search-by-xpathcss-in-chrome-developer-tools/ How to search by Xpath/Css in Chrome Developer Tools?]

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ12">12. How to download PDF file automatically?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ12">
<div class="toccolours mw-collapsible-content">
Q: How to avoid browsers asking what to do with a file after clicking the "Download" button on a website?<br>
A: In FireFox you should add additional capabilites settings:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("prefs", "pdfjs.disabled", True)
_WD_CapabilitiesAdd("prefs", "browser.download.folderList", 2)
_WD_CapabilitiesAdd("prefs", "browser.download.dir", $s_Download_dir)
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.saveToDisk", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.helperApps.neverAsk.openFile", "application/pdf,application/octet-stream")
_WD_CapabilitiesAdd("prefs", "browser.download.useDownloadDir", True)
</syntaxhighlight>
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ13">13. How to setup session with proxy?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ13">
<div class="toccolours mw-collapsible-content">
Q: How to automate websites behind proxy?<br>
A: Take a look on:

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498049

and

https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/?do=findComment&comment=1498085
</div>
</div>

<div class="usermessage mw-customtoggle-FAQ14">14. How to add capabilities options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"'''?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ14">
<div class="toccolours mw-collapsible-content">
Q: How to add options for '''"goog:chromeOptions"''' or '''"ms:edgeOptions"''' or '''"moz:firefoxOptions"''' ?<br>
A: WORK IN PROGRESS: https://github.com/Danp2/au3WebDriver/pull/263

</div>
</div>

<div class="usermessage mw-customtoggle-FAQ15">15. How to change user-agent?</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-FAQ15">
<div class="toccolours mw-collapsible-content">
Q: How to change user-agent?<br>
A: Example for chrome:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("chrome") & " Safari/537.36")
</syntaxhighlight>

A: Example for firefox:
<syntaxhighlight lang="autoit">
_WD_CapabilitiesAdd("args", "user-agent", "Mozilla/5.0 (Windows NT 10.0; Win" & StringReplace(@OSArch, "X", "") & "; " & @CPUArch & ") AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" & _WD_GetBrowserVersion("firefox") & " Safari/537.36")
</syntaxhighlight>

</div>
</div>

== Tools ==
The following tools will help you to automate your browser:
* [https://autonomiq.io/deviq-chropath.html ChroPath] plugin: Makes finding an element by XPath, ID or CSS incredibly easy (Chrome, Firefox, Opera)
* [https://selectorshub.com/ SelectorsHub] plugin: Next Gen XPath tool to generate, write and verify the XPath and cssSelectors (All browsers)
* [https://addons.mozilla.org/pl/firefox/addon/save-page-we Save Page WE] plugin: helps to save web page content as single MHTML file (Firefox, [https://chrome.google.com/webstore/detail/save-page-we/dhhpefjklgkmgeafimnjhojgjamoafof Save Page WE for Chrome])

== References ==
<small>(Last modified: 2022/02/12)<br></small>

Further information sources:
* W3C: https://www.w3.org/TR/webdriver/
* AutoIt WebDriver discussion threads:
** '''[https://www.autoitscript.com/forum/topic/191990-webdriver-udf-w3c-compliant-version-01312022/ WebDriver UDF (W3C compliant version)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/192730-webdriver-udf-help-support/ WebDriver UDF - Help & Support]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201106-webdriver-udf-help-support-ii/ WebDriver UDF - Help & Support (II)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/205553-webdriver-udf-help-support-iii/ WebDriver UDF - Help & Support (III)]''' by @Danp2
** '''[https://www.autoitscript.com/forum/topic/201283-im-creating-a-webdriver-tutorial I'm creating a WebDriver tutorial]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ WebDriver example scripts collection]''' by @Water
** '''[https://www.autoitscript.com/forum/topic/201537-webdriver-example-scripts-collection/ Webdriver, Websockets, and Chrome DevTools Protocol]''' by @Danp2

* WebDriver Exe documentation:
** [https://sites.google.com/chromium.org/driver/ Chrome]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver Edge]
** [https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium Edge Chromium]
** [https://firefox-source-docs.mozilla.org/testing/geckodriver/ Firefox]
** [https://selenium.dev/documentation/en/webdriver/ Opera (Selenium)]

* Other useful links:
** [https://github.com/jlipps/simple-wd-spec/ The W3C WebDriver Spec: A Simplified Guide]

[[Category:Tutorials]]