IDE

The Integrated Development Environment (IDE) is a framework for viewing, editing, and testing code. It allows you to view the code of commercial integrations and to create custom integrations from scratch or by duplicating commercial integrations code.

In addition – this is the place to manage, import and export custom integrations.
To open the IDE, click the IDE code icon on the top right menu. The IDE screen displays.

The following options are available from the top left of the screen:

Option	Description
	Choose between Integrations or Types (Connectors, Actions, Jobs and Managers)
	Import or Export Packages (zip files only)
	Show or Hide disabled items (actions, connectors)
	Can add a new custom Integration, connector, action, job or manager to the list.

To add a connector

1. Click plus icon and give a name to the new connector.
2. In the right of the screen, add Integration details.
3. Add the required parameters.
4. Toggle the button at the top to the green position to enable the job.
5. Click Save when done, or click Ctrl + S.
   
   

The following options are available from the right of the screen:

Option	Description
	The delete option is available for IDE items added to Custom Integrations only.
	Runs the Test method of the script, which runs the selected script (action \ job \ connector). The result of the script is shown in the Testing tab and the debug information (Python prints) is shown in Debug Output for debugging purposes.
	This is the JSON Sample import/export dialog. Note that you need to enable “Include JSON Result” and then when using an action which returns JSON result, you can click on this icon and choose whether to import your own JSON sample, or export the current one in order to edit it.
Details	In the details tab, you can provide the user supplied input as well as other parameters such as Integration name.
	Version Control - Select an action/job/connector and click to see the following options: Save as New Version - Click to save the object as a new version, add your comments, then click Save as. View Version History - Click to see the version history of the object in a tabular form. Click Restore to revert to any of the previous versions anytime. This is only available if you have clicked Save as New Version on an action/job/connector/manager previously.
	Select a job/action/connector/manager and click the duplicate icon to create a copy of the job/action/manager. You can then edit this according to your needs. You will notice that after pressing Save this now appears in the list without the lock icon.

To create a custom integration:

1. Click the plus icon and select Integration. Enter a name and click Create.
2. Click the wheel icon and add in the relevant information:
   1. Description of your Integration. Note that this description will appear in the Marketplace and will be visible to all Siemplify users.
   2. Image of your integration. Note that this picture will appear in the Marketplace and will be visible to all Siemplify users.
   3. Script dependencies – you can add scripts written in whl, py, tar, gz formats. These scripts will add more functionality to your integration.
   4. Parameters – you can add parameters or fields to your Integration which need to be configured in the Marketplace. You can choose type of parameter, default value and whether or not to make it a mandatory field.
3. Click Save when done.
   

*Note that you can add jobs, actions, managers and connectors to your custom integration and use them to push or collect information according to your needs. Simply create a new action and then choose the custom Integration. It is also recommended to create a Ping action so that you can test it in the Marketplace.
For more detailed information on Custom Integrations, please refer here.

To create a job:

1. Click the plus icon and select Job. Enter a name and click Create.
2. Toggle the button at the top to the green position to enable the job.
3. In the Details tab at the right, select an Integration.
   
   You can also add parameters which enables you to configure jobs to receive input from users or another script.
4. Make sure to click the Save icon on the top right of the screen, or click Ctrl + S.
5. Click the green arrow (Play Item) in order to run the script.
6. Next, navigate to Settings > Jobs.
7. Click the plus icon and select the Job that you just created.
8. Choose the required time in the Scheduler to run the Job (script) that you created.
   

To create a new action to be used in a Playbook:

1. Click the plus icon and select Actions. Enter a name and click Create.
   
2. Edit the code as required.
3. Make sure to enable the “Include JSON Result” if you want the Action to return JSON results in the Playbook.
4. If necessary, add parameters to be displayed as a drop down list.
5. Make sure to enable the action and click Save at the top right of the screen.
6. In the right side of the screen, under the heading Polling Configuration, you can choose to define the amount of time after which if the Action has not returned a result it times out. You can add a default value to be returned in the event of a timeout.
   
   The Action is now available for use in the Playbook > Actions.
   

To create a custom manager:

1. Click the plus icon and select Manager. Enter a name and the required Integration and click Create.
   
2. Edit the code as required.
3. Click Save.
   

*For more help with this page, click on the link to the SDK Guide in the screen or alternatively, click here.