Skip to main content
Skip table of contents

Logged Events

This section lists the events that are logged for each of the SuperSTAR components, as well as what data is logged in each event record.

Common Data

All event records contain the following information:

KeyDescriptionExample
time
The time the event occurred (UNIX timestamp, in UTC). The accuracy of the timestamp information depends on the machine where the event logger is running.1361592000
thread
A thread ID.42
action
The action being logged. See the tables below for more details about the actions that are logged by each application.login
user

The username of the user who generated the event.

For Job Queue Manager events, the audit logs will always record the user that you configured JQM to use (configured in service-config.xml), rather than the user who actually submitted the job. The user who submitted the job can be obtained from the jqmRequestingUser field. See Configure JQM for more details.

johndoe
groups
The groups this user belongs to.[ group1, group2 ]
source
The name of the source application that generated the event.SuperWEB2
hostname
The name of the host machine that generated the event.myhostname

Some event records include additional data, which is listed in the tables below.

SuperWEB2 / Job Queue Manager / Open Data API

ActionDescription
action

The type of event:

Event
SW2JQMODAPI
login
A user has successfully logged in to SuperWEB2.--
logout
A user has logged out of SuperWEB2.-
login.failed
Unsuccessful login attempt. The user value shows the username that was used in the failed login attempt.--
query

A tabulation query has completed successfully.

When this event is logged, full details of the table that was used in the query are recorded in txd in TXD (Textual Table Definition) format. This is a proprietary text based format for describing the structure of a SuperSTAR table; it is one of the SuperCROSS save options and is the internal format used to save tables inside SuperWEB2. TXD files can be loaded into SuperCROSS, added to SuperWEB2 by an administrator, and used with the Production System.

-
query.cacheHit

A tabulation query that had been requested previously was requested and a tabulated version existed in cache. The job did not have to be run again. 

--
query.failed
A tabulation query was not successful. The details of the query will be recorded in txd.-
jqmQuery
A query has been submitted to Job Queue Manager. The jqmStatus will contain more information about the submitted job.--
jqmQuery.failed
A query submitted to the Job Queue Manager was not successful. --
chart.displayed
A chart has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs.--
map.displayed
A map has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs.--
table.displayed

A table has been displayed in SuperWEB2. The txdId can be used to identify the related query record in the logs.

--
unitdata.displayed
Unit record data has been displayed in SuperWEB2 (RecordVIEW). Use selectedColumns to see a list of the columns that were displayed.--
userDataChange
A change has been made to the User Data Repository. The dataType, operation and udrId fields contain more information about the change.-
chart.download
A chart has been downloaded in SuperWEB2. downloadFormat can be used to identify the file format.--
jqm.download
A task submitted to Job Queue Manager has completed and downloaded. downloadFormat can be used to identify the file format.--
map.download
A map has been downloaded in SuperWEB2. downloadFormat can be used to identify the file format.--
table.download

A table has been downloaded in SuperWEB2. downloadFormat can be used to identify the file format.

table.download events only appear in audit logs if the download file contains table data. For example, CSV, Excel, and SDMX.zip files.

Downloads of JSON, TXD and SDMX Structure.xml file formats are not recorded as these are structural formats and do not contain data.

--

login  and logout events are also recorded for implicit login and logout events, such as a direct URL. When someone accesses one of these links the system automatically logs them in as the guest user (and will also automatically log them out of the guest account if that user does not have access to the linked resource). 

FieldDescriptionSW2JQMODAPI
ipAddress
The source IP address of all user-initiated logged events.
Please see these steps for some additional configuration that is required in order to correctly log the end user's IP address, rather than the gateway IP address.
-
jobUuid
A unique ID for this tabulation request. The same ID is recorded in the SuperSERVER log for events relating to this tabulation.
part
If the TXD is very large it will be split into multiple parts (up to 60,000 characters per part). When a TXD has been split in the logs, this will indicate which part this record relates to for a given txdId. Each part of the query will have a unique part number.
dataType

This will be present when the action is userDataChange. One of the following, indicating the type of data change:

TABLE
A saved table.
UDF
A user defined field.
RECODE
A recode.
JOB
A JQM job.
-
operation

This will be present when the action is userDataChange. One of the following, indicating the type of data change:

UPDATE
A record (table, UDF, recode or JQM job, depending on the dataType) has been created or modified.
DELETE
A record has been deleted.
-
udrId

This will be present when the action is userDataChange or jqmQuery. The ID of the record that has been updated or deleted.

For saved tables it will be a UUID, while for JQM jobs it will be a simple integer.

