Siemplify enables analysts to create custom integrations inside the IDE with the same structure as Siemplify commercial integrations. Users can write or upload different script dependencies required for custom integrations to work. The custom integrations will appear in the Marketplace and can be configured for different environments so they can be used in Playbooks, manual actions and remote agents. They can also be imported and exported the same as other IDE items.
In this article we will explore how to build a custom integration to the Confluence Wiki product and adding in a Job which writes each new incoming Siemplify case in a specific page in Confluence. We will also discuss other general aspects in the Siemplify platform which support custom integrations.
Setting up the Custom Integration
- Navigate to the IDE Screen.
- Click the + icon to add a new IDE item.
- Click on Integration and add the Integration name. For the purposes of this example, we will enter Confluence Integration.
- Click Create. The new Integration appears in the list of Integrations with the Custom symbol next to it.
- Click on the wheel icon to open the custom integration main box. Here you can add the following:
- Description of your Integration. Note that this description will appear in the Marketplace and will be visible to all Siemplify users.
- Image of your integration. Note that this picture will appear in the Marketplace and will be visible to all Siemplify users.
- Script dependencies – you can upload scripts written in whl, py, tar, gz formats. These scripts will add more functionality to your integration. For example, you can upload an HTTP Python library for REST operations. Click on the + icon and upload the required script.
- Parameters – you can add parameters or fields to your Integration which need to be configured in the Marketplace. You can choose the type of parameter, default value and whether or not to make it a mandatory field. For example, for a Confluence Integration, you might want to add Confluence API Address, Username, Password etc.
- Click Save when done.
Creating a new job
There are several ways to do this. One option is to find an existing predefined job which does something similar, duplicate it and adapt it to your needs.
Another option is to create a new job as follows:
- Click the + icon to add a new Job. Enter a name. For example, Push Siemplify Case into Confluence and select the Confluence Integration in the Integration field. This automatically places the new job underneath the Confluence custom integration in the list on the left hand side.
- Edit the job as required. Please note that for the purposes of this article, we will not detail the actual work needed to change the code for the Job. If you need help with scripting, please speak to your Account Manager.
- After the job is saved – it will appear in the Jobs section and can be used and scheduled.
Creating a Ping Action
In order for your custom integration to have the same testing abilities as other integrations in the Marketplace, you need to configure a Ping action for your integration.
- Click the + icon to add a new Action. Enter a name. For example, Ping.
- Select the Confluence Integration and click Create.
- Select the Ping action and configure the Details and Testing as required.
- Click Save when done.
This action should implement (via code) the logic for the test and return back a result. For more information, refer to the SDK Guide.
Viewing your Custom Integration in the Marketplace
Navigate to the marketplace and search for the custom integration you created. Note that if you didn’t create an image during the initial configuration, then the default custom image will be assigned to it. You can configure any parameters necessary here but you do not need to download or update it. Note that Marketplace updates will not override or delete any custom integrations.
Exporting/Importing in the IDE
Use the Export / Import buttons to back up or share the integration with other parties.
Custom integration export/import zip packages contain the following:
- Action scripts
- Action def
- Integration def
- Connector scripts
- Connector def
- Job scripts
- Job def
- Mapping rules
- Modeling rules
If you need help configuring your integration or working on existing Jobs/Actions/Connectors and making them interact with the Siemplify platform, you can click on the SDK link at the top of the screen to access the Siemplify SDK guide.
Need more help with this?
Click here to open a Support ticket