GENJ1100 - Generate XML File from System Log

Purpose

To create an XML file from a system log created by a Callista job.

SubSystem

System

Normally Run By System Specialist
Anticipated Frequency To be run as required
Structure  Block Generate XML File from System Log
Tab Parameters

  

This job allows an administrator to select a system log file that was created when a job was run, and generate an XML file. This process does not create any new data, it simply changes the format of the log file derived by another job. All records in the selected log are included in the XML file.

The job's definition details allow the system output type to be defined as XML. The file extension will be XML.

The user can have the XML delivered as an email attachment using standard Callista Job Scheduler functionality. The file is viewable in the Internet Explorer and Firefox web browsers.

This job can also be used in conjunction with other log type jobs to generate an XML file containing the data that was logged by the previously run job.

An administrator is able to select a System Log Type, and then a specific job run instance of the selected job.

The output file is opened in the default job output directory. If the output directory cannot be found, then an error is raised and the job fails. Likewise, if the output file cannot be opened for writing or writing fails during a write attempt.

This job is accessed from the Main Menu, or from JBSF5210 or JBSF5300 (display only). It can be run for HE or VET sector system log files.

 

The Generate XML File from System Log block contains:

Parameters Tab

  • Log Level (poplist)

Select either...

  • Use Log from Current Request (check box)

Or

  • Log Type (LOV)
  • Previous Log (LOV)

Rules/Notes:

Log Level - Used to select the alert level of messages (for example, error, warning, or information) and the message number. Records that appear in the output XML are filtered by these parameters.

Use Log from Current Request check box - this check box should only be selected when GENJ1100 is scheduled to run in conjunction with another job (via JBSF5210).

If this check box is selected:

  • And if an extract is created by another job that is included in the same request as this job (in JBSF5210), then the Use Log from Current Request check box can be used to create an XML file for this extract.
  • The job automatically looks for an extract generated by a job in the same job request.
  • The Log Type and Previous Log fields are disabled.
  • And if no extract file is created for a COMPLETED job run in this request, then a message is logged to the RUN_LOG table indicating that no extract was found. If more than one extract exists from the current request, then each record is processed individually (generating a separate file).

Log Type - Used to select a System Log Type for which an XML file is created. Once a Log Type is selected, the number of records listed in the LOV for the Previous Log parameter is automatically reduced to those that relate to the selected Log Type.

Previous Log - Mandatory, except if the 'Use Log from Current Request' check box is checked, then this parameter is optional.
The user has the option of selecting any previously run log, even ones that were not created by the immediately previous job, and creating from this an XML file.

Using Stylesheets from the S_LOG_TYPE Table.

If a stylesheet (XSLT) is specified in the stylesheet column of the S_LOG_TYPE table, then the XML tags are given meaningful names reflective of the data stored within them, i.e. after the columns that appear in the S_LOG_ENTRY and S_MESSAGE tables. Otherwise the XML tags are named after the column names of the S_LOG_ENTRY tables.

Rules/Notes:

There is no provision to alter the stylesheet through Callista SMS product, so changes to the stylesheets need to be made by administrators directly on the back-end database table (S_LOG_TYPE).

The columns S_MESSAGE and ALERT_TYPE from S_MESSAGE also appear in the XML output, in additional to the columns in S_LOG and S_LOG_ENTRY.

 

Last Modified on 28 June, 2010 1:06 PM

History Information

Release Version Project Change to Document
12.0.0.3 1646 - Skills VIC FEE-HELP Reporting New Help page