1. Home
  2. Opkey Help
  3. 5. Working with Mobile Apps Testing
  4. 5.5 iOS App Instrumentation with Opkey Framework Library

5.5 iOS App Instrumentation with Opkey Framework Library

An Overview:

Now, OpKey has a framework library for instrumenting the iOS apps for testing. During app instrumentation, the OpKey framework library is being embedded in the app. Once the instrumentation has finished, the iOS app can be uploaded to the OpKey Cloud environment (Application Management under Mobile Management) which can be further used for testing the app on OpKey.


Pre-instrumented iOS apps are required only if you want to execute a recorded test script on a locally connected iOS device with your system. If you want to execute your iOS flow (test script) on an iOS device existing on cloud (pCloudy) then uploading pre-instrumented iOS App is not required as OpKey allows you to upload your un-instrumented iOS app directly on OpKey cloud, create your test script and then execute it on desired iOS device located on cloud (pCloudy).


  1. The Source Code of the IPA (iOS App).
  2. OpKey iOS Recorder Framework (To download the updated OpKey iOS Recorder Framework, click here).
  3. A Mac Machine with Xcode that can compile the source code (Here, we have used Xcode version 11.4.1).
  4. An Apple Developer Certificate and Provisioning Profile (to resign the application).

Adding Framework Library:

  • Make sure that you have downloaded the OpKey framework library from the authentic link shared by the OpKey team.

  • Open your iOS app in Xcode and then embed the OpKey framework library.
  • Navigate to the Frameworks, Libraries, and Embedded Content tab and expand it. Here, you can view that there is no framework.

  • Click on the Add button to upload the Embed Frameworks.

  • Browse and select the IosRecorder.framework Library and click on Open.


  • In this step, here are a few options for adding the files.
  • Click Finish.

  • Now, here you can view that the IosRecorder.framework Library has been embedded in your iOS app.

  • Build the iOS App

Now, you need to build your iOS App. Click on the Product menu and click on the Build option.

  • Archive iOS App

Once the iOS App build has created successfully, you need to archive it to make it a usable iOS App. Let us archive the iOS app now. Click on the Product menu and then click on the Archive option.

Points to remember:

  • Before uploading the instrumented iOS in this way, you are recommended to install this app in your iOS device which should work as a normal iOS app.
  • If the iOS app is working normally in your iOS device then you can upload this instrumented iOS app on OpKey Cloud (by clicking on Upload Instrumented Application(s) button) from the Application Management tab under Mobile Management in OpKey. (For details, please refer Application Management)
  • Once the instrumented iOS App has uploaded successfully, you can record actions performed on this iOS app on the pCloudy device and create your iOS test script which can be further executed on a local iOS device connected with your system.
Was this article helpful to you? Yes No 2