System signals and their attributes

When a system signal is raised, attributes that identify the cause of the signal are set. These attributes are passed as implicit variables into the associated signal trigger.

You can refer to system signal variables by using the %signal notation in the action section of a signal trigger. The % symbol indicates that you are referencing an implicit variable. The signal keyword references the signal currently passed to the trigger. For example, to reference the time at which a system signal was raised in a signal trigger, use the following syntax:

%signal.at

Tip: You can also use the % helper button to select %signal variables.

The system signals that can be raised by the ObjectServer or the gateway are as follows:

startup signal
shutdown signal
connect signal
disconnect signal
backup_failed signal
backup_succeeded signal
login_failed signal
security_timeout signal
create_object signal
alter_object signal
drop_object signal
permission_denied signal
gw_counterpart_down signal
gw_counterpart_up signal
iduc_missed signal
iduc_connect signal
iduc_disconnect signal
iduc_data_fetch signal
resync_lock signal
resync_unlock signal
gw_resync_start signal
gw_resync_finish signal
pre_connect signal

Tip: You can query the catalog.primitive_signals table and the catalog.primitive_signal_parameters table to view information about system signals. For example, to view the attributes of each system signal, use the following SQL command:

SELECT
* FROM catalog.primitive_signal_parameters ORDER BY SignalName, OrdinalPosition;

startup signal

The startup signal is raised when the ObjectServer starts. The following table describes the attributes of this signal.

Table 1. startup signal attributes
Attributes	Data type	Description
`server`	string	Indicates the name of the ObjectServer that started.
`node`	string	Indicates the computer on which the ObjectServer started.
`at`	UTC	Indicates the time at which the ObjectServer started.

shutdown signal

The shutdown signal is raised when the ObjectServer shuts down. The following table describes the attributes of this signal.

Table 2. shutdown signal attributes
Attributes	Data type	Description
`server`	string	Indicates the name of the ObjectServer that shut down.
`node`	string	Indicates the computer on which the ObjectServer shut down.
`at`	UTC	Indicates the time at which the ObjectServer shut down.

connect signal

The connect signal is raised when a client connects to the ObjectServer. The following table describes the attributes of this signal.

Table 3. connect signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that connected to the ObjectServer.
`description`	string	Contains additional information about the client that connected, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that connected to the ObjectServer.
`node`	string	Indicates the name of the client computer that connected to the ObjectServer.
`connectionid`	int	Uniquely identifies the connection.
`at`	UTC	Indicates the time at which the client connected.

disconnect signal

The disconnect signal is raised when a client disconnects from the ObjectServer. The following table describes the attributes of this signal.

Table 4. disconnect signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of process that disconnected from the ObjectServer.
`description`	string	Contains additional information about the client that disconnected, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that disconnected from the ObjectServer.
`node`	string	Indicates the name of the client computer that disconnected from the ObjectServer.
`connectionid`	int	Uniquely identifies the connection.
`at`	UTC	Indicates the time at which the client disconnected.

backup_failed signal

The backup_failed signal is raised when an attempt to back up the ObjectServer fails. The following table describes the attributes of this signal.

Table 5. backup_failed signal attributes
Attributes	Data type	Description
`error`	string	Indicates a reason why the backup attempt failed.
`at`	UTC	Indicates the time at which the backup attempt occurred.
`path_prefix`	string	Indicates the directory to which the backup attempted to write.
`elapsed_time`	real	Indicates the amount of time the backup was running before it failed.
`node`	string	Indicates the name of the computer from which the backup was run.

backup_succeeded signal

The backup_succeeded signal is raised when the ObjectServer is successfully backed up. The following table describes the attributes of this signal.

Table 6. backup_succeeded signal attributes
Attributes	Data type	Description
`at`	UTC	Indicates the time at which the backup occurred.
`path_prefix`	string	Indicates the directory to which the backup was written.
`elapsed_time`	real	Indicates the amount of time that the backup took to complete.
`node`	string	Indicates the name of the computer from which the backup was run.

