Links to XTM Cloud Modules
In the SOAP API, you can use these XTM Cloud module-related methods:
These methods provide links that enable you to open the different modules of XTM Cloud in an iframe.
obtainPMProjectEditorLink()
Returns the URL to the PM Project Editor for the given project. It requires a project descriptor and optional settings, which can be specified in the
PMProjectEditorOptionsobject. Options enable you to set visibility for the following tabs: generals, metrics, statistics, workflow, files, estimates. By default, all tabs will be visible.obtainPMTranslationPropsLink()
Returns the URL to the PM Translation Properties page. This configuration can be opened for the whole system or for a given customer. Additional options in the
PMTranslationPropsOptionsobject enable you to set visibility for the following parts: translation, application options, segment status, and machine translation.The following data should be filled:
configuration level.
customer descriptor – only when the configuration level is set to Customer.
ConfigurationLevel– possible configuration levels:Table 45. : ConfigurationLevel – possible configuration levelsOption
Description
CLIENTConfiguration for Client.
CUSTOMERConfiguration for Customer.
obtainXTMEditorLink()
Returns the
XTMEditorURLResponseAPIobject that contains a URL to the Editor for the specified job and the project activity status. The Editor can be opened only for active projects. It requires theXTMEditorAPIobject.The
XTMEditorAPIcontains the information required to prepare the Editor URL in two ways:based on the job, user, and customer from XTM Cloud. The following fields should be specified:
user descriptor.
job descriptor.
customer descriptor.
user options: role.
workflow options:
currentWorkflowStep,lqaDecisionType (LQADecisionType),manageType (XTMEditorWorkflowManageTypeEnum).
based on the
XLIFFfile, user, and customer who do not necessarily exist in XTM Cloud. The following fields should be specified:user outer descriptor:
id,name,preferredLanguage.job outer descriptor:
xliffFileId,xliffFilePath,projectId,projectName,targetLanguageId,sourceFilePath,xtmXliff.customer outer descriptor:
id,name.user options:
role,terminologyRights (EDITOR_TERMINOLOGY_RIGHTS_API).workflow options:
workflowSteps,currentWorkflowStep,manageType (XTMEditorWorkflowManageTypeEnum).
There is an additional option to open XTM Cloud Visual Editor instead of XTM Standard Editor. This mode can be enabled by setting field editorMode (EditorModeEnum) in editor options. XTM Visual Editor is available for
HTMLandXML(with definedXSLT) files only. If the XTM Cloud Visual Editor is not available, then the XTM Standard Editor will be opened by default.
Field
manageTypeenable you to manage workflow steps in the Editor. The following criteria must be met for this to happen:jobDescriptorfilled with data.a step must exist in workflow.
the current bundles must be active.
XTMEditorWorkflowManageTypeEnumTable 46. : XTMEditorWorkflowManageTypeEnumOption
Description
FINISHEnables finishing a step.
EditorModeEnumTable 47. : EditorModeEnumOption
Description
STANDARDXTM Cloud Standard Editor.
VISUALXTM Cloud Visual Editor if available.
EDITOR_TERMINOLOGY_RIGHTS_APITable 48. : EDITOR_TERMINOLOGY_RIGHTS_APIOption
Description
ADDAdd right.
MODIFYModify right. DEPRECATED.
VIEWView right.
IMPORTImport right.
EXPORTExport right.
DELETEDelete right.
UPDATE_APPROVEUpdate and approve right.
SUGGESTSuggest right.
LQADecisionTypeTable 49. : LQADecisionTypeOption
Description
NOIt is not possible to add or view LQA errors.
YES_SAVING_RESULTS_FOR_USERIt is possible to add or view LQA errors. Errors will contain information about the user who carried out the LQA and about the user who performed the translation.
YES_NOT_SAVING_RESULTS_FOR_USERIt is possible to add or view LQA errors. The information about the users involved is not recorded in the system.
NO_SHOW_EXISTING_ERRORSIt is possible to view the existing LQA errors.
obtainXTMTermManagerLink()
Returns the URL to the Terminology Manager. It requires the
XTMTermManagerAPIobject. TheXTMTermManagerAPIcontains the information required to prepare the Terminology manager URL in two ways:based on the user and customers from XTM Cloud. The following fields should be specified:
users descriptor.
customer descriptors.
based on the user and customers who do not necessarily exist in XTM Cloud. The following fields should be specified:
user outer descriptor:
id,name,preferredLanguage.customers outer descriptors:
id,name.user options:
termRights.
XTM_TERM_MANAGER_RIGHTS_API– possible terminology rights:Table 50. : XTM_TERM_MANAGER_RIGHTS_API – possible terminology rightsOption
Description
ADDAdd right.
MODIFYModify right. DEPRECATED.
VIEWView right.
IMPORTImport right.
EXPORTExport right.
DELETEDelete right.
UPDATE_APPROVEUpdate and approve right.
SUGGESTSuggest right.
obtainXTMTmManagerLink()
Returns the URL to the TM Manager. It requires the
XTMTmManagerAPIobject. TheXTMTmManagerAPIcontains the information required to prepare the URL to the TM manager in two ways:based on users and customers from XTM Cloud. The following fields should be specified:
user descriptor.
customers descriptors.
based on users and customers who do not have to exist in XTM Cloud. The following fields should be specified:
user outer descriptor:
id,name,preferred language.customers outer descriptors:
id,name.user options:
tmRights.
XTM_TM_MANAGER_RIGHTS_API– possible TM rights:Table 51. : XTM_TM_MANAGER_RIGHTS_API – possible TM rightsOption
Description
MODIFYModify right.
VIEWView right.
IMPORTImport right.
EXPORTExport right.
MODIFY_UPDATE_ONLYUpdate right.
DELETEDelete right.
obtainPMTemplateEditorLink()
Returns the URL to the PM Template Editor for the given template. It requires the template descriptor and optional settings which can be specified in the
PMTemplateEditorOptionsobject. Options enable users to set the visibility for the following groups: project settings, customer settings, translation settings, and machine translation settings. By default, all parts are visible.checkUserLogin()
Checks if a user with the given login credentials can log in to XTM. The
XTMUserLoginAPIobject contains user login credentials: id, username, password, and, optionally, the XTM Cloud instance descriptor (XTMInstanceDescriptorAPI). IfXTMInstanceDescriptorAPIis specified, then the user will be checked into this XTM Cloud account. TheXTMInstanceDescriptorAPIobject contains information about the XTM Cloud account: id, name, and instance type (XTMInstanceTypeEnum). This method returns one of the following results (XTM_USER_LOGIN_RESULT_API):Table 52. : XTM_USER_LOGIN_RESULT_APIOption
Description
SUCCESSUser can log in.
INVALID_LOGIN_CREDENTIALSInvalid user login credentials.
TOO_MANY_USERSToo many users are currently logged.
INVALID_LICENSEUnable to check the licence for the specified client.
PASSWORD_EXPIREDPassword is correct but has been expired.
TOO_MANY_INVALID_LOGIN_ATTEMPTSMax number of login attempts has been exceeded.
USER_ACCOUNT_EXPIREDUser account has been expired.
XTMInstanceTypeEnum– possible XTM Cloud instance types:Table 53. : XTMInstanceTypeEnum – possible XTM Cloud instance typesOption
Description
LSPLSP.
obtainXTMProjectManagerLink()
Returns the URL to the Project Manager for the specified user. It requires the
XTMProjectManagerAPIobject, which containsXTMUserLoginAPIwith user login credentials (described in point 7). By default, when the window is opened via the API, the logout button in the top right-hand corner is not visible. It is possible to toggle the visibility of the logout button. WhenfullWindowModeis set to true (false being the default value) the logout button is visible.obtainPMConcordanceLink()
Returns the URL to the Concordance tab. It requires the
XTMConcordanceAPIobject. TheXTMConcordanceAPIobject contains the information required to open Concordance in a new window or tab. There are two ways of defining information displayed:based on an XTM Cloud user: customers and language combinations are taken from the user settings. The following fields should be specified:
user descriptor.
based on customers and language combinations. The following fields should be specified:
customersDescriptors.
languageCombinations.