Contact
Newsletter
Schedule Consultation

CrossTankManager

  • 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 CrossTankManager functions.
Exports translations to a TMX file.
Returns the progress of a job. The function only works for jobs created from CrossTankManager functions.
Returns the result of a finished job. The function only works for jobs created from CrossTankManager functions.
Returns the status of a job. The function only works for jobs created from CrossTankManager functions.
Imports TMX to crossTank.
Returns whether partial matches should be applied during pre-translation or not.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Starts a pre-translation.
Defines whether partial matches should be applied during pre-translation or not.
Lets you specify the behavior of the pre-translation carried out during the check-in or update process.
This function lets you specify the behavior of the pre-translation carried out during the check-in or update process.
Sets the weights for non-matching elements for the pre-translation.
Sets the weights for non-matching elements for the pre-translation.
Sets the weights for non-matching elements for the pre-translation.
Sets the weights of non-matching RichTM elements in the pre-translation.
Sets the options used during storing of translations to crossTank in context of CrossTankManager.StoreFinishedTranslations.
This function lets you specify the behavior of the pre-translation.
Stores all finished translations of a task to crossTank.
Stores all finished translations of a task to crossTank.
Creates a job that stores all finished translation of a task to crossTank. The job progress, status and result can be checked with the corresponding CrossTankManager functions.
Updates the pretranslation statistics without generating a report.

CrossTankManager.CancelJob

Cancels the specified job. The function only works for jobs created from CrossTankManager 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.

CrossTankManager.ExportTMX

Exports translations to a TMX file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
OutputFileName
The name of the output file. You have to enter a path.
3
int
SourceLanguageLcid
The LCID of the source language.
4
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.
5
bool
MakeBackup
true will create a TMX backup for Across, false will create a TMX export for use with other CAT tools.
6
bool
ExportRichTM
Specifies whether to export Rich TM (true) or not (false).
7
string
FilterXML
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
18
Unable to create job.
Tip

The SourceLanguageLcid is needed, and one of the LCIDs in the pairs "lcid1-lcid2;lcid1-lcid3" should correspond to it. In this case it would be lcid1.

CrossTankManager.GetJobProgress

Returns the progress of a job. The function only works for jobs created from CrossTankManager 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.

CrossTankManager.GetJobResult

Returns the result of a finished job. The function only works for jobs created from CrossTankManager 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
The data of the job. The type of the return value depends on the job.
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.

CrossTankManager.GetJobStatus

Returns the status of a job. The function only works for jobs created from CrossTankManager 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
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.

CrossTankManager.ImportTMX

Imports TMX to crossTank.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
InputFileName
The path to the input file.
3
string
StorageFile
Path to the file in which all questionable entries will be stored. ImportTMX works in silent mode.
4
string
Languages
The LCIDs of the languages in which the translation units or terms should be imported, listed as language pairs: "lcid1-lcid2;lcid1-lcid3" etc.
5
string
MappingsXML
XML structure representing the mapping which can be configured during import on the pages. Map TMX attributes to Across properties and TMX attribute values to Across values.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the import job.
Error
18
Unable to create job.

CrossTankManager.IsApplyPartialMatch

Returns whether partial matches should be applied during pre-translation or not.

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
bool
True in case partial matches are inserted, otherwise false.
Tip

The value returned is for the setting used in case no crossTank options are available in the project settings. If crossTank options are part of the project settings, these settings are taken.

From Across v7, crossTank options are always part of project settings.

CrossTankManager.PreTranslate

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslate2

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslate3

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.
9
bool
EnableContextMatch
Checks whether context matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

10
bool
ContextMatchPreTranslationStateIsFinal
If set to true, paragraphs with a context match will be set to the final state of the workflow. If no workflow is assigned, this parameter will not be used.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslate4

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.
9
bool
EnableContextMatch
Checks whether context matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

10
bool
EnableStructureMatch
Checks whether structure matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslateAsync

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslateAsync2

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslateAsync3

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.
9
bool
EnableContextMatch
Checks whether context matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

10
bool
ContextMatchPreTranslationStateIsFinal
If set to true, paragraphs with a context match will be set to the final state of the workflow. If no workflow is assigned, this parameter will not be used.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslateAsync4

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.
9
bool
EnableContextMatch
Checks whether context matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

10
bool
ContextMatchPreTranslationStateIsFinal
If set to true, paragraphs with a context match will be set to the final state of the workflow. If no workflow is assigned, this parameter will not be used.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.PreTranslateAsync5

Starts a pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document within the context of which the task should be assigned.
3
int
TargetLanguageLcid
The LCID of the target language for which the task should be assigned.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
CWP
Minimum value for the similarity. Valid values are whole numbers between 0 and 100. Sentences with a lower similarity are ignored during the pre-translation analysis. A value of 100 leads to an especially fast pre-translation without additional effort for the analysis.
6
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
7
bool
SetPreTranslatedFlag
Signifies whether the pre-translation flag should be set additionally to the paragraph state defined by StateGuid. The Across GUI always sets the pre-translation to "Touched" plus the pre-translation flag. If you do not set the flag, the pre-translations cannot be recognized as such later. If a paragraph is edited, the pre-translation flag is then deleted.
Tip

