Contact
Newsletter
Schedule Consultation

CheckInManager

  • 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
Adds an attachment to a document.
Cancels the specified job. The function only works for jobs created from CheckInManager functions.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
Creates a check-in job that adds a document to a project.
The function returns an XML file with information about all available document types and lists the configured transformations and document settings templates.
Returns the GUID of a document according to the GUID of a current check-in job.
Returns the progress of a check-in job. The function only works for jobs created from CheckInManager functions.
Returns the result of a finished check-in job. The function only works for jobs created from CheckInManager functions.
Returns the status of a check-in job. The function only works for jobs created from CheckInManager functions.
This function lets you specify the behavior of the pre-translation carried out during the check-in or update process.
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.
This function allows to specify how pre-translated paragraphs should be marked.
Sets the weights of non-matching Rich TM elements in the pre-translation.
Sets the font substitution settings used by crossAPI. These settings will be used by all subsequent check-ins.
This function lets you specify the behavior of the pre-translation carried out during the check-in or update process.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.
Uploads an externally edited document.
Uploads an externally edited document.

CheckInManager.AddAttachmentToDocument

Adds an attachment to a document.

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
string
FilePath
The path to the attachment that should be added.

Return Values

Result
Type/Value
Interpretation
Success
int
Database ID of the attachment.
Error
16
Document does not exist.
Error
73
Cannot add attachment.
Tip

This function is an alias for DocumentManager.AddAttachmentToDocument.

CheckInManager.CancelJob

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

CheckInManager.CreateCheckInJob

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
OriginalLanguageLcid
The language of the document.
5
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
7
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob2

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
OriginalLanguageLcid
The language of the document.
5
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
7
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob3

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
OriginalLanguageLcid
The language of the document.
5
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
7
bool
RunCTaPreTranslation
If true a pre-translation is executed.
8
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob4

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
OriginalLanguageLcid
The language of the document.
5
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
7
bool
RunCTaPreTranslation
If true a pre-translation is executed.
8
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob3 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob5

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob6

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob5 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob7

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
11
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob8

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
11
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob7 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob9

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
11
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
12
bool
EnableContextMatch
Checks whether context matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob10

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
bool
RunCTaPreTranslation
If true a pre-translation is executed.
10
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
11
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
12
bool
EnableContextMatch
Checks whether context matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob9 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob11

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob12

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob11 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob13

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob15

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob16

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
object
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob15 only in the type of the parameter TargetLanguages. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob17

Tip

Available from Across v7.0.

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.
16
string
UserGuid
The GUID of the user.
When this is left empty, the style options set by the last call to CheckInManager.SetStyleOptions are used.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.CreateCheckInJob18

Tip

Available from Across v7.0.

Creates a check-in job that adds a document to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
5
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
6
string
OriginalLanguageLcid
The language of the document.
7
anyType
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array. The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.
16
string
UserGuid
The GUID of the user.
When this is left empty, the style options set by the last call to CheckInManager.SetStyleOptions are used.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
28
Document template does not exist.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

This function differs from CheckInManager.CreateCheckinJob17 only in the type of the TargetLanguages parameter. This function expects an array of integers for this parameter.

CheckInManager.CreateCheckInJob19

Tip

Available from v7 15854.

Creates a check-in job that adds a document to a project.

The function uses document extension instead of document type to specify document transformations in a way that allows for application of post-processing when doing a manual check-out in the Across client.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
object
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentExtensionGuid
The GUID of the document extension to be used during check-in.
Tip

Document extension are configured in the Across client under Tools > System settings > Document associations. Document extensions can include pre and post-processing scripts.

6
string
OriginalLanguageLcid
The language of the document.
7
anyType
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array. The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.
16
string
UserGuid
The GUID of the user.
When this is left empty, the style options set by the last call to CheckInManager.SetStyleOptions are used.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
25
Failed to assign workflow to document. Occurs if the workflow is not released.
Error
28
Document template does not exist.
Error
71
File not found.
Error
243
Document extension is not found.
Error
245
Incorrect workflow for unsupported document.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

To get the document extension GUID, please use CheckInManager.GetDocumentExtensionsXml.

CheckInManager.CreateCheckInJob20

Tip

Available from v7 15854.

Creates a check-in job that adds a document to a project.

The function uses document extension instead of document type to specify document transformations in a way that allows for application of post-processing when doing a manual check-out in the Across client.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
anyType
DocumentPath
The path to the document that should be checked in. The user account under which the crossAPI service runs must have access to this path.
4
string
DocumentExtensionGuid
The GUID of the document extension to be used during check-in.
Tip

