• Show convenient version of this site
  • Deutsch
  • English
Contact
Newsletter
  • Products
    • ALS
      • Across Language Server
        • Translation Management
        • Terminology Management
        • Translation Memory
      • Editions
      • Interfaces
    • ATE
      • Across Translator Edition
      • Editions
      • Download
      • Across Account
    • Elanion
      • Overview
      • Login
  • Solutions
    • Customers
      • Enterprises
      • Language Service Providers
      • Translators
    • Industries
      • E-Commerce & Trade
      • Pharmaceuticals & medicine
      • IT & Software
    • Departments
      • Marketing & E-Commerce
      • Technical Documentation
      • Software User Interfaces
  • Services
    • Hosting
    • Training
    • Consulting
  • Partners
    • Language Service Providers
    • Universities
  • Company
    • Across Systems
    • News
    • Events
    • Career
    • Contact
  • Knowledge
    • Blog
    • Video Library
    • Case Studies
    • White Papers
    • Fact Sheets
    • File Formats
    • Expert Features
  • Support
    • New Functions
    • Online Help
    • FAQ
    • Support Request
    • Updates
Schedule Consultation
  • Online-Help
  • SDK
  • APIs
  • crossAPI SI
  • List of Objects in crossAPI SI
  • CheckOutManager
  • General Information
    • Connectors
    • LCIDs
    • GUIDs
    • Paragraph states and flags
    • crossTerm Web
    • crossTransform
      • crossTransform - examples
  • Connecting Third-party Systems
    • crossConnect for content systems
      • Requirements
      • Configuration
        • Configuring the connector
        • Job configuration
        • Testing crossConnect
      • Troubleshooting
    • crossConnect for External Editing
      • Purpose and usage
        • Use case - Machine translation
        • Use Case - Review and QA
        • Use case - Machine review
      • Requirements
      • Implementation
        • Across XLIFF format
          • Across-specific Extensions
          • <xliff> Element Attributes
          • <file> Element Extensions
          • <trans-unit> Element Extension
          • Paragraph States
          • Paragraph State Flags
          • <source> and <target> Element Content
          • <bpt> Element Attributes
          • <ph> Element Attributes
          • <x> Element Attributes
          • Across-specific Properties
          • Analysis Results
          • Sample Files
          • Across XLIFF - import, export and segmentation
          • Context information
          • Exporting best matches in Across XLIFF
          • Hyperlinks to XLIFF
        • Secure file handling with C#
        • Secure file handling with JAVA
        • Workflow and vendor configuration
          • Adding workflows to crossAutomate Host Manager
          • Adjusting preset watchfolders
          • The filter rules
          • External editing workflows
        • Sample code - Integrated solution
    • Generic File Connector
      • Process Overview
      • Exchange Folder Structure
      • Package Format
        • Control File
  • Display Texts
    • Solution approaches
    • The Across solution in detail
    • Requirements
    • Integration
    • The display text format
      • Line height vs. line spacing
      • DT-XML format structure
        • DT-XML - Main elements
        • Children of paragraphStyles and characterStyles
        • Children of the sizeInfos element
        • Children of the paragraph element
        • DT-XML v5 example
        • DT-XML v4 example
    • The display text package
      • Creating a display text package
  • APIs
    • APIs - Technology
    • crossTank API v1
      • Requirements
      • Testing the crossTank API installation
      • OData-URLs in Chrome
      • Example
    • crossTank API v2
      • Requirements
      • QuickStart
        • Searching for Translations
        • Creating Translations
      • crossTank API v2 Overview
        • Finding Translations
        • Creating Translations
        • Translation Properties
        • Formatting and Auto-Adjustment of Formatting and Numbers
      • C# Example
    • crossTerm API v1
      • Scenarios of use
        • Example - usage information
        • Example - finding terms
      • Requirements
      • Special Controllers
      • OData-URLs in Chrome
      • crossTerm API with C#
      • crossTerm API with Java
      • crossTerm API with JavaScript
    • crossTerm API v2
      • Requirements
      • QuickStart
        • Authentication Basics
        • First Request Examples
      • crossTerm API v2 Example in C#
        • Used Functions
      • crossTank API, crossTerm API v2 - Authentication
      • crossTerm API v2 - Examples of Use
        • Finding Terms of Entry
        • Searching Terminology via API
    • crossAPI SI
      • Requirements
      • Function Return Types
      • crossAPI SI and Java
        • Example: hot integration
        • Executing the hot integration example
      • List of Objects in crossAPI SI
        • AssignManager
        • Authorization
        • CheckInManager
        • CheckOutManager
        • CrossTankManager
        • CrossTermManager
        • DocumentManager
        • FileManager
        • LanguageJobManager
        • LanguageManager
        • LicenseManager
        • Message
        • ObjectManager - Overview
          • Part 1
          • Part 2
          • Part 3
        • ReportManager
          • ID values for analysis and analysis-result
        • ProjectManager - Overview
          • Part 1
          • Part 2
          • Attribute Information
        • SqlQuery
        • SystemManager
        • TaskManager
        • WanGridManager - Overview
          • Part 1
          • Part 2
      • Sample - transferring checkout files via FileManager
      • Sample - VBS
    • Text Preprocessing API
      • Introduction
      • How to browse the API
      • Sentence splitting
      • Abbreviations

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
CheckOutManager.CancelJob
Cancels the specified job. The function only works for jobs created from CheckOutManager functions.
CheckOutManager.CreateCheckOutJob
Creates a check-out job that creates a document in the target language.
CheckOutManager.CreateCheckOutJob2
Creates a check-out job that creates a document in the target language.
CheckOutManager.CreateCheckOutJob3
Creates a check-out job that creates a document in the target language.
CheckOutManager.CreateCheckOutJob4
Creates a check-out job that creates a document in the target language.
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.
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.
CheckOutManager.GetJobProgress
Returns the progress of a check-out job. The function only works for jobs created from CheckOutManager functions.
CheckOutManager.GetJobResult
Returns the result of a finished check-out job. The function only works for jobs created from CheckOutManager functions.
CheckOutManager.GetJobStatus
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.
Register for our Newsletter now

Our newsletter provides you with exclusive news about the Across Language Server, often even before the official announcement. The newsletter also provides you with early information on events, webinars, and training sessions.

  • Legal Notice
  • GTC
  • Privacy Statement
  • Cookies
  • info@across.net