TIBCO Spotfire® Server and Environment - Installation and Administration

Action log entries

When you analyze an action log, you can organize the data into categories, actions, and properties (identifiers and arguments). You can map these to database columns, which you can display in a Spotfire visualization.

Different levels and types of information are logged. The log entries include the following information:
  • The time of the action.
  • The time the server logged the action.
  • The addresses for the server and the computer where the action was performed.
  • The user account that performed the logged action.
  • The category of the action, specifying whether the action originated on the Spotfire Server (such as an admin action) or from a service (such as Automation Services).
  • The properties (identifying properties or arguments) specific to the action performed. For example, when a user changes a password, the property uName is logged to indicate the user name.
  • Whether the action was completed successfully.
  • The session and service instance unique identifiers.

How the data is presented

Every logged event is placed on a new row in the log, and semicolons separate the entries within the logged event.

The logged information appears in the following fields, in the order given.
LOGGED_TIME; MACHINE; USER_NAME; ORIGINAL_TIME; ORIGINAL_IP; LOG_CATEGORY; LOG_ACTION; SUCCESS; SESSION_ID; ID1; ID2; ARG1; ARG2; ARG3; ARG4; ARG5; ARG6
The properties and arguments correspond to the fields id1, id2, and arg1 through arg6.
Note: For categories with the suffix "_wp" (Web Player), ARG5 corresponds to SERVICE_INSTANCE_ID.

Example

When a user changes a password, the text log entry resembles the following.
2019-03-18T09:36:00.381+0100;10.100.32.129;jdoe;2019-03-18T09:36:00,381+0100;10.98.45.189;
admin;change_passwd;true;7583cdc4-a6b8-40d4-88e6-90f5d499ff79

For logs that are written to a database, the fields correspond to column names. The logged data is mapped to the appropriate columns to create a database view.

