CrossTermManager

  • Unless stated otherwise, all objects are available in the following Across versions:
  • 5.7
  • 6.0
  • 6.3
  • 7.0
Tip

Function-specific return values are listed with each function.

For more information on return values and a complete list of error codes, see Function Return Types.

Function
Description
Cancels the specified job. The function only works for jobs created from CrossTermManager functions.
Exports terms to a TBX file.
Exports terms to a TBX file.
Exports terms to a TBX file.
Returns the GUID of the specified crossTerm instance.
Returns the progress of a job. The function only works for jobs created from CrossTermManager functions.
Returns the result of a finished job. The function only works for jobs created from CrossTermManager functions.
Returns the status of a job. The function only works for jobs created from CrossTermManager functions.
Imports terminology from a TBX file.

CrossTermManager.CancelJob

Cancels the specified job. The function only works for jobs created from CrossTermManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
17
Job does not exist.
Error
87
Job already finished.
Error
88
Canceling is not supported for the job.

CrossTermManager.ExportTBX

Exports terms to a TBX file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TargetFile
The name of the output file. You have to enter a path.
3
string
Languages
The LCIDs of the languages in which the translation units or terms should be exported, listed as language pairs: "lcid1-lcid2;lcid1-lcid3" etc.
4
bool
ExportPictures
If set to true, the export will contain pictures.
5
bool
IncludeSynonyms
If set to true, the export will include all terms of the entry being exported, even if they do not satisfy configured filters.
6
bool
OfficialTBXFormat
If set to true, the export will use the official TBX format, otherwise the exported file will contain some Across-specific parts.
7
bool
IncludeEntryIDs
If set to true, entry IDs are included.
8
string
Filter
XML structure specifying the filter that should be applied. An empty string means no filtering.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the export job.
Error
15
Language does not exist.
Error
184
crossTerm job failed.

CrossTermManager.ExportTBX2

Exports terms to a TBX file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TargetFile
The name of the output file. You have to enter a path.
3
string
Languages
The LCIDs of the languages in which the translation units or terms should be exported, listed as language pairs: "lcid1-lcid2;lcid1-lcid3" etc.
4
bool
ExportPictures
If set to true, the export will contain pictures.
5
bool
IncludeSynonyms
If set to true, the export will include all terms of the entry being exported, even if they do not satisfy configured filters.
6
bool
OfficialTBXFormat
If set to true, the export will use the official TBX format, otherwise the exported file will contain some Across-specific parts.
7
bool
IncludeEntryIDs
If set to true, entry IDs are included.
8
string
Filter
XML structure specifying the filter that should be applied. An empty string means no filtering.
9
string
InstanceGuid
The GUID of the crossTerm instance to export from.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the export job.
Error
15
Language does not exist.
Error
184
crossTerm job failed.

CrossTermManager.ExportTBX3

Exports terms to a TBX file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TargetFile
The name of the output file. You have to enter a path.
3
string
ExportTemplate
Path to a file containing a crossTerm export template, or the crossTerm export template as raw XML.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the export job.
Error
184
crossTerm job failed.

CrossTermManager.GetInstanceGuidByName

Returns the GUID of the specified crossTerm instance.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the crossTerm instance.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the requested instance
Error
187
The instance does not exist.
Error
188
Cannot get instance.

CrossTermManager.GetJobProgress

Returns the progress of a job. The function only works for jobs created from CrossTermManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The progress of the job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

Attention

Do not use this method to find out whether a job is finished or not. A progress of 100 does not necessarily mean that the job is finished already. Use GetJobStatus instead.

CrossTermManager.GetJobResult

Returns the result of a finished job. The function only works for jobs created from CrossTermManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The progress of the job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Error
43
The job has not yet been completed.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

CrossTermManager.GetJobStatus

Returns the status of a job. The function only works for jobs created from CrossTermManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The status of the job.
  • The following values are possible:
  • 0 - in progress
  • 1 - finished successfully
  • 2 - finished with errors
Error
17
Job does not exist.

CrossTermManager.ImportTBX

Imports terminology from a TBX file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ImportFile
The name of the TBX file. You have to enter a path.
3
string
ImportTemplate
Path to a file containing a crossTerm import template, or the crossTerm import template as raw XML.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the import job.
Error
184
crossTerm job failed.