Generate Run Code for BitBar Dialog

1. Select the mobile device and a tested application for which you want to open a testing session:

   • You can select devices that have any status in the Status column. However, the selected device must be Available when the test run starts.

   • If the selected device is not available, TestComplete will not be able to connect to it. To command TestComplete to search for a replacement device, select the Connect to another device when the selected one is not available check box. On the Device Cloud > Mobile page of your project, you can set the search criteria for the replacement devices.

   • 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.

     For iOS only: 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 View more BitBar parameters > Custom Parameters tab.

2. To get more advanced options, click View more BitBar parameters:

   • On the Parameters tab, you can filter the device list by the device type, the version of the operating system running on the devices, their screen resolution, and their location.

   • By default, when a device is disconnected, the testing session on it is closed, and the device is restored to its initial state. Until the device is restored, it will remain unavailable. To keep the session alive to be able to reconnect to it, select the Keep the device available for quick reconnection check box. The session will be available for reconnection for up to 60 seconds.

   • 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

     Copy Code

     JSON

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

     The JSON code will be validated 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.

The dialog will generate the code based on the parameters you specify and will show the generated code in the lower part of the dialog. You can select and copy the code to the clipboard manually, or you can click Copy to clipboard. The dialog will copy the entire code to the clipboard and then close. Insert the code from the clipboard to the needed place in your code.

Click Close to close the dialog without copying anything.

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.

The dialog will generate the code based on the server URL and capabilities you specify and will show the generated code in the lower part of the dialog.

You can select and copy the code to the clipboard manually, or you can click Copy to clipboard. The dialog will copy the entire code to the clipboard and then close. Insert the code from the clipboard to the needed place in your code.

Click Close to close the dialog without copying anything.