Always set to true in Across v7.

8
bool
UpdateReports
If set to true, the reports of the project are updated, i.e. MDR, DDR etc.
9
bool
EnableContextMatch
Checks whether context matches exist or not.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

10
bool
ContextMatchPreTranslationStateIsFinal
If set to true, paragraphs with a context match will be set to the final state of the workflow. If no workflow is assigned, this parameter will not be used.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

11
bool
EnableSetPretranslatedByReleasedToProtectedTarget
If set to true, paragraphs pre-translated with released translations will be set to the final state of the workflow to protect them.
Attention

This flag will only be applied if the project settings do not contain crossTank search settings. For example when the settings are to be loaded from the (user) profile settings.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
41
The paragraph state does not exist.
Error
180
The document is not ready because it is being checked in.
Error
225
The language content cannot be changed.

CrossTankManager.SetApplyPartialMatch

Defines whether partial matches should be applied during pre-translation or not.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
Value
Whether partial matches should be applied or not.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetMultipleFullMatchOptions

Lets you specify the behavior of the pre-translation carried out during the check-in or update process.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
MakePretranslationWhenMultipleMatchWithEqualBonus
Indicates whether a paragraph should be pre-translated if there is more than one 100% match with maximum bonus. Set to false if the paragraph should be pre-translated if there is exactly one 100% match. Set to true if the paragraph should be pre-translated if there is at least one 100% match. In this case, the most recent translation will be used.
3
int
BonusExactMatch
The percentage bonus to add for a 100% match when the source text is an exact match.
4
int
BonusReleasedMatch
The percentage bonus to add for a 100% match when the selected translation has released state.
5
int
BonusContextMatch
The percentage bonus to add for a 100% match when it is a context match.
6
int
BonusStructureMatch
The percentage bonus to add for a 100% match when it is a structure match.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetPretranslatedStateOptions

This function lets you specify the behavior of the pre-translation carried out during the check-in or update process.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
SetFinalStateToPretranslated
If true, enables setting paragraphs to the final state of the workflow when pre-translated. Other parameters specify conditions. default = false
3
bool
SetFinalStateAlways
If true, set to final state for all pre-translated paragraphs. default = true
4
bool
SetFinalStateWhenContextMatch
If true, set to final state when pre-translated with a context match. Influenced by last parameter. default = false
5
bool
SetFinalStateWhenStructureMatch
If true, set to final state when pre-translated with a structure match. Influenced by last parameter. default = false
6
bool
SetFinalStateCombineOperatorAnd
If true, set to final state when both context and structure conditions are met. default = false

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetPreTranslationPenalties

Sets the weights for non-matching elements for the pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
WrongSubLanguage
Sets the weights in case the sublanguage is wrong.
3
int
WrongWordsOrder
Sets the weights in case the words are in the wrong order.
4
int
WrongSubject
Sets the weights in case the subject is wrong.
5
int
WrongProject
Sets the weights in case the project is wrong.
6
int
WrongRelation
Sets the weights in case the relation is wrong.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

If this method is not called and crossTank options are not part of the project settings, the following default values are used:

Penalty type
Penalty value
Different sublanguage
2
Wrong word order
10
Different subject
0
Different project
0
Wrong relation
0

CrossTankManager.SetPreTranslationPenalties2

Sets the weights for non-matching elements for the pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
WrongSubLanguage
Sets the weights in case the sublanguage is wrong.
3
int
WrongWordsOrder
Sets the weights in case the words are in the wrong order.
4
int
WrongSubject
Sets the weights in case the subject is wrong.
5
int
WrongProject
Sets the weights in case the project is wrong.
6
int
WrongRelation
Sets the weights in case the relation is wrong.
7
int
WrongUserDefined
Sets the weights in case one of the user-defined attributes is wrong.
8
int
WrongStructure
Sets the weights in case the structure attribute of the paragraph does not match.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetPreTranslationPenalties3

Sets the weights for non-matching elements for the pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
WrongSubLanguage
Sets the weights in case the sublanguage is wrong.
3
int
WrongWordsOrder
Sets the weights in case the words are in the wrong order.
4
int
WrongSubject
Sets the weights in case the subject is wrong.
5
int
WrongProject
Sets the weights in case the project is wrong.
6
int
WrongRelation
Sets the weights in case the relation is wrong.
7
int
WrongUserDefined
Sets the weights in case one of the user-defined attributes is wrong.
8
int
WrongStructure
Sets the weights in case the structure attribute of the paragraph does not match.
9
int
WrongContext
Sets the weights in case the context of the translation does not match.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetRichTMPenalties

Sets the weights of non-matching RichTM elements in the pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
DifferentFormatting
Sets the penalties that will be applied if there is different formatting in the source and target sentence.
3
int
DifferentElements
Sets the penalties that will be applied if there are different inline elements in the source and target sentence.
4
int
DifferentSpecialChars
Sets the penalties that will be applied if there are different special characters in target and source sentence.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

