Handler - forwardAsXMLFile

Note: To use this agent the file PAMXML.jar must be in your Java classpath. This requires you to modify ipam.bat or ipam12.bat.

Description

Creates an XML representation of an iPAM product including the products attributes. Uses the following primary tags:

The order and values of the XML elements depend on the structure and type of product, while the structure of the XML will conform to the following Document Type Definition (DTD):

 <!ELEMENT Container (Property+,(Content|Container)*)>
 <!ELEMENT Content (Property+,(StringValue|A|Filename|ByteValue)?)>
 <!ELEMENT Filename (#PCDATA)>
 <!ELEMENT Property (Value*)>
 <!ATTLIST Property name CDATA #IMPLIED>
 <!ELEMENT A (#PCDATA)>
 <!ATTLIST A HREF CDATA #IMPLIED>
 <!ELEMENT ByteValue (#PCDATA)>
 <!ELEMENT StringValue (#PCDATA)>
 <!ELEMENT Value (#PCDATA)>
      

Configuration Variables

productAttributesToExclude
A list of product properties that should not appear in the XML. By default the attributes lifeTimeLong, mementoUid, and description are excluded

xmlOutputFileName

Optional name for the XML file.  If one is not supplied a "random" name will be used that changes every time the agent is used.

Product

The output product is a BasicProduct that contains the newly created XML file as content. See the example output below.

How it Works

The agent uses the AsXML product visitor to create the XML file. The resultant file is then stored in a BasicProduct with a FileRef content.

Example Output

 This example was created by using two getPIM1 agents to input to the forwardAsXMLFile agent.

  <?xml version="1.0" ?>
  <Container>
    <Property name="knownContentProperties">
     <Value>description</Value>
     <Value>id</Value>
     <Value>lifeTimeLong</Value>
   </Property>
   <Property name="description">
     <Value />
   </Property>
   <Property name="id">
     <Value>Multiple products</Value>
   </Property>
   <Property name="lifeTimeLong">
     <Value>259200</Value>
   </Property>
   <Content>
     <Property name="description">
       <Value>Creates a string product</Value>
     </Property>
     <Property name="id">
       <Value>AdmingetPIM12</Value>
     </Property>
     <Property name="lifeTimeLong">
       <Value>259200</Value>
     </Property>
     <StringValue><content></StringValue>
   </Content>
   <Content>
     <Property name="description">
       <Value>Creates a string product</Value>
     </Property>
     <Property name="id">
       <Value>AdmingetPIM11</Value>
     </Property>
     <Property name="lifeTimeLong">
       <Value>259200</Value>
     </Property>
     <StringValue><content></StringValue>
   </Content>
  </Container>
   

Revised: 12 November 1999