com.haulmont.reports

Interface ReportingConfig

All Superinterfaces:

com.haulmont.cuba.core.config.Config

public interface ReportingConfig
extends com.haulmont.cuba.core.config.Config

Reporting configuration interface.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getCountOfRetry()
java.lang.String	getCurlParams() Reporting uses CURL tool to generate reports from URL.
java.lang.String	getCurlPath() Reporting uses CURL tool to generate reports from URL.
java.lang.Integer	getCurlTimeout()
boolean	getDisplayDeviceAvailable()
java.lang.Integer	getDocFormatterTimeout()
java.lang.Integer	getEntityTreeModelMaxDeep() Maximum depth of entity model that is used in report wizard and report dataset view editor.
int	getHistoryCleanupMaxDays() Report execution history deletes all history items older than this number of days.
int	getHistoryCleanupMaxItemsPerReport() Report execution cleanup leaves only this number of execution history items for each report, deleting all older items.
java.lang.Integer	getHtmlExternalResourcesTimeoutSec()
java.lang.Integer	getOfficeConnectionTimeout()
java.lang.String	getOfficePath()
java.lang.String	getOfficePorts()
java.lang.Integer	getParameterPrototypeQueryLimit()
java.lang.String	getPdfFontsDirectory()
java.lang.Boolean	getPutEmptyRowIfNoDataSelected()
java.lang.Long	getRetryIntervalMs()
java.lang.Boolean	getUseReadOnlyTransactionForGroovy() Toggle for Groovy dataset's transactions.
java.lang.String	getWizardEntitiesBlackList() Return entities that will not be available for report wizard.
java.lang.String	getWizardEntitiesWhiteList() Entities that will be available for report wizard.
java.util.List<java.lang.String>	getWizardPropertiesBlackList() Entity properties that will not be available for report creation wizard.
java.util.List<java.lang.String>	getWizardPropertiesExcludedBlackList() Entity properties that will not to be excluded by reporting.wizardPropertiesBlackList setting
boolean	isFormulasPostProcessingEvaluationEnabled()
boolean	isHistoryRecordingEnabled() Flag to enable execution history recording.
boolean	isSaveOutputDocumentsToHistory() If enabled - then save all output documents to file storage, so they can be downloaded later.
void	setCurlParams(java.lang.String value)
void	setCurlPath(java.lang.String value)
void	setCurlTimeout(java.lang.Integer value)
void	setEntityTreeModelMaxDeep(java.lang.Integer entityTreeModelMaxDeep)
void	setFormulasPostProcessingEvaluationEnabled(boolean formulasPostProcessingEvaluationEnabled)
void	setHistoryCleanupMaxDays(int historyCleanupMaxDays)
void	setHistoryCleanupMaxItemsPerReport(int historyCleanupMaxItemsPerReport)
void	setHistoryRecordingEnabled(boolean historyRecordingEnabled)
void	setHtmlExternalResourcesTimeoutSec(java.lang.Integer externalResourcesTimeoutSec)
void	setPutEmptyRowIfNoDataSelected(java.lang.Boolean putEmptyRowIfNoDataSelected)
void	setSaveOutputDocumentsToHistory(boolean saveOutputDocumentsToHistory)
void	setUseReadOnlyTransactionForGroovy(java.lang.Boolean useReadOnlyTransactionForGroovy)
void	setWizardEntitiesBlackList(java.lang.String wizardEntitiesBlackList)
void	setWizardEntitiesWhiteList(java.lang.String wizardEntitiesWhiteList)
void	setWizardPropertiesBlackList(java.util.List<java.lang.String> wizardPropertiesBlackList)
void	setWizardPropertiesExcludedBlackList(java.util.List<java.lang.String> wizardPropertiesExcludedBlackList)

Method Detail

getOfficePath

java.lang.String getOfficePath()

Returns:

Path to the installed OpenOffice

getOfficePorts

java.lang.String getOfficePorts()

Returns:

The list of ports to start OpenOffice on.

getDocFormatterTimeout

java.lang.Integer getDocFormatterTimeout()

Returns:

timeout in seconds for executing office task (document generation or pdf conversation).

getCountOfRetry

java.lang.Integer getCountOfRetry()

Returns:

the number of times for executing office task after unsuccessful execution.

getRetryIntervalMs

java.lang.Long getRetryIntervalMs()

Returns:

timeout in milliseconds between retries.

getOfficeConnectionTimeout

java.lang.Integer getOfficeConnectionTimeout()

Returns:

timeout in seconds for connecting to new office process.

getDisplayDeviceAvailable

boolean getDisplayDeviceAvailable()

Returns:

Has to be false if using OpenOffice reporting formatter on a *nix server without X server running

getPdfFontsDirectory

java.lang.String getPdfFontsDirectory()

Returns:

Directory with fonts for generate PDF from HTML

getPutEmptyRowIfNoDataSelected

java.lang.Boolean getPutEmptyRowIfNoDataSelected()

Returns:

The option which enforces standard data extractor to put empty row in each band if no data has been selected In summary this option says - would table linked with empty band have at least one empty row or not.

setPutEmptyRowIfNoDataSelected

void setPutEmptyRowIfNoDataSelected(java.lang.Boolean putEmptyRowIfNoDataSelected)

getParameterPrototypeQueryLimit

java.lang.Integer getParameterPrototypeQueryLimit()

Returns:

Default limit used if parameter prototype object does not specify limit itself

getWizardEntitiesBlackList

java.lang.String getWizardEntitiesBlackList()

Return entities that will not be available for report wizard. Note that if reporting.wizardEntitiesWhiteList is not empty, this list will be ignored

Returns:

list of ignored entities

setWizardEntitiesBlackList

void setWizardEntitiesBlackList(java.lang.String wizardEntitiesBlackList)

getWizardEntitiesWhiteList

java.lang.String getWizardEntitiesWhiteList()

Entities that will be available for report wizard. All others entities will be ignored. Note that even if cuba.reporting.wizardEntitiesBlackList is not empty, this list will be used anyway.

Returns:

list of entities that available for reportWizard

setWizardEntitiesWhiteList

void setWizardEntitiesWhiteList(java.lang.String wizardEntitiesWhiteList)

getWizardPropertiesBlackList

java.util.List<java.lang.String> getWizardPropertiesBlackList()

Entity properties that will not be available for report creation wizard. Format is like BaseUuidEntity.id,BaseUuidEntity.createTs,ref$Car.id,...
Properties support inheritance, i.e. BaseUuidEntity.id will filter that field for all descendants, e.g. ref$Car. To allow selection of a field for a concrete descendant (e.g. ref$Car), use reporting.wizardPropertiesExcludedBlackList setting with value ref$Car.id.

Returns:

blacklisted properties that is not available

setWizardPropertiesBlackList

void setWizardPropertiesBlackList(java.util.List<java.lang.String> wizardPropertiesBlackList)

getWizardPropertiesExcludedBlackList

java.util.List<java.lang.String> getWizardPropertiesExcludedBlackList()

Entity properties that will not to be excluded by reporting.wizardPropertiesBlackList setting

See Also:

getWizardPropertiesBlackList()

setWizardPropertiesExcludedBlackList

void setWizardPropertiesExcludedBlackList(java.util.List<java.lang.String> wizardPropertiesExcludedBlackList)

getEntityTreeModelMaxDeep

java.lang.Integer getEntityTreeModelMaxDeep()

Maximum depth of entity model that is used in report wizard and report dataset view editor.

setEntityTreeModelMaxDeep

void setEntityTreeModelMaxDeep(java.lang.Integer entityTreeModelMaxDeep)

getHtmlExternalResourcesTimeoutSec

java.lang.Integer getHtmlExternalResourcesTimeoutSec()

setHtmlExternalResourcesTimeoutSec

void setHtmlExternalResourcesTimeoutSec(java.lang.Integer externalResourcesTimeoutSec)

getCurlPath

java.lang.String getCurlPath()

Reporting uses CURL tool to generate reports from URL. This is the system path to the tool.

setCurlPath

void setCurlPath(java.lang.String value)

getCurlParams

java.lang.String getCurlParams()

Reporting uses CURL tool to generate reports from URL. This the string with parameters used while calling CURL.

setCurlParams

void setCurlParams(java.lang.String value)

getCurlTimeout

java.lang.Integer getCurlTimeout()

setCurlTimeout

void setCurlTimeout(java.lang.Integer value)

getUseReadOnlyTransactionForGroovy

java.lang.Boolean getUseReadOnlyTransactionForGroovy()

Toggle for Groovy dataset's transactions. If true, transactions are read-only.

setUseReadOnlyTransactionForGroovy

void setUseReadOnlyTransactionForGroovy(java.lang.Boolean useReadOnlyTransactionForGroovy)

isHistoryRecordingEnabled

boolean isHistoryRecordingEnabled()

Flag to enable execution history recording.

setHistoryRecordingEnabled

void setHistoryRecordingEnabled(boolean historyRecordingEnabled)

isSaveOutputDocumentsToHistory

boolean isSaveOutputDocumentsToHistory()

If enabled - then save all output documents to file storage, so they can be downloaded later. Note that ReportExecution stores file that is independent from the one created by ReportingApi#createAndSaveReport methods.

setSaveOutputDocumentsToHistory

void setSaveOutputDocumentsToHistory(boolean saveOutputDocumentsToHistory)

getHistoryCleanupMaxDays

int getHistoryCleanupMaxDays()

Report execution history deletes all history items older than this number of days. Value == 0 means no cleanup by this criteria.

setHistoryCleanupMaxDays

void setHistoryCleanupMaxDays(int historyCleanupMaxDays)

getHistoryCleanupMaxItemsPerReport

int getHistoryCleanupMaxItemsPerReport()

Report execution cleanup leaves only this number of execution history items for each report, deleting all older items. Value == 0 means no cleanup by this criteria.

setHistoryCleanupMaxItemsPerReport

void setHistoryCleanupMaxItemsPerReport(int historyCleanupMaxItemsPerReport)

isFormulasPostProcessingEvaluationEnabled

boolean isFormulasPostProcessingEvaluationEnabled()

setFormulasPostProcessingEvaluationEnabled

void setFormulasPostProcessingEvaluationEnabled(boolean formulasPostProcessingEvaluationEnabled)