Skip to content
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

Desired capabilities

A desired capability is a setting passed to the browser, device, or Cloud machine when a session starts, such as accepting an expired certificate or granting an app’s permissions at install. Common ones are listed here by browser and platform, with the key, data type, and value to enter for each. Add one to a run configuration, an app, or a Copilot session.

You add a capability as a KEY, a DATA TYPE, and a VALUE. Where you add it decides which sessions get it:

  • Run configuration: under Custom Desired Capabilities. Applies to every run that uses the configuration. Data types are String, Integer, Boolean, and Array. See Run configurations.
  • App: under Capabilities on the app page. Applies to every run of the app. Keys must start with appium: or ts:. See Apps.
  • Copilot session: under Custom Desired Capabilities in the Copilot configuration. Applies to that session’s run and device, and Arcus doesn’t keep it for the next session. See Copilot configuration.

When an app and a run configuration both set a capability, the run configuration’s value wins.

To do thisKeyData typeValue
Accept insecure or expired certificatesacceptInsecureCertsBooleantrue
Change the user agentgoog:chromeOptionsString{"args":["--user-agent=<user agent string>"]}
Add one extensiongoog:chromeOptionsString{"extensions":["path/to/extension.crx"]}
Add several extensionsgoog:chromeOptionsString{"extensions":["path/to/extension1.crx","path/to/extension2.crx"]}
Load an unpacked extension from a foldergoog:chromeOptionsString{"args":["--disable-features=DisableLoadExtensionCommandLineSwitch","--load-extension=/path/to/extension"]}
Emulate a mobile devicegoog:chromeOptionsString{"mobileEmulation":{"deviceName":"iPhone X"}}
Emulate a screen size Chrome doesn’t listgoog:chromeOptionsString{"mobileEmulation":{"deviceMetrics":{"width":560,"height":600,"pixelRatio":3.0}}}
Turn off browser and alert notificationsgoog:chromeOptionsString{"args":["--disable-notifications"]}
Use a custom browser profilegoog:chromeOptionsString{"args":["user-data-dir=/path/to/profile"]}
Bypass download protectiongoog:chromeOptionsString{"prefs":{"safebrowsing.enabled":"true"}}
Stop the password leak pop-upgoog:chromeOptionsString{"prefs":{"profile.password_manager_leak_detection":false}}
Use a fake UI for media streamsgoog:chromeOptionsString{"args":["--use-fake-ui-for-media-stream"]}
Use a fake device for media streamsgoog:chromeOptionsString{"args":["--use-fake-device-for-media-stream"]}
Capture the entire screengoog:chromeOptionsString{"args":["--auto-select-desktop-capture-source=Entire screen"]}
Stop waiting for a page to finish loadingpageLoadStrategyStringnone

Use pageLoadStrategy for a page that keeps scripts running and never fires its load event, such as a 3D Secure payment page. Without it, the driver waits for a load that never comes and stops responding after the navigation.

For a custom browser profile, name the folder with user-data-dir. The --profile-directory argument doesn’t work in Chrome. To use a profile such as Profile 1, copy its contents into a folder named Default and pass the folder that holds it. For a run on Local Agent, open chrome://version in Chrome on that machine to see the current profile path.

A geolocation takes two capabilities. The first allows location access, and the second sets the latitude, longitude, and accuracy in meters.

KeyData typeValue
goog:chromeOptionsString{"profile.default_content_setting_values.geolocation":1}
geolocationString51.50735, -0.12776, 100
To do thisKeyData typeValue
Accept insecure or expired certificatesaccept_untrusted_certsBooleantrue
Set a geolocationfirefoxprofileStringThe profile object below

The geolocation profile allows location access and sets a fixed position:

{
"geo.prompt.testing": true,
"geo.prompt.testing.allow": true,
"geo.enabled": true,
"geo.wifi.uri": "data:application/json,{\"location\": {\"lat\": 34.052235, \"lng\": -118.243683}, \"accuracy\": 100.0}"
}
To do thisKeyData typeValue
Accept insecure or expired certificatesacceptInsecureCertsBooleantrue
Run in private browsingMsOptionsString{"args":["--inprivate"]}
Allow clipboard accessMsOptionsString{"prefs":{"profile.default_content_setting_values.clipboard":1}}
Stop waiting for a page to finish loadingpageLoadStrategyStringnone
Open the app in Internet Explorer modets.ieModeBooleantrue

Internet Explorer mode runs a legacy app that needs Internet Explorer 11 inside Edge. It needs a Windows machine with Internet Explorer 11 installed. Protected Mode must also be the same in all 4 Windows security zones, or the session hangs.

