Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for PhixFlow administrators who need to monitor PhixFlow activity.

Overview

The System Console provides details on active and completed tasks, files imported and exported by PhixFlow, and the audit trail of changes made to PhixFlow's configuration.  

Excerpt

Access to the console, depends on your privileges. Application users, analysis modellers and application designers are notified of errors that prevent their work, but are not notified of system warnings. These are only reported to the console. This means it is important for the PhixFlow administrator to monitor the console for warnings and to determine what action is required.

For logs with information related to server and Tomcat traffic, see Server Log Files.

Excerpt-include
_standard_settings
_standard_settings
nopaneltrue

Console Information

The following buttons are available at the top of the System Console:

Press this to bring up the Opens the  System Logging Configuration. From this form, analysis logging properties can be configured tab where you can configure the logging for data analysis models and objects.

Press this to bring up Opens the task plan list.

There are five tabs available to that show information about the system:

Anchor
TaskLogs
TaskLogs
Task Logs

...

Displays a log file summary for each Task PlanPlans that is currently active. Right click on the task and select Show Log File on the context menu to bring up the detailed log file.

...

Displays a log file summary for each Task PlanPlans that has completed.

The following buttons are available for Completed Tasks:

Apply a filter to the list of Completed Tasks.

Refresh the list of Completed Tasks.

...

FieldDescription
StartedThe date and time that this Analysis run was started.
FinishedThe date and time that this Analysis run finished.
Archive TimeThe date and time that this Log File was archived.
NameThe name of the Task which has been run.
CancelledWhether this Analysis run was cancelled by a user.
StatusAn icon will indicate if the stream sets generated by the Analysis run were rolled back from the Stream Sets tab in the system console. See below for details.
TasksThe number of individual Tasks that were run as part of this Analysis run.
MessagesThe total number of messages in the Log File.
InfoThe number of information messages contained in the Log File.
ErrorsThe number of error messages contained in the Log File.
WarningsThe number of warning messages contained in the Log File.
Initiator TypeThe PhixFlow object that was used to launch this Analysis run.
Login nameThe user that stated this run.
ActionWhether the task was a stream action.

If a Log File is selected from the list with a right click, the Show Log Details option can be chosen from the context menu to bring up the log file.To display a log file, right-click its name to open the context menu, then select the Show Log Details.

For stream sets that have been rolled back from the system console Stream Sets tab:

  • If the stream sets generated by an analysis run were rolled back and the analysis repeated (see

...

  • Tab: Stream Sets

...

  • , below), the log file entry

...

  • is displayed with a

...

  • Image Modified button in the Status field.

...

  • Click Image Added to open the new log file

...

  • from the rerun of analysis.
  • If the stream sets generated by an analysis run were rolled back, the log file entry

...

  • is displayed with a Image Added button in the Status field.

...

  • Click Image Added to open the log file for the rollback.

These buttons will only appear if the stream sets were rolled back from the system console stream sets tab.

Tab: Messages

The log messages for the currently selected log file. For each message the following fields are shown:

...

The following buttons are available for log messages:

Apply a filter to the list of log messages.

Refresh the list of log messages.

...

FieldDescription
Message DetailDisplays the values of the variables in the parser or detailed stack trace. Populated if an error occurs during analysis or a debug attribute function has been processed.

Tab: Stream Sets

The Stream Sets for the currently selected log file.

If the Stream Sets generated by an Analysis run produced a number of Cycles, and one or more Cycle was rolled back and repeated, then Status field will contain a symbol to indicate whether:

...

A list of files that have been read into PhixFlow by File Collectors or produced by PhixFlow File Exporters. This is found on the Imported/Exported Files tab on the System Console 2168684927, on the Imported/Exported Files tab in the System Console 2168684927 tab on the System Console, or when viewing the details of an individual file.

...

FieldDescription
CycleThe analysis cycle in which the file was processed.
Processed AtDate and time that file was processed
TypeImported or Exported
File Importer/ExporterThe Importer or Exporter used to handle this file.
StatusStatus of the file.
RecordsThe number of records in the file.
FTP SiteThe FTP Site the underlying file handler is attached to, if there is one.
LocationThe location of the file on the file system.

...

All Audit Summaries can be viewed from the Audit Summary tab on the System Console 2168684927. Details for an individual Audit Summary can be viewed by selecting an Audit Summary from this view, and double clicking.

The System Administrator uses Privilege Codes to configure which operations should be audited. If a given privilege has been configured for auditing, PhixFlow tracks details of every associated action and presents these in an Audit Summary.

Tip

PhixFlow database administrators can directly query the PhixFlow database for audit information in the audit_summary and audit_detail tables. Audit records that pre-date the upgrade to version 8.1.0 of PhixFlow will not have an entry in the message_text column.

Form: Audit Summary

FieldDescription
Date/TimeThe date/time the audited action took place.
UsernameName of the User who performed the audited action.
Action SummaryA summary description of the audited action.

...

The Audit Details of an audited action can be viewed with the details of an individual System Console 2168684927.

Form: Audit Details

FieldDescription
Audit DetailsA detailed description of the audited action.

...

FieldDescription
Date/TimeThe date/time the audited action took place.
UsernameName of the User who performed the audited action.
Original NameOriginal Name of the Object that was changed. i.e. if the name of the object was up dated, this is the original value.
Action DescriptionA summary description of the action.

...

Details of archived Stream Sets from Streams which have been configured to archive.

Details for an individual Archive Log can be viewed by selecting an Archive Log from this view, and double clicking.

The following fields are listed for each archive:

...

When viewing the list of Archive Logs from the System Console, the following icon is also available:

...

Image Removed

...

Restore archived data. This brings up the Restore from Archive form.

Note: Each Archive ZIP file contains a number of CSV files, each containing archived data for a single stream set. Ensure that you have extracted the CSV files for the stream sets that you want to restore from the Archive ZIP file and placed them in the restore directory before initiating the Restore.

Tab: Stream Sets

This form is only available when viewing the details of an individual Archive Log.

FieldDescription
Stream NameThe name of the Stream that was archived.
From DateThe From Date of the Stream Set archived.
To DateThe To Date of the Stream Set archived.
Records ArchivedThe number of records in the Stream Set archived.
Partial ArchiveTicked if the archive was only partial.