BackPrevious Topic  Next TopicNext

Configuring Export Settings

Administrators can configure the default settings for exporting reports to email and fax, and customize the precision level for different export formats.

This topic contains the following sections:

Configuring Settings for Exporting Reports to Email

The settings are applied when end users schedule report tasks to publish reports to email.

  1. On the system toolbar of the Server Console, navigate to Administration > Configuration > Export to open the Export page. Server displays the E-mail tab by default.

    Configure Email

  2. From the Default E-mail Format drop-down list, specify the format in which you want to send a report by email. The format can be one of the following:
    • E-mail Result in HTML E-mail Format
      Select to send the report via email to the specified address in HTML. The report will display in HTML in the mail body.
    • E-mail Result in Plain Text E-mail Format 
      Select to send the report via email to the specified address in plain text. The report will display in plain text in the mail body with no other information such as color and images.
    • Attachment in Logi Report Result Format
      Select to send the report via email to the specified address with a Logi Report result file as attachment.
    • Attachment in HTML Format
      Select to send the report via email to the specified address with an HTML file as attachment.
    • Attachment in PDF Format
      Select to send the report via email to the specified address with a PDF file as attachment.
    • Attachment in Excel Format
      Select to send the report via email to the specified address with an Excel file as attachment.
    • Attachment in Text Format
      Select to send the report via email to the specified address with a Text file as attachment.
    • Attachment in RTF Format
      Select to send the report via email to the specified address with a RTF file as attachment.
    • Attachment in XML Format
      Select to send the report via email to the specified address with an XML file as attachment.
    • Attachment in PostScript Format
      Select to send the report via email to the specified address with a PostScript file as attachment.
  3. If you want to compress the mail attachment as Java archive, select Compress Attachment as Java Archive.
  4. To split the PDF file in the mail attachment, specify in which way and how to split.
    • To split the PDF file by file size, select Maximum Split PDF File Size and then type the largest size in KB each PDF file could have after splitting. The default value "Unlimited" means not to split.

      If you choose to split by file size, then how to split the PDF file depends on the following two aspects:

      • The separated pages by the before-split PDF file
      • The maximum file size specified for an after-split PDF file

      Here the before-split PDF file refers to the big PDF file to be split and an after-split PDF refers to one of the smaller PDF files generated after splitting the big PDF file. When a PDF file is to be split by file size, the splitting will be carried out based on the pages the file separates but not physically on the maximum file size specified for an after-split PDF file. However, the maximum file size helps to decide by which page to split: the page that the maximum size comes to is not included with the previous pages in an after-split file, but instead is the beginning page of the following after-split file. For example, there is a 2M PDF file with 1M per page. If the maximum file size is set to 1.5M, we will get two PDF files with each 1M and one page as the split result.

    • To split the PDF file by file page, select Maximum Split PDF File Page and then type the number of pages each PDF file could have at most after splitting. The default value "Unlimited" means not to split.
  5. In the Send E-mail Timeout text box, specify the maximum time for sending an email before Server stops the sending. The default value 0 means no timeout. In a cluster environment, all nodes take the same value of this option.
  6. Select Save.
  7. Restart Server to make the email settings take effect.

Note icon

  • You can enable the Split PDF feature only when the value is not Unlimited no matter which splitting way you choose.
  • When the before-split PDF file contains only one page, the split function does not take effect as the only one page cannot further split either by file size or by file page, and therefore the result is one PDF file as attachment no matter whether you enable the Split PDF feature.
  • Accessible PDF files will lose their accessibility after being split.

Report Server saves the email settings in the configuration file mailconfig.properties in the <install_root>\bin directory. You can also use the file for default email configuration. The following table lists the available properties and the UI options they are mapped to.

Property in mailconfig.properties Mapped UI Option
default.format Default E-mail Format
compress.mail Compress Attachment as Java Archive
Tag_MaxMailSize Maximum Split PDF File Size
Tag_MaxMailPage Maximum Split PDF File Page

Back to top

Configuring Timeout for Publishing Reports to FTP

Administrators can customize the maximum time for uploading reports to an FTP server before Server stops the uploading.

  1. On the Server Console, navigate to Administration > Configuration > Export on the system toolbar. Server displays the Export page.
  2. Select FTP.
  3. In the Upload File Timeout text box, specify the maximum time for uploading reports to an FTP server before Server stops the uploading. The default value 0 means no timeout.

    Note iconIn a cluster environment, all nodes take the same value of this option.

  4. Select Save.

Back to top

Configuring Settings for Exporting Reports to Fax

Administrators can specify to export reports via either a fax machine or a fax server. Server will use the settings when you schedule report tasks to publish reports to fax.