-
jqmStatus
This will be present when the action is jqmQuery. The status of the JQM job: SUBMITTED, COMPLETE, COLLECTED or ERROR.--
jqmRequestingUser
The username of the user who submitted a query to Job Queue Manager.--
jqmFormat

The output format of the Job Queue Manager query.

CSVComma-separated values (.CSV) delimited text file.
CSV_STRINGComma-separated values (.CSV) string file.
EXCEL_2007Microsoft Excel 2007 (.XLXS) file.
SDMX_ARCHIVEStatistical Data and Metadata eXchange (.ZIP) file.
SDMX_DATASTRUCTUREStatistical Data and Metadata eXchange Structure (.XML) file.
--
downloadFormat

The format of a downloaded item.

csvString

Comma-separated values (.CSV) delimited text file.

Users can download CSV files from Table View.

kmz

Keyhole Markup language Zip file.

Users can download KMZ files from Map View.

pdf

Portable Document File.

Users can download PDF files from Chart View and Map View.

png

Portable Network Graphic file.

Users can download PNG files from Chart View.

sdmxArchive

Statistical Data and Metadata eXchange zip file.

Users can download SDMX ZIP files from Table View.

xls

For opening in Microsoft Excel 97 or 2003.

Users can download XLS files from Table View.

xlxs

For opening in Microsoft Excel 2007 or 2010.

Users can download XLXS files from Table View and Job Queue Manager.

Downloads of JSON, TXD and SDMX Structure.xml file formats are not recorded as these are structural formats and do not contain data.

--
logoutType

When action is logout, indicates the type of logout.

user
Logout initiated by the user.
error
Logout caused by a system error.
system
Logout generated by the server for other reasons. For example, session timeout.
--
duration

The duration of the event in seconds. In the case of a logout event it lists the total duration of the session.

txd

The TXD used in the query (up to 60,000 characters).

txdId
A unique ID for this TXD. This can be used to link events relating to a single table.
selectedColumns

The unit record data columns that were displayed.

--

SuperADMIN

ActionDescriptionAdditional Data
admin.login
An administrator has logged into SuperADMIN.
admin.logout
An administrator has logged out of SuperADMIN.
group.created
A group has been created.
groupid
The group ID.
displayname
The display name of the group.
group.removed
A group has been removed
groupid
The group ID.
group.displayname.changed
The display name for a group has been changed.
groupid
The group ID.
to
The new display name of the group.
user.created
A user has been created.
userid
The user ID of the new user.
displayname
The user's display name.
user.removed
A user has been removed.
userid
The user ID of the deleted user.
user.added.to.group
A user has been added to a group.
userid
The user ID.
groupid
The ID of the group this user has been added to.
user.removed.from.group
A user has been removed from a group.
userid
The user ID.
groupid
The ID of the group this user has been removed from.
user.displayname.changed
A user's display name has been changed.
userid
The user ID.
to
The new display name for this user.
user.locked
A user account has been locked.
userid
The user ID.
user.unlocked
A user account has been unlocked.
userid
The user ID.
user.password.changed
A user has changed their password.
userid
The user ID.
user.api.token.reset
A user has reset their Open Data API key within SuperWEB2.
userid
The user ID.
database.added
A dataset has been added to the catalogue.
databaseid
The dataset ID.
displayname

The database's display name.