When the log entry is written to the database, the data appears in a specific view. For an Oracle database, the view is defined as the following.
CREATE OR REPLACE VIEW ADMIN_CHANGE_PASSWD AS SELECT 
LOGGED_TIME; 
MACHINE; 
USER_NAME; 
ORIGINAL_TIME; 
ORIGINAL_IP; 
SUCCESS; 
SESSION_ID; 
ID1 AS UNAME FROM ACTIONLOG WHERE LOG_CATEGORY = 'admin' AND LOG_ACTION = 'change_passwd'
Category Action id1 id2 arg1 arg2 arg3 arg4 arg5 arg6
admin change_passwd uName
admin create_group gName displayName email
admin create_user uName displayName email
admin group_add_member name gName sort groupingId
admin group_remove_member name gName sort groupingId
admin remove_license gName licenseName
admin remove_principal name sort groupingId
admin rename_principal oldName newName sort
admin set_license gName licenseName excludingFunction
admin set_preference name prefType category id
analysis_as apply_bookmark libraryId path bookmarkName
analysis_pro apply_bookmark libraryId path bookmarkName
analysis_pro arrange_visualizations libraryId path pageName tileMode origin
analysis_pro canvas_size libraryId path layoutName layoutSize
analysis_pro change_column_or_aggregation libraryId path oldExpression newExpression origin
analysis_pro create_visualization_recommendations libraryId path visualizationType predictorsType origin - userInput
analysis_pro create_annotation libraryId path visualizationTitle visualizationType pageName
analysis_pro create_comment libraryId path visualizationTitle conversationId captureState
analysis_pro create_details_visualization libraryId path originVisualizationType visualizationType visualizationTitle
analysis_pro create_page libraryId path origin
analysis_pro create_visualization libraryId path visualizationType visualizationTitle origin - userInput
analysis_pro delete_page libraryId path pageName origin
analysis_pro duplicate_page libraryId path pageName origin
analysis_pro duplicate_visualization libraryId path visualizationType visualizationTitle
analysis_pro exclude_column_from_recommendations libraryId path columnName value
analysis_pro export libraryId path exportFormat exportPages
analysis_pro hide_page libraryId path pageName origin
analysis_pro initiate_analyze_from_marking libraryId path visualizationType origin
analysis_pro modify_filter libraryId path filterName filterType origin
analysis_pro rename_page libraryId path oldName pageName origin
analysis_pro reset_all_filters libraryId path origin
analysis_pro reset_all_visible_filters libraryId path origin
analysis_pro reset_filter libraryId path filterName filterType origin
analysis_pro set_custom_expression libraryId path oldExpression newExpression origin
analysis_pro set_page libraryId path pageName
analysis_pro show_page libraryId path pageName origin
analysis_pro switch_visualization libraryId path originVisualizationType visualizationType visualizationTitle
analysis_pro visualization_area_layout_mode libraryId path visualizationAreaMode
analysis_pro y_axis_number_of_scales libraryId path numberOfScales visualizationType origin
analysis_wp apply_bookmark libraryId path bookmarkName webplayerSessionId analysisId service_instance_id
analysis_wp arrange_visualizations libraryId path pageName tileMode webplayerSessionId analysisId service_instance_id origin
analysis_wp change_column_or_aggregation libraryId path oldExpression newExpression webplayerSessionId analysisId service_instance_id origin
analysis_wp create_annotation libraryId path visualizationTitle visualizationType webplayerSessionId analysisId service_instance_id pageName
analysis_wp create_comment libraryId path visualizationTitle conversationId webplayerSessionId analysisId service_instance_id captureState
analysis_wp create_details_visualization libraryId path originVisualizationType visualizationType webplayerSessionId analysisId service_instance_id visualizationTitle
analysis_wp create_page libraryId path webplayerSessionId analysisId service_instance_id origin
analysis_wp create_visualization libraryId path visualizationType visualizationTitle webplayerSessionId analysisId service_instance_id origin - userInput
analysis_wp delete_page libraryId path pageName webplayerSessionId analysisId service_instance_id origin
analysis_wp duplicate_page libraryId path pageName webplayerSessionId analysisId service_instance_id origin
analysis_wp duplicate_visualization libraryId path visualizationType webplayerSessionId analysisId service_instance_id visualizationTitle
analysis_wp export libraryId path exportFormat exportPages webplayerSessionId analysisId service_instance_id
analysis_wp hide_page libraryId path pageName webplayerSessionId analysisId service_instance_id pageTabs or contextMenu
analysis_wp modify_filter libraryId path filterName filterType webplayerSessionId analysisId service_instance_id origin
analysis_wp rename_page libraryId path oldName pageName webplayerSessionId analysisId service_instance_id origin
analysis_wp reset_all_filters libraryId path webplayerSessionId analysisId service_instance_id origin
analysis_wp reset_all_visible_filters libraryId path webplayerSessionId analysisId service_instance_id origin
analysis_wp reset_filter libraryId path filterName filterType webplayerSessionId analysisId service_instance_id origin
analysis_wp set_custom_expression libraryId path oldExpression newExpression webplayerSessionId analysisId service_instance_id origin
analysis_wp set_page libraryId path pageName webplayerSessionId analysisId service_instance_id
analysis_wp show_page libraryId path pageName webplayerSessionId analysisId service_instance_id pageTabs or contextMenu
analysis_wp switch_visualization libraryId path originVisualizationType visualizationType webplayerSessionId analysisId service_instance_id visualizationTitle
analysis_wp visualization_area_layout_mode libraryId path visualizationAreaMode webplayerSessionId analysisId service_instance_id
analysis_wp y_axis_number_of_scales libraryId path numberOfScales visualizationType webplayerSessionId analysisId service_instance_id origin
auth impersonate uName
auth login clientType clientVer displayName email
auth logout uName
auth_as login uName
auth_as logout uName
auth_pro login uName
auth_pro logout uName
auth_wp login uName webplayerSessionId
auth_wp logout uName webplayerSessionId
automation_job_as job_finished libraryId libraryPath jobId status executionTime message
automation_job_as job_started libraryId libraryPath jobId status executionTime message
automation_task_as task_finished libraryId libraryPath jobId status executionTime message
automation_task_as task_started libraryId libraryPath jobId taskClass unused taskName
data_connector_pro create_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_pro create_source libraryId libraryPath dataSourceType dataSourceInformation
data_connector_pro get_data libraryId libraryPath dataSourceType dataSourceInformation internalQuery NumRows duration externalQuery
data_connector_pro load_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_pro load_source libraryId libraryPath dataSourceType dataSourceInformation
data_connector_pro synch_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_pro update_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_pro update_source libraryId libraryPath dataSourceType dataSourceInformation
data_connector_wp create_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_wp create_source libraryId libraryPath dataSourceType dataSourceInformation
data_connector_wp get_data libraryId libraryPath dataSourceType dataSourceInformation internalQuery NumRows duration externalQuery
data_connector_wp load_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_wp load_source libraryId libraryPath dataSourceType dataSourceInformation
data_connector_wp synch_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_wp update_connection libraryId libraryPath dataSourceType dataSourceInformation dataSourceLibraryId
data_connector_wp update_source libraryId libraryPath dataSourceType dataSourceInformation
datafunction_pro execute unused path params duration
datafunction_wp execute unused path params duration
datasource_pro execute unused path title params duration NumRows
datasource_wp execute unused path title params duration NumRows
ems create_connection unused unused arguments
file_pro load unused path
file_wp load unused path
find_pro search libraryId path expression
find_wp search libraryId path expression webPlayerSessionId analysisId serviceInstanceId
info_link create_il libraryId path
info_link get_data libraryId path duration sizeb groupingId
info_link load_il libraryId path groupingId
info_link update_il libraryId path
library clear_perm libraryId path recursive
library copy libraryId path libraryType destLibraryId destPath groupingId
library create libraryId path libraryType preSize postSize
library delete libraryId path libraryType groupingId
library export libraryId path destPath groupingId
library import libraryId path destPath groupingId
library load_content libraryId path libraryType duration sizeb groupingId
library move libraryId path libraryType destLibraryId destPath groupingId
library remove_perm libraryId path name sort
library save_content libraryId path libraryType preSize postSize
library set_group_perm libraryId path gName permission groupingId
library set_user_perm libraryId path uName permission groupingId
library_as load libraryId path
library_pro close libraryId path
library_pro load libraryId path
library_wp clone libraryId path webplayerSessionId analysisId
library_wp close libraryId path webplayerSessionId analysisId
library_wp load libraryId path webplayerSessionId analysisId
library_wp load_start libraryId path webplayerSessionId analysisId
library_wp update libraryId libraryPath webplayerSessionId analysisId
library_wp update_start libraryId libraryPath webplayerSessionId analysisId
routing_rules create ruleId unused ruleName message
routing_rules create_schedule scheduleId unused scheduleName message
routing_rules delete ruleId unused unused message
routing_rules disable ruleId unused ruleName message
routing_rules enable ruleId unused ruleName message
routing_rules update ruleId unused ruleName message
scheduled_updates adjust_ratio unused libraryId message
scheduled_updates analysis_update taskId analysisId destination message
scheduled_updates cancel_update ruleId libraryId ruleName destination message
scheduled_updates evaluation unused unused serviceUrl seviceStatus message
scheduled_updates external_update ruleId libraryId analysisPath resourcePool message
scheduled_updates job_cancel_load jobTaskId serviceId message
scheduled_updates job_execution jobId taskId payLoad message
scheduled_updates job_load jobTaskId serviceId message
scheduled_updates job_unload jobTaskId serviceId message
scheduled_updates load ruleId libraryId ruleName destinationList message
scheduled_updates no_retry unused libraryId message
scheduled_updates no_update taskId libraryId destination message
scheduled_updates reload ruleId libraryId ruleName message
scheduled_updates reschedule ruleId libraryId ruleName message
scheduled_updates retry unused libraryId destination message
scheduled_updates retry_exhausted unused unused destination message
scheduled_updates routing unused libraryId message
scheduled_updates rule_schedule ruleId libraryId ruleName message
scheduled_updates schedule_change ruleId libraryId ruleName message
scheduled_updates su_evaluation ruleId libraryId ruleName message
scheduled_updates su_execution jobId libraryId message
scheduled_updates su_request jobId libraryId processType message
scheduled_updates task_execution taskId unused destinationName message
scheduled_updates unload ruleId libraryId ruleName destinationList message
scheduled_updates update ruleId libraryId ruleName message

For more information, see Action log generic entries and Action log categories. For an example of a typical set of user actions logged to the action logs, see Sample action log output.

You can configure action logging so that only certain categories are logged. See Configuring the action log web service from the configuration tool for more information.