login_failed signal

The login_failed signal is raised when a client fails to log in to the ObjectServer. The following table describes the attributes of this signal.

Table 7. login_failed signal attributes
Attributes	Data type	Description
`process`	string	Indicates the name of the process that could not connect because the login was denied.
`username`	string	Indicates the name of the user that failed to connect because login was denied.
`node`	string	Indicates the name of the client computer that could not connect because the login was denied.
`at`	UTC	Indicates the time at which the client failed to connect because the login was denied.

security_timeout signal

The security_timeout signal is raised when a login attempt to the ObjectServer times out. The following table describes the attributes of this signal.

Table 8. security_timeout signal attributes
Attributes	Data type	Description
`process`	string	Indicates the name of the process that failed to connect because login credentials could not be validated.
`username`	string	Indicates the name of the user that failed to connect because login credentials could not be validated.
`node`	string	Indicates the name of the client computer that failed to connect because login credentials could not be validated.
`at`	UTC	Indicates the time at which the client failed to connect because login credentials could not be validated.

create_object signal

The create_object signal is raised when an object is created in the ObjectServer. The following table describes the attributes of this signal.

Table 9. create_object signal attributes
Attributes	Data type	Description
`objecttype`	string	Indicates the object type, which is one of the following types: CREATE DATABASE CREATE TABLE CREATE INDEX CREATE TRIGGER GROUP CREATE TRIGGER CREATE PROCEDURE CREATE RESTRICTION FILTER CREATE USER SIGNAL CREATE FILE CREATE USER CREATE GROUP CREATE ROLE CREATE VIEW CREATE STORE
`parentname`	string	Indicates the name of the parent object. For triggers, this is the trigger group name. For tables, this is the database name. Other objects do not have a parent object.
`name`	string	Indicates the name of the object. For example, the value for the alerts.status table is `status`.
`username`	string	Indicates the name of the user that ran the command.
`server`	string	Indicates the name of the ObjectServer to which the object was added.
`node`	string	Indicates the name of the computer running the ObjectServer to which the object was added.
`hostname`	string	Indicates the name of the client computer from which the request to add the object was made.
`at`	UTC	Indicates the time at which the object was added.

alter_object signal

The alter_object signal is raised when an object in the ObjectServer is altered. The following table describes the attributes of this signal.

Table 10. alter_object signal attributes
Attributes	Data type	Description
`objecttype`	string	Indicates the object type, which is one of the following types: ALTER TABLE ALTER TRIGGER GROUP ALTER TRIGGER ALTER PROCEDURE ALTER RESTRICTION FILTER ALTER USER SIGNAL ALTER FILE ALTER USER ALTER GROUP ALTER ROLE ALTER VIEW ALTER STORE Note: The ALTER PROCEDURE, ALTER RESTRICTION FILTER, and ALTER USER SIGNAL permissions are required if a CREATE OR REPLACE command is run against an object of one of these types and the object already exists. You must have the appropriate ALTER permission even though there is no ALTER command for these objects.
`parentname`	string	Indicates the name of the parent object. For triggers, this is the trigger group name. For tables, this is the database name. Other objects do not have a parent object.
`name`	string	Indicates the name of the object. For example, the value for the alerts.status table is `status`.
`username`	string	Indicates the name of the user that ran the command.
`server`	string	Indicates the name of the ObjectServer in which the object was altered.
`node`	string	Indicates the name of the computer running the ObjectServer in which the object was altered.
`hostname`	string	Indicates the name of the client computer from which the request to alter the object was made.
`at`	UTC	Indicates the time at which the object was altered.

drop_object signal

The drop_object signal is raised when an object in the ObjectServer is dropped. The following table describes the attributes of this signal.