If this method is not called and crossTank options are not part of the project settings, the following default values are used:

Penalty type
Penalty value
Different formatting
0
Different elements
0
Different special characters
0

CrossTankManager.SetStoringOptions

Sets the options used during storing of translations to crossTank in context of CrossTankManager.StoreFinishedTranslations.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
StoreProjectAttribute
Whether the project attribute should be added to the stored translation.
3
bool
StoreRelationAttribute
Whether the relation attribute should be added to the stored translation.
4
bool
StoreSubjectAttribute
Whether the subject attribute should be added to the stored translation.
5
bool
StoreFormatRanges
Whether format ranges should be stored.
6
bool
StoreInlineElements
Whether inline elements should be stored.
7
bool
StoreSpecialCharacters
Whether special characters should be stored.
8
bool
PreventMultipleTransByOverwriting ExistingEntries
Whether multiple translations in crossTank should be prevented.
9
int
OverwriteMode
Which translations should be overwritten to prevent multiple translations.
  • Possible values:
  • 0 - Unreleased translations will be overwritten. If the existing translation is not unreleased, a duplicate will be created.
  • 1 - Existing translations will be overwritten. Duplicates are never created.
  • 2 - Unreleased translations created by the current user will be overwritten, a duplicate will be created otherwise.
  • 3 - All translations created by the current user will be overwritten, a duplicate will be created otherwise.
  • 4 - If the existing translation is released, storing will be skipped. A duplicate will be created otherwise.
  • 5 - Storing is always skipped if there already exists a translation.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
120
Cannot change settings.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.SetUseOnlyOneFullMatch

This function lets you specify the behavior of the pre-translation.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
UseOnlyOneFullMatch
Indicates whether a paragraph should be pre-translated if there is more than one 100% match. Set to true if the paragraph should be pre-translated if there is exactly one 100% match. Set to false if the paragraph should be pre-translated if there is at least one 100% match. In this case the most recent translation will be used.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Tip

This function has no effect in case the project settings contain crossTank options. From Across v7.0 on, crossTank options are always stored in project settings.

CrossTankManager.StoreFinishedTranslations

Stores all finished translations of a task to crossTank.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document to which the task belongs.
3
int
TargetLanguageLcid
The LCID of the target language.
4
int
SourceLanguageLcid
The LCID of the source language.
5
string
StateGuid
The GUID of the paragraph state that should be used to determine which translations should be exported.
6
bool
IgnoreSuspicious
The GUID of the paragraph state that should be used to determine which translations should be exported.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
20
One or more invalid parameters have been assigned to the function. An example of this is a NULL pointer in C++ when a string is expected.
Error
22
crossSPI has not been initialized. Details available in crossAPI.log. There is most probably an incompatibility in a DSE*.dll file.
Error
41
The paragraph state does not exist.
Error
142
Unexpected error.
Error
151
Cannot store finished translation.

CrossTankManager.StoreFinishedTranslations2

Stores all finished translations of a task to crossTank.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document to which the task belongs.
3
int
TargetLanguageLcid
The LCID of the target language.
4
int
SourceLanguageLcid
The LCID of the source language.
5
string
StateGuid
The GUID of the paragraph state that should be used to determine which translations should be exported.
6
bool
IgnoreSuspicious
The GUID of the paragraph state that should be used to determine which translations should be exported.
7
int
TranslationState
  • 0 - StateNewInserted
  • 1 - StateSmartInserted
  • 2 - StateAligned
  • 3 - StateReleased

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
41
The paragraph state does not exist.
Error
151
Cannot store finished translation.
Error
180
The document is not ready because it is being checked in.
Error
234
The operation is rejected.

CrossTankManager.StoreFinishedTranslationsAsync

Tip

Available from Across v7.0.

Creates a job that stores all finished translation of a task to crossTank. The job progress, status and result can be checked with the corresponding CrossTankManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document to which the task belongs.
3
int
TargetLanguageLcid
The LCID of the target language.
4
int
SourceLanguageLcid
The LCID of the source language.
5
string
StateGuid
The GUID of the paragraph state that should be used to determine which translations should be exported.
6
bool
IgnoreSuspicious
The GUID of the paragraph state that should be used to determine which translations should be exported.
7
int
TranslationState
  • 0 - StateNewInserted
  • 1 - StateSmartInserted
  • 2 - StateAligned
  • 3 - StateReleased
8
string
TaskGuid
GUID of the task.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
41
The paragraph state does not exist.
Error
151
Cannot store finished translation.
Error
180
The document is not ready because it is being checked in.
Error
234
The operation is rejected.

CrossTankManager.UpdatePreTranslationStatistics

Updates the pretranslation statistics without generating a report.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document.
3
int
TargetLanguageLcid
The LCID of the target language.
4
int
SourceLanguageLcid
The LCID of the source language.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
36
Unable to carry out pre-translation. More detailed information can be found in the error description.
Error
180
The document is not ready because it is being checked in.