Versions Compared

Key

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

Task Logs

The Task Logs tab in the The System Console provides details on active and completed tasks, files imported and on items used exported by and produced by Tasks.

Active Tasks

Displays a Log File summary for each PhixFlow, and the audit trail of changes made to PhixFlow's configuration.

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

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

Image Added

Press this to bring up the System Logging Configuration. From this form, analysis logging properties can be configured.

Image Added

Press this to bring up the task plan list.


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


Anchor
TaskLogs
TaskLogs
Task Logs

Active Tasks

Displays a log file summary for each Task that is currently active. If a Log File is selected from the list with a right click, the Show Log Details option can be chosen from Right click on the task and select Show Log File on the context menu to bring up the Log File Detailsdetailed log file.

Active Tasks can be stopped at any time, if required (this may be useful when testing new models) by pressing the button.

...

Completed Tasks

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

The following icon is buttons are available for Active Completed Tasks:

Image Removed

Image Added

Apply a filter to the list of

Active

Completed Tasks.

Image Added

Refresh the list of Completed Tasks.


Displays a Log File summary for each Task that has completedLog file entries are colour coded as shown below:

Red

This log file contains errors

Orange

This log file contains warnings

BlueThe initiator of this log file is currently suspended which is why the task has not run.


The following details are available for each log file:

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 Detailsthe log file.

If the Stream Sets stream sets generated by an Analysis analysis run were rolled back and the analysis repeated (see under Stream Sets form below), the Log File log file entry will have a button Image Removed Image Added in the Status field. Pressing this button will bring up the new Log File log file that was produced when the Analysis run was redone.

Form Icons

The following icons are available for Completed Tasks:

...

.

If the stream sets generated by an analysis run were rolled back, the log file entry will have a buttonImage Added in the Status field. Pressing this button will bring up 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:

FieldDescription
TypeThe type of message e.g. INFO, WARN, ERROR or DEBUG
CodeThe numeric error message code.
MessageThe summary message output by the analysis engine.

The following buttons are available for log messages:

Image Added

Apply a filter to the list of

Completed Tasks

log messages.

Image Modified

Refresh the list of

Completed Tasks

log messages.

Log

...

message details

Double-click on a log message to see further detail.

Imported/Exported Files

The Imported and Exported Files for the currently selected Task.

Form Icons

The form provides some of the standard form icons.

Alarms

The Alarms for the currently selected Task.

Form Icons

The form provides the standard form icons.

details. In addition to the standard fields, you will also find, on its own tab, the message detail:

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 Tasklog 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:

  • Image Removed Image Added this Stream Set was originally generated as part of this Analysis run, but has been moved forward into the log for the Analysis to generate those Stream Sets which were rolled back and repeated.
  • Image Removed Image Added this Stream Set was moved forward into this log from the original Analysis run, along side new Stream Sets generated in this Analysis run - the new Stream Sets are those that were rolled back to be redone from the original log.

Forms: Log File

For each Task Plan or Analysis Task run, a Log File is generated. These can be viewed in the Task Logs view. While a task is running the Log File can be viewed in the Active Tasks list, once it has finished it can be viewed in the Completed Tasks list.

Form: Log File Details

...

Form Icons

The form provides the following icons:

Image Removed

This icon is only available if this Log File is the result of a request to rollback and redo the Stream Sets from a previous Analysis run. Pressing this brings up the Log File for the original Analysis run.

Log Messages

The Log Messages in this Log File. The user can drill down on each message to see further detail.

Imported/Exported Files

The Imported and Exported Files for this Analysis run.

Form Icons

The form provides some of the standard form icons.

Alarms

The Alarms for this Analysis run.

Form Icons

The form provides the standard form icons.

Stream Sets

The Stream Sets for generated by this Analysis run.

Form Icons

The form provides the following icons:

Image Removed

Attempt to run analysis again for any failed Stream Sets.

Image Removed

Roll back the data for each Stream Set, and run Analysis again. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back. After "reprocessing" a Log File in this way, the Log File will be flagged as "Reprocessed", and no Stream Sets will be associated with it.

Image Removed

Roll back the data for each Stream Set. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back.

Form Icons

The form provides the following icons:

...

Image Removed

...

Attempt to run analysis again for any failed Stream Sets.

...

Image Removed

...

Roll back the data for each Stream Set, and run Analysis again. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back. After "reprocessing" a Log File in this way, the Log File will be flagged as "Reprocessed", and no Stream Sets will be associated with it.

If the Stream Sets cover a number of Cycles, pressing this will bring up the Repeat Cycle Analysis dialogue, so that you can choose which Cycles you want to rollback and redo.

...

Image Removed

...

Roll back the data for each Stream Set. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back.

If the Stream Sets cover a number of Cycles, pressing this will bring up the Rollback Cycles dialogue, so that you can choose which Cycles you want to rollback.

See Also

...

The stream set in the console also provides the following buttons:

Image Added

Roll back the data for each Stream Set, and run Analysis again. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back. After "reprocessing" a Log File in this way, the Log File will be flagged as "Reprocessed", and no Stream Sets will be associated with it.

Image Added

Roll back the data for each Stream Set. Note that when data is rolled back, any subsequent - "downstream" - Stream Sets will also be rolled back.

Tab: Imported/Exported Files

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, on the Imported/Exported Files tab in the System Console tab on the System Console, or when viewing the details of an individual file.

By right clicking on a file you can select Show Log File from the context menu. This will bring up the log file of the Analysis run that handled this file - whether as a file imported or exported.

By right clicking on a file you can select Show File Importer/Exporter. This will being up the configuration of the importer or exporter used to handle this file.


Anchor
ImportedExportedFiles
ImportedExportedFiles
Imported/Exported Files

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.

Anchor
EmailMessages
EmailMessages
Email Messages

Emails which have been created by the system, from task plans or file exporters.

FieldDescription
Created Date/TimeThe date and time at which the email was created.
Send by Date/TimeThe date and time at which the system will stop trying to send the email.
StatusThe status of the email (ready, sent, failed, etc).
Status MessageA message associated with the status, such as the reason for failure.
Email SubjectThe subject of the email.
Email MessageThe message of the email.
FromThe email address the message is being sent from.
ToA list of the email addresses the email will be sent to.
CcA list of the email addresses the email will be Cc to.
BccA list of the email addresses the email will be Bcc to.
Creator NameThe name of the PhixFlow object which created the email.
Creator TypeThe type of the PhixFlow object which created the email.
Zip all attachmentsWhether any attachments are being added as a zip file.
Zip file nameThe name of the attached zip file.

Anchor
AuditSummary
AuditSummary
Audit Summary

Summary details of audited actions performed on PhixFlow objects.

All Audit Summaries can be viewed from the Audit Summary tab on the System Console. 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.

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.

Audit Details

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

Form: Audit Details

FieldDescription
Audit DetailsA detailed description of the audited action.

Forms: Audit Summary for Object

This form shows summary details of audited actions performed on a particular PhixFlow object.

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.

Anchor
systemConsoleArchiveLog
systemConsoleArchiveLog
Archive Log

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:

FieldDescription
Archive TimeDate and time of the Archive task.
Archive TaskThe name of the Archive Task.
Stream Sets ArchivedThen number of Stream Sets archived.
Archive FileThe name of the compressed zip file created to contain the archived data.

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

Image Added

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.