Document extension are configured in the Across client under Tools > System settings > Document associations. Document extensions can include pre and post-processing scripts.

6
string
OriginalLanguageLcid
The language of the document.
7
anyType
TargetLanguages
The LCIDs of the languages into which the document should be translated. Stored as integers in an array. The LCIDs of the languages into which the document should be translated. Separated by semicolons.
8
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
9
string
WorkflowGuid
The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function.
10
bool
RunCTaPreTranslation
If true a pre-translation is executed.
11
bool
StoreCompleteCTaMatches
If true the 100% matches from the pre-translation analysis are inserted in the corresponding paragraph.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
13
bool
EnableContextMatch
Checks whether context matches exist or not.
14
bool
EnableStructureMatch
Checks whether structure matches exist or not.
15
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.
16
string
UserGuid
The GUID of the user.
When this is left empty, the style options set by the last call to CheckInManager.SetStyleOptions are used.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-in job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
24
Workflow does not exist.
Error
25
Failed to assign workflow to document. Occurs if the workflow is not released.
Error
28
Document template does not exist.
Error
71
File not found.
Error
243
Document extension is not found.
Error
245
Incorrect workflow for unsupported document.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

To get the document extension GUID, please use CheckInManager.GetDocumentExtensionsXml.

CheckInManager.GetDocumentExtensionsXml

Tip

Available from v7 15854.

The function returns an XML file with information about all available document types and lists the configured transformations and document settings templates.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
The document type information in XML format; see remarks below for details.

Remarks

The function returns the following XML format (comments are for documentation purposes only and are not included in function output):

<DocumentAssociations>
  <!-- DocumentType: Can occur multiple times. Entry for a specific document type in across.
    Name: The name of this document type, it should match the name visible in system settings.
    GUID: The document type guid. This value is used to identify the document type in checkin and update functions.
 -->
  <DocumentType Name="Tagged XML v2" GUID="a4204b55-c1d2-41f1-9fec-fccff4075f45">
    <!-- Extension: Can occur multiple times. Links file extensions to the document type together with configured pre and post processing.
      Name: The name of the document extension, visible as Description in System Settings -> Document Associations
      GUID: The document extension guid, used in CreateCheckinJob19 and CreateCheckinJob20
      PreProcessingScript: The full path of the script used to transform the document before checkin.
      PostProcessingScript: The full path of the script used to transform the document after checkout.
      DefaultSettings: The associated default document settings template.
    -->
    <Extension Name="Tagged XML v2" GUID="a4204b55-c1d2-41f1-9fec-fccff4075f45">
        <!-- FileExtension: Can occur multiple times. Specifies a supported file extension.
          IsDefault: If this is set to 1 it indicates that this is the default document type extension for files with this file extension.
        -->
        <FileExtension IsDefault="1">.xml</FileExtension>
    </Extension>
    <Extension
      Name="PO files"
      GUID="87a1ba26-ba48-4ff3-86ad-4b355f9ca9ce"
      PreProcessingScript="C:\Program Files (x86)\Across\crossTransform\po2txml\po2txml.bat"
      PostProcessingScript="C:\Program Files (x86)\Across\crossTransform\po2txml\txml2po.bat"
      DefaultSettings="17B85555-9C8F-4127-9A3C-A6ACFCC93AAB">
        <FileExtension IsDefault="1">.po</FileExtension>
    </Extension>
    <!-- Settings: Can occur multiple times. Entry for a defined document settings template.
      Name: The name of the document settings template. This should match name displayed in the document type settings in system settings
      GUID: The document settings guid. This value is used in CreateCheckinJob and UpdateDocument functions to identify the document settings.
    -->
    <Settings Name="Portable Objects and Templates" GUID="17B85555-9C8F-4127-9A3C-A6ACFCC93AAB"/>
    <Settings Name="Default" GUID="0a7f707c-f6f8-4631-8920-c71ab08dd96c"/>
  </DocumentType>
</DocumentAssociations>
  • This function can be used to:
  • Get the document extension guid needed to use CheckInManager.CreateCheckInJob19 and CheckInManager.CreateCheckInJob20
  • Get the full list of supported document types with name and guid. Document type guid is a parameter for functions
    • CheckinManager.CreateCheckinJob - CheckinManger.CreateCheckinJob18
    • CheckinManager.UpdateDocument - CheckinManger.UpdateDocument7
    • CheckinManager.UpdateDocumentAsync - CheckinManger.UpdateDocumentAsync7
    • ObjectManager.ExportDocumentSettings
    • ObjectManager.ImportDocumentSettings
  • Get the full list of document settings templates defined for a document type. Document settings template guid is a parameter for functions:
    • CheckinManager.CreateCheckinJob - CheckinManger.CreateCheckinJob20
    • CheckinManager.UpdateDocument - CheckinManger.UpdateDocument7
    • CheckinManager.UpdateDocumentAsync - CheckinManger.UpdateDocumentAsync7
