Task Logs
The Task Logs tab in 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.
The following buttons are available at the top of the System Console:
Press this to bring up the System Logging Configuration. From this form, analysis logging properties can be configured. | |
Press this to bring up the task plan list. |
There are five tabs available to show information about the system:
Anchor | ||||
---|---|---|---|---|
|
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:
...
. |
The following details are available for each log file:
Field | Description |
---|---|
Started | The date and time that this Analysis run was started. |
Finished | The date and time that this Analysis run finished. |
Archive Time | The date and time that this Log File was archived. |
Name | The name of the Task which has been run. |
Cancelled | Whether this Analysis run was cancelled by a user. |
Status | An 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. |
Tasks | The number of individual Tasks that were run as part of this Analysis run. |
Messages | The total number of messages in the Log File. |
Info | The number of information messages contained in the Log File. |
Errors | The number of error messages contained in the Log File. |
Warnings | The number of warning messages contained in the Log File. |
Initiator Type | The PhixFlow object that was used to launch this Analysis run. |
Login name | The user that stated this run. |
Action | Whether 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 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:
Apply a filter to the list of Completed Tasks. | |
Refresh the list of Completed Tasks. |
Log Messages
The Log Messages for the currently selected Task. The user can drill down on each message to see further detail.
Forms: Log Message
All Log Messages can be viewed in the Task Logs view. Any Analysis Task will generate a Log File, containing a number of Log Messages. While a task is running the Log File can be viewed in the Active Tasks list in the Task Log view, once it has finished it can be viewed in the Completed Tasks list.
...
If the stream sets generated by an analysis run were rolled back, the log file entry will have a button 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:
Field | Description |
---|---|
Type | The type of message e.g. INFO, WARN, ERROR or DEBUG |
Code | The |
numeric error message code. | |
Message | The summary message output by the analysis engine. |
The following fields are displayed through a separate tab within the main log message formbuttons are available for log messages:
Apply a filter to the list of log messages. | |
Refresh the list of log messages. |
Log message details
Double-click on a log message to see further details. In addition to the standard fields, you will also find, on its own tab, the message detail:
Field | Description |
---|---|
Message Detail | Displays 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. |
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.
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:
- 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.
- 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:
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:
Attempt to run analysis again for any failed Stream Sets. | |
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. | |
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:
...
...
Attempt to run analysis again for any failed Stream Sets.
...
...
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.
...
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.
...
The stream set in the console also provides the following buttons:
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. | |
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 | ||||
---|---|---|---|---|
|
Field | Description |
---|---|
Cycle | The analysis cycle in which the file was processed. |
Processed At | Date and time that file was processed |
Type | Imported or Exported |
File Importer/Exporter | The Importer or Exporter used to handle this file. |
Status | Status of the file. |
Records | The number of records in the file. |
FTP Site | The FTP Site the underlying file handler is attached to, if there is one. |
Location | The location of the file on the file system. |
Anchor | ||||
---|---|---|---|---|
|
Emails which have been created by the system, from task plans or file exporters.
Field | Description |
---|---|
Created Date/Time | The date and time at which the email was created. |
Send by Date/Time | The date and time at which the system will stop trying to send the email. |
Status | The status of the email (ready, sent, failed, etc). |
Status Message | A message associated with the status, such as the reason for failure. |
Email Subject | The subject of the email. |
Email Message | The message of the email. |
From | The email address the message is being sent from. |
To | A list of the email addresses the email will be sent to. |
Cc | A list of the email addresses the email will be Cc to. |
Bcc | A list of the email addresses the email will be Bcc to. |
Creator Name | The name of the PhixFlow object which created the email. |
Creator Type | The type of the PhixFlow object which created the email. |
Zip all attachments | Whether any attachments are being added as a zip file. |
Zip file name | The name of the attached zip file. |
Anchor | ||||
---|---|---|---|---|
|
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
Field | Description |
---|---|
Date/Time | The date/time the audited action took place. |
Username | Name of the User who performed the audited action. |
Action Summary | A summary description of the audited action. |
Audit Details
The Audit Details of an audited action can be viewed with the details of an individual Audit Summary.
Form: Audit Details
Field | Description |
---|---|
Audit Details | A 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.
Field | Description |
---|---|
Date/Time | The date/time the audited action took place. |
Username | Name of the User who performed the audited action. |
Original Name | Original Name of the Object that was changed. i.e. if the name of the object was up dated, this is the original value. |
Action Description | A summary description of the action. |
Anchor | ||||
---|---|---|---|---|
|
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:
Field | Description |
---|---|
Archive Time | Date and time of the Archive task. |
Archive Task | The name of the Archive Task. |
Stream Sets Archived | Then number of Stream Sets archived. |
Archive File | The name of the compressed zip file created to contain the archived data. |
Form Icons
The form provides some of the standard form icons. When viewing the list of Archive Logs from the System Console, the following icon is also available:
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.
Field | Description |
---|---|
Stream Name | The name of the Stream that was archived. |
From Date | The From Date of the Stream Set archived. |
To Date | The To Date of the Stream Set archived. |
Records Archived | The number of records in the Stream Set archived. |
Partial Archive | Ticked if the archive was only partial. |