Contact
Newsletter
Schedule Consultation

CheckOutManager

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

Function-specific return values are listed with each function.

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

Function
Description
Cancels the specified job. The function only works for jobs created from CheckOutManager functions.
Creates a check-out job that creates a document in the target language.
Creates a check-out job that creates a document in the target language.
Creates a check-out job that creates a document in the target language.
Creates a check-out job that creates a document in the target language.
Creates a check-out job that creates a document in the target language. If the workflow contains a target language post-processing task as the final step, this function will always check out the state of the document before the post-processing.
Creates a check-out job that creates a document in the target language. The behavior of the function can be defined via the user defined parameters.
Returns the progress of a check-out job. The function only works for jobs created from CheckOutManager functions.
Returns the result of a finished check-out job. The function only works for jobs created from CheckOutManager functions.
Returns the status of a check-out job. The function only works for jobs created from CheckOutManager functions.

CheckOutManager.CancelJob

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

CheckOutManager.CreateCheckOutJob

Creates a check-out job that creates a document in the target language.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.CreateCheckOutJob2

Creates a check-out job that creates a document in the target language.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.
5
string
PostProcessingScriptPath
The path to a script that should be used for post-processing the file after it has been checked out. The user account under which the crossAPI service runs must have access to this path.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.CreateCheckOutJob3

Creates a check-out job that creates a document in the target language.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.
5
string
PostProcessingScriptPath
The path to a script that should be used for post-processing the file after it has been checked out. The user account under which the crossAPI service runs must have access to this path.
6
bool
CheckOutFTESource
If set to true, check-out will get the modified source for an FTE document.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.CreateCheckOutJob4

Creates a check-out job that creates a document in the target language.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.
5
string
ReferencePath
The path to the location of the reference DLL files.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.CreateCheckOutMostRecentEditedInAcross

Creates a check-out job that creates a document in the target language. If the workflow contains a target language post-processing task as the final step, this function will always check out the state of the document before the post-processing.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.
5
string
PostProcessingScriptPath
The path to a script that should be used for post-processing the file after it has been checked out. The user account under which the crossAPI service runs must have access to this path.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.CreateUserDefinedCheckOutJob

Creates a check-out job that creates a document in the target language. The behavior of the function can be defined via the user defined parameters.

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
string
TargetPath
The path in which the document should be created. The user account under which the crossAPI service runs must have access to this path.
5
string
PostProcessingScriptPath
The path to a script that should be used for post-processing the file after it has been checked out. The user account under which the crossAPI service runs must have access to this path.
6
string
UserDefinedParemeters
When the parameter is empty, the check-out will be done as usual.
If this is not wanted, the string can be used to configure all parameters for the post-processing script (its path either specified with the parameter above or via the default postprocessing configured in document associations section of system settings in the client).
  • Possible inline values for the parameters string:
  • %outdoc - the output document
  • %trgdoc - the result of the target language check-out
  • %srcdoc - the result of the source language check-out
  • %xliffdoc - the result of the XLIFF export
  • %trglcid - LCID of the target language
  • %srclcid - LCID of the source language
  • %docguid - GUID of the document
Example: """%outdoc"" %srclcid %trglcid ""%docguid""" will produce the same result as the empty parameters string.
7
bool
MostRecentEditedInAcross
TRUE means the function is identical to CreateCheckOutMostRecentEditedInAcross.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the check-out job.
Error
15
Language does not exist.
Error
16
Document does not exist.
Error
18
Unable to create job.
Error
180
The document is not ready because it is being checked in.
Error
221
Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
Tip

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

CheckOutManager.GetJobProgress

Returns the progress of a check-out job. The function only works for jobs created from CheckOutManager 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-out job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
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.

CheckOutManager.GetJobResult

Returns the result of a finished check-out job. The function only works for jobs created from CheckOutManager 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-out job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Error
43
The job has not yet been completed.

CheckOutManager.GetJobStatus

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