Tip

The result also includes a document type that can be used with unsupported documents. This document type is restricted and does not have any extensions or document settings templates associated. Also, it can only be used with workflows that contain only steps of the type 'external processing'.

CheckInManager.GetDocumentGuidByJobGuid

Returns the GUID of a document according to the GUID of a current check-in job.

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
string
The GUID of the document.
Error
17
Job does not exist.
Error
21
Job has been canceled.

CheckInManager.GetJobProgress

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

CheckInManager.GetJobResult

Returns the result of a finished check-in job. The function only works for jobs created from CheckInManager 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.

CheckInManager.GetJobStatus

Returns the status of a check-in job. The function only works for jobs created from CheckInManager 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 check-in job. The following values are possible:
  • 0 - in progress
  • 1 - finished successfully
  • 2 - finished with errors
Error
17
Job does not exist.

CheckInManager.SetMultipleFullMatchOptions

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
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.

CheckInManager.SetPretranslatedStateOptions

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.
3
bool
SetFinalStateAlways
Parameter If true, set to final state for all pre-translated paragraphs.
4
bool
SetFinalStateWhenContextMatch
If true, set to final state when pre-translated with a context match.
5
bool
SetFinalStateWhenStructureMatch
If true, set to final state when pre-translated with a structure match.
6
bool
SetFinalStateCombineOperatorAnd
If true, set to final state when both context and structure conditions are met.

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.

CheckInManager.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

CheckInManager.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.
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.

CheckInManager.SetPreTranslationState

Attention

With Across v7.0, this function is no longer supported.

This function allows to specify how pre-translated paragraphs should be marked.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
StateGuid
The GUID of a paragraph state which should be applied to all pre-translated paragraphs.
3
bool
SetPreTranslatedFlag
Indicates whether pre-translated paragraphs should explicitly be marked as pre-translated or not.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
41
The paragraph state does not exist.

CheckInManager.SetRichTMPenalties

Sets the weights of non-matching Rich TM 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, the following default values are used:

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

CheckInManager.SetStyleOptions

Sets the font substitution settings used by crossAPI. These settings will be used by all subsequent check-ins.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
XMLSettings
The font substitution settings in XML format. Verified against StyleSettings.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.

Sample of XML corresponding to the Fonts section of the user settings in Across (<v7.0 profile settings):

<StyleOptions><PropertyValue="Arial Unicode MS"Name="ARABIC"/><PropertyValue="Arial Unicode MS"Name="ARMENIAN"/><PropertyValue="Arial Unicode MS"Name="BALTIC"/><PropertyValue="Arial Unicode MS"Name="CHINESE_SIMPLIFIED"/><PropertyValue="Arial Unicode MS"Name="CHINESE_TRADITIONAL"/><PropertyValue="Arial Unicode MS"Name="CYRILLIC"/><PropertyValue="Arial Unicode MS"Name="EASTERN_EUROPE"/><PropertyValue="Arial Unicode MS"Name="GEORGIAN"/><PropertyValue="Arial Unicode MS"Name="GREEK"/><PropertyValue="Arial Unicode MS"Name="HERBEW"/><PropertyValue="Arial Unicode MS"Name="INDIAN"/><PropertyValue="Arial Unicode MS"Name="JAPANESE"/><PropertyValue="Arial Unicode MS"Name="COREAN"/><PropertyValue="Arial Unicode MS"Name="LATIN"/><PropertyValue="Arial Unicode MS"Name="TAMIL"/><PropertyValue="Arial Unicode MS"Name="THAI"/><PropertyValue="Arial Unicode MS"Name="TURKISH"/><PropertyValue="Arial Unicode MS"Name="VIETNAMES"/><PropertyValue="@MS Gothic"Name="NotSubstitutedFont-0"/><PropertyValue="@NSimSun"Name="NotSubstitutedFont-1"/></StyleOptions>

If some properties are not specified by XML, they will be initialized by default values. For example, to prevent font substitution of Calibri, use the following XML:

<StyleOptions> 
   <Property Value="Calibri" Name="NotSubstitutedFont-0"/> 
</StyleOptions>

To protect multiple fonts, please increase the number in <NotSubstitutedFont-N>:

<StyleOptions> 
  <Property Value="Aharoni" Name="NotSubstitutedFont-0"/> 
  <Property Value="Calibri" Name="NotSubstitutedFont-1"/> 
</StyleOptions>

CheckInManager.SetUseOnlyOneFullMatch

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
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.

