Previous Topic: The Index Record

Next Topic: Creating CSV Files Using the Report Writer


Optional iCan Service Management Suite XML Profiles

In addition to the CSV members and Index Records, CA JARS provides the option of generating an XML Profile for the CSV report. This XML profile enables the iCan Service Management Suite product to process the CSV reports that are produced by CA JARS, and on behalf of CA JARS by CA Earl. The XML Profile produced is a well-formed XML document that describes the data in the CSV report's data records. The following XML tags are generated in the document (note that the indentation reflects the parent/child tag relationship within the document).

<--   -->  - These lines are comments to XML parsers.  They are used
             to indicate the date and time of generation, as well as the
             Job Name that created the XML Profile.

<root> - The base tag for the document

  <profile> - Indicates this is a data profile

    <profile_name> - This is the member name in the PDS of the profile

    <domain_name> - Not used

    <profile_type> - The profile type, which is always 1, indicating the
                     CSV file reports metrics.

    <is_data_file_fixed_length> - Indicates if the data records are
                                  fixed formats (value = 1) or variable
                                  (value = 0).  For CA JARS,
                                  this is always 0.

    <field_separator> - This indicates what character is used to
                        separate objects on the data lines.  It is an
                        integer representation of an ASCII character.
                        In most cases the value will be '44', which
                        represents a comma (ASCII code X'2C') or '59',
                        which represents a semicolon (ASCII code X'3B').

    <build_sql_query> - Not used

    <comment> - This is set to the title of the Report as indicated
                in the CA JARS input statements.

    <field> - Description of each field.  There is one field element
              per column heading in the dictionary record of the CSV
              member.

      <display_name> - This is the column heading text.

      <data_type> - The type of data this field represents:

                      0 - Character string
                      1 - Integer
                      2 - Floating Point Number
                      3 - Date stamp

      <data_length> - Size of character data, unused for other types

      <data_format> - Date stamp formats, unused for other types

      <default_value> - The default value for a column if not present.
                        This is not used by CA JARS


      <start_position> - For variable length data files like the
                         CA JARS files, this indicates which
                         element in a line this field definition covers.

      <end_position> - This is not used by CA JARS

Note: There is no time format for iCan Service Management Suite XML profiles. Times are considered 8-byte strings. String manipulation is needed to process time information within iCan Service Management Suite.

If the CSV files are generated using the CA Earl product, all numeric fields are treated as floating point values, and all character strings and date stamps are treated as character strings.

The following sample XML Profile is generated by CA JARS along with the sample CSV Output that is mapped by the profile.

<!-- ======================================== -->
<!-- Generated by JARS     Version n.n        -->
<!-- Date Generated:2003-08-14 at 09.32.54    -->
<!-- CSV Member:JOBINFO  CSV Key:K1D9         -->
<!-- ======================================== -->
<root>
<profile>
<profile_name>PRFINFO</profile_name>
<domain_name/>
<profile_type>1</profile_type>
<is_data_file_fixed_length>0</is_data_file_fixed_length>
<field_separator>44</field_separator>
<build_sql_query/>
<comment>SAMPLE CSV REPORT</comment>
<field>
<display_name>JOB NAME</display_name>
<data_type>0</data_type>
<data_length>8</data_length>
<data_format/>
<default_value/>
<start_position>1</start_position>
<end_position/>
</field>
<field>
<display_name>USER ID</display_name>
<data_type>0</data_type>
<data_length>8</data_length>
<data_format/>
<default_value/>
<start_position>2</start_position>
<end_position/>
</field>
<field>
<display_name>RDR STRT DATE</display_name>
<data_type>3</data_type>
<data_length/>
<data_format>YY/MM/DD</data_format>
<default_value/>
<start_position>3</start_position>
<end_position/>
</field>
<field>
<display_name>RDR STRT TIME</display_name>
<data_type>0</data_type>
<data_length>8</data_length>
<data_format/>
<default_value/>
<start_position>4</start_position>
<end_position/>
</field>
<field>
<display_name>JOB NBR</display_name>
<data_type>1</data_type>
<data_length/>
<data_format/>
<default_value/>
<start_position>5</start_position>
<end_position/>
</field>
<field>
<display_name>CPU TIME</display_name>
<data_type>0</data_type>
<data_length>8</data_length>
<data_format/>
<default_value/>
<start_position>6</start_position>
<end_position/>
</field>
<field>
<display_name>CC</display_name>
<data_type>0</data_type>
<data_length>4</data_length>
<data_format/>
<default_value/>
<start_position>7</start_position>
<end_position/>
</field>
<field>
<display_name>ELAPSED TIME</display_name>
<data_type>0</data_type>
<data_length>8</data_length>
<data_format/>
<default_value/>
<start_position>8</start_position>
<end_position/>
</field>
<field>
<display_name>PERCENT TOTAL</display_name>
<data_type>2</data_type>
<data_length/>
<data_format/>
<default_value/>
<start_position>9</start_position>
<end_position/>
</field>
<field>
<display_name>ELAP PAGE</display_name>
<data_type>1</data_type>
<data_length/>
<data_format/>
<default_value/>
<start_position>10</start_position>
<end_position/>
</field>
</profile>
</root>

The following CSV output corresponds to the XML profile on the previous pages:

"HCSV","0000","JARS","C.0","20030814","093254","JOBINFO","CAI","JARS",10,0000,"K1D9"," ","SAMPLE CSV
"JOB NAME","USER ID","RDR STRT DATE","RDR STRT TIME","JOB NBR","CPU TIME","CC","ELAPSED TIME","PERCENT
"RXQUMON","STCSYS","03/07/07","19:26:14",00422,"00:00:01","0000","01:00:01",.000,0
"ABBCH02","ABBCH02","03/07/08","10:30:01",0,"00:00:00","S622","00:01:53",.000,0
"ABEWI01","ABEWI01","03/07/08","09:37:31",0,"00:00:00","0000","00:34:17",.000,0
"ANDMA02","ANDMA02","03/07/08","10:19:16",0,"00:00:02","0000","00:39:48",.000,0
"ANDMA02P","ANDMA02","03/07/08","10:49:54",05300,"00:00:08","0000","00:01:00",.000,6
"ANTAS000","+ANTAS00","03/07/05","22:21:10",0,"00:00:00","0000","01:00:00",.000,0
"ANTMAIN","+ANTMAIN","03/07/05","22:21:01",0,"00:00:00","0000","01:00:00",.000,0
"APPC","APPC","03/07/05","22:23:50",0,"00:00:00","0000","01:00:00",.000,0
"AREAS01","AREAS01","03/07/08","07:36:54",0,"00:00:04","0000","01:07:15",.000,0
"ASCH","STCSYS","03/07/05","22:23:50",0,"00:00:00","0000","01:00:00",.000,0
"ASTEX","STCSYS","03/07/05","22:23:50",08059,"00:01:14","0000","01:00:00",.000,0
"AWSTART6","AWADMIN","03/07/05","22:25:01",00000,"00:00:00","0000","01:00:00",.000,0
"AWSTART7","AWADMIN","03/07/05","22:25:03",00000,"00:00:01","0000","01:00:00",.000,0
"AWSTART8","AWADMIN","03/07/05","22:25:08",00000,"00:00:02","0000","01:00:00",.000,0