Creating Aurea CRM win Reports in Aurea CRM.Web

This topic explains how to create reports on Aurea CRM Win.

In Aurea CRM.Web you can create reports based on report formats defined in Aurea CRM win by using the ExecuteReport action. For further details, see ExecuteReport.

For information on Aurea CRM win reports, see Defining Report Formats in the Aurea CRM win User Manual.

The corresponding XML is generated by the core, but all transformations with style sheets are done by Aurea CRM.Web. Therefore it is necessary that all required files (xslt, css and images) are available in the respective directories on the web server (i.e. you need to manually copy the required files to these locations):

..\data\reports\crm\xslt

..\data\reports\crm\xslt\images

The report format to be used is specified by the name parameter of the ExecuteReport action. The uid parameter can be used to pass the uid of a linked record for the report. The parameters parameter allows you to specify additional settings (as JSON):

  • XSL transformations: Enter {XslTransformation: "<transformation name>"} to apply an additional transformation at the end (i.e. after a transformation defined in the format was performed).
  • target and contentDisposition settings, e.g. {target: "CreateNewTab"} or {target: 'myIFrame', contentDisposition: 'inline'}

    For more information on these parameters, see targetFrame and contentDisposition.

    Note: The parameters parameter does not support any other export options like Export.Encoding, Export.Xml.EmitConditions etc. You need to set them directly in the format definition in Aurea CRM win.
  • The parameters listed below as defaults, e.g. {stylesheet: " myreport.css "}

By default, the following parameters are passed from Aurea CRM.Web to the XSL:

  • style: name of the style to be used, e.g. "update"
  • stylesheet: file name or path (URL or UNC) to the CSS file, e.g. " update.css " or "http://myweb.com/styles/custom.theme/report.css"
    Note: The CSS file must be located as defined in the XSLT file. Aurea CRM.Web uses ../styles/update/report.css as default.
  • imagepath: relative or full path (URL or UNC) to Aurea CRM.Web's images, e.g. " ../images/update/ " or "http://myweb.com/images/update/"
  • imagefolder: full path to the ..\xslt\images folder, e.g. " c:\my_web_installation\web\data\reports\crm\xslt\images "
Note: These defaults cannot be modified directly in the XSL, but can be overridden by the format definition or by parameters of the action definition, e.g. by {stylesheet: "<style sheet name>"}.
Note: In order to be able to override these defaults via the action definition (parameters parameter), the corresponding parameters need to be defined as param in the XSLT file, i.e. you cannot use e.g. imagefolder if the XLST only contains imagepath.
Note: Settings provided via the action definition always take precedence over parameters defined in the XSL or in the format definition.

If the report format has the Output Link option checked, make sure you have configured the web URL entry in the Configuration info area (MC, category Link). For further details, see Configuration Info Area in the CRM.Core Administrator Guide.

The following restrictions apply to Aurea CRM win reports executed in Aurea CRM.Web:

  • The XSLT files must be located in ..\data\reports\crm\xslt.
  • If the XslTransformation parameter is set in the action definition, the provided transformation is always applied last.
  • The placeholders $userdir and $installDir cannot be used.
  • You cannot use variable conditions in the transfer field format.
  • The Save as file option is not supported: Reports in Aurea CRM.Web are always executed synchronously and then displayed.
  • The Save first/second transformation to file options are not supported.
  • The Transfer to spreadsheet option is not supported.
  • The creation of PDF reports as described in the Aurea CRM win User manual (chapter PDF Reports) is not supported.

Use the Export.WinReportAlwaysInMemory and Export.WinReportMemoryThreshold Web Configuration parameters to control whether a report is generated as a file (in web.data\session\report.xml) or only in the memory:

If Export.WinReportAlwaysInMemory is checked, the report is created in-memory (instead of as a file).

Export.WinReportMemoryThreshold defines the max. file size (in KB) used for in-memory creation (default: 256 KB)

If Export.WinReportAlwaysInMemory is checked and the defined Export.WinReportMemoryThreshold is exceeded, the report creation is aborted with an error message.