Microsoft Azure Translator Service spoke
Summarize
Summary of Microsoft Azure Translator Service spoke
The Microsoft Azure Translator Service spoke integrates Microsoft’s machine translation capabilities into ServiceNow workflows. It provides subflows and actions that allow detection and translation of user-entered text dynamically, supporting both single and multiple text inputs.
Show less
To enable this functionality, you must activate either the Dynamic Translation plugin (com.glide.dynamictranslation) or the Microsoft Azure Translator Service Spoke plugin (com.glide.microsofttranslationspoke). This spoke requires a ServiceNow subscription at the Professional level or above, which includes Dynamic Translation support.
The service supports API versions v3 and v4, with different subflows available depending on the ServiceNow release version.
Key Features
- Subflows for Translation Integration:
- Detect Language [detectlanguagev3]: Detects the language of input text for releases before Xanadu Patch 3.
- Detect Language V4 [detectlanguagev4]: Updated detection subflow for releases from Xanadu Patch 3 onwards.
- Translate Text [translatetextv3]: Translates input text into multiple languages, supporting both pre- and post-Xanadu Patch 3 releases.
- Spoke Actions:
- Detect Language [detectlanguagev3]: Action to identify the language of given text.
- Translate Text [translatetextv3]: Action to translate text into multiple target languages.
Setup and Configuration
- Microsoft Account: You must register with Microsoft and obtain credentials for the Translator Text API as per Microsoft documentation.
- Connection and Credential Aliases: IntegrationHub uses aliases to manage connection and credential information efficiently across environments, preventing the need for multiple configuration updates.
- Alias Requirements:
- The spoke uses the MicrosoftTranslation alias (
snmstransspoke.MicrosoftTranslation) for authorization. - Connection type is HTTP with a base URL typically like
https://api.cognitive.microsofttranslator.com, though custom or region-specific URLs may apply depending on your Azure configuration.
- The spoke uses the MicrosoftTranslation alias (
- Configuration Tasks:
- Create a credential record for the MicrosoftTranslation alias to authorize actions.
- Create a connection record for the MicrosoftTranslation alias to enable HTTP connection to the translation service.
- Activate the Microsoft translator configuration within ServiceNow to make the service available for use.
Practical Benefits for ServiceNow Customers
By utilizing this spoke, customers can automate language detection and translation within their workflows, enhancing communication and service delivery across different languages. The provided subflows and actions can be integrated into broader ServiceNow flows, enabling seamless multilingual support without manual intervention.
The use of aliases streamlines management of credentials and connections, simplifying maintenance across development, test, and production environments.
Microsoft Azure Translator Service spoke provides subflows and actions to detect and translate user-entered text, using the Microsoft machine translation service. Dynamic Translation supports detection and translation of single texts and multiple texts.
Activation
Activate the Dynamic Translation plugin (com.glide.dynamic_translation) or the Microsoft Azure Translator Service Spoke plugin (com.glide.microsoft_translation_spoke).
Subscription
This spoke requires any ServiceNow subscription that is Professional or above, and includes Dynamic Translation.
Supported versions
API version v3 and v4.
Spoke subflows
The spoke provides subflows in the Published state to integrate with Microsoft translation service. These subflows can be used as part of other subflows and flows.
| Subflow | Description |
|---|---|
| Detect Language [detect_language_v3] | Contains a set of inputs, actions, and output to detect the language of the input text. Releases before Xanadu Patch 3 use v3 flows. |
| Detect Language V4 [detect_language_v4] | Contains a set of inputs, actions, and output to detect the language of the input text. Releases from Xanadu Patch 3 use v4 flows. For more information about v4 flows, see Migrate customized Translator Configurations to v4 flows. |
| Translate Text [translate_text_v3] | Contains a set of inputs, actions, and outputs to translate the input text to multiple languages. This subflow uses v3 for releases before and after Xanadu Patch 3. |
Spoke actions
The spoke provides actions to integrate with Microsoft translation services.
| Action | Description |
|---|---|
| Detect Language [detect_language_v3] | Detects the language of the input text. |
| Translate Text [translate_text_v3] | Translates the input text to multiple languages. |
Microsoft account requirements
Ensure that you are registered with Microsoft and obtain the credential information. For more information, see Microsoft documentation.
For information on Microsoft Translator Text API, see the Microsoft documentation.
Connection and credential alias requirements
IntegrationHub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you do not need to update any actions that use the connection. For more information, see Credentials and connection information.
To use the spoke connection aliases, create an associated connection record and a credential record for each alias.
This spoke uses the MicrosoftTranslation alias (sn_ms_trans_spoke.MicrosoftTranslation) to authorize actions.
- Connection type: HTTP
- Connection URL: For example, https://api.cognitive.microsofttranslator.com. Note:The URL provided here is a sample only. Microsoft translation customers may need to use custom API URLs or virtual network type API URLs, even when they do not subscribe to a virtual network. Microsoft customers who use multi-service or regional translation services also need to know their Ocp-Apim-Subscription-Region attribute, and their API URL may contain a regional reference. Check your Azure portal for this information. Refer to the Microsoft documentation for further details.
Perform the following tasks to connect to the Microsoft machine translation service.