Package com.inductiveautomation.reporting.common

Class ReportingModule

java.lang.Object

com.inductiveautomation.reporting.common.ReportingModule

public class ReportingModule
extends Object

Central registry for Reporting module constants, IDs, and custom shape registrations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportingModule.LocationConstants

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDITION_EMBEDDED	Embedded edition license type.
static final String	EDITION_LIMITED	Limited edition license type.
static final String	EDITION_STANDARD	Standard edition license type.
static final String	EXECUTION_COMPLETED_MSG	Message ID used for execution completion notifications.
static final String	LIMITED_REPORT_COUNT	License key for report count in limited edition.
static final String	MODULE_ID	The module ID for the Reporting module.
static final String	PERSPECTIVE_COMPONENTS_DEF_FILENAME	The filename for Perspective component definitions.
static final String	PERSPECTIVE_MODULE_ID	The module ID for the Perspective module.
static final String	REPORT_PATH_KEY	MDC key for report path.

Method Summary

Modifier and Type	Method	Description
static LoggerEx	getLogger(String name)	Returns a LoggerEx for the specified name, prefixed with "reporting.".
static void	registerCustomShapes()	Registers custom shapes with the RMArchiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE_ID

public static final String MODULE_ID

The module ID for the Reporting module.

See Also:

• Constant Field Values

EXECUTION_COMPLETED_MSG

public static final String EXECUTION_COMPLETED_MSG

Message ID used for execution completion notifications.

See Also:

• Constant Field Values

PERSPECTIVE_MODULE_ID

public static final String PERSPECTIVE_MODULE_ID

The module ID for the Perspective module.

See Also:

• Constant Field Values

PERSPECTIVE_COMPONENTS_DEF_FILENAME

public static final String PERSPECTIVE_COMPONENTS_DEF_FILENAME

The filename for Perspective component definitions.

See Also:

• Constant Field Values

EDITION_STANDARD

public static final String EDITION_STANDARD

Standard edition license type.

See Also:

• Constant Field Values

EDITION_LIMITED

public static final String EDITION_LIMITED

Limited edition license type.

See Also:

• Constant Field Values

EDITION_EMBEDDED

public static final String EDITION_EMBEDDED

Embedded edition license type.

See Also:

• Constant Field Values

LIMITED_REPORT_COUNT

public static final String LIMITED_REPORT_COUNT

License key for report count in limited edition.

See Also:

• Constant Field Values

REPORT_PATH_KEY

public static final String REPORT_PATH_KEY

MDC key for report path.

See Also:

• Constant Field Values

Method Details

registerCustomShapes

public static void registerCustomShapes()

Registers custom shapes with the RMArchiver. This is essential for proper serialization and deserialization of reports containing these custom shapes in ReportMill.

getLogger

public static LoggerEx getLogger(String name)

Returns a LoggerEx for the specified name, prefixed with "reporting.".

Parameters:

name - The name of the logger.

Returns:

A logger instance.