Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ utility / languageTranslatePhrase

  • Article
  • 1 minutes to read

Description

This operation takes a phrase in one language and attempts to translate it to another language. This operation uses the Google Translate API which is a chargeable service provided by Google. You need to add a Google Translate API Key through the administration tool before this operation will work. Please note that the underlying Google Translate API does not have support for Language cultures so if specified the culture will be ignored. For example ‘en’, ‘en-GB’ and ‘en-US’ are all treated as ‘en’

API Details

  • Status:
  • The required privilege level to invoke this method is guest
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The languageTranslatePhrase method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
phraseToTranslate xs:string Required The text or phrase to translate
sourceLanguage xs:language Optional The language that the ‘phraseToTranslate’ is in. If not specified and detectSourceLanguage param is set to false then user’s session language is used.
targetLanguage xs:language Optional The language that you would like the source translated to. If not specified then user’s session language is used.
detectSourceLanguage xs:boolean Optional
Default=false		 Set this param to ‘true’ to detect the language of specified phrase. If sourceLanguage param is specified then this params will be ignored.

Response Parameters

Name Type Attributes Description
translatedPhrase xs:string Required The translated text or phrase.
detectedSourceLanguage xs:language Optional The detected source language of specified phrase. This is only returned if detectSourceLanguage param is set to ‘true’
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document