Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

The IBM Watson Language Translator service converts text input in one language into a destination language for the end user using background from domain-specific models. Translation is available among Arabic, Chinese (Simplified and Traditional), English, French, Portuguese, German, Spanish, Dutch, Turkish, Russian, Korean, Italian and Polish (some languages may not be available for all domains).

This document provides information about the IBM Watson connector, which facilitates automated interactions, with a IBM Watson server using FortiSOAR™ playbooks. Add the IBM Watson connector as a step in FortiSOAR™ playbooks and perform automated operations such as, identifying the language of input text and translating text from one language to another.

 

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-ibm-watson

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

  • You must have the URL of the IBM Watson server to which you will connect and perform the automated operations and the credentials (username and password pair) to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the IBM Watson connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the IBM Watson server to which you will connect and perform the automated operations.
Username Username to access the IBM Watson server to which you will connect and perform the automated operations.
Password Password to access the IBM Watson server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Get Language Identifies the language of the input text.
Note: The output contains a list of possible languages that match with text that you have specified. Each of the languages has a confidence level associated with it. Generally, the language that has the maximum confidence is the language of input text.
get_language
Investigation
Translate Text Translates the input text into the language of your choice. translate_text
Investigation
List Languages Retrieves a list of languages that can be identified and translated by the IBM Watson service. list_languages
Investigation
List Translations Retrieves a list of language translations models that are supported by the IBM Watson service. list_translations
Investigation

 

operation: Get Language

Input parameters

Parameter Description
Text Text whose language you want to identify.

 

Output

The JSON output contains a list of possible languages that match with text that you have specified. Each of the languages has a confidence level associated with it. Generally, the language that has the maximum confidence is the language of input text.

Following image displays a sample output:

Sample output of the Get Language operation

operation: Translate Text

Input parameters

Parameter Description
Text Text that you want to translate.
Source Language Language code of the source text language, i.e the language from which you want to translate the text.
For example, en, es.
Target Language Language code of the translation target language, i.e the language to which you want to translate the text.
For example, en, es.

 

Output

The JSON output contains text that has been translated by IBM Watson to the target language that you have specified.

Following image displays a sample output:

Sample output of the Translate Text operation

operation: List Languages

Input parameters

None.

Output

The JSON output contains a list of languages that can be identified and translated by the IBM Watson service.

Following image displays a sample output:

Sample output of the List Languages operation

operation: List Translations

Input parameters

None.

Output

The JSON output contains a list of translation models supported by the IBM Watson service.

Following image displays a sample output:

Sample output of the List Translations operation

Included playbooks

The Sample - IBM Watson - 1.0.0 playbook collection comes bundled with the IBM Watson connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the IBM Watson connector.

  • Get Language
  • List Languages
  • List Translations
  • Translate Text

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

The IBM Watson Language Translator service converts text input in one language into a destination language for the end user using background from domain-specific models. Translation is available among Arabic, Chinese (Simplified and Traditional), English, French, Portuguese, German, Spanish, Dutch, Turkish, Russian, Korean, Italian and Polish (some languages may not be available for all domains).

This document provides information about the IBM Watson connector, which facilitates automated interactions, with a IBM Watson server using FortiSOAR™ playbooks. Add the IBM Watson connector as a step in FortiSOAR™ playbooks and perform automated operations such as, identifying the language of input text and translating text from one language to another.

 

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-ibm-watson

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the IBM Watson connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the IBM Watson server to which you will connect and perform the automated operations.
Username Username to access the IBM Watson server to which you will connect and perform the automated operations.
Password Password to access the IBM Watson server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Get Language Identifies the language of the input text.
Note: The output contains a list of possible languages that match with text that you have specified. Each of the languages has a confidence level associated with it. Generally, the language that has the maximum confidence is the language of input text.
get_language
Investigation
Translate Text Translates the input text into the language of your choice. translate_text
Investigation
List Languages Retrieves a list of languages that can be identified and translated by the IBM Watson service. list_languages
Investigation
List Translations Retrieves a list of language translations models that are supported by the IBM Watson service. list_translations
Investigation

 

operation: Get Language

Input parameters

Parameter Description
Text Text whose language you want to identify.

 

Output

The JSON output contains a list of possible languages that match with text that you have specified. Each of the languages has a confidence level associated with it. Generally, the language that has the maximum confidence is the language of input text.

Following image displays a sample output:

Sample output of the Get Language operation

operation: Translate Text

Input parameters

Parameter Description
Text Text that you want to translate.
Source Language Language code of the source text language, i.e the language from which you want to translate the text.
For example, en, es.
Target Language Language code of the translation target language, i.e the language to which you want to translate the text.
For example, en, es.

 

Output

The JSON output contains text that has been translated by IBM Watson to the target language that you have specified.

Following image displays a sample output:

Sample output of the Translate Text operation

operation: List Languages

Input parameters

None.

Output

The JSON output contains a list of languages that can be identified and translated by the IBM Watson service.

Following image displays a sample output:

Sample output of the List Languages operation

operation: List Translations

Input parameters

None.

Output

The JSON output contains a list of translation models supported by the IBM Watson service.

Following image displays a sample output:

Sample output of the List Translations operation

Included playbooks

The Sample - IBM Watson - 1.0.0 playbook collection comes bundled with the IBM Watson connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the IBM Watson connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.