• 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
  • ReportManager
  • 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

ReportManager

  • 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
ReportManager.GenerateCOR
Creates a Comments Overview Report as HTML, XML, or XLSX file.
ReportManager.GenerateDDR
Creates a Dynamic Data Report as HTML file with all necessary files.
ReportManager.GenerateDDR2
Creates a Dynamic Data Report as XML file or as HTML file.
ReportManager.GenerateDDR3
Creates a Dynamic Data Report as XML file or as HTML file.
ReportManager.GenerateEDR
Creates an Edit Distance Report as HTML, XML, or XLSX file.
ReportManager.GenerateMDR
Creates a Master Data Report as HTML file with all necessary files.
ReportManager.GenerateMDR2
Creates a Master Data Report as XML file or as HTML file.
ReportManager.GenerateMDR3
Creates a Master Data Report as XML file or as HTML file.
ReportManager.GenerateMDR4
Creates a Master Data Report as XML file or as HTML file.
ReportManager.GenerateQMR
Creates a Quality Management Report as HTML file with all necessary files.
ReportManager.GenerateQMR2
Creates a Quality Management Report as XML file or as HTML file.
ReportManager.GenerateTCR
Creates a Task Confirmation Report as HTML file with all necessary files.
ReportManager.GenerateTCR2
Creates a Task Confirmation Report as XML file or as HTML file.
ReportManager.GenerateTCR3
Creates a Task Confirmation Report as XML file or as HTML file.
ReportManager.GenerateUR
Creates an Update Report as HTML file with all necessary files.
ReportManager.GenerateUR2
Creates an Update Report as XML file or as HTML file.
ReportManager.GenerateUR3
Creates an Update Report as XML file or as HTML file.
ReportManager.GetProjectReports
Returns an information about all generated and stored reports for a project.
ReportManager.GetReport
Saves a project report to a file.

ReportManager.GenerateCOR

Tip

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
  • Specifies whether the report should be saved as unprocessed XML, as HTML, or as Excel XLSX file. Possible values are:
  • 0 - output as HTML.
  • 1 - output as XML.
  • 3 - output as XLSX.

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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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

Tip

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
  • Specifies whether the report should be saved as unprocessed XML, as HTML or as Excel XLSX file. Possible values are:
  • 0 - output as HTML.
  • 1 - output as XML.
  • 3 - output as XLSX.

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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
  • Possible values are:
  • 0 - output as HTML. Uses the XSLT specified via XsltPath to carry out the transformation.
  • 1 - output as XML. XsltPath is not being used.
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.
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