Skip to main content

Cyware Orchestrate

Debug Custom Apps

Orchestrate provides a python IDE editor to help analysts easily develop custom apps. Analysts can debug the custom app’s code by testing it as they develop them in the IDE. Once the Playbook is executed, you can find the overall test results under the Debug tab of the editor.

For example, if a custom code is created for an app, and if the API-token is missed, then the error __init__() missing 1 required positional argument: 'api_key' is displayed.

Before you Start

Ensure that you have the Create/Update App Config permission.

Steps

You can debug the custom app in the IDE after it has been saved.

  1. Sign in to Orchestrate, and go to Main Menu > Apps.

  2. Hover to the ellipsis icon of the custom app, and click Edit App.

  3. Click Run in the python IDE editor.

  4. In the Details to Test tab, choose one of the following options and enter the required details:

    • Click Choose Instance to test the app for a single instance. Choose the required instance and the action from the dropdowns.

    • Click Provide JSON data to test the app for multiple instances. Enter the JSON data consisting of multiple instances, and choose the required action from the dropdown.

  5. Click Test.

The app is tested and the test results are displayed in the Debug tab.