- 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
ProjectManager - Part 2
ProjectManager.GetProjectProgress
Returns the progress of the 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 | int | Method | The method to use to calculate the progress.
Tip Child object-based calculation returns the percentage of finished documents. |
Return Values
Result | Type/Value | Interpretation |
Success | double | The progress of the project in percent. |
ProjectManager.GetProjectRelation
Returns the relation of 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. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The relation of a project. |
Error | 13 | Relation does not exist. |
Error | 19 | Project does not exist. |
ProjectManager.GetProjectReportTemplates
Returns the GUIDs of all across report templates associated with 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. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the report templates as array. |
Error | 19 | Project does not exist. |
Error | 161 | Cannot load reporting templates. |
ProjectManager.GetProjects
Returns the projects in Across.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | UnfineshedFlag | If set, unfinished projects will be returned. |
3 | bool | ActiveFinishedFlag | If set to true, projects which are finished but not in the archive will be returned. |
4 | bool | ArchiveFlag | Specifies whether the project is to be archived (true) or reactivated (false). |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the projects, separated by semicolons. |
ProjectManager.GetProjectsDeadlines
Returns the list of project due dates.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | ProjectGuids | The GUIDs of the projects. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The deadlines of the projects as XML. |
<?xmlversion="1.0"encoding="UTF-16"?><Projects><ProjectGuid="e5f46b16-07d9-4804-9ff8-ada23cb56d28"Deadline="2013-09-11T04:10:45"Error="0"Description=""/><ProjectGuid="8714b53f-a1b2-4f6d-8c66-a98fda7c4b37"Deadline="2013-09-11T04:13:27"Error="0"Description=""/><ProjectGuid="bf4df1ec-31f4-4234-93d3-c93c01b1bf62"Deadline="2013-09-11T04:14:33"Error="0"Description=""/><ProjectGuid="6c39a753-2d9a-4864-9fa4-24e8336f38ab"Deadline="2013-09-11T04:15:07"Error="0"Description=""/><ProjectGuid="9e17b5ed-f2db-4c4d-9067-e6bf9ae378f8"Deadline="2013-09-10T18:29:00"Error="0"Description=""/><ProjectGuid="32f3865c-8270-4d3b-a688-81e32f9677cd"Deadline="2013-09-11T04:16:27"Error="0"Description=""/><ProjectGuid="cd836603-e986-4fce-aef7-4452341e77f8"Deadline="2009-03-14T18:53:43"Error="0"Description=""/><ProjectGuid="662d2945-10a5-4674-b9f5-2670e2340547"Deadline="2008-06-10T12:32:58"Error="0"Description=""/><ProjectGuid="659d7ed3-26a3-420c-a84d-6f1982a00a89"Deadline="2008-07-30T14:15:52"Error="0"Description=""/><ProjectGuid="9c2fc738-5809-4138-9984-6377eae99c6a"Deadline="2008-11-20T09:44:28"Error="0"Description=""/></Projects>
ProjectManager.GetProjectSettingsGuidByName
Returns the GUID of the project settings with the specified name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the project settings template for which the GUID should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the project settings. |
Error | 144 | Project settings do not exist. |
Attention
There is currently no crossAPI call for retrieving complete list of ProjectSettingsTemplates name. For this purpose you can use SqlQuery.ExecuteQuery with:
SELECT PName FROM Profiles where PFlag = 32 or PFlag = 96
32 represents customer-defined project setting templates. 96 are the predefined ones.
ProjectManager.GetProjectSettingsXml
Gets the settings of a project in XML format.
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 | int | Type |
|
Return Values
Result | Type/Value | Interpretation |
Success | string | String that contains information about the specified projects in XML format. See info below for examples. |
Error | 19 | Project does not exist. |
Error | 144 | Project settings do not exist. |
Error | 195 | Cannot save project settings. |
Error | 196 | Cannot load project settings. |
ProjectManager.GetProjectsInformationXml
Returns project information from Across in an XML format.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | anyType | ProjectsGuids | A project GUID as string or a list of project GUIDs as an array of strings. |
3 | string | Xslt | An XSLT that is applied to the generated XML. This parameter can be used to filter or reformat the returned XML format. See below for a simple example. |
Return Values
Result | Type/Value | Interpretation |
Success | string | String that contains information about the specified projects in XML format. |
Error | 98 | Cannot load XML content. |
Example transformation for parameter Xslt.
Tip
Please note that this parameter is not necessary to access any of the information returned. The specified transformation is used to change the XML formatting only.
ProjectManager.GetProjectsInformationXmlFile
Returns project information from across in an XML format and stores it in a file that can be retrieved using FileManager functions.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | anyType | ProjectsGuids | A project GUID as string or a list of project GUIDs as an array of strings. |
3 | string | Xslt | An XSLT that is applied to the generated XML. This parameter can be used to filter or reformat the returned XML format. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the created file in the FileManager. |
Error | 70 | Cannot open file. |
Error | 98 | Cannot load XML content. |
Tip
See ProjectManager.GetProjectsInformationXml for more information on the XML format.
ProjectManager.GetProjectStatus
Returns the status of 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. |
Return Values
Result | Type/Value | Interpretation |
Success | int | Contains the progress of a project in percent. The figure states how many percent of the existing languages have already been completely translated. |
Error | 19 | Project does not exist. |
ProjectManager.GetProjectSubject
Returns the subject of the 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 | Returns the GUID of the subject of the project. |
Error | 14 | Subject does not exist. |
Error | 19 | Project does not exist. |
Tip
In case the project has multiple subjects, the first entry of the list is returned. This should map to the first subject that was assigned.
In case the project has no subject, the default subject is returned.
ProjectManager.ImportProject
Imports a project into Across.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | ProjectPath | The file that holds a project export that should be imported. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the imported project. |
Error | 71 | File not found. |
Error | 102 | Cannot import project. |
ProjectManager.ImportProjectAsync
Imports a project into Across.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | ProjectPath | The file that holds a project export that should be imported. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the import job. |
Error | 18 | Unable to create job. |
Error | 71 | File not found. |
Error | 102 | Cannot import project. |
ProjectManager.IsCrossGridProject
Returns whether a project is a crossGrid project or not.
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 | int/bool | 0 (false) if the project is not a cross grid project, otherwise (true) if it is a crossGrid project. |
Error | 19 | Project does not exist. |
ProjectManager.IsProjectArchived
Returns whether a project is in the archive or not.
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 | int/bool | 0 (false) if the project is not in the archive, otherwise (true) if it has been archived. |
Error | 19 | Project does not exist. |
ProjectManager.IsProjectFinished
Returns whether a project has been finished.
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 | int/bool | 0 (false) if the project has not been finished yet, otherwise (true) if it is finished. |
Error | 19 | Project does not exist. |
ProjectManager.IsProjectHasCheckiningDocument
Returns whether a checkin is running for a particular project or not.
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 | bool | true if a document checkin is running, false if not. |
Error | 19 | Project does not exist. |
ProjectManager.IsProjectReleased
Returns whether a project has been released or not.
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 | bool | true if the project has been released, false if not. |
Error | 19 | Project does not exist. |
ProjectManager.LoadProject
This functions loads a project that has not been loaded at startup.
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 | Is always empty. | |
Error | 19 | Project does not exist. |
ProjectManager.MarkAllCommentsAsResolved
Tip
Available from Across v7.0.
Marks all warnings and errors in the project history as resolved.
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 | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 231 | Could not mark all comments as resolved. |
ProjectManager.RemoveAllProjectAttributes
Removes all project attributes from 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. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
ProjectManager.RemoveProject
Deletes an existing 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 | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 30 | Unable to delete project. More detailed information can be found in the error description. |
Attention
This method will fail in case there are no imported offline packages for it. Please use WanGridManager.GetListOfUnimportedOfflinePackages to check for not imported packages.
ProjectManager.RemoveProject2
Deletes an existing 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 | bool | ForceRemoveUnimportedPackages | Specifies whether to remove the unimported packages or not. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 30 | Unable to delete project. More detailed information can be found in the error description. |
ProjectManager.RemoveProjectAttachment
Removes an attachment of 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 | int | AttachmentID | The ID of the attachment. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. |
ProjectManager.RemoveProjectAttribute
Removes the specified project attribute from 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 | string | AttributeGuid | The GUID of the attribute. |
4 | string | AttributeValueGuid | The GUID of the value of the attribute. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 170 | Attribute does not exist. |
Error | 171 | Attribute value does not exist. |
ProjectManager.RenameProject
Renames 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 | string | Name | The new name of the project. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 39 | Unable to rename project. More detailed information can be found in the error description. |
ProjectManager.SaveProjectAttachment
Saves the attachment of 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 | int | AttachmentID | The ID of the attachment. |
4 | string | TargetFilePath | The path of the target file. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. |
ProjectManager.SetAutomaticallyLoadUnloadedProjects
Sets whether an unloaded project is automatically loaded if needed, e.g. when trying to get a property like the finish date.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | Value | When set to true, projects which are accessed by crossAPI SI are loaded automatically, if they are not loaded already. When set to false it does not load the project(s). The default should be true. Tip When this is set to true it can happen that ALL unloaded projects are loaded in one call to crossAPI SI. That is the case if this call needs to access every project to retrieve the correct information. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. |
ProjectManager.SetFinishDate
Sets the finish date of a project and optionally adjusts all due dates.
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 | DateTime | FinishDate | The new finish date that should be set. |
4 | bool | AdjustTaskDeadlines | Specifies whether the due dates of the tasks should be adjusted or not. |
Return Values
Result | Type/Value | Interpretation |
Success | bool | true in case the due date has been set to an earlier date to match the new due date, false in case it has not been changed or it has been extended. |
Error | 19 | Project does not exist. |
Error | 137 | Cannot set finish date. |
ProjectManager.SetProjectDescription
Sets the description of 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 | string | Description | The description of the project. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. |
ProjectManager.SetProjectFinished
Marks a project as finished.
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 | bool | Finished | True if the document should be set to finished, false if it should be set to unfinished. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 85 | Cannot set project to finished. |
ProjectManager.SetProjectFinished2
Marks a project as finished.
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 | bool | Finished | True if the document should be set to finished, false if it should be set to unfinished. |
4 | bool | WithChild | If True then the child objects will also be considered. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 85 | Cannot set project to finished. |
ProjectManager.SetProjectID
Sets the ID of 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 | int | ProjectID | The new ID that should be used for the project. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 74 | Cannot set project ID. |
ProjectManager.SetProjectRelation
Sets the relation of 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 | string | RelationGuid | The GUID of the relation. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 13 | Relation does not exist. |
Error | 19 | Project does not exist. |
Error | 45 | Unable to assign the relation to the project. More detailed information can be found in the error description. |
ProjectManager.SetProjectReleased
Sets a project to released.
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 | Released | Whether to mark the project as released or not. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 156 | Cannot set project to released state. |
ProjectManager.SetProjectSubject
Sets the subject of 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 | string | SubjectGuid | The GUID of the subject. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 14 | Subject does not exist. |
Error | 19 | Project does not exist. |
Error | 44 | Unable to assign the subject to the project. More detailed information can be found in the error description. |
ProjectManager.UnloadProject
This function unloads a project that has already been loaded.
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 | Is always empty. | |
Error | 19 | Project does not exist. |