CLASS Report

This class requires report privileges. The functions in this class provide control and creation of Report objects within ConsoleWorks to named asset objects.

Class Field Properties

Name	Codename	Description	Ability	Length
curpriv	CurrentPrivs	Current Privileges	RO	255
created	Created	Created	RO	255
created_by	CreatedBy	Created By	RO	255
updated	Updated	Updated	RO	255
updated_by	UpdatedBy	Updated By	RO	255
exampver	ExampleVersion	Example Version	RO	255
exampoutofdate	ExampleOutOfDate	Example Out Of Date	RO	255
adhocname	AdHocName	Ad Hoc Name	WO	100
typename	ReportTypeName	Report Type	RO	255

Class Functions

Name	Description
static add	Report.add(name) takes an argument, Report name. The Report name can be explicit or checked for existence then retrieved with Report.getNames(). User must have create privileges. Report.add() creates a named Report object.
static AdHocRun	AdHocRun() takes no arguments. This action returns an adhoc report object for a named reported object. Used with Report.get(name).
static cancel	cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with Report.get(name).
static close	Report.close() takes no arguments.
static connect	Report.connect() takes no arguments.
static create	Report.create() takes no arguments.
static delete	Report.delete() takes 1 argument.
static ExclusiveConnect	Report.ExclusiveConnect() takes no arguments.
static exists	Report.exists() takes no arguments.
static get	Report.get() takes no arguments.
static getCount	Report.getCount() takes no arguments. This standard function gets the number of defined Report resources.
static getFetchLevel	Report.getFetchLevel() takes no arguments.
static getList	Report.getList() takes no arguments. This standard function gets and returns an arrary (list) of Report resources.
static getLog	Report.getLog() takes no arguments.
static getLogCalendar	Report.getLogCalendar() takes no arguments.
static getNames	Report.getNames() takes no arguments. This standard function gets and returns an array of strings object with the Report names.
static getRange	Report.getRange() takes no arguments.
static getUsage	Report.getUsage() takes no arguments.
static isConnected	Report.isConnected() takes no arguments.
static isNew	isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called.
static log	Report.log() takes no arguments.
static logScannable	Report.logScannable() takes no arguments.
static monitor	Report.monitor() takes no arguments.
static read	Report.read() takes no arguments.
static refresh	Report.refresh() takes no arguments.
static Rename	Rename(newName) takes one argument, the new name of the Report object string. User must have rename and report privileges. Used with Report.getName(name).
static Run	Run() takes no arguments. This action runs a report routine on a named report object. Used with Report.get(name).
static save	save() takes no arguments. User must have save privileges. This standard function saves to the server a Report object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails.
static setFetchLevel	Report.setFetchLevel() takes no arguments.
static update	Report.update() takes no arguments.
static write	Report.write() takes no arguments.

Class Privilege Properties

Type	Name
AWARE	Aware
CREATE	Add
DELETE	Delete
VIEW	View
MODIFY	Edit
RENAME	Rename
RUNREPORT	Run
VIEWREPORTOUTPUT	View Report Output
LOCK	Lock Report Output
UNLOCK	Unlock Report Output
STREAMREPORTOUTPUT	Stream Report Output
DELETEREPORTOUTPUT	Delete Report Output
VIEWLIVE	View Active
KILL	Kill Active

Class Association Properties

Type	Name
tag	Report to Tag
scheduler	Report to Schedule