Use the Content Hub to install and configure connectors in FortiSOAR™. The Content Hub enables you to easily view, search, install, upgrade, and uninstall connectors that are part of the FortiSOAR™ repository.
Note: The Connector Store is filtered to display only connectors, whereas the Content Hub displays all the add-ons. In this article the screenshots included are from the Content Hub page; similar screens are displayed on the Connector Store page.
For the procedure to install a connector, click here.
To configure connectors into FortiSOAR™, you must be assigned a role that has a minimum of Update
access to the Connectors
module.
Some connectors, such as Spamhaus and PDF Reader do not require any configurations. In the case of Spamhaus, the connector looks up freely-accessible Spamhaus blocklists.
Use the Content Hub to install and configure connectors in FortiSOAR™.
Log on to FortiSOAR™.
On the left navigation pane, click Content Hub.
The Discover tab displays all the add-ons, i.e., Connectors, Widgets, and Solution Packs, available in the Content Hub. Use the Filter panel to filter the connectors by clicking the > arrow in the Content Type list and then selecting Connectors:
You can search for a connector by its name in the Search field and sort the content alphabetically (A-Z) or by date. Using the Filters panel, you can filter the connectors displayed in all the tabs based on varied criteria. For more information on Content Hub, see the Content Hub chapter in the "User Guide.'
Connectors that are installed appear with a tick on their card. For example, the Active Directory connector in the above image.
Manage
page, you will see the list of installed connectors in the card view. You can search for a connector by its name in the Search box and sort the connectors either alphabetically or by date. Also, when you select Connectors as the Content Type by default, Non Configured connectors are displayed in the Manage tab. You can select Configured from the drop-down to view the configured connectors:Name
for each configuration in the Configuration Name field.password
type fields in FortiSOAR™ include encryption and decryption. Passwords are encrypted before saving them to the database and decrypted when they are used in actions. In case of an upgrade, connectors that are already installed will work with stored passwords.True
.To save your configuration, click Save.
To view the list of actions that can be performed by the connector and the playbook file that is bundled with the connector, click the Actions & Playbooks tab.
(Optional) You can optionally perform a Health Check by clicking the Refresh icon that is present in the Health Check
bar. The Health Check checks if the configuration parameters you have specified are correct and if connectivity can be established to the specified server, endpoint, or API.
If all the details are correct and the connectivity to the server can be established, then on the Connectors page, Available is displayed in the health check dialog.
If any or all the details are incorrect or if the connectivity to the server cannot be established then on the Connectors page, Disconnected is displayed in the health check dialog.
If you are upgrading a connector to a newer version, you must be assigned a role that has a minimum of Upgrade
access to the Connectors
module. For example, if you are upgrading the Symantec Security Analytics connector version from v1.0.0 to v2.0.0, then keep a note of the following points:
Existing (older) connector configuration fields retain their value, i.e., the value from the older configuration will be displayed in the configuration pane of the newer connector version. New connector configuration field(s), if any, will be added to the connector configuration pane.
If the newly added configuration field is mandatory, and FortiSOAR™ has specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain the default value for this configuration field. For more information on the connector framework and the info.json
file, see the Building a custom connector chapter. For information on common connector framework issues, see the Common connector framework errors section in the Debugging common playbook and connector issues article present in the Fortinet Knowledge Base.
If the newly added configuration field is mandatory, and FortiSOAR™ has not specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain a blank
value for this configuration field. If you also do not specify a value for this mandatory configuration field, then the connector configuration pane will display Partially Configured, and an error will also be displayed in the Playbook Execution Log. For more information on the Playbook Execution Log, see the Debugging and Optimizing Playbooks chapter in the "Playbooks Guide."
If the field type of a mandatory configuration field is changed from the older version to the newer version, for example from a text field to a drop-down list, then the value of that field will not be retrieved from the older version. However, if FortiSOAR™ has specified its default value (in the info.json
file of the connector), then that value will be displayed for this configuration field in the configuration pane of the newer version of the connector. If however FortiSOAR™ has not defined the default value and you also do not specify a value for this mandatory configuration field, then the configuration pane of the newer version of the connector will contain a blank
value for this configuration field, and the connector configuration pane will display Partially Configured. An error will also be displayed in the Playbook Execution Log. For more information on the Playbook Execution Log, see the Debugging and Optimizing Playbooks chapter in the "Playbooks Guide."
If the newly added configuration field is optional, and FortiSOAR™ has specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain the default value for this configuration field. If there is no default value set, then its value is set as blank
.
Use the Content Hub to install and configure connectors in FortiSOAR™. The Content Hub enables you to easily view, search, install, upgrade, and uninstall connectors that are part of the FortiSOAR™ repository.
Note: The Connector Store is filtered to display only connectors, whereas the Content Hub displays all the add-ons. In this article the screenshots included are from the Content Hub page; similar screens are displayed on the Connector Store page.
For the procedure to install a connector, click here.
To configure connectors into FortiSOAR™, you must be assigned a role that has a minimum of Update
access to the Connectors
module.
Some connectors, such as Spamhaus and PDF Reader do not require any configurations. In the case of Spamhaus, the connector looks up freely-accessible Spamhaus blocklists.
Use the Content Hub to install and configure connectors in FortiSOAR™.
Log on to FortiSOAR™.
On the left navigation pane, click Content Hub.
The Discover tab displays all the add-ons, i.e., Connectors, Widgets, and Solution Packs, available in the Content Hub. Use the Filter panel to filter the connectors by clicking the > arrow in the Content Type list and then selecting Connectors:
You can search for a connector by its name in the Search field and sort the content alphabetically (A-Z) or by date. Using the Filters panel, you can filter the connectors displayed in all the tabs based on varied criteria. For more information on Content Hub, see the Content Hub chapter in the "User Guide.'
Connectors that are installed appear with a tick on their card. For example, the Active Directory connector in the above image.
Manage
page, you will see the list of installed connectors in the card view. You can search for a connector by its name in the Search box and sort the connectors either alphabetically or by date. Also, when you select Connectors as the Content Type by default, Non Configured connectors are displayed in the Manage tab. You can select Configured from the drop-down to view the configured connectors:Name
for each configuration in the Configuration Name field.password
type fields in FortiSOAR™ include encryption and decryption. Passwords are encrypted before saving them to the database and decrypted when they are used in actions. In case of an upgrade, connectors that are already installed will work with stored passwords.True
.To save your configuration, click Save.
To view the list of actions that can be performed by the connector and the playbook file that is bundled with the connector, click the Actions & Playbooks tab.
(Optional) You can optionally perform a Health Check by clicking the Refresh icon that is present in the Health Check
bar. The Health Check checks if the configuration parameters you have specified are correct and if connectivity can be established to the specified server, endpoint, or API.
If all the details are correct and the connectivity to the server can be established, then on the Connectors page, Available is displayed in the health check dialog.
If any or all the details are incorrect or if the connectivity to the server cannot be established then on the Connectors page, Disconnected is displayed in the health check dialog.
If you are upgrading a connector to a newer version, you must be assigned a role that has a minimum of Upgrade
access to the Connectors
module. For example, if you are upgrading the Symantec Security Analytics connector version from v1.0.0 to v2.0.0, then keep a note of the following points:
Existing (older) connector configuration fields retain their value, i.e., the value from the older configuration will be displayed in the configuration pane of the newer connector version. New connector configuration field(s), if any, will be added to the connector configuration pane.
If the newly added configuration field is mandatory, and FortiSOAR™ has specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain the default value for this configuration field. For more information on the connector framework and the info.json
file, see the Building a custom connector chapter. For information on common connector framework issues, see the Common connector framework errors section in the Debugging common playbook and connector issues article present in the Fortinet Knowledge Base.
If the newly added configuration field is mandatory, and FortiSOAR™ has not specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain a blank
value for this configuration field. If you also do not specify a value for this mandatory configuration field, then the connector configuration pane will display Partially Configured, and an error will also be displayed in the Playbook Execution Log. For more information on the Playbook Execution Log, see the Debugging and Optimizing Playbooks chapter in the "Playbooks Guide."
If the field type of a mandatory configuration field is changed from the older version to the newer version, for example from a text field to a drop-down list, then the value of that field will not be retrieved from the older version. However, if FortiSOAR™ has specified its default value (in the info.json
file of the connector), then that value will be displayed for this configuration field in the configuration pane of the newer version of the connector. If however FortiSOAR™ has not defined the default value and you also do not specify a value for this mandatory configuration field, then the configuration pane of the newer version of the connector will contain a blank
value for this configuration field, and the connector configuration pane will display Partially Configured. An error will also be displayed in the Playbook Execution Log. For more information on the Playbook Execution Log, see the Debugging and Optimizing Playbooks chapter in the "Playbooks Guide."
If the newly added configuration field is optional, and FortiSOAR™ has specified its default value (in the info.json
file of the connector), then the configuration pane of the newer version of the connector will contain the default value for this configuration field. If there is no default value set, then its value is set as blank
.