Service Translation Tool

From Hornbill
Jump to navigation Jump to search

About the Hornbill Service Manager Service Translation Tool

The utility provides a simple, safe and secure way to bulk-translate your Services, and associated Catalog Items, FAQs, Bulletin, Customer Feedback Questions and Sub Statuses. Translation of Sub Statuses requires Service Manger build of 2144 or above.

The tool is designed to run behind your corporate firewall and connects to your Hornbill instance in the cloud over HTTPS/SSL. So as long as you have standard internet access then you should be able to use the tool without the need to make any firewall configuration changes.

Open Source

The Hornbill Service Manager Service Translation Tool is provided open source under the Hornbill Community Licence and can be found on GitHub

Installation Overview

  • Download the OS and architecture-specific ZIP archive
  • Extract zip into a folder you would like the application to run from e.g. C:\servicetranslate\
  • Open a Command Line Prompt as Administrator
  • Change Directory to the folder containing the utility C:\servicetranslate\
  • Run the command relevant to the OS of the machine you are running this on:

Windows:
goHornbillServiceTranslation.exe -instance=yourinstanceid -key=yourapikey -src=en-GB -dst=it

Configuration

Command Line Parameters

  • instance:: This is the name of your Hornbill instance and can be found within the URL you use to navigate to it: live.hornbill.com/[instance name]/. E.g. if the URL you use to access your instance is live.hornbill.com/arescomputing/, then your instance id would be "arescomputing". This value is case sensitive;
  • key: API Key to use as Authentication when connecting to Hornbill Instance;
  • debug: true/false, defaults to false - Log extended debug information;
  • src: The source language code to translate the records from;
  • dst: The destination language code to translate the records to;
  • getlangs: Return a list of supported languages and their codes into a file in the tool folder called languages.txt, then exits;
  • version: Output the tools version number, and exit.

API Key Rules

This utility uses (API keys):

  • data:entityBrowseRecords2
  • system:getLanguageList
  • session:getApplicationList
  • apps/com.hornbill.servicemanager/Services:smGetServiceDetails
  • apps/com.hornbill.servicemanager:translateData
  • apps/com.hornbill.servicemanager:translateAddLanguage

HTTP Proxies

If you use a proxy for all of your internet traffic, the HTTP_PROXY Environment variable needs to be set. The https_proxy environment variable holds the hostname or IP address of your proxy server. It is a standard environment variable and like any such variable, the specific steps you use to set it depends on your operating system.

For windows machines, it can be set from the command line using the following:
set HTTP_PROXY=HOST:PORT set HTTPS_PROXY=HOST:PORT
Where "HOST" is the IP address or host name of your Proxy Server and "PORT" is the specific port number.

Troubleshooting

Logging Overview

All logging output is saved in the log directory, in the same directory as the executable. The file name contains the date and time the import was run Service_Translation_20210202142114.log