To execute automation scripts, the following sequential process is involved.
Customers can subscribe to one or more automation scripts in the AppDirect Marketplace. Once subscribed, Infoblox enables the automation in the customer's Cloud Services Portal account.
Key points to note:
Customers are responsible for setting up and maintaining their On-Prem Host.
In the case of AppDirect Marketplace automation scripts, subscribers cannot view the script code. However, script variables can be modified per the organization’s requirements in Data Connector. The exception to this is the Data Connector source which cannot be modified.
Customers can deploy a new on-prem host. Upon subscribing to a script, the customer can use the script within their newly deployed environment. New workflows are created using the automation application in the Cloud Data Connector Manager (CDC). The automated workflow, which runs based on the script, is deployed and executed on the organization’s On-Prem Host. The processed data is then sent to the specified destination as described in the script.
Note: The organization is responsible for executing automation scripts.
Viewing and Modifying Marketplace Integration Scripts for Data Connector in the Cloud Service Portal
In the Cloud Services Portal, subscribed scripts can be viewed in Data Connector. (Cloud Services Portal > Automations > Data Connector > Traffic Flows). Script subscribers will be able to view the script’s auto-generated flow, the source, and the destination and assign variables to its destination. Under the Automations tab, subscribers can view their scripts. In the case of subscribed scripts, the script will not be displayed. For the source and destination, script subscribers can modify the script once it populates in the Data Connector section in CSP. The script’s name and description can be updated, as can the variables and tags associated with its destination. The script’s source cannot be modified.
Configuring Subscribed to AppDirect Automation Scripts in Data Connector
With the automation scripts to which you’ve subscribed to through the AppDirect Marketplace, you have the option of staying with the default configuration or modifying the script in Data Connector to better suit your orgaizations' requirements.
Automation scripts subscribed to through the AppDirect Marketplace are imported directly into Data Connector in a disabled state. Before they can be used, they must be enabled.
Enabling an Automation Script in Data Connector (default configuration)
To enable a subscribed to automation script in Data Connector without modifying its default configuration, perform the following:
a. Navigate to the Data Connector Traffic Flow tab in the Cloud Services Portal ( Cloud Services Portal > Integrations > Data Connector > Automations > Traffic Flows).
b. Locate the script from among the scripts listed on the page.
c. Select the script, then click Edit to open the Data Configurator Wizard.
d. In the General page’s State section of the Data Configurator Wizard, toggle the switch to the enable position.
e. On the Log Source Configuration page in the Source Configuration section, add Log Type as the Source Configuration type followed by selecting Internal Notifications from among the notification type options to set up notifications to your message application.
Modifying and Enabling an Automation Script in Data Connector (customized configuration)
To modify and enable a subscribed to automation script in Data Connector, perform the following:
Step 1. Destinations tab
a. Navigate to the Data Connector Destinations tab in the Cloud Services Portal Destinations tab ( Cloud Services Portal > Integrations > Data Connector > Automations > Destinations).
b. Select a service instance (On-prem VM) from among the options on the drop-down list.
c. Name: Update the name with a meaningful name (optional).
d. Description: Provide a meaningful description for the automation script (optional).
e. State: Enable the automation script. By default, scripts subscribed to through the AppDirect Marketplace are disabled.
f. Automation Script: In the Automation Script section of the page, a drop-down list of your automation scripts will be displayed. Select the desired automation script from among the options on the page.
g. When configuring the destination for your script, confirm you have selected the correct automation script.
h. Variables: In the Variables section of the page, click Add and specify the following variables to associate an automated script with a destination:
KEY: For automation scripts subscribed to through the AppDirect Marketplace, a webhook must be created. For example, if an automation script reports to Slack, then a Slack webhook must be created. When configuring an automation script reporting to Slack, the key webhook will be "SlackWebhook". For a script reporting to Microsoft TEAMs, the webhook is "TeamsWebhook." Additionally, a second key value must also be added: CspApiKey.
VALUE: Add your own organization's webhook. Your webhook can be obtained in the Cloud Services Portal Service Notifications tab (Notifications > Service Integrations). When adding a webhook for Slack, it should look similar to the following example:
https://hooks.slack.com/services/<alphanumeric URL string>.
Likewise, a webhook for microsoft Teams would look similar to the following: https://hooks.teams.com/services/<alphanumeric URL string>.
i. Tags: Apply updated tags (optional).
j. Click Save & Close.
Step 2. Traffic Flow tab
a. Navigate to the Data Connector Traffic Flow tab in the Cloud Services Portal ( Cloud Services Portal > Integrations > Data Connector > Automations > Traffic Flows).
b. Locate the script from among the scripts listed on the page.
c. Select the script, then click Edit to open the Data Configurator Wizard.
d. On the General page of the wizard in the State section, toggle the switch to the enable position.
e. On the Log Source Configuration page in the Source Configuration section, add Log Type as the Source Configuration type followed by selecting Internal Notifications from among the notification type options.
f. On the Destination Configuration page of the wizard, the destination will already be selected as part of the destination configuration process which has previously been completed in step 1-e. If the script has not already been enabled, enable it now.
Step 3. Service Instance tab
a. Navigate to the Data Connector Destinations tab in the Cloud Services Portal Destinations tab ( Cloud Services Portal > Integrations > Data Connector > Automations > Service Instance)
b. Select a service instance (On-prem VM) from among the options on the drop-down list.
Step 4. Configuration process update completion
a. Click Next followed by clicking Finish to complete the configuration update process.
Step 5. Automations tab
To review the updated automation script configuration in the Automations tab perform the following:
a. Navigate to the Data Connector Automations tab in the Cloud Services Portal Destinations tab ( Cloud Services Portal > Integrations > Data Connector > Automations > Automations).
b. Locate the desired automation script from among the list of automation scripts.
c. Review its updated configuration information. For automated scripts, the destination column will indicate it is an auto-generated script.
d. On the Destination Configuration page of the wizard, the destination will already be selected as part of the destination configuration process which has previously been completed in step 1-e. If the script has not already been enabled, enable it now.
You can add additional reporting destination channel by creating a new application, selecting the same automation script and adding your key values obtained from the Cloud Services Portal along with adding an addition unique webhook to direct the reporting to the additional channel.
For additional information on creating and using automation scripts with Data Connector, see the following topis:
Configuring Automations (need to update the hyperlinks due to the name change)
For information on how to subscribe and use marketplace integration scripts, see the following topics:
Termination of Data Connector Flows on the Event of Unsubscribing to a Marketplace Integration Script
Upon unsubscribing to a Marketplace script, the Marketplace Controller will delete the data connector traffic flow associated with the script. the controller will also delete any applications created using the script.
Creating and Using Your Own Organization’s Application Scripts
In addition to purchasing pre-made scripts through the Marketplace, your organization can create and deploy its own automation scripts. To use your organization’s own automation script with data connector, see the following topics.