CheckInManager.UpdateDocument

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
4
bool
KeepOriginalDocument
If false, the original document is deleted.
5
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync.

This update function does not have the ability to carry out versioning or pre-translating. In order to use these features, please use the functions UpdateDocument2 and UpdateDocumentAsync2.

CheckInManager.UpdateDocument2

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentNewName
The new name of the document.
6
bool
KeepOriginalDocument
If false, the original document is deleted.
7
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
8
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
9
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
10
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
11
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync2.

CheckInManager.UpdateDocument3

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync3.

CheckInManager.UpdateDocument4

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync4.

CheckInManager.UpdateDocument5

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
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.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync5.

CheckInManager.UpdateDocument6

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
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.
18
bool
PreservingAttachments
If set to true, document attachments will be kept.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync6.

CheckInManager.UpdateDocument7

Updates a document within a project. The process takes place synchronously, i.e. the function only returns after the operation has been completed. Progress information is not available during the process.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
bool
PreservingAttachments
If set to true, document attachments will be kept.
18
bool
EnableStructureMatch
Checks whether structure matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the new document.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

It is advisable to switch to the function UpdateDocumentAsync7.

CheckInManager.UpdateDocumentAsync

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
4
bool
KeepOriginalDocument
If false, the original document is deleted.
5
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
6
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

This update function does not have the ability to carry out versioning or pre-translating. In order to use these features, please use the functions UpdateDocument2 and UpdateDocumentAsync2.

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync2

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentNewName
The new name of the document.
6
bool
KeepOriginalDocument
If false, the original document is deleted.
7
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
8
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
9
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
10
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
11
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
12
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync3

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync4

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync5

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
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.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync6

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
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.
18
bool
PreservingAttachments
If set to true, document attachments will be kept.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UpdateDocumentAsync7

Updates a document within a project. The process takes place asynchronously and the progress can be monitored via the returned job.

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
string
TargetLanguages
The LCIDs of the languages into which the document should be translated. Separated by semicolons.
4
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.
5
string
DocumentTypeGuid
The GUID of the document type as which the specified document should be checked in.
6
string
PreProcessingScriptPath
The path to a script that should be used for pre-processing the file before it will be checked in. The user account under which the crossAPI service runs must have access to this path.
7
string
DocumentNewName
The new name of the document.
8
bool
KeepOriginalDocument
If false, the original document is deleted.
9
bool
CreateNewVersion
Turns the document into the new version (just like the Across update). KeepOriginalDocument must be set.
10
bool
KeepOriginalAssignments
If false, the task assignments are given to the updated document. In this case, no further tasks are assigned to the original document.
11
string
DocSettingsGuid
The GUID of the document template that should be used. The GUID can be obtained via the ObjectManager.GetDocumentTemplateGuidByName2 function.
12
int
PreTranslationOptions
Configures the pre-translation.
  • The following values are possible:
  • 0 - No pre-translation will be carried out
  • 1 - Only analysis will be carried out (for the pre-translation table)
  • 2 - Analysis and translation of the remaining "untouched after update" paragraphs
  • 3 - Translation of the remaining "untouched after update" using the fast 100% search
13
int
PreTranslationCWP
Only valid if PreTranslationOptions is set to either 1 or 2. In this case it indicates the smallest similarity from which two sentences could count as being translations of each other.
14
string
PreTranslationSourceLanguage
The LCID of the language that should be used as source for the pre-translation.
15
bool
PreservingBookmarksAnd Comments
True if bookmarks and comments should not be deleted during update, false otherwise.
16
bool
EnableContextMatch
Checks whether context matches exist or not.
17
bool
PreservingAttachments
If set to true, document attachments will be kept.
18
bool
EnableStructureMatch
Checks whether structure matches exist or not.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the job.
Error
2
User does not exist.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
28
Document template does not exist.
Error
35
Unable to update document. More detailed information can be found in the error description.
Error
56
Document type is not supported.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

CheckInManager.UploadExternalEditedDocument

Uploads an externally edited document.

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
string
TaskTemplateGuid
The GUID of the task definition that should be assigned to the users.
6
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
24
Workflow does not exist.
Error
27
Task template does not exist.
Error
53
Task does not exist.
Error
71
File not found.
Error
73
Cannot add attachment.
Error
157
Wrong task type.
Error
180
The document is not ready because it is being checked in.

CheckInManager.UploadExternalEditedDocument2

Uploads an externally edited document.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TaskGuid
GUID of the task.
3
string
DocumentPath
The path of the document to be uploaded. The user account under which crossAPI runs must have access to this path.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
53
Task does not exist.
Error
71
File not found.
Error
73
Cannot add attachment.
Error
157
Wrong task type.