path
The location of the database's SXV4 file.
database.removed
A dataset has been removed from the catalogue.
databaseid
The dataset ID.
database.location.changed
The location of a dataset's SXV4 file has been changed.
databaseid
The dataset ID.
path
The new location of the dataset's SXV4 file.
database.displayname.changed
The display name of a dataset has been changed.
databaseid
The dataset ID.
to
The new display name for this database.
database.access.granted.to.user
A user has been granted access to a dataset.
databaseid
The dataset ID.
userid
The user ID.
database.access.revoked.from.user
A user's access to a dataset has been revoked.
databaseid
The dataset ID.
userid
The user ID.
database.access.granted.to.group
A group has been granted access to a dataset.
databaseid
The dataset ID.
groupid
The group ID.
database.access.revoked.from.group
A group's access to a dataset has been revoked.
databaseid
The dataset ID.
groupid
The group ID.
database.method.changed
A data control method has been added or removed from this dataset.
databaseid
The dataset ID.
method
The name of the method that has changed.
change
The change (added or removed).
database.statfunction.changed
A statistical function has been added or removed from this dataset.
databaseid
The dataset ID.
statfunction
The statistical function.
change
The change (added or removed).
database.setting.changed
A setting has been changed for this dataset (such as changing the multilingual status.
databaseid
The dataset ID.
setting
The setting that has been changed.
field.access.granted.to.user
The user has been granted access to a field.
userid
The user ID.
databaseid
The dataset ID.
facttable
The name of the table containing the field.
field
The name of the field.
field.access.revoked.from.user

A user's access to a field has been revoked.

userid
The user ID.
databaseid
The dataset ID.
facttable
The name of the table containing the field.
field
The name of the field.
field.access.granted.to.group
A group has been granted access to a field.
userid
The user ID.
databaseid
The dataset ID.
facttable
The name of the table containing the field.
field
The name of the field.
field.access.revoked.from.group
A group's access to a field has been revoked.
userid
The user ID.
databaseid
The dataset ID.
facttable
The name of the table containing the field.
field
The name of the field.
folder.access.granted.to.user
The user has been granted access to a folder.
userid
The user ID.
folder
The name of the folder.
folder.access.revoked.from.user

A user's access to a folder has been revoked.

userid
The user ID.
folder
The name of the folder.
folder.access.granted.to.group
A group has been granted access to a folder.
userid
The user ID.
folder
The name of the folder.
folder.access.revoked.from.group
A group's access to a folder has been revoked.
userid
The user ID.
folder
The name of the folder.
value.access.granted.to.user
The user has been granted access to a value.
userid
The user ID.
databaseid
The dataset ID.
value
A single value in the value set.
valueset
The name of the set of discrete values, categories or classification items.
value.access.revoked.from.user

A user's access to a value has been revoked.

userid
The user ID.
databaseid
The dataset ID.
value
A single value in the value set.
valueset
The name of the set of discrete values, categories or classification items.
value.access.granted.to.group
A group has been granted access to a value.
userid
The user ID.
databaseid
The dataset ID.
value
A single value in the value set.
valueset
The name of the set of discrete values, categories or classification items.
value.access.revoked.from.group
A group's access to a value has been revoked.
userid
The user ID.
databaseid
The dataset ID.
value
A single value in the value set.
valueset
The name of the set of discrete values, categories or classification items.
valueset.access.granted.to.user
The user has been granted access to a value set.
userid
The user ID.
databaseid
The dataset ID.
valueset
The name of the set of discrete values, categories or classification items.
valueset.access.revoked.from.user

A user's access to a value set has been revoked.

userid
The user ID.
databaseid
The dataset ID.
valueset
The name of the set of discrete values, categories or classification items.
valueset.access.granted.to.group
A group has been granted access to a value set.
userid
The user ID.
databaseid
The dataset ID.
valueset
The name of the set of discrete values, categories or classification items.
valueset.access.revoked.from.group
A group's access to a value set has been revoked.
userid
The user ID.
databaseid
The dataset ID.
valueset
The name of the set of discrete values, categories or classification items.
client

The client that generated the event. This can be one of the following:

  • SA Console
  • SuperWEB2
  • SuperCROSS

SuperSERVER

ActionDescriptionAdditional Data
tabulation.query

Details of the query. By default this will include details of the fact tables and fields, but you can use the server command in SuperADMIN to control what details are logged. See Configure for more details.

jobUuid
The job ID for the query.
client
The client that processed the query. For example: SuperWEB2, ODAPI, SuperCROSS.
values
(If configured in SuperADMIN) the values used in the query.
valueSets
(If configured in SuperADMIN) the value sets used in the query.
fields
(If configured in SuperADMIN) the fields used in the query.
sumFields

(If configured in SuperADMIN) the measures used in the query.

factTables
(If configured in SuperADMIN) the fact tables used in the query
methods
Details of any Data Control (confidentiality) methods that were applied to this dataset when the query was processed.
tabulation.request

A cross tabulation job has been submitted to the server.

jobUuid
The job ID for the query.
tabulation.started

SuperSERVER has started processing a cross tabulation job.

jobUuid
The job ID for the query.
duration
The time taken to complete the action (in milliseconds).
tabulation.complete
A cross tabulation job has completed successfully. The event record includes the job ID and the time taken to complete the tabulation (in seconds).
jobUuid
The job ID for the query.
duration

The time taken to complete the action (in milliseconds).

tabulation.retrieved

The cross tabulation results have been retrieved by the client.

jobUuid
The job ID for the query.
duration
The time taken to complete the action (in milliseconds).
jobUuid
A unique ID for this tabulation request. The same ID is recorded in the SuperWEB2 log for events relating to this tabulation.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.