Table 11. drop_object signal attributes
Attributes	Data type	Description
`objecttype`	string	Indicates the object type, which is one of the following types: DROP DATABASE DROP TABLE DROP INDEX DROP TRIGGER GROUP DROP TRIGGER DROP PROCEDURE DROP RESTRICTION FILTER DROP USER SIGNAL DROP FILE DROP USER DROP GROUP DROP ROLE DROP VIEW DROP STORE
`parentname`	string	Indicates the name of the parent object. For triggers, this is the trigger group name. For tables, this is the database name. Other objects do not have a parent object.
`name`	string	Indicates the name of the object. For example, the value for the alerts.status table is `status`.
`username`	string	Indicates the name of the user that ran the command.
`server`	string	Indicates the name of the ObjectServer from which the object was dropped.
`node`	string	Indicates the name of the computer running the ObjectServer from which the object was dropped.
`hostname`	string	Indicates the name of the client computer from which the request to drop the object was made.
`at`	UTC	Indicates the time at which the object was dropped.

permission_denied signal

The permission_denied signal is raised when permission to perform an operation is denied. The following table describes the attributes of this signal.

Table 12. permission_denied signal attributes
Attributes	Data type	Description
`username`	string	Indicates the name of the user that made the request that caused the permission denied error.
`server`	string	Indicates the name of the ObjectServer that generated the permission denied error.
`node`	string	Indicates the name of the computer running the ObjectServer that generated the permission denied error.
`hostname`	string	Indicates the name of the client computer from which the request that caused the permission denied error was made.
`at`	UTC	Indicates the time at which the permission denied error occurred.
`sql_cmd`	string	Indicates the SQL command that caused the permission denied error.

gw_counterpart_down signal

The gateway raises a gw_counterpart_down signal in the backup ObjectServer when it detects that the primary ObjectServer is unavailable. The following table describes the attributes of this signal.

Table 13. gw_counterpart_down signal attributes
Attributes	Data type	Description
`server`	string	Indicates the name of the counterpart ObjectServer that failed, in a failover/failback pair.
`node`	string	Indicates the name of the computer from which the counterpart ObjectServer was run.
`at`	UTC	Indicates the time at which the counterpart ObjectServer failed.
`gateway_name`	string	Indicates the name of the gateway between the primary and backup ObjectServers.

gw_counterpart_up signal

The gateway raises a gw_counterpart_up signal in the backup ObjectServer when it detects that the primary ObjectServer is available again. The following table describes the attributes of this signal.

Table 14. gw_counterpart_up signal attributes
Attributes	Data type	Description
`server`	string	Indicates the name of the counterpart ObjectServer that is available again, in a failover/failback pair.
`node`	string	Indicates the name of the computer from which the counterpart ObjectServer was run.
`at`	UTC	Indicates the time at which the counterpart ObjectServer failed.
`gateway_name`	string	Indicates the name of the gateway between the primary and backup ObjectServers.

iduc_missed signal

The iduc_missed signal is raised whenever a desktop or gateway client fails to respond to an IDUC prompt from the ObjectServer. The following table describes the attributes of this signal.

Table 15. iduc_missed signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that failed to respond to the IDUC prompt from the ObjectServer.
`description`	string	Contains additional information about the client, where available.
`username`	string	Indicates the name of the user that is connected to the ObjectServer.
`node`	string	Indicates the name of the client computer that is connected to the ObjectServer.
`connectionid`	int	Uniquely identifies the connection.
`at`	UTC	Indicates the time at which the IDUC cycle was missed.
`missed_cycles`	int	Indicates the number of consecutively-missed IDUC cycles.

iduc_connect signal

The iduc_connect signal is raised when a client establishes an IDUC connection. The following table describes the attributes of this signal.

Table 16. iduc_connect signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that connected to the ObjectServer.
`description`	string	Contains additional information about the client that connected, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that connected to the ObjectServer.
`node`	string	Indicates the name of the client computer that connected to the ObjectServer.
`conn_id`	int	Indicates the ID of the connection.

