TM Management
In the SOAP API, you can use these TM management-related methods:
Methods available in the XTM Cloud Project Manager web service:
importTMURL()
Use this method to import
TMXorXLIFFfiles for a customer and language combination. You can also specify the TM tags that should be attached to the TM and set the status of the imported segments (SegmentStatusEnum). This method returns the file descriptors that should be used in the method described in point 3.importTMMTOM()
Use this method to import
TMXorXLIFFfiles for a customer and language combination using either MTOM or BASE64, depending on the chosen web service. You can also specify TM tags that should be attached to the TM and set the status of the imported segments (SegmentStatusEnum). This method returns the file descriptors that should be used in the method described in point 3.checkTMCompletion()
Use this method to check if the importing or exporting process has finished. This method requires a list of file descriptors and returns the status of each file (
XTM_TM_COMPLETION_STATUS).exportTM()
Use this method to export
TMXfiles for specified customers. You can also specify the project, source language, target language, and TM status. This method returns the file descriptors that should be used in the method described in point 3. There are additional options to include Reverse Memory and to choose the exported file type (XTM_TM_FILETYPE).downloadTMURL()
Downloads the exported
TMXfile. This method requires a file descriptor and returns the URL to theTMX zipfile.downloadTMMTOM()
Downloads the exported
TMXfile. This method requires a file descriptor and returns the files in MTOM or BASE64 format, depending on the chosen web service. Files are packed as azipfile.findConcordance()
Use this method to search concordance. It requires search parameters that can be defined in the
XTMConcordanceFilterAPIobject and returns a list of segments that match the search criteria, each represented by theXTMTmSegmentAPIobject. The required parameters in theXTMConcordanceFilterAPIare:languageCombinationorbaseProjectDescriptor:languageCombination– source and target language.baseProjectDescriptor– this contains the “uuid” field, which is assigned to theTIPPpackage and is used to find the base project. The base project will be used to get information about the customer, source and target language.
phrase– the phrase to search.searchType– this defines whether the search will take place in the source or target segment (XTMConcordanceSearchTypeEnum).
The optional parameters in the
XTMConcordanceFilterAPIare:checkLanguageVariants– set to define language variants for the searchcustomers– set to define a list of customerscustomerSearchType– set to define whether the search will take place for all customers (XTMConcordanceSearcheCustomerTypeEnum)exactMatch– set only to find exact matchreverseMemory– set to use reverse memory
XTMConcordanceSearcheCustomerTypeEnum– type of customers to search in:Table 54. : XTMConcordanceSearcheCustomerTypeEnum – type of customers to search inOption
Description
ALL_CUSTOMERSSearch in all customers
findMatches()
Use this method to search matches in the TM. It requires search parameters that can be defined in the
XTMFindMatchesFilterAPIobject and returns a list of matches found by using the given criteria, each represented by theXTMMatchAPIobject. In the filter criteria, you can specify customer, language combination, context information, source sentence, and segment ID.deleteTM()
Use this method to delete TM. It requires search parameters, which can be defined in the
XTMDeleteTMFilterAPIobject, and returns the process result. In the filter criteria, you can specify customer, project name, source and target language, status, tags, andXLIFF:docstatuses.
XTM_TM_COMPLETION_STATUS – possible TM completion statuses:
Option | Description |
|---|---|
| Import/Export is still processing. |
| Import/Export is completed successfully. |
| Import/Export could not be completed. |
| The given TM file does not exist. |
XTMConcordanceSearchTypeEnum – a list of possible types for phrase search:
Option | Description |
|---|---|
| The phrase will be searched in the segment source. |
| The phrase will be searched in the segment target. |
XTM_TM_FILETYPE – list of possible TM file types:
Option | Description |
|---|---|
| TMX file (default). |
| Excel file. |
SegmentStatusEnum – a list of possible ways of setting the segment status during a TM import:
Option | Description |
|---|---|
| The TM segment status will automatically be set to approved. |
| The TM segment status will automatically be set to not approved. |
| The TM segment status will be set according to their status in the TM import file and to approved where the status is not defined. |
| The TM segment status will be set according to their status in the TM import file and to not approved where the status is not defined. |