- 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
ReportManager
- 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 |
Creates a Comments Overview Report as HTML, XML, or XLSX file. | |
Creates a Dynamic Data Report as HTML file with all necessary files. | |
Creates a Dynamic Data Report as XML file or as HTML file. | |
Creates a Dynamic Data Report as XML file or as HTML file. | |
Creates an Edit Distance Report as HTML, XML, or XLSX file. | |
Creates a Master Data Report as HTML file with all necessary files. | |
Creates a Master Data Report as XML file or as HTML file. | |
Creates a Master Data Report as XML file or as HTML file. | |
Creates a Master Data Report as XML file or as HTML file. | |
Creates a Quality Management Report as HTML file with all necessary files. | |
Creates a Quality Management Report as XML file or as HTML file. | |
Creates a Task Confirmation Report as HTML file with all necessary files. | |
Creates a Task Confirmation Report as XML file or as HTML file. | |
Creates a Task Confirmation Report as XML file or as HTML file. | |
Creates an Update Report as HTML file with all necessary files. | |
Creates an Update Report as XML file or as HTML file. | |
Creates an Update Report as XML file or as HTML file. | |
Returns an information about all generated and stored reports for a project. | |
Saves a project report to a file. |
ReportManager.GenerateCOR
Available from Across v7 15854.
Creates a Comments Overview Report as HTML, XML, or XLSX file.
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 or array of strings | DocumentsGuids | The list of documents GUIDs for which the COR should be created. In case of single string GUIDs should be separated by ";". |
4 | string or array of integers | TargetLanguageLcids | The list of target language LCIDs for which the COR should be created. In case of single string integers should be separated by ";". |
5 | bool | IncludeParagraphsWithoutComments | To include to the report paragraphs without comments. |
6 | bool | Anonymize | To replace comment author with DB user ID for security reasons. |
7 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
8 | int | OutputMode |
|
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 237 | The specified documents have different workflows. |
Error | 238 | Your license doesn't allow building advanced reports. |
ReportManager.GenerateDDR
Creates a Dynamic Data Report as HTML file with all necessary files.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateDDR2
Creates a Dynamic Data Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateDDR3
Creates a Dynamic Data Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
7 | string | CreatorName | The name of the creator. |
8 | bool | UpdatePretranslationAnalysis | If true then updates the pretranslation analysis in the report. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateEDR
Available from Across v7 15444.
Creates an Edit Distance Report as HTML, XML, or XLSX file.
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 or array of strings | DocumentsGuids | The list of documents GUIDs for which the EDR should be created. In case of single string GUIDs should be separated by ";". |
4 | string or array of integers | TargetLanguageLcids | The list of target language LCIDs for which the EDR should be created. In case of single string integers should be separated by ";". |
5 | string | InitialStateGuid | The GUID of a paragraph state from which the initial paragraph text should be used. The GUID can be obtained via the GetParagraphStateGuidByName function. |
6 | string | FinalStateGuid | The GUID of a paragraph state from which the final paragraph text should be used. The GUID can be obtained via the GetParagraphStateGuidByName function. |
7 | int | StateFlags | Paragraphs state flags 0 - means any. For actual values, please check Paragraph states and flags. |
8 | string | TargetFilePath | The complete path of the file that will contain the EDR. The user account under which crossAPI runs must have access to this path. |
9 | int | OutputMode |
|
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 237 | The specified documents have different workflows. |
Error | 238 | Your license doesn't allow building advanced reports. |
Error | 239 | Unable to evaluate source language for relay translation because relay tasks have different source languages. |
ReportManager.GenerateMDR
Creates a Master Data Report as HTML file with all necessary files.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateMDR2
Creates a Master Data Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateMDR3
Creates a Master Data Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
7 | string | CreatorName | The name of the creator. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateMDR4
Creates a Master Data Report as XML file or as HTML file.
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 | (any) | DocumentsGuids | |
4 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
5 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
6 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
7 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
8 | string | CreatorName | The name of the creator. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateQMR
Creates a Quality Management Report as HTML file with all necessary files.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateQMR2
Creates a Quality Management Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateTCR
Creates a Task Confirmation Report as HTML file with all necessary files.
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 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 29 | Cannot generate report. |
Error | 53 | Task does not exist. |
ReportManager.GenerateTCR2
Creates a Task Confirmation Report as XML file or as HTML file.
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 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 29 | Cannot generate report. |
Error | 53 | Task does not exist. |
ReportManager.GenerateTCR3
Creates a Task Confirmation Report as XML file or as HTML file.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TaskGuids | The GUIDs of the task for which the report should be created. |
3 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 29 | Cannot generate report. |
Error | 53 | Task does not exist. |
ReportManager.GenerateUR
Creates an Update Report as HTML file with all necessary files.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateUR2
Creates an Update Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
ReportManager.GenerateUR3
Creates an Update Report as XML file or as HTML file.
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 | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | TemplateName | Name of the report settings template that should be used to generate the report. |
6 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
7 | int | VersionNumber | The version of the document to report. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 19 | Project does not exist. |
Error | 29 | Cannot generate report. |
Error | 163 | Wrong document version number. |
ReportManager.GetProjectReports
Returns an information about all generated and stored reports for 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 | An XML file containing information about all generated and stored project reports. |
Error | 19 | Project does not exist. |
ReportManager.GetReport
Saves a project report to a file.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | ReportGuid | The report GUID. Use ReportManager.GetProjectReports to receive available reports for a project. |
3 | string | TargetFilePath | The complete path of the file that will contain the report. The user account under which crossAPI runs must have access to this path. |
4 | int | OutputMode | Specifies whether the report should be saved as unprocessed XML or as HTML.
|
5 | string | XsltPath | The path to the XSLT file that should be used to transform the XML to HTML. The user account under which the crossAPI service runs must have access to this path. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 29 | Cannot generate report. |
Error | 214 | Report does not exist. |