To export reports to fax via a fax machine:

  1. Configure the running environment first. Download Java Communications API (Version 2.0): https://reportkbase.logianalytics.com/third_party_tool/JavaCommAPIV2_Win32.zip for Win32 or https://reportkbase.logianalytics.com/third_party_tool/JavaCommAPIV2_Solaris.zip for Solaris, and place the following files in the specified locations:
    • For Windows:
      File Name Location
      comm.jar <server_install_root>\lib
      javax.comm.properties<Java_install_root>\jre\lib
      Win32Com.dll<Java_install_root>\jre\bin
    • For Solaris:
      File Name Location
      comm.jar <server_install_root>/lib
      javax.comm.properties<Java_install_root>/jre/lib
      libSolarisSerialParallel.soLD_LIBRARY_PATH
  2. On the Server Console, navigate to Administration > Configuration > Export on the system toolbar. Server displays the Export page.
  3. Select the Fax tab. Server selects the Fax Machine radio button by default.

    Configure Fax Machine

  4. From the Dialing drop-down list, select the dialing mode for the fax modem: Tone or Pulse.
  5. From the Modem Class drop-down list, select the class of the modem: Class 1, Class 2, or Class 2.0. Most modems only support Class 1. If you select Class 2 or Class 2.0, you should make sure that your modem can support it.
  6. From the Flow Control drop-down list, select the flow control mode between DTE (Data Terminal Equipment) and DCE (Data Circuit-terminating Equipment). Specifying flow control can help the compressing data function of the modem work better.
    • RtsCts
      Flow control of the hardware (recommended).
    • Xon/Xoff
      Flow control of the software.
    • None
      No flow control specified.
  7. From the Flow Control Command drop-down list, select the flow control command according to the modem in use. If not contained in the drop-down list, you can leave this empty and type the command as part of the initial string. You should obtain the command from your modem manual.
  8. In the Port text box, type the port number. You should obtain the port from your modem manual.
  9. In the Initialization String text box, type the string to initialize the modem. You should obtain the string from your modem manual.
  10. In the Timeout text boxes, specify the maximum amount of time that the fax should wait for a response from the destination before timing out.
  11. When the line is busy, reports may fail to fax, so you can specify the maximum number of times the modem re-tries faxing the reports in the Retries text box.
  12. Select Save.
  13. Restart Report Server to make the fax settings take effect.

To export reports to fax via a fax server:

  1. On the Server Console, navigate to Administration > Configuration > Export on the system toolbar. Server displays the Export page.
  2. Select the Fax tab.
  3. Select the Fax Server radio button.

    Configure Fax Server

  4. In the Fax Gateway Connector text box, type the name of the implemented class.

    By default, the fax server Report uses is based on Hylafax Server. However, if you want to export your reports via Hylafax Server, you need to download the gnu-hylafax packages according to your requirements from http://sourceforge.net/projects/gnu-hylafax/, for example, gnu-hylafax-util-0.0.9.2.jar, gnu-inet-ftp-0.0.9.2.jar, and gnu-hylafax-0.0.9.2.jar, and then add them to the class path of the file setenv.bat in <server_install_root>\bin.

  5. In the Server IP text box, type the IP address or domain name of the fax server.
  6. In the Server Port text box, type the port number of the fax server.
  7. In the Login ID text box, type the username for the class communicating with fax server.
  8. In the Password text box, type the password for the class communicating with fax server.
  9. In the Fax Sender text box, specify the user's name that is shown in the fax server manager.
  10. In the Special Parameters text box, type the parameters for the fax server.
  11. In the Timeout text boxes, specify the maximum amount of time that the fax should wait for a response from the destination before timing out. For Hylafax Server the value should not be larger than 59 seconds. It is a limitation of Hylafax Server.
  12. In the Retries text box, type the number of times the modem retries faxing the reports.
  13. Select Save.
  14. Restart Report Server to make the fax settings take effect.

Server saves the fax settings in the faxconfig.properties file in <install_root>\bin. You can also use the file for default fax configuration. The following table lists the properties in the file and the UI options they are mapped to.

Property in faxconfig.properties Mapped UI Option
via_fax_server Fax Machine/Fax Server
time_out Timeout
max_retries Retries
dialing Dialing
modem_class Modem Class
flow_control Flow Control
flow_command Flow Control Command
port Port
init_string Initialization String
connector Fax Gateway Connector
server_ip Server IP
server_port Server Port
user_id Login ID
npassword Password
user_name Fax Sender
special_parameters Special Parameters

Back to top

Customizing the Layout Precision

Administrators can customize the precision to apply when running reports or exporting reports and dashboards to different formats. However, for page reports created in Report Designer, the customized precision can take effect only in report tabs whose Precision Sensitive property is set to true.

  1. On the Server Console, navigate to Administration > Configuration > Export on the system toolbar. Server displays the Export page.
  2. Select Layout Precision.

    Configure Layout Precision

  3. Select Customize for each format.

    By default, Report selects Optimize for speed over visual effect, which means Report will decide the precision level which is oriented towards speed more than visualization.

  4. Select System Default Settings. Server displays the System Default Settings dialog box.
  5. Specify the precision level for each format. The RSD format controls only the Page Report Result format when scheduling to run page report tabs.

    System Default Precison Settings

    Report provides two precision levels: high and low. High precision provides better layout but slower efficiency while low precision brings higher performance but maybe poorer visual effect. If low precision can give reports well looks, it is reasonable to apply low precision for at the same time faster performance is guaranteed. By default, Report applies high precision for formats such as PDF, RTF, Excel, Fax, and PostScript, thus the report layouts of these formats are different from the other formats such as HTML, Logi Report Result, XML, and Text.

  6. Select OK.
  7. In the Layout Precision tab, select the required formats to apply the defined precision level. For formats that you do not select, Report will decide their precision.
  8. Select Save.
  9. Restart Server to make the settings take effect.

Back to top

Escaping Formulas in Exported CSVs

You can specify to escape formulas for exported CSV files by setting Escape Formula for CSV on the Server Console > Administration > Configuration > Export > Text tab. Server selects this option by default. Therefore, in the CSV output, Report adds a tab character in the front of the content in any cell when the content begins with =, +, -, or @.

Notably, it is a configuration within the Server, rather than the report template. After you change the setting, simply select Save to confirm your update. Only users with administrative authorization can modify this option.

System Default Precison Settings

Back to top

BackPrevious Topic  Next TopicNext