Events Class Reference

This class defines the Audit Events for the system. More...

Inheritance diagram for Events:

Collaboration diagram for Events:

Static Public Member Functions
_.Library.Status	Clear (_.Library.String EventSources, _.Library.String EventTypes, _.Library.String EventNames)
	This class defines the Audit Events for the system. More...
_.Library.Status	Create (_.Library.String Source, _.Library.String Type, _.Library.String Name, _.Library.String Description, Security.Datatype.BooleanYN Enabled, _.Library.Integer Flags)
	Create an Event. More...
_.Library.Status	Delete (_.Library.String Source, _.Library.String Type, _.Library.String Name)
	Delete an Event. More...
_.Library.Boolean	Exists (_.Library.String Source, _.Library.String Type, _.Library.String Name, _.Library.ObjectHandle Event, _.Library.Status Status)
	Event exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String Sources, _.Library.String Types, _.Library.String Names)
	This method exports Event records to a file in xml format. More...
_.Library.Status	Get (_.Library.String Source, _.Library.String Type, _.Library.String Name, _.Library.String Properties)
	Get an Events properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import Event records from an xml file. More...
_.Library.Status	Modify (_.Library.String Source, _.Library.String Type, _.Library.String Name, _.Library.String Properties)
	Modify an Event's properties. More...

Public Attributes
	Description
	Description of the event. More...
	Enabled
	Event enabled. More...
	Name
	Name of the event. More...
	Source
	Source (system events all have "%System" here). More...
	Type
	Type. More...

Detailed Description

This class defines the Audit Events for the system.

An Event name consists of 3 separate fields:

1) Source - Source of the event
2) Type - Type of the event
3) Event - Name of the event<br>
And Event name is the combination of the 3 fields separated by "/". For example:

System/Login/Login

Event names have the following properties:
1) Source, Type, and Event fields are case insensitive.
2) Source, Type, and Event fields cannot contain a "/".
3) Only system defined events can have a Source = "%System" or Source start with a "%".
4) Only system defined events can have a Type start with a "%".


The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Member Function Documentation

Clear()

_.Library.Status Clear ( _.Library.String  EventSources, _.Library.String  EventTypes, _.Library.String  EventNames  )

static

This class defines the Audit Events for the system.

An Event name consists of 3 separate fields:

1) Source - Source of the event
2) Type - Type of the event
3) Event - Name of the event<br>
And Event name is the combination of the 3 fields separated by "/". For example:

System/Login/Login

Event names have the following properties:
1) Source, Type, and Event fields are case insensitive.
2) Source, Type, and Event fields cannot contain a "/".
3) Only system defined events can have a Source = "%System" or Source start with a "%".
4) Only system defined events can have a Type start with a "%".


The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Clear the in memory event counters for the specified events.

EventSources - Comma separated list of Event Sources, "*" = All
EventTypes - Comma separated list of Types Sources, "*" = All
Events - Comma separated list of Events, "*" = All

Create()

_.Library.Status Create ( _.Library.String  Source, _.Library.String  Type, _.Library.String  Name, _.Library.String  Description, Security.Datatype.BooleanYN  Enabled, _.Library.Integer  Flags  )

static

Create an Event.

Create an Event in the Security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specification in the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
Description - Description of the Event
Enabled - Enabled for auditing - 0/1
Flags - Internal use only. Pass 0 for this value.

Delete()

_.Library.Status Delete ( _.Library.String  Source, _.Library.String  Type, _.Library.String  Name  )

static

Delete an Event.

This method will delete an Event from the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specification in the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
This method also clears the in memory counters.

Exists()

_.Library.Boolean Exists ( _.Library.String  Source, _.Library.String  Type, _.Library.String  Name, _.Library.ObjectHandle  Event, _.Library.Status  Status  )

static

Event exists.

This method checks for the existence of an Event in the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specificationin the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
Return values:
If Value of the method = 0 (Event does not exist, or some error occured)
Event = Null
Status = Event "x" does not exist, or other error message<br>
If Value of the method = 1 (Event exists)
Event = Object handle to Event
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  Sources, _.Library.String  Types, _.Library.String  Names  )

static

This method exports Event records to a file in xml format.

Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
Sources - Comma separated list of Sources to export, "*" = All
Types - Comma separated list of Types to export, "*" = All
Names - Comma separated list of event Names to export, "*" = All

Get()

_.Library.Status Get ( _.Library.String  Source, _.Library.String  Type, _.Library.String  Name, _.Library.String  Properties  )

static

Get an Events properties.

Gets an Events properties from the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specification in the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
Return values:
Properties - Array of properties
"Description" - Description of the event
"Enabled" - Event is enabled for auditing
"Flags" - Internal use only

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

Import Event records from an xml file.

Parameters:
FileName - Filename to import Event records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

Modify()

_.Library.Status Modify ( _.Library.String  Source, _.Library.String  Type, _.Library.String  Name, _.Library.String  Properties  )

static

Modify an Event's properties.

Modifies an Event's properties from the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specification in the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Member Data Documentation

Description

Description

Description of the event.

 

Enabled

Enabled

Event enabled.

 

Name

Name

Name of the event.

 

Source

Source

Source (system events all have "%System" here).

 

Type

Type

Type.