Run Remote Device Operation

If you use BitBar and there is no BitBar API key specified in the current TestComplete project, enter the API key you will use to run tests and click Apply.

Learn how to get the API Key

Learn how to get the API KeyLearn how to get the API Key

1. Log in to BitBar with your BitBar account.

   If you still do not have a BitBar account, you can sign up for a free trial.

2. Click  > My Account at the top right of the page.

3. In the My Integrations section, click API.

4. On the resulting page, click to copy your API key to the clipboard.

Click the image to enlarge it.

If you use a private mobile cloud, click Local Appium.

1. On the Parameters tab, select the mobile device and a tested application for which you want to open a testing session.

   The Found devices list contains all the devices that are available for you in BitBar and that match the search criteria. If needed, you can filter the list by using the Device Type, OS Version, Resolution and Quick Search filters.

   The Status column shows the status of a device:

   • Ready

   • Occupied

   • On maintenance

   • Subscription only

   Select the device to which you want to connect. Note: You can select a device that has any status. However, the selected device must have the Ready status at the moment when the operation will run.

   To configure the operation to connect to another suitable device if the selected device is not available during the test run, select the Connect to another device when the selected one is not available check box. To find a suitable device, the operation will use the criteria to find a BitBar device. You can view and edit the criteria on the Project Properties > BitBar & Local Appium page of the project.

   If no suitable device is found, the operation will report an error.

2. In the Application drop-down list box, select a mobile application for which you want to open a testing session. The application file must be either stored in the BitBar Files Library or added to the Tested Applications of the current TestComplete project. In the latter case, click Upload to BitBar to upload the application file to the BitBar Files Library and then select it in the list.

   If you are testing an iOS application: To be able to launch and stop the tested application from tests or by using the Mobile Device Screen window of TestComplete, specify the bundle ID of the application when connecting to the device. It is the bundle ID that was used to compile the specified .ipa file. Add the bundleId capability to the list of desired capabilities on the Custom Parameters tab.

3. If needed, on the Custom parameters tab, you can specify additional capabilities to be used for the testing session. Specify the capabilities in the JSON format. For example:

   JSON

   JSON

   {
     "bitbar_project": "Automated tests",
     "bitbar_description": "Testing the Orders app"
   }

   The operation will validate the JSON code as you are typing it.

   Note: The capabilities you specify on the Custom capabilities tab can overwrite values specified on the Parameters tab.

   For the list of available capabilities, see the BitBar Documentation - Desired Capabilities.

Note: You must have your local Appium server running and available from your TestComplete workstation. For information on how to configure a local Appium server, see Set up Appium Server.

1. In the Server URL text box, enter the URL address of your Appium server.

2. In the Application Path text editor, specify the full path to the application that you want to install on the target mobile device and from which you want to open a testing session. If your application is added to the list of tested applications in your TestComplete project, you can click the down-arrow button and select the application path from the drop-down list. You can also type the path manually, or you can click the ellipsis button and browse for the needed application file.

   Specify the application path relatively to the Appium server location.

   You can also specify the application path using the app capability in the Parameters editor. The app capability value will override the Application Path value.

3. In the Parameters editor, enter the capabilities that describe a testing session you want to open, in the JSON format. The dialog will validate the JSON code as you are typing.

   View required capabilities

   View required capabilitiesView required capabilities

   Capability	Description	Sample value for iOS	Sample value for Android
   platformName	The name of the mobile OS where you want to open a testing session.	iOS	android
   platformVersion	The version of the mobile OS where you want to open a testing session.	14.0	11
   deviceName	The mobile device or emulator on which you want to run your test.	iPhone Simulator	Galaxy Z41
   udid	The unique identifier of the mobile device. Compulsory for physical iOS devices. To learn how to get your iOS device UDID, see Get iOS Device UDIDs.	Hxs7pLHkUZ2O3R74	80A7FO960a61Ye3h
   automationName	The test automation framework to use.	XCUITest	UIAutomator2
   app	The full file path or the URL address of your tested mobile application. For iOS devices, it could be a debug version of the application (.app) or a release version of the application (.ipa). For Android devices, it is .apk files.	.app (for emulators) .ipa (for physical devices)	.apk

   For information on all available capabilities, see Appium Desired Capabilities.