To do thisKeyData typeValue
Accept insecure or expired certificatescapabilityType.ACCEPT_SSL_CERTSBooleantrue
Sign in to a site that uses basic authenticationtestsigma.customHeadersString{"Authorization":"Basic <token>"}

Safari blocks a username and password passed in the URL, so basic authentication needs the header instead. The token is your username and password, joined by a colon and encoded in Base64.

The same capabilityType.ACCEPT_SSL_CERTS key accepts insecure certificates in Internet Explorer.

These settings decide what the browser does when a page asks for the microphone, camera, location, or notifications. In each value, 0 asks every time, 1 allows, and 2 blocks.

PermissionFirefox, with firefoxprofileChrome, with goog:chromeOptions
Microphone{"permissions.default.microphone":1}{"prefs":{"profile.default_content_setting_values.media_stream_mic":1}}
Camera{"permissions.default.camera":1}{"prefs":{"profile.default_content_setting_values.media_stream_camera":1}}
Location{"permissions.default.geo":1}{"prefs":{"profile.default_content_setting_values.geolocation":1}}
Notifications{"permissions.default.desktop-notification":1}{"prefs":{"profile.default_content_setting_values.notifications":1}}

Both keys take the data type String. To set several permissions, put them in one object, separated by commas.

To do thisKeyData typeValue
Open the browser in incognito or private modetestsigma.privateBrowsingBooleantrue

Leaving the key out, or setting it to false, opens the browser normally. Private browsing works in Chrome, Firefox, and Edge.

These capabilities control the Cloud machine itself, so they apply only to runs on Cloud.

To do thisKeyData typeValue
Limit how long the browser waits for the next commandidleTimeoutIntegerSeconds. Default 90, minimum 0, maximum 1000
Limit the total length of a testmaxDurationIntegerSeconds. Default 3600, minimum 0, maximum 10800
Set the machine’s time zonetimeZoneStringA city name, such as Madrid
Capture the console log for each URLextendedDebuggingBooleantrue
Run from a location, for localization testinggeoLocationStringA 2-letter location code, such as DE

Both limits stop a test that has gone wrong from running indefinitely.

For timeZone, take the city from the list of tz database time zones on Wikipedia. Leave out the continent and replace underscores with spaces, so America/New_York becomes New York.

geoLocation takes one of these 48 codes:

LocationCodeLocationCode
ArgentinaARItalyIT
AustraliaAUJapanJP
AustriaATJordanJO
BelgiumBEMalaysiaMY
BrazilBRMexicoMX
BulgariaBGNetherlandsNL
CanadaCANew ZealandNZ
ChileCLNorwayNO
ChinaCNPhilippinesPH
CroatiaHRPolandPL
Czech RepublicCZPortugalPT
DenmarkDKRussiaRU
EgyptEGSingaporeSG
FinlandFISouth AfricaZA
FranceFRSouth KoreaKR
GermanyDESpainES
GreeceGRSwedenSE
Hong KongHKSwitzerlandCH
HungaryHUTaiwanTW
IcelandISThailandTH
IndiaINTurkeyTR
IndonesiaIDUkraineUA
IrelandIEUnited KingdomGB
IsraelILUnited StatesUS

On an app’s Capabilities, a key must start with appium:, so add it to a key that doesn’t have it, for example appium:autoGrantPermissions. An app doesn’t accept noReset, so set it in a run configuration.

To do thisKeyData typeValue
Keep the app’s data between sessionsnoResetBooleantrue
Grant the permissions in the app manifest at installautoGrantPermissionsBooleantrue
Speed up taps and typing in a slow appappium:waitForIdleTimeoutString1000L
Test a Flutter app with the Flutter integration driverautomationNameStringFlutterIntegration

appium:waitForIdleTimeout helps most with apps built in React Native or Flutter, which can be slow to record and run.

To do thisKeyData typeValue
Accept every permission pop-up, including location, contacts, and photosautoAcceptAlertsBooleantrue
Dismiss every permission pop-upautoDismissAlertsBooleantrue
Test a Flutter app with the Flutter integration driverautomationNameStringFlutterIntegration

Re-signing isn’t a capability in Arcus. To keep an iOS build as it is, select Skip re-signing when you upload it. Use this only for a build already signed for the target devices. See Upload a build.

Camera image injection and network logs aren’t capabilities in Arcus. They’re the Fixed Capabilities toggles in a mobile run configuration, and they’re off unless you turn them on. See Mobile configurations.

An app with security controls against camera or network spoofing can stop responding after it launches. If that happens, turn Camera image injection and Network logs off for the run. With camera image injection off, steps that inject an image through the camera don’t work.

To do thisKeyData typeValue
Simulate Touch ID or fingerprint input on Android and iOStestsigma.allowTouchIdEnrollBooleantrue

Was this page helpful?