GENJ1000 - Generate Extract XML File

Purpose

The creates an XML file for an extract file created by a Callista job

SubSystem

System

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

  

This job allows the user to select an extract that has been created and create an XML file of that extract. It does not create any new data it just changes the format of an extract derived by another job. The file extension will be XML. If the Use Extract from Current Request check box is selected then the job automatically looks for an extract generated by a job in the same job request.
The XML file created, contains all the records included in the selected extract. It has XML tags that are named after the columns that appear in the S_EXTRACT and S_EXTRACT_RECORD tables, unless an XSLT stylesheet is defined for the S_EXTRACT_TYPE of the extract (this is defined on the S_EXTRACT_TYPE table).

The user can have the XML delivered as an email attachment using standard Callista Job Scheduler functionality.
The system output type in the job details form (JBSF4110) is defined as XML.

If the 'Use Extract from Current Request' checkbox is selected but 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).

The output file is opened in the default job output directory, and is named <s_extract_type>-<creation_dt>.xml. If the output directory can not 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.

 

The Generate Extract XML File block contains:

Parameters Tab

  • Use Extract from Current Request check box
  • System Extract Type
  • Previous Extract

Rules/Notes:

If an extract is created by another job which is included in the same request as this job (in JBSF5210) then the Use Extract from Current Request checkbox can be used to create an XML file for this extract.

When the Use Extract from Current Request check box is selected then the other fields on the parameter form are disabled and cleared. When it is not selected, the rest of the fields are enabled.

The Extract Type field acts as a filter to reduce the number of records displayed by the Previous Extract LOV.

The Previous Extract LOV displays in order of creation date (Most recent first).

Using Stylesheets from the S_EXTRACT_TYPE table.

If a stylesheet (XSLT) is specified in the stylesheet column of the S_EXTRACT_TYPE table, then the XML tags will be given meaningful names reflective of the data stored within them, otherwise the XML tags will be named after the column names of the extract 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_EXTRACT_TYPE).
If the stylesheet or the data source are in any way corrupted or improperly formatted, a warning is logged to inform the user and the processing should continue (returning the un-transformed data source).

Effect of stylesheets on the XML file
a. Data source generated by XML engine
This data source segment is generated by the XML engine ran directly on the S_EXTRACT_RECORD table, no transformation has been applied:

<DOCUMENT>
      <DOC>
                        <ROWSET>
                                        <ROW>
                                                                <S_EXTRACT_TYPE>ACAD-TRANS</S_EXTRACT_TYPE>
<CREATION_DT>13/03/2003 12:26:25</CREATION_DT>
<SEQUENCE_NUMBER>2696681</SEQUENCE_NUMBER>
<KEY1>4</KEY1>
<KEY2>PATRICK</KEY2>
<KEY3>JON</KEY3>
<KEY4></KEY4>
<KEY5></KEY5>
<KEY6></KEY6>
<KEY7></KEY7>
<KEY8></KEY8>
<KEY9></KEY9>
<KEY10></KEY10>
<RECORD_TYPE>PERSON</RECORD_TYPE>
<TEXT>4|PATRICK||JON||01/01/1970</TEXT>
<UPDATE_WHO>SIS_OWNER</UPDATE_WHO>
<UPDATE_ON>6/12/2007 17:05:01</UPDATE_ON>
                                                </ROW>
                                                <ROW>
                                                                <S_EXTRACT_TYPE>ACAD-TRANS</S_EXTRACT_TYPE>
<CREATION_DT>13/03/2003 12:26:25</CREATION_DT>
<SEQUENCE_NUMBER>2696682</SEQUENCE_NUMBER>
<KEY1>4</KEY1>
<KEY2>PATRICK</KEY2>
<KEY3>JON</KEY3>
<KEY4></KEY4>
<KEY5></KEY5>
<KEY6></KEY6>
<KEY7></KEY7>
<KEY8></KEY8>
<KEY9></KEY9>
<KEY10></KEY10>
<RECORD_TYPE>ADDRESS</RECORD_TYPE>
<TEXT>1 TEST STREET|ADELAIDE|SA|||4000||POSTAL|19/12/2001|</TEXT>
<UPDATE_WHO>SIS_OWNER</UPDATE_WHO>
<UPDATE_ON>6/12/2007 17:05:01</UPDATE_ON>
                                                </ROW>
                                                <ROW>…


b) Data source after XML transformation
The data source segment below is generated by the XML engine and then transformed using a customised (example) stylesheet.

<PERSON_EXTRACT>
        <PERSON>
                        <PERSON_ID>4</PERSON_ID>
                        <FIRST_NAME>PATRICK</FIRST_NAME>
                        <SURNAME>JON</SURNAME>
                        <DOB>01/01/1970</DOB>
                        <ADDRESS>
                                        <STREET_ADDR>1 TEST STREET</STREET_ADDR>
                                        <CITY>ADELAIDE</CITY>
                                        <STATE>SA</STATE>
                                        <POSTCODE>4000</POSTCODE>
                                        <ADDT_TYPE>POSTAL</ADDR_TYPE>
                                        <ADDR_START_DT>19/12/2001</ADDR_START_DT>
                                        <ADDR_END_DT></ADDR_END_DT>
                        </ADDRESS>
</PERSON>
</PERSON_EXTRACT>

           

 

Last Modified on 11 October, 2010 3:13 PM

History Information

Release Version Project Change to Document
13.1 1400 - Calipso 30701 Changed 'Extract Type' parameter to be 'System Extract Type'
11.0.0.0.0.0 1360 - ESOA Compliance 2008 Part 1 New Help page