iduc_disconnect signal

The iduc_disconnect signal is raised when a client disconnects an established IDUC connection. The following table describes the attributes of this signal.

Table 17. iduc_disconnect signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that disconnected from the ObjectServer.
`description`	string	Contains additional information about the client that disconnected, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that disconnected from the ObjectServer.
`node`	string	Indicates the name of the client computer that disconnected from the ObjectServer.
`conn_id`	int	Indicates the ID of the connection.

iduc_data_fetch signal

The iduc_data_fetch signal is raised whenever an IDUC client retrieves its IDUC changes from the ObjectServer. The following table describes the attributes of this signal.

Table 18. iduc_data_fetch signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that requested pending IDUC changes from the ObjectServer.
`description`	string	Contains additional information about the client, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that is connected to the ObjectServer.
`node`	string	Indicates the name of the client computer that is connected to the ObjectServer.
`connectionid`	int	Uniquely identifies the connection.
`at`	UTC	Indicates the time at which the client retrieved changes corresponding to the last IDUC notification.

resync_lock signal

The resync_lock signal is raised by the ObjectServer when the resync lock is locked. The following table describes the attributes of this signal.

Table 19. resync_lock signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that locked the resync lock.
`description`	string	Contains additional information about the client that locked the resync lock, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user running the process.
`node`	string	Indicates the name of the client computer connected to the ObjectServer.
`at`	UTC	Indicates the time at which the signal occurred

resync_unlock signal

The resync_unlock signal is raised by the ObjectServer when the resync lock is unlocked. The following table describes the attributes of this signal.

Table 20. resync_unlock signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that unlocked the resync lock.
`description`	string	Contains additional information about the client that unlocked the resync lock, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user running the process.
`node`	string	Indicates the name of the client computer connected to the ObjectServer.
`at`	UTC	Indicates the time at which the signal occurred

gw_resync_start signal

The gw_resync_start signal is raised by the gateway to indicate the start of a resynchronization operation. The following table describes the attributes of this signal.

Table 21. gw_resync_start signal attributes
Attributes	Data type	Description
`gateway_name`	string	Indicates the name of the gateway that is starting the resynchronization.
`node`	string	Indicates the host name of the computer on which the gateway is running.
`at`	UTC	Indicates the time at which the resynchronization started.
`is_master`	Boolean	Indicates whether the local ObjectServer is the master or slave of the resynchronization.

gw_resync_finish signal

The gw_resync_finish signal is raised by the gateway to indicate the end of a resynchronization operation. The following table describes the attributes of this signal.

Table 22. gw_resync_finish signal attributes
Attributes	Data type	Description
`gateway_name`	string	Indicates the name of the gateway that is finishing the resynchronization.
`node`	string	Indicates the host name of the computer on which the gateway is running.
`at`	UTC	Indicates the time at which the resynchronization finished.
`is_master`	Boolean	Indicates whether the local ObjectServer is the master or slave of the resynchronization.

pre_connect signal

The pre_connect signal is raised when a client connects to an ObjectServer. It is raised before authentication. This signal can be used to redirect a client to a different ObjectServer or to a different virtual pair using the ALTER SYSTEM REDIRECT CONNECT command. The following table describes the attributes of this signal.

Table 23. pre_connect signal attributes
Attributes	Data type	Description
`process`	string	Indicates the type of client process that connected to the ObjectServer.
`description`	string	Contains additional information about the client that connected, where available. For example, if the client is a probe, the description contains the probe name.
`username`	string	Indicates the name of the user that connected to the ObjectServer.
`node`	string	Indicates the name of the client computer that connected to the ObjectServer.
`connectionid`	int	Uniquely identifies the connection.
`at`	UTC	Indicates the time at which the client connected.
`can_redirect`	Boolean	Indicates whether the client accepts redirects using the ALTER SYSTEM command.