• 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
  • ObjectManager - Overview
  • 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

ObjectManager - Overview

  • 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
ObjectManager.AddAttachmentToDocument
This function lets you add an attachment to a document.
ObjectManager.AddAttachmentToLanguage
Adds an attachment to the language of a document.
ObjectManager.AddDocumentComment
Adds a comment to the specified document.
ObjectManager.AddLanguageComment
Adds a comment to the language of a document.
ObjectManager.AddLanguageRatingToUser
Adds a language rating to the specified user.
ObjectManager.AddLanguageToDocument
Adds another target language to the specified document.
ObjectManager.AddRelationComment
Adds a comment to the specified relation.
ObjectManager.AddUserComment
Adds a comment to a user.
ObjectManager.AddUserToGroup
Adds a user to a specified user group.
ObjectManager.ArchiveProject
Archives or reactivates a project.
ObjectManager.BinaryCompare
Compares two files binary, to tell if both are the same.
ObjectManager.CheckUserRight
Checks if a user has a specific right.
ObjectManager.CreateGroup
Creates a new Across user group.
ObjectManager.CreateMainSubject
Creates a main subject.
ObjectManager.CreateProject
Creates a new project.
ObjectManager.CreateRelation
Creates a new relation.
ObjectManager.CreateRelation2
Creates a new relation.
ObjectManager.CreateSubSubject
Creates a sub-subject.
ObjectManager.CreateUser
Creates a new Across user.
ObjectManager.CreateUser2
Creates a new Across user.
ObjectManager.ExportDocumentSettings
Exports document settings from Across to a DST file.
ObjectManager.Finish100progressTasks
Sets all confirmed tasks with a progress of 100% to finished.
ObjectManager.GetAllMainSubjects
Returns all existing main subjects.
ObjectManager.GetAllMainSubjectsCSV
Returns all existing main subjects.
ObjectManager.GetAllOfflineUsers
Returns all existing offline users.
ObjectManager.GetAllOfflineUsersCSV
Returns all existing offline users.
ObjectManager.GetAllOnlineUsers
Returns all existing online users.
ObjectManager.GetAllOnlineUsersCSV
Returns all existing online users.
ObjectManager.GetAllRelations
Returns all existing relations.
ObjectManager.GetAllRelationsCSV
Returns all existing relations.
ObjectManager.GetAllReportTemplates
Returns the GUIDs of all the report templates.
ObjectManager.GetAllReportTemplatesCSV
Returns the GUIDs of all the report templates as semicolon-separated values.
ObjectManager.GetAllSubSubjects
Returns all existing sub-subjects.
ObjectManager.GetAllSubSubjectsCSV
Returns all existing workflows.
ObjectManager.GetAllTaskTemplates
Returns all task templates of a given workflow.
ObjectManager.GetAllTaskTemplatesCSV
Returns all task templates of a given workflow.
ObjectManager.GetAllUsers
Returns all existing users.
ObjectManager.GetAllUsersCSV
Returns all existing users.
ObjectManager.GetAllWorkflows
Returns all existing workflows. This includes workflows that were received via crossGrid.
ObjectManager.GetAllWorkflowsCSV
Returns all existing workflows. This includes workflows that were received via crossGrid.
ObjectManager.GetAttributesList
Returns the list attribute descriptions as XML.
ObjectManager.GetAttributesList2
Returns the list attribute descriptions as XML.
ObjectManager.GetAttributesListFile
Gets a file with the list of existing attributes.
ObjectManager.GetAttributeValuesList
Returns the description of the values of an attribute as XML.
ObjectManager.GetDocTypeGuidByFileName
Returns the GUID of the document type that matches the supplied filename.
ObjectManager.GetDocTypeGuidsByFileName
Returns the GUIDs of the document types that match the supplied filename.
ObjectManager.GetDocTypeGuidsByFileNameCSV
Returns the GUIDs of the document types that match the supplied filename.
ObjectManager.GetDocumentAttachmentList
Returns a list of the attachments of a specific document.
ObjectManager.GetDocumentComments
Returns the comments of a document.
ObjectManager.GetDocumentLanguages
Returns all languages of the document. The source language is the first one in the list.
ObjectManager.GetDocumentName
Returns the name of the document with the specified GUID.
ObjectManager.GetDocumentParagraphCount
Returns the number of paragraphs in a document.
ObjectManager.GetDocumentTemplateGuidByName
Returns the GUID of a document template according to its name.
ObjectManager.GetDocumentTemplateGuidByName2
Returns the GUID of a document template according to its name which belongs to a specific document type.
ObjectManager.GetDocumentWorkflow
Returns the workflow that has been assigned to the specified document.
ObjectManager.GetFinishedDocumentLanguages
Returns the fully translated languages for a document.
ObjectManager.GetGroupIdByName
Returns the ID of an Across user group.
ObjectManager.GetGroupIdsByName
Returns the IDs of the groups with the specified name.
ObjectManager.GetGroupIdsByNameCSV
Returns the IDs of the groups with the specified name.
ObjectManager.GetGroupIDsByUserGuid
Returns the IDs of the groups to which the user belongs
ObjectManager.GetGroupIDsByUserGuidCSV
Returns the IDs of the groups to which the user belong as semi-colon separated list.
ObjectManager.GetGroupNameByID
Returns the name of the group with the specified ID.
ObjectManager.GetLanguageAttachmentList
Returns a list of the attachments of a language of a specific document.
ObjectManager.GetLanguageComments
Returns the comments of a language.
ObjectManager.GetLanguageParagraphCountByState
Returns the number of paragraphs in the target language of a certain document that have a certain (Untouched, Touched, Translated, Checked, etc.) paragraph state.
ObjectManager.GetLanguageRatingsForUser
Returns the language ratings for the specified Across user.
ObjectManager.GetLanguageRatingsForUser2
Returns the language ratings for the specified Across user.
ObjectManager.GetLanguageWordCountByState
Returns the number of words in the target language of a certain document that have a certain (Untouched, Touched, Translated, Checked, etc.) paragraph state.
ObjectManager.GetMainSubjects
Returns the GUIDs of the main subjects.
ObjectManager.GetMainSubjectsCSV
Returns the GUIDs of t he main subjects as semi-colon separated values.
ObjectManager.GetOrCreateProject
Returns the GUID of a project according to its name, relation and subject. If no project matches these criteria, one will then be created.
ObjectManager.GetOrCreateRelation
Returns the GUID of a relation according to its name. If no relation exists with this name, one will then be created.
ObjectManager.GetOrCreateSubject
Returns or creates a new subject.
ObjectManager.GetParagraphStateGuidByName
Returns the GUID of a paragraph state according to its name.
ObjectManager.GetParagraphStatesGuidsByName
Returns the GUIDs of all paragraph states with the specified name.
ObjectManager.GetParagraphStatesGuidsByNameCSV
Returns the GUIDs of all paragraph states with the specified name.
ObjectManager.GetProfileByUserGUID
Returns the user settings of a specified user.
ObjectManager.GetProfileTemplateGuidByName
Returns the GUID of the user settings template which can be assigned to a user.
ObjectManager.GetProjectDocumentsCount
Returns the number of documents in a project.
ObjectManager.GetProjectStatus
Returns the status of a project.
ObjectManager.GetReferences
Returns the relation GUIDs.
ObjectManager.GetReferencesCSV
Returns the relation GUIDs as semicolon-separated values.
ObjectManager.GetRelationComments
Returns the comments of a relation.
ObjectManager.GetRelationGuidByName
Returns the GUID of a relation according to its name.
ObjectManager.GetRelationID
Returns the ID of the relation as specified in the properties of the relation.
ObjectManager.GetRelationNameByGuid
Returns the name of a relation according to its GUID.
ObjectManager.GetReportTemplateGuidByName
Returns the GUID of the report template.
ObjectManager.GetReportTemplateNameByGuid
Returns the name of the report template.
ObjectManager.GetSubjectGuidByName
Returns the GUID of a subject according to its name.
ObjectManager.GetSubjectNameByGuid
Returns the name of a subject according to its GUID.
ObjectManager.GetTaskDeadline
Returns the due date of a specific task.
ObjectManager.GetTaskProgress
Returns the progress of a task in percent.
ObjectManager.GetTaskState
Used to query the state of a specific task.
ObjectManager.GetTaskStatistics
Returns the statistics of a task. It is the same data that is used to generate the Task Report.
ObjectManager.GetTaskTemplateGuidByName
Returns the GUID of a task template according to its name.
ObjectManager.GetTaskTemplateNameByGuid
Returns the name of a task template.
ObjectManager.GetTaskTemplateType
Returns the type of a specified task template.
ObjectManager.GetUserComments
Returns the comments of a user.
ObjectManager.GetUserContact
Returns the contact data of the specified Across user.
ObjectManager.GetUserGuidByLogin
Returns the GUID of a user according to the login name.
ObjectManager.GetUserGuidsByGroupID
Returns a list of user GUIDs that belong to the group specified by the ID.
ObjectManager.GetUserGuidsByGroupIDCSV
Returns a list of user GUIDs that belong to the group specified by the ID as semicolon-separated list.
ObjectManager.GetUserID
Returns the ID of a user according to the corresponding GUID.
ObjectManager.GetUserIDByLogin
Returns the ID of a user according to the login name.
ObjectManager.GetUserLoginByGuid
Returns the login of the specified user GUID.
ObjectManager.GetWorkflowGuidByName
Returns the GUID of a workflow according to its name.
ObjectManager.GetWorkflowNameByGuid
Returns the name of a workflow according to its GUID.
ObjectManager.GetWorkflows
Returns the GUIDs of the workflows. Use the parameter to specify whether to include workflows received via crossGrid.
ObjectManager.GetWorkflowsCSV
Returns the GUIDs of the workfows as semicolon-separated values. Use the parameter to specify whether to include workflows received via crossGrid.
ObjectManager.GetWorkflowTaskTemplateGuids
Returns the GUIDs of the task templates that belong to a specific workflow.
ObjectManager.GetWorkflowTaskTemplateGuidsCSV
Returns the GUIDs of the task templates that belong to a specific workflow.
ObjectManager.ImportDocumentSettings
Imports document settings into Across from a DST file.
ObjectManager.IsDocumentFinished
Returns whether a document has been completely translated or not.
ObjectManager.IsMtEngineEnabled
Checks if the specified MT engine is enabled.
ObjectManager.IsProjectArchived
Returns whether a project is in the archive or not.
ObjectManager.IsProjectFinished
Returns whether a project has been completed or not.
ObjectManager.IsTaskFinished
Returns whether a task is finished or not.
ObjectManager.RemoveAttachment
Removes an attachment from a document or language.
ObjectManager.RemoveComment
Removes a comment from a project, a language, a document, a user, or a relation.
ObjectManager.RemoveDocument
Deletes an existing document.
ObjectManager.RemoveLanguageFromDocument
Removes a target language from the specified document.
ObjectManager.RemoveLanguageRatingFromUser
Removes a language rating from the specified Across user.
ObjectManager.RemoveProject
Deletes an existing project.
ObjectManager.RemoveRelation
Deletes an existing relation.
ObjectManager.RemoveSubject
Removes a subject.
ObjectManager.RemoveUser
Deletes an Across user.
ObjectManager.RemoveUserFromGroup
Removes a user from a group.
ObjectManager.RenameDocument
Renames a document.
ObjectManager.SaveAttachment
Saves an attachment to the hard disk.
ObjectManager.SetDocumentFinished
Sets the finished flag of the specified document.
ObjectManager.SetEmailUserSettings
Sets the SMTP settings in the user settings used for sending notifications in the client from this user.
ObjectManager.SetLanguageParagraphsState
Sets the state of all paragraphs to a certain value. Optionally, only empty paragraphs can be taken into account.
ObjectManager.SetRelationAddress
Sets the address for the specified relation.
ObjectManager.SetRelationPrimaryContact
Sets the primary contact for the specified relation.
ObjectManager.SetRelationSecondaryContact
Sets the secondary contact for the specified relation.
ObjectManager.SetTaskDeadline
Sets the due date of a specific task.
ObjectManager.SetUserContact
Sets the contact information of the specified Across user.
ObjectManager.SwitchLanguageParagraphState
Changes one paragraph state to another for a certain target language in a certain document.
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