1.B. Server Commands

The configurations specified in the Server Options tab can also be set in a configuration text file. Under the <EDABInstallDir>/WEB-INF/classes directory there is a file called QB.properties that contains several arguments that control server settings. The QB.properties is a INI file. Server commands belog to the "ServerCommands" property. Arguments in the text file assume the format of a dash - followed by a command. Arguments should be added in a single line (starting with ServerCommands=) in the file separated by spaces.

-log:

When you type the -log argument, this turns on the basic server logging. This has the same effect as enabling the option in the Admin Console.

-writeLogToDatabase:

This turns on the detailed server logging feature. This has the same effect as enabling the Generate Detail Logs option in the Admin Console.

-cleanupIntervalForLog:hh:

This is the cleanup interval for the detail logs. The value following the colon is specified in Hours.

-recordLimit:nn:

This argument allows you to set a maximum limit for the number of records the server will retrieve from a database when executing a query. This has the same effect as setting the record limit in the Admin Console

-queryTimeout:sss:

This argument allows you to sepcify a timeout interval in seconds for report/chart queries. This has the same effect as setting the query timeout in the Admin Console.

-DBBuffer:nnn:

This allows you to set the number of database buffers for the server to use. This argument is the same as the buffering feature available in the Admin Console. The argument allows you to specify the number of buffers from 1 to 999.

-DBCleanAll:ddhhmm:

This allows you to set the clean up interval for the database buffers. This argument is the same as the clean up feature in the Admin Console. The value of ddhhmm means dd days, hh hours and mm minutes. You can also use omitted format, meaning that the server will translate the value with the assumption that the omitted digits are the higher digits. For Example:

  • DBCleanAll:101010 means clean buffer every 10 days, 10 hours and 10 minutes

  • DBCleanAll:1010 means clean buffer every 10 hours and 10 minutes

  • DBCleanAll:10 means clean buffer every 10 minutes

-RequireLogin:

This argument is used in conjunction with the QbDesignerPassword argument to apply security to Report Designer and Chart Designer when they are launched via the API. Normally when Report or Chart Designer is called via the API there is no user authentication. This allows users to apply their own authentication to the programs, but can also allow unauthorized users access to the server. To prevent this, users can turn on this argument (values are true/false) to force authentication for Report and Chart Designer when they are called from the API. This option cannot be set in the Admin Console

-QbDesignerPassword:

This argument allows you to set the password to use when the -RequireLogin argument is turned on. The password specified here needs to be passed in via a method call when calling Report or Chart Designer via the API. This option cannot be set in the Admin Console.

-globalFormat:<xmlfile>:

This argument allows you to supply a global format XML file to set the default look and feel of report elements. This argument is the same as the default global formatting option in the Admin Console. For this argument specify a file path to the XML file relative to the EDAB install directory i.e. (-globalFormat:ReportFiles/FormatFile.xml).

-fontMapping:<xmlfile>:

This argument allows you to supply a font mapping XML file to set the default font mapping for PDF export. This argument is the same as the default font mapping option in the Admin Console. For this argument specify a file path to the XML file relative to the EDAB install directory i.e. (-fontMapping:Templates/FontFile.xml).

-htmlDpi:nn:

This argument allows you to hard-code the screen resolution that should be used when reports are exported to DHTML format. This argument is the same as the HTML DPI option in the Admin Console.

-ListenerManagerClass:<classfile>:

This argument allows you to specify a class for the EDAB listener mechanism. This argument is the same as the EDAB listener class option in the Admin Console.

-LoginListenerClass:<classfile>:

This argument allows you to specify a class for the EDAB login listener mechanism. This argument is the same as the EDAB login listener class option in the Admin Console.

-ScheduleCallBackClass:<classfile>:

This argument allows you to specify a class for the scheduler callback mechanism. This argument is the same as the scheduler callback class option in the Admin Console.

-UserSecurityProviderClass:<classfile>:

This argument allows you to specify a class file for the user security provider interface. This argument is the same as the user security provider class option in the Admin Console.

-singleTableForDistinctParamValue:

When you use -singleTableForDistinctParamValue argument, the parameter dialog for parameterized reports and charts will be drawn using a select distinct on a single table. This argument is the same as the Single Table for Distinct Param Value option in the Admin Console.

-showViewPrivilege:true/false:

This option determines if non-admin users will be able to view the file and folder privilege in the organizer. By default this option is true.

-schedulerThreadLimit:nn:

This argument allows you to set the maximum number of schedule jobs that can run concurrently. This argument is the same as the max scheduler threads option in the Admin Console.

-runMissedScheduleJob:

When you use the -runMissedScheduleJob argument, any schedule jobs that were missed due to server down-time will be run when the server is re-started. This argument is the same as the re-run missed schedule jobs in the Admin Console.

-batchDeleteForScheduler:TRUE/FALSE:

This argument controls the process by which schedule job information is removed from the EDAB database for expiring schedule jobs. Setting this option to true can improve schedule performance if you have large numbers of jobs that will expire at the same time. The effects of this feature may vary depending on the EDAB database platform. This option cannot be set in the Admin Console.

-xmlEncoding:encoding:

This argument allows you to specify the encoding that EDAB should use when writing XML. This includes data registry files, XML report and chart templates, XML exports, and XML global formatting, and font mapping files. This parameter needs to be set both in the server and in the Organizer. For more information about XML encoding, see Section 9.1.2.4 - XML Encoding.

QuickDesignerSecuredParameters:xmlfile:

This argument allows you to supply a data view security XML file to enable/apply security filters to data views and data view queries. You can specify either an absolute path to the XML file or a relative path to the EDAB install directory i.e. (-ERES/SecuredParameters.xml). For more information about secured parameters, see Section 1.4.1.3.1 - Secured Parameter.

-debug:DVW_SEC_PARAM:

Use this argument to troubleshoot the -QuickDesignerSecuredParameters option. This debug statement will print multiple debug statements to the server console specifying whether there is a match for the column listed in the xml file. If you specify multiple debug options, only the last one will take effect.

-disableDataViewInQuickDesigner:

This argument allows you to disable the data views in quick designers such that the user can only make ad hoc reports based on data view queries, but not from data views. This feature can prevent users from bypassing the data view secured parameters.

-disableSaveQueryInQuickDesigner:

This argument allows you to disable the save query option in quick designers. This feature prevents users from creating and saving too many queries in the data registry.

-ReplaceColumnInfoList:xmlfile:

This argument allows you to turn on the automatic decryption feature in quick designer and menu page. The XML file must specify all the information for the column to be decrypted, including database information, table name, and column name. You can specify either an absolute path to the XML file or a relative path to the EDAB install directory i.e. (-ReplaceColumnInfoList:help/examples/DataDecryption/QBReplaceColumnInfoList.xml). You can find more details as well as an example for this feature in Section 3.8.1.2 - Querying Encrypted Data.

-debug:REPLACE_SQL_COLUMN:

Use this argument to troubleshoot the -ReplaceColumnInfoList option. This debug statement will print multiple debug statements to the server console whether there is a match for the column listed in the xml file. If you specify multiple debug options, only the last one will take effect.

-debug:MEMORY_PAGING:

Use this argument to troubleshoot the virtual memory/paging feature. This debug statement will print debug statements to the server console regarding the amount of memory used, and the paging process. If you specify multiple debug options, only the last one will take effect.

-ExcelExportFitCell:true/false:

Set this argument to true if you want to fit numeric values into single cells when exporting your report to Excel from the Dashboard. By default, this option is false.

-paperSize:LETTER/A4:

Set this argument to define the default paper size. If this option is not set, reports will default to Letter size.

-ExportNewlineDelimiter:windows/mac/others/system:

Set this argument to specify a default newline delimiter for CSV export. Use windows for any Windows version, it will use \n\r for the delimiter. Use mac for any version of Mac, it will use \r for the delimiter. Use others for any Unix/Linux variants, it will use \n for the delimiter. You can also use system to allow the server to pick up the system default value.

-QDResizeToFitContentDefault:true/false:

When you set this argument to true, reports created in QuickDesigner will automatically have the Resize to Fit Content option turned on for all columns. By default this option is turned off.

-QDNullValueHandler:"<NullValue>":

This argument allows you to control the display for null data in the QuickDesigner. <NullValue> can be any string that does not contain spaces. To insert a space into the null data handler, use the word SPACE in uppercase. For example:

-QDNullValueHandler:"-SPACE-"

will replace all null values in the QuickDesigner with - -.