- General Information
- Connecting Third-party Systems
- crossConnect for content systems
- crossConnect for External Editing
- Purpose and usage
- 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
- Sample code - Integrated solution
- Across XLIFF format
- Generic File Connector
- Display Texts
- APIs
- APIs - Technology
- crossTank API v1
- crossTank API v2
- crossTerm API v1
- crossTerm API v2
- crossAPI SI
- Requirements
- Function Return Types
- crossAPI SI and Java
- List of Objects in crossAPI SI
- Sample - transferring checkout files via FileManager
- Sample - VBS
- Text Preprocessing API
AssignManager
- Unless stated otherwise, all objects are available in the following Across versions:
- 5.7
- 6.0
- 6.3
- 7.0
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 |
Assigns an Across user crowd to a task. Relay assignments are not possible. | |
Assigns the project management task to a user. | |
Assigns the project management task to a user. | |
Assigns a task to a user. Relay assignments are not possible. | |
Assigns a task to a user. So-called relay translations can also be carried out (e.g. from German to English to Chinese). | |
Assigns a task to a user. Relay translations are not possible. | |
Assigns a task to a user. So-called relay translations can also be carried out (e.g. from German to English to Chinese). This function allows assignment of one or multiple partitions of a partitioned target language to a user. | |
Assigns a certain workflow to a document. | |
Assigns a certain workflow to a document. This function allows you to specify a custom mapping from the paragraph states of the old workflow to the paragraph states of the new workflow. | |
Assigns a certain workflow to a document. | |
Assigns a certain workflow to a document. Allows specifications of a state mapping. | |
Cancels the specified job. The function only works for jobs created from AssignManager functions. | |
Returns the assigned project manager of a specific project. | |
Returns the GUID of the user that is assigned to a specific task. | |
Returns the GUID of the user that is assigned to a specific task. | |
Returns the progress of a job. The function only works for jobs created from AssignManager functions. | |
Returns the result of a finished job. The function only works for jobs created from AssignManager functions. | |
Returns the status of a job. The function only works for jobs created from AssignManager functions. | |
Unassigns a user from a task. | |
Revokes a task from a user, user crowd, or crossGrid package. | |
Unassigns a user from a task. Optionally resets all paragraph states. | |
Unassigns all tasks from a user. | |
Unassigns a task from a user. |
AssignManager.AssignCrowdToTask
Assigns an Across user crowd to a task. Relay assignments are not possible.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | int | CrowdId | The ID of the crowd the task should be assigned to. |
3 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 26 | Unable to assign user to document. |
Error | 180 | The document is not ready because it is being checked in. |
AssignManager.AssignProjectManager
Assigns the project management task to a user.
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 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 19 | Project does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 53 | Task does not exist. |
Error | 109 | Cannot revoke the task. |
Error | 143 | User does not have the permission. |
AssignManager.AssignProjectManager2
Assigns the project management task to a user.
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 | string | UserGuid | The GUID of the user. |
4 | boolean | AllowMultipleAssignment | If set to true, the user will be assigned in addition to the already assigned users, otherwise replaces project management assignment with specified user. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 19 | Project does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 53 | Task does not exist. |
Error | 109 | Cannot revoke the task. |
Error | 143 | User does not have the permission. |
AssignManager.AssignUserToTask
Assigns a task to a user. Relay assignments are not possible.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language for which the task should be assigned. |
5 | string | TaskTemplateGuid | The GUID of the task definition that should be assigned to the users. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 180 | The document is not ready because it is being checked in. |
AssignManager.AssignUserToTask2
Assigns a task to a user. So-called relay translations can also be carried out (e.g. from German to English to Chinese).
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language for which the task should be assigned. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task definition that should be assigned to the users. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 38 | Unable to carry out relay assignment. More detailed information can be found in the error description. |
Error | 180 | The document is not ready because it is being checked in. |
In contrast to AssignManager.AssignUserToTask, it is possible to use AssignUserToTask2 to carry out so-called relay translations. In that case, SourceLanguageLcid can deviate from the language of the source document.
For example, a German document should be translated into both English and Chinese. The designated Chinese translator can translate from English but not from German, so the English translator begins translating from German into English and the Chinese translator, in turn, begins translating from English into Chinese. In this case, one would set English and not German as the source language of the task for the Chinese translator.
AssignManager.AssignUserToTask3
Assigns a task to a user. Relay translations are not possible.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 180 | The document is not ready because it is being checked in. |
AssignManager.AssignUserToTask4
Assigns a task to a user. So-called relay translations can also be carried out (e.g. from German to English to Chinese). This function allows assignment of one or multiple partitions of a partitioned target language to a user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language for which the task should be assigned. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | PartitionIndexes | A list of partition indexes separated by ;. |
7 | string | TaskTemplateGuid | The GUID of the task definition that should be assigned to the users. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 38 | Unable to carry out relay assignment. More detailed information can be found in the error description. |
Error | 180 | The document is not ready because it is being checked in. |
In contrast to AssignManager.AssignUserToTask, it is possible to use AssignUserToTask4 to carry out so-called relay translations. In that case, SourceLanguageLcid can deviate from the language of the source document.
For example, a German document should be translated into both English and Chinese. The designated Chinese translator can translate from English but not from German, so the English translator begins translating from German into English and the Chinese translator, in turn, begins translating from English into Chinese. In this case, one would set English and not German as the source language of the task for the Chinese translator.
In contrast to AssignManager.AssignUserToTask2, it is possible to use AssignUserToTask4 to assign one or multiple partitions of a partitioned target language.
For example, a document is split into 2 partitions. With AssignUserToTask4, it is possible to assign partition 1 to User A and partition 2 to User B.
AssignManager.AssignWorkflowToDocument
Assigns a certain workflow to a document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | WorkflowGuid | The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | DateTime | Deadline | The date by which the task should be finished. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 16 | Document does not exist. |
Error | 24 | Workflow does not exist. |
Error | 25 | Failed to assign workflow to document. A possible reason for this is that the workflow has already been assigned to the document. |
Error | 218 | Workflow with possibility of source document editing cannot be assigned to partitioned document. |
AssignManager.AssignWorkflowToDocument2
Assigns a certain workflow to a document. This function allows you to specify a custom mapping from the paragraph states of the old workflow to the paragraph states of the new workflow.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | WorkflowGuid | The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | DateTime | Deadline | The date by which the task should be finished. |
5 | string | StateMappingsXML | An XML formatted string with mappings between paragraph states. StateFrom and StateTo contain the respective paragraph state GUID. <StateMappings><StateMappingStateFrom="00DA2430-8B4A-432f-BDF8-035CA956844C"StateTo="E850038C-51BC-4ede-8BE9-31508D998584"/></StateMappings> |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
Error | 16 | Document does not exist. |
Error | 24 | Workflow does not exist. |
Error | 25 | Failed to assign workflow to document. A possible reason for this is that the workflow has already been assigned to the document. |
Error | 41 | The paragraph state does not exist. |
Error | 218 | Workflow with possibility of source document editing cannot be assigned to partitioned document. |
AssignManager.AssignWorkflowToDocumentAsync
Assigns a certain workflow to a document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | WorkflowGuid | The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | DateTime | Deadline | The date by which the task should be finished. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the created job. |
Error | 18 | Unable to create job. |
The created job basically executes AssignManager.AssignWorkflowToDocument. Please see that function for possible errors returned from AssignManager.GetJobResult.
AssignManager.AssignWorkflowToDocumentAsync2
Assigns a certain workflow to a document. Allows specifications of a state mapping.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | WorkflowGuid | The GUID of the workflow that should be assigned to the document. This GUID can be obtained via the ObjectManager.GetWorkflowGuidByName function. |
3 | string | DocumentGuid | DocumentGuid |
4 | DateTime | Deadline | The date by which the task should be finished. |
5 | string | StateMappingsXML | An XML formatted string with mappings between paragraph states. StateFrom and StateTo contain the respective paragraph state GUID. <StateMappings><StateMappingStateFrom="00DA2430-8B4A-432f-BDF8-035CA956844C"StateTo="E850038C-51BC-4ede-8BE9-31508D998584"/></StateMappings> |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the created job. |
Error | 18 | Unable to create job. |
AssignManager.CancelJob
Cancels the specified job. The function only works for jobs created from AssignManager 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. |
AssignManager.GetAssignedProjectManager
Returns the assigned project manager of a specific 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. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the project manager. |
Error | 19 | Project does not exist. |
Error | 53 | Task does not exist. |
Error | 154 | The task is not assigned. |
This function will only return the first project manager in case multiple project managers are assigned to the project.
If you need to find all project managers assigned to a project, it is possible to get the GUIDs of assigned project managers via ProjectManager.GetProjectsInformationXml.
AssignManager.GetAssignedUserForTask
Returns the GUID of the user that is assigned to a specific task.
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. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the assigned user. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 24 | Workflow does not exist. Tip Error 24 is also returned when the specified document has no workflow assigned. |
Error | 27 | Task template does not exist. |
Error | 53 | Task does not exist. |
Error | 154 | The task is not assigned.
|
Error | 180 | The document is not ready because it is being checked in. |
AssignManager.GetAssignedUserForTask2
Returns the GUID of the user that is assigned to a specific task.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the assigned user. |
Error | 53 | Task does not exist. |
Error | 154 | The task is not assigned.
|
AssignManager.GetJobProgress
Returns the progress of a job. The function only works for jobs created from AssignManager functions.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | JobGuid | The GUID of the job. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The progress of the job in percent. |
Error | 17 | Job does not exist. |
Error | 21 | Job has been canceled. |
Other return values are possible. They depend on the executed job and mean the job itself failed.
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.
AssignManager.GetJobResult
Returns the result of a finished job. The function only works for jobs created from AssignManager 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. |
Other return values are possible. They depend on the executed job and mean the job itself failed.
AssignManager.GetJobStatus
Returns the status of a job. The function only works for jobs created from AssignManager 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 |
|
Error | 17 | Job does not exist. |
AssignManager.RevokeTask
Unassigns a user from a task.
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 | TaskTemplateGuid |
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. Tip Error 24 is also returned when the specified document has no workflow assigned. |
Error | 27 | Task template does not exist. |
Error | 53 | Task does not exist. |
Error | 109 | Cannot revoke the task. |
Error | 154 | The task is not assigned. |
Error | 180 | The document is not ready because it is being checked in. |
AssignManager.RevokeTask2
Revokes a task from a user, user crowd, or crossGrid package.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 109 | Cannot revoke the task. |
Error | 154 | The task is not assigned. |
AssignManager.RevokeTask3
Unassigns a user from a task. Optionally resets all paragraph states.
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 | boolean | ResetParagraphStates | If true the states of all paragraphs are reset, if false the states are kept. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 53 | Task does not exist. |
Error | 109 | Cannot revoke the task. |
Error | 154 | The task is not assigned. |
Error | 226 | Cannot reset paragraph states for the task. |
AssignManager.UnassignUserFromAllTasks
Unassigns all tasks from a user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | int | Number of tasks unassigned from this user. |
Error | 2 | User does not exist. |
Error | 109 | Cannot revoke the task. |
AssignManager.UnassignUserFromTask
Unassigns a task from a user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document within the context of which the task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language for which the task should be assigned. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task definition that should be assigned to the users. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 2 | User does not exist. |
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 | 109 | Cannot revoke the task. |
Error | 180 | The document is not ready because it is being checked in. |
Error 24 is returned when the specified document has no workflow assigned.
In case the task exists but is not assigned to the specified user, the function returns error 53.