Mobile Center Appium Capabilities

The Mobile Center integration extends the standard Appium capabilities. The following table provides information about several common capabilities:

Appium/MC capability Required Comments
userName * * If your administrator allowed anonymous logins for Appium scripts, you can leave out the userName and password capabilities. The administrator sets anonymous access in the General section of the Administration > Settings screen. For details, see Administration Settings.
password * * See comments by userName.
tenantId

When working with the Early access features and multiple projects, you must also include the nine-digit project ID. You can find this in the toolbar of the Lab Console. For details, see Connect to a Mobile Center project . The default project's ID is 999999999.

app --

Not supported in MC integration. To install an app on a device, use appPackage and appActivity for Android, and bundleId for iOS.

appPackage (Android)

The package name that identifies the app, displayed as Package ID in the app details card. See the image below this table for an example.

If the app is not already installed on the device, Mobile Center checks to see if the app exists in the database. If it exists, it installs it automatically before running the test steps.

appActivity (Android)

The name of the Android activity to be launched, displayed as the Launch activity in the app details card. See the image below this table for an example.

If the app is not already installed on the device, Mobile Center checks to see if the app exists in the database. If it exists, it installs it automatically before running the test steps.

bundleId (iOS)

A unique identifier, the Bundle ID of the app, displayed as Package ID in the app details card. For example, "com.hpe.advantage", or as shown in the example below.

If the app is not already installed on the device, Mobile Center checks to see if the app exists in the database. If it exists, it installs it automatically before running the test steps.

deviceHostingType

"PrivateOnPremise", "Public", or "PrivateHosting"

deviceType

"real" or "emulator"
platformName "Android" or "iOS"
platformVersion

The version of the OS. You can specify a enumeration symbol, such as <, >, <=. >=, and =.

For example, "platformVersion", ">5.0.1"

deviceName

The physical or emulated device name. You can specify a manufacturer, model, or logical name as it appears in Mobile Center console. See the image below this table for an example.

If no device name is specified, the script uses a default device for the specified capabilities. Use this capability in conjunction with or instead of udid.

Use these guidelines when specifying a device by its manufacturer, model name, or logical name.

  • By default, the search engine performs a fuzzy search, returning the first device that matches part of the string, even if it is not the best match.
  • If your device name is a sub-string of another device's name, use other capabilities such as udid, to avoid ambiguity.
  • To match an exact string, use a refined search with double quotes. For example "\"Apple iPhone 5c (GSM+CDMA)\"" will look for a device with that exact manufacturer and model name. (Note the use of backslashes as escape characters.)
UDID

The UDID identifier of the device as assigned by MC. See the image below this table for an example.

If no UDID is specified, the script uses a default device for the specified capabilities. Use this capability in conjunction with or instead of deviceName.

browserName

When testing a web application on a browser, for example, "browserName", "safari".

automationName

For iOS (versions 9.3 and higher):

The standard Appium behavior for automation is to use XCUITest. If you explicitly wish to use UI Automation, set this capability to uiAutomation.

Mobile Center enables you to run an Appium test with any type of connector (Mac, Windows, or Linux), for iOS versions 9.3 and higher, for both XCUITest and UIAutomation.

If you are running a pure Appium script, XCUITest requires a Mac Connector. UIAutomation does not require a Mac connector for a pure Appium execution.

For Android:

The uiautomator2 driver uses Google's UiAutomator2 technology to allow automation on a device or emulator.

To use automation for your Android apps, set the automationName capability to “uiautomator2”. To use Uiautomator1, the default value, set the value to "android".

mcWorkspaceName

Enables you to specify an application which was uploaded to a specific workspace.

mc:net:profileName

Enables Network Virtualization in your Appium test and starts a new emulation on the NV Test Manager server.

Specify a network profile to use from the known NV profiles. You can change to a different profile after the test started. For details, see the Common Appium API calls.

Note: When the Appium session terminates, the emulation also stops.

The following sample App Details box (opened by clicking the More button on the App card) shows the Package ID and Launch activity for an Android app.

The following sample device card shows the deviceName (which can be represented as the logical, manufacturer, or model name) and UDID for an Android device.

Back to top

See also: