Zen Report Render Server definition and utility methods/queries. More...

Inheritance diagram for RenderServer:

[legend]

Collaboration diagram for RenderServer:

[legend]

Static Public Member Functions
_.Library.String	CmdLine (_.ZEN.Report.RenderServer pReportServer, _.Library.String pCmd, pCmdArgs)
	Generate the command line to run the script to start up the Render Server. More...

_.Library.Integer	GetState (_.Library.Integer port, _.Library.Integer pingport, _.Library.Integer timeout, _.Library.String reportedPort, _.Library.String reportedType)
	Determine the state of a Hot Server: More...

_.Library.Status	PortToName (_.Library.String pPort, _.Library.String pName)
	Get the Zen Report Hot Server name given its port.

_.Library.Status	Start (_.Library.String pName, _.Library.Integer pPreviousState, _.Library.String pReturn, _.Library.Boolean pVerbose)
	/ Startup a Zen Report Hot Server given its name.

_.Library.Status	StartByPort (_.Library.String pPort, _.Library.Integer pPreviousState, _.Library.String pReturn, _.Library.Boolean pVerbose)
	Startup a Zen Report Hot Server given its main port.

_.Library.Status	Stop (pName, _.Library.Boolean pVerbose)
	Stop a Zen Report Hot Server given its name.

	TerminateAllRenderServers ()
	Invoked on system shutdown to terminate the external Hot JVM processes. More...

	TerminateAllRenderServers2 ()
	Invoked on system shutdown to terminate the external Hot JVM processes. More...

_.Library.Boolean	ZenReportServerExists (_.Library.String pName, _.Library.String pType)
	Check if there exists a Zen Report Hot Server with a given name.

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	ConfigFile
	Fully qualified name of the renderer configuration file. More...

	ConnectionTimeout
	Number of seconds to wait for a connection to be established with the Render Server. More...

	InitQueueSize
	Initial size of rendering queue. More...

	InitializationTimeout
	Number of seconds to wait for the Render Server to start up. More...

	JVMArgs
	Optional additional arguments to be passed to the Java Virtual Machine (JVM) to include when assembling the. More...

	JavaHome
	Location of the JVM (similar to the JAVA_HOME environment variable). More...

	LogFile
	Fully qualified name of the log file. More...

	LogLevel
	Log level: More...

	LogRotationCount
	Number of log files accumulated before we recycle through log files. More...

	MaxLogFileSize
	Maximum size, in bytes, for each log file. More...

	MemoryThreshold
	Number of bytes that define memory usage threshold. More...

	Name
	Unique mnemonic identifier. More...

	NumPingThreads
	Number of ping threads. More...

	NumThreads
	Number of threads. More...

	PingPort
	TCP port number for pinging the Render Server. More...

	Port
	TCP port number for communication with the Render Server. More...

	Server
	IP address or name of the machine where the JVM to be used by the Render Server is located. More...

	ServerType
	Type is "0" (or null/empty for backward compatibility) for Render Servers. More...

	ThresholdPollingPeriod
	Miliseconds to wait to poll memory threshold. More...

Static Public Attributes
	DOMAIN = None
	Zen Report Render Server definition and utility methods/queries. More...

	TYPE = None
	"0" indicates a Render Server. More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Additional Inherited Members
Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

Zen Report Render Server definition and utility methods/queries.

Also a superclass for other types of Zen Report Hot Servers.

Member Function Documentation

◆ CmdLine()

_.Library.String CmdLine	(	_.ZEN.Report.RenderServer	pReportServer,
		_.Library.String	pCmd,
			pCmdArgs
	)

static

Generate the command line to run the script to start up the Render Server.

Subclasses must override this method.

◆ GetState()

_.Library.Integer GetState	(	_.Library.Integer	port,
		_.Library.Integer	pingport,
		_.Library.Integer	timeout,
		_.Library.String	reportedPort,
		_.Library.String	reportedType
	)

static

Determine the state of a Hot Server:

0 = Inactive and ready to be started;
1 = Active and responsive to PING;
2 = Unresponsive (one or both ports are in use but it is unresponsive to PING);
3 = Troubled (main port is not in use but it is responsive to PING);
4 = Error with port and/or ping port configuration;
5 = Ping returns mismatching main port and/or server type.

◆ TerminateAllRenderServers()

TerminateAllRenderServers ( )

static

Invoked on system shutdown to terminate the external Hot JVM processes.

Lookup active (registered) Zen Report Servers.

◆ TerminateAllRenderServers2()

TerminateAllRenderServers2 ( )

static

Invoked on system shutdown to terminate the external Hot JVM processes.

Lookup all Zen Report Server definitions.

Member Data Documentation

◆ DOMAIN

DOMAIN = None

static

Zen Report Render Server definition and utility methods/queries.

Also a superclass for other types of Zen Report Hot Servers.

◆ TYPE

TYPE = None

static

"0" indicates a Render Server.

Subclasses must override this parameter.

◆ ConfigFile

ConfigFile

Fully qualified name of the renderer configuration file.

Note: This property applies to Render Servers only.

◆ ConnectionTimeout

ConnectionTimeout

Number of seconds to wait for a connection to be established with the Render Server.

The default is 5 s.

◆ InitQueueSize

InitQueueSize

Initial size of rendering queue.

If left blank (default) it will be the same as the number of threads; otherwise it must be an integer between 1 and the number of threads.

◆ InitializationTimeout

InitializationTimeout

Number of seconds to wait for the Render Server to start up.

The default is 5 s.

◆ JVMArgs

JVMArgs

Optional additional arguments to be passed to the Java Virtual Machine (JVM) to include when assembling the.

command to start the Render Server.
For example, you can specify system properties: Dsystemvar=value
or set the maximum heap size: Xmx256mb
and so on, as needed.

◆ JavaHome

JavaHome

Location of the JVM (similar to the JAVA_HOME environment variable).

It is used to find the target JVM

and assemble the command to start the Render Server.
If there is a default JVM on the machine that is usable without the need to specify its location, this setting may be left blank.

◆ LogFile

LogFile

Fully qualified name of the log file.

If a file name is not specified and logging is enabled, the file used is renderserver.log in the user's home directory (or the root directory if the home directory does not exist).

◆ LogLevel

LogLevel

Log level:

0 = no logging,
1 = log errors,
2 = log warnings,
3 = log info (default). The logs are created in the user's home directory. These logs have the name renderserver.log.n. renderserver.log.0 is the current log.

◆ LogRotationCount

LogRotationCount

Number of log files accumulated before we recycle through log files.

The default is 100.

◆ MaxLogFileSize

MaxLogFileSize

Maximum size, in bytes, for each log file.

The default is 32000 bytes and the maximum allowed is 2147483647 bytes (2 GB). A value of 0 indicates no maximum defined.

◆ MemoryThreshold

MemoryThreshold

Number of bytes that define memory usage threshold.

Used for memory checking. The default is 0 (off).

◆ Name

Name

Unique mnemonic identifier.

◆ NumPingThreads

NumPingThreads

Number of ping threads.

◆ NumThreads

NumThreads

Number of threads.

◆ PingPort

PingPort

TCP port number for pinging the Render Server.

◆ Port

Port

TCP port number for communication with the Render Server.

◆ Server

Server

IP address or name of the machine where the JVM to be used by the Render Server is located.

Currently not exposed to the UI as we only support local JVMs.

◆ ServerType

ServerType

Type is "0" (or null/empty for backward compatibility) for Render Servers.

◆ ThresholdPollingPeriod

ThresholdPollingPeriod

Miliseconds to wait to poll memory threshold.

Used for memory checking. The default is 0 (off).

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CmdLine()

◆ GetState()

◆ TerminateAllRenderServers()

◆ TerminateAllRenderServers2()

Member Data Documentation

◆ DOMAIN

◆ TYPE

◆ ConfigFile

◆ ConnectionTimeout

◆ InitQueueSize

◆ InitializationTimeout

◆ JVMArgs

◆ JavaHome

◆ LogFile

◆ LogLevel

◆ LogRotationCount

◆ MaxLogFileSize

◆ MemoryThreshold

◆ Name

◆ NumPingThreads

◆ NumThreads

◆ PingPort

◆ Port

◆ Server

◆ ServerType

◆ ThresholdPollingPeriod