898 lines
27 KiB
HTML
898 lines
27 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Software components DTD</title>
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- UNIX11 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
|
||
|
|
<!-- RCHVMW2 on 1 Jun 1999 at 16:14:12 -->
|
||
|
|
<!-- Edited by James Masanz July 03 -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Software components DTD</h2>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<p>This Document Type Declaration (DTD) contains the structure of the elements
|
||
|
|
needed to describe software components. XML documents conforming to this
|
||
|
|
structure are provided to and returned by
|
||
|
|
the i5/OS Registered Application Information Repository APIs.</p>
|
||
|
|
|
||
|
|
<p>If a character encoding is specified in your XML document,
|
||
|
|
it must be specified in the XML declaration.
|
||
|
|
If the encoding is not specified then the XML processor will assume
|
||
|
|
UTF-8 as the character encoding.</p>
|
||
|
|
|
||
|
|
<p>The DTD for the Registered
|
||
|
|
Application Information Repository APIs
|
||
|
|
is contained in the stream file located at
|
||
|
|
/QIBM/XML/DTD/QszRegAppInfoRepository.dtd.</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<?xml version='1.0' encoding='utf-8' ?>
|
||
|
|
|
||
|
|
<!-- RegAppInfoRepository must be the root element of the XML document
|
||
|
|
Contains 0 to n Component elements -->
|
||
|
|
<!ELEMENT RegAppInfoRepository (Component)*>
|
||
|
|
|
||
|
|
<!-- The RegAppInfoRepository element also must contain a
|
||
|
|
DTDVersion attribute -->
|
||
|
|
<!ATTLIST RegAppInfoRepository DTDVersion CDATA #REQUIRED >
|
||
|
|
|
||
|
|
<!-- Component element defines a separately installable piece of an
|
||
|
|
application. May contain an ExtendedData element -->
|
||
|
|
<!ELEMENT Component (ExtendedData?)>
|
||
|
|
|
||
|
|
<!-- The component also must contain the following attribute list:
|
||
|
|
ProductName - describes the name of the product the Component belongs to
|
||
|
|
ComponentName - describes the name of the component
|
||
|
|
|
||
|
|
Optionally it may contain the following attribute list:
|
||
|
|
ComponentVersion - the version of the component
|
||
|
|
Instance - used to differentiate among copies of the same
|
||
|
|
component
|
||
|
|
FeatureName - describes the feature of the component
|
||
|
|
ComponentVendor - describes the name of the vendor who created the
|
||
|
|
component
|
||
|
|
PackagedProduct - indicates this component is an i5/OS packaged
|
||
|
|
product, "0" means the component is not an i5/OS
|
||
|
|
packaged product "1" means the component is an
|
||
|
|
i5/OS packaged product, if the attribute
|
||
|
|
is not specified then "0" is assumed -->
|
||
|
|
<!ATTLIST Component ProductName CDATA #REQUIRED
|
||
|
|
ComponentName CDATA #REQUIRED
|
||
|
|
ComponentVersion CDATA #IMPLIED
|
||
|
|
Instance CDATA #IMPLIED
|
||
|
|
FeatureName CDATA #IMPLIED
|
||
|
|
ComponentVendor CDATA #IMPLIED
|
||
|
|
PackagedProduct (0|1|_) "0" >
|
||
|
|
|
||
|
|
<!-- ExtendedData element contain additional information related to the
|
||
|
|
component. May contain a Shared element, a ProductDescription element,
|
||
|
|
a Files element and zero or more AdditionalValue elements -->
|
||
|
|
<!ELEMENT ExtendedData (Shared?,
|
||
|
|
ProductDescription?,
|
||
|
|
Files?,
|
||
|
|
AdditionalValue*)>
|
||
|
|
|
||
|
|
<!-- The ExtendedData element may contain the following attribute list:
|
||
|
|
Installed - indicates if the component is installed, "0" means
|
||
|
|
not installed "1" means installed, if the attribute
|
||
|
|
is not specified then installed ("1") is assumed
|
||
|
|
Supported - indicates if the component is supported, "0" means
|
||
|
|
not supported, "1" means supported, this is attribute
|
||
|
|
is optional
|
||
|
|
UninstallInfo - describes the procedure to uninstall the component
|
||
|
|
LastFixPackApplied - contains the last fixpack applied to the component
|
||
|
|
InstallerType - describes the type of installer
|
||
|
|
CCSID - the CCSID of the information provided -->
|
||
|
|
<!ATTLIST ExtendedData Installed (0|1|_) "1"
|
||
|
|
Supported (0|1|_) #IMPLIED
|
||
|
|
UninstallInfo CDATA #IMPLIED
|
||
|
|
LastFixPackApplied CDATA #IMPLIED
|
||
|
|
InstallerType CDATA #IMPLIED
|
||
|
|
CCSID CDATA #IMPLIED >
|
||
|
|
|
||
|
|
<!-- Shared element it should be present when this is a shared component -->
|
||
|
|
<!ELEMENT Shared (SharingComponent)+>
|
||
|
|
|
||
|
|
<!-- SharingComponent element contains information of the component
|
||
|
|
which is using this component, although this is an empty element,
|
||
|
|
the information is provided as attributes -->
|
||
|
|
<!ELEMENT SharingComponent EMPTY>
|
||
|
|
|
||
|
|
<!-- The sharing component must contain the following attribute list:
|
||
|
|
ProductName, ComponentName
|
||
|
|
Optionally it may contain the following attribute list:
|
||
|
|
ComponentVersion, Instance, FeatureName, ComponentVendor -->
|
||
|
|
<!ATTLIST SharingComponent ProductName CDATA #REQUIRED
|
||
|
|
ComponentName CDATA #REQUIRED
|
||
|
|
ComponentVersion CDATA #IMPLIED
|
||
|
|
Instance CDATA #IMPLIED
|
||
|
|
FeatureName CDATA #IMPLIED
|
||
|
|
ComponentVendor CDATA #IMPLIED >
|
||
|
|
|
||
|
|
<!-- ProductDescription element contains the description of the product -->
|
||
|
|
<!ELEMENT ProductDescription EMPTY>
|
||
|
|
|
||
|
|
<!-- The ProductDescription element must contain the following
|
||
|
|
attribute list:
|
||
|
|
MessageLibrary - contains the name of the message file library
|
||
|
|
MessageFile - contains the name of the message file
|
||
|
|
MessageID - the message id which contains the description
|
||
|
|
of the product -->
|
||
|
|
<!ATTLIST ProductDescription MessageLibrary CDATA #REQUIRED
|
||
|
|
MessageFile CDATA #REQUIRED
|
||
|
|
MessageID CDATA #REQUIRED >
|
||
|
|
|
||
|
|
<!-- Files element contains the list of the application files
|
||
|
|
at least one Directory element should be specified when this
|
||
|
|
element is used to add/update information in the Registered Application
|
||
|
|
Information Repository, when information about all files wants to be
|
||
|
|
removed from the repository then this element can be empty -->
|
||
|
|
<!ELEMENT Files (Directory)*>
|
||
|
|
|
||
|
|
<!-- Directory element contains a full directory path name (as an attribute)
|
||
|
|
and may contain a set of FileName elements -->
|
||
|
|
<!ELEMENT Directory (FileName)*>
|
||
|
|
|
||
|
|
<!-- The Directory element must contain the following attribute:
|
||
|
|
DirectoryName - contains the full directory path name -->
|
||
|
|
<!ATTLIST Directory DirectoryName CDATA #REQUIRED >
|
||
|
|
|
||
|
|
<!-- FileName element contains the name of a file -->
|
||
|
|
<!ELEMENT FileName (#PCDATA)>
|
||
|
|
|
||
|
|
<!-- AdditionalValue element can be used to store any information useful to the
|
||
|
|
installer or application -->
|
||
|
|
<!ELEMENT AdditionalValue EMPTY>
|
||
|
|
|
||
|
|
<!-- The AdditionalValue element must contain the following attribute:
|
||
|
|
ValueName - The name of a user defined piece of information
|
||
|
|
|
||
|
|
Optionally it may contain the following attributes:
|
||
|
|
ValueID - Should be specified if the user wants to store more than
|
||
|
|
one additional value with the same ValueName.
|
||
|
|
Value - contains a user defined value associated to the ValueName -->
|
||
|
|
<!ATTLIST AdditionalValue ValueName CDATA #REQUIRED
|
||
|
|
ValueID CDATA #IMPLIED
|
||
|
|
Value CDATA #IMPLIED >
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p><strong><a name="Header">DTD Element and Attribute
|
||
|
|
Descriptions</a>: </strong> The maximum length of each element
|
||
|
|
or attribute value is 15360 UCS-2 characters unless otherwise
|
||
|
|
specified.</p>
|
||
|
|
|
||
|
|
<table cellpadding="3">
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>AdditionalValue element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element has been defined to store information that is only useful to
|
||
|
|
the installer or application. Any number of repetitions of this element
|
||
|
|
can be defined. This element
|
||
|
|
has to contain the following attribute:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ValueName</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Optionally it may contain one of each of the following attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ValueID</li>
|
||
|
|
|
||
|
|
<li>Value</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Here is an example of the use of this element for i5/OS packaged products:
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="PrimLangLoadId" Value="2924"/>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Although <strong>PrimLangLoadId</strong> is not an element defined by the DTD,
|
||
|
|
it will be stored as an AdditionalValue to improve queries.
|
||
|
|
|
||
|
|
<p>A user who wants to retrieve this value can use the list API and
|
||
|
|
include the following in the input:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="PrimLangLoadId" Value=""/>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="PrimLangLoadId" />
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p>Another use of the AdditionalValue element can be for an installer to
|
||
|
|
record the progress of an
|
||
|
|
install. For example, an installer could be written to call the update API several
|
||
|
|
times during the installation process, as follows:</p>
|
||
|
|
|
||
|
|
<ol type="1">
|
||
|
|
<li>The installer registers the component being installed and also defines an
|
||
|
|
additional value called "State" and sets its value to "Registered". (The
|
||
|
|
example only shows the AdditionalValue element).
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="State" Value="Registered"/>
|
||
|
|
</pre>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The installer creates a set of directories and then calls the update API to
|
||
|
|
set the AdditionalValue element with the
|
||
|
|
"State" ValueName to a new
|
||
|
|
Value "DirsCreated".
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="State" Value="DirsCreated"/>
|
||
|
|
</pre>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The installer copies all files to the corresponding directories and calls
|
||
|
|
the update API to set the "State" tag to "FilesCopied"
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="State" Value="FilesCopied"/>
|
||
|
|
</pre>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The installer creates some user profiles to finish its installation and
|
||
|
|
then calls the update API to update the "State" to "Complete".
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<AdditionalValue ValueName="State" Value="Complete"/>
|
||
|
|
</pre>
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<p>The previous example was used only to illustrate a possible use for
|
||
|
|
the AdditionalValue
|
||
|
|
element. This does not mean that "State", "Registered", "DirsCreated", and so on
|
||
|
|
are elements or attributes
|
||
|
|
defined by this DTD. These values are free format, so they may
|
||
|
|
contain any character value.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>CCSID attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The CCSID for the values specified in the attribute and element
|
||
|
|
values.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Component element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element describes a software component - a separately
|
||
|
|
installable piece of an application. This element must contain the following
|
||
|
|
attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ProductName</li>
|
||
|
|
|
||
|
|
<li>ComponentName</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>This element may contain the following attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ComponentVersion</li>
|
||
|
|
|
||
|
|
<li>Instance</li>
|
||
|
|
|
||
|
|
<li>FeatureName</li>
|
||
|
|
|
||
|
|
<li>ComponentVendor</li>
|
||
|
|
|
||
|
|
<li>PackagedProduct</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>This element may also contain an <strong>ExtendedData</strong> element.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ComponentName attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The name of the component. It is composed of character data and its
|
||
|
|
length must not be greater than 256 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ComponentVendor attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The name of the creator of the component. It is composed of
|
||
|
|
character data and its length must not be greater than 256 UCS-2
|
||
|
|
characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ComponentVersion attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The version of the component. It is composed of character
|
||
|
|
data and its length must not be greater than 64 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>DTDVersion attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The version of the DTD the XML document should be validated
|
||
|
|
against.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Directory element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element identifies a directory and optionally a set of files that are
|
||
|
|
part of the software component. This element has to contain a <strong>
|
||
|
|
DirectoryName</strong> attribute and zero or more <strong>FileName</strong>
|
||
|
|
elements.</p>
|
||
|
|
|
||
|
|
<p>When FileName elements are specified it means they belong in
|
||
|
|
the directory named in the <strong>DirectoryName</strong>
|
||
|
|
attribute of the Directory element where they were specified.</p>
|
||
|
|
|
||
|
|
<p>The following is an example of how a user could specify this element.</p>
|
||
|
|
|
||
|
|
<p>Suppose a user wants to register the following:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin (directory)
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin/edit1.exe (file)
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin/edit2.exe (file)
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin/edit3.exe (file)
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin/edit4.exe (file)
|
||
|
|
/ProgramFiles/XYZTools/Editor/bin/edit5.exe (file)
|
||
|
|
/ProgramFiles/XYZTools/Editor/Personal (directory)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p>The Files element in the XML document could be specified as follows:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<Files>
|
||
|
|
<Directory DirectoryName="/ProgramFiles/XYZTools/Editor/bin">
|
||
|
|
<FileName>edit1.exe</FileName>
|
||
|
|
<FileName>edit2.exe</FileName>
|
||
|
|
<FileName>edit3.exe</FileName>
|
||
|
|
<FileName>edit4.exe</FileName>
|
||
|
|
<FileName>edit5.exe</FileName>
|
||
|
|
</Directory>
|
||
|
|
<Directory DirectoryName="/ProgramFiles/XYZTools/Editor/Personal">
|
||
|
|
</Directory>
|
||
|
|
</Files>
|
||
|
|
</pre>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>DirectoryName attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The full path name of a directory that is part of this component.
|
||
|
|
It is composed of
|
||
|
|
character data and its length must not be greater than 15360 UCS-2
|
||
|
|
characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ExtendedData element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element contains all other information related to the component. None
|
||
|
|
of the attributes or elements it contains are required. One of each of the
|
||
|
|
following attributes may be contained in this element:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Installed</li>
|
||
|
|
|
||
|
|
<li>Supported</li>
|
||
|
|
|
||
|
|
<li>UninstallInfo</li>
|
||
|
|
|
||
|
|
<li>LastFixPackApplied</li>
|
||
|
|
|
||
|
|
<li>InstallerType</li>
|
||
|
|
|
||
|
|
<li>CCSID</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>It may also contain a <strong>Shared</strong> element, a <strong>
|
||
|
|
ProductDescription</strong> element, a <strong>Files</strong> element and zero
|
||
|
|
or more <strong>AdditionalValue</strong> elements.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>FeatureName attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The component feature. It is composed of character
|
||
|
|
data and its length must not be greater than 64 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>FileName element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The name of a file that is part of the software component.
|
||
|
|
It is composed of character data and its length must not be greater than 256
|
||
|
|
UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Files element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element contains the list of directories and files belonging to the
|
||
|
|
software component. It is composed of 1 to n <strong>Directory</strong>
|
||
|
|
elements.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Installed attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute indicates if this component is currently installed. It can be
|
||
|
|
the character value "0" which means the component is not installed or it can be
|
||
|
|
"1" which means the component is installed. When this attribute is not present
|
||
|
|
or it is empty then the default value is "1" which means <strong>
|
||
|
|
installed</strong>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>InstallerType attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The type of installer used to install this
|
||
|
|
software component. It is composed of character data. Some types of installers
|
||
|
|
are ISJE and RSTLICPGM.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Instance attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The component Instance is useful when a user wants to
|
||
|
|
install more than one copy of the same component on the system.
|
||
|
|
An installer can use this attribute to
|
||
|
|
store any value that allows the installer to differentiate
|
||
|
|
among copies. For example, the path name
|
||
|
|
where this component was installed might be used.
|
||
|
|
This attribute is composed of character data and its length must
|
||
|
|
not be greater than 256 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>LastFixPackApplied attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The last fix pack applied for the component. It is
|
||
|
|
composed of character data.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>MessageID attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The identifier of the message that describes the product option. Its length
|
||
|
|
must not be greater than 7 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>MessageFile attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The name of the message file containing the messages that describe the
|
||
|
|
product and its options. The message file for the base option is considered the
|
||
|
|
message file for the product. Its length must not be greater than 10 UCS-2
|
||
|
|
characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>MessageLibrary attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>The name of the library for the message file that contains the messages
|
||
|
|
describing the product and its options. Its length must not be greater than 10
|
||
|
|
UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>PackagedProduct attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute indicates if the component is a native i5/OS License Program
|
||
|
|
Product including the i5/OS Operating System. It can be the character
|
||
|
|
value "0" which means the component is not a native i5/OS License Program
|
||
|
|
Product or it can be "1"
|
||
|
|
which means it is. When this attribute is not present
|
||
|
|
then the default value is "0".</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ProductName attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This is the name of the software product the component belongs to. It is
|
||
|
|
composed of character data and its length must not be greater than 256 UCS-2
|
||
|
|
characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ProductDescription element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element contains the description of the product. It has to contain the
|
||
|
|
following attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>MessageLibrary</li>
|
||
|
|
|
||
|
|
<li>MessageFile</li>
|
||
|
|
|
||
|
|
<li>MessageID</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>RegAppInfoRepository element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This is the root element of the DTD. There must be 1 of these elements in
|
||
|
|
each XML object. This element must contain a <strong>DTDVersion</strong>
|
||
|
|
attribute and may contain 1 or more <strong>Component</strong>
|
||
|
|
elements.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Shared element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>If present, this element indicates the component is a shared component.
|
||
|
|
Its purpose is to provide an uninstaller with a way to know whether
|
||
|
|
a component is still needed by another product or component.
|
||
|
|
This element contains 1 to n
|
||
|
|
SharingComponent elements.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>SharingComponent element</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This element identifies the component user of this component. This element
|
||
|
|
has to contain the following attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ProductName</li>
|
||
|
|
|
||
|
|
<li>ComponentName</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Optionally it may contain one of each of the following attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ComponentVersion</li>
|
||
|
|
|
||
|
|
<li>Instance</li>
|
||
|
|
|
||
|
|
<li>FeatureName</li>
|
||
|
|
|
||
|
|
<li>ComponentVendor</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Supported attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute indicates if this component is currently supported. It can be
|
||
|
|
the character value "0" which means the component is not supported or it can be
|
||
|
|
"1" which means the component is supported. When this attribute is not present
|
||
|
|
or it is empty then no value is registered in the repository.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>UninstallInfo attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute can be used to describe how to uninstall the component. It is
|
||
|
|
composed of character data.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>Value attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute contains additional information related to the software
|
||
|
|
component and it is identified by the ValueName attribute.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ValueID attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute should be used to differentiate among additional values
|
||
|
|
(AdditionalValue elements) with the same value name (ValueName attribute).</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr valign="TOP">
|
||
|
|
<td>
|
||
|
|
<p><strong>ValueName attribute</strong></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>This attribute identifies a user defined piece of information. Its length
|
||
|
|
should not be greater than 256 UCS-2 characters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong><a name="Header">Additional Specifications and
|
||
|
|
Restrictions</a>: </strong> The percent character (%)
|
||
|
|
and the underline character (_) are allowed
|
||
|
|
only for query purposes.</p>
|
||
|
|
|
||
|
|
<p><strong><a name="HDRPPMAP">i5/OS Packaged Products
|
||
|
|
Considerations</a>: </strong> When
|
||
|
|
the PackagedProduct attribute
|
||
|
|
is present and has a value of "1", the component is part of
|
||
|
|
an i5/OS packaged product.
|
||
|
|
For example:</p>
|
||
|
|
<pre>
|
||
|
|
<Component ProductName="5722SM1" ComponentVendor="04 1-800-IBM-SERV"
|
||
|
|
FeatureName="0000" ComponentName="5050" PackagedProduct="1">
|
||
|
|
...
|
||
|
|
...
|
||
|
|
</Component>
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
The following table describes the
|
||
|
|
mapping of i5/OS Packaged Products information to the elements of the XML
|
||
|
|
document.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<table border>
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Packaged product field</th>
|
||
|
|
<th align="left" valign="top">Corresponding XML element or attribute</th>
|
||
|
|
<th align="left" valign="top">Example of original value</th>
|
||
|
|
<th align="left" valign="top">XML format</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Product ID</th>
|
||
|
|
<th align="left" valign="top">ProductName</th>
|
||
|
|
<th align="left" valign="top">5722SM1</th>
|
||
|
|
<th align="left" valign="top"><Component ProductName="5722SM1" ...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Release</th>
|
||
|
|
<th align="left" valign="top">ComponentVersion</th>
|
||
|
|
<th align="left" valign="top">V5R1M0</th>
|
||
|
|
<th align="left" valign="top"><Component ComponentVersion="V5R1M0"
|
||
|
|
...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Load ID</th>
|
||
|
|
<th align="left" valign="top">ComponentName</th>
|
||
|
|
<th align="left" valign="top">5050</th>
|
||
|
|
<th align="left" valign="top"><Component ComponentName="5050" ...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message File Name
|
||
|
|
|
||
|
|
<p>Message File Library</p>
|
||
|
|
|
||
|
|
<p>Message ID</p>
|
||
|
|
</th>
|
||
|
|
<th align="left" valign="top">ProductDescription</th>
|
||
|
|
<th align="left" valign="top">QSMUMSG
|
||
|
|
|
||
|
|
<p>QSMU</p>
|
||
|
|
|
||
|
|
<p>SMU1601</p>
|
||
|
|
</th>
|
||
|
|
<th align="left" valign="top">
|
||
|
|
<pre>
|
||
|
|
<ProductDescription
|
||
|
|
MessageLibrary="QSMU"
|
||
|
|
MessageFile="QSMUMSG"
|
||
|
|
MessageID="SMU1601" />
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Registration ID (type and value)</th>
|
||
|
|
<th align="left" valign="top">ComponentVendor</th>
|
||
|
|
<th align="left" valign="top">04 1-800-IBM-SERV</th>
|
||
|
|
<th align="left" valign="top"><Component ComponentVendor="04 1-800-IBM-SERV"
|
||
|
|
...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Product option</th>
|
||
|
|
<th align="left" valign="top">Feature</th>
|
||
|
|
<th align="left" valign="top">*BASE</th>
|
||
|
|
<th align="left" valign="top"><Component FeatureName="0000" ...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">CCSID</th>
|
||
|
|
<th align="left" valign="top">CCSID</th>
|
||
|
|
<th align="left" valign="top">00037</th>
|
||
|
|
<th align="left" valign="top"><CCSID>00037</CCSID></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Installed Primary Library</th>
|
||
|
|
<th align="left" valign="top">Instance</th>
|
||
|
|
<th align="left" valign="top">QSMU</th>
|
||
|
|
<th align="left" valign="top"><Component Instance="/QSYS.LIB/QSMU.LIB"
|
||
|
|
...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Delta level</th>
|
||
|
|
<th align="left" valign="top">AdditionalValue</th>
|
||
|
|
<th align="left" valign="top">01</th>
|
||
|
|
<th align="left" valign="top"><AdditionalValue ValueName="DeltaLevel"
|
||
|
|
Value="L01"/></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Allow Mixed Release</th>
|
||
|
|
<th align="left" valign="top">AdditionalValue</th>
|
||
|
|
<th align="left" valign="top">Y</th>
|
||
|
|
<th align="left" valign="top"><AdditionalValue ValueName="AllowMixedRelease"
|
||
|
|
Value="Y"/></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Primary Language Load ID</th>
|
||
|
|
<th align="left" valign="top">AdditionalValue</th>
|
||
|
|
<th align="left" valign="top">2924</th>
|
||
|
|
<th align="left" valign="top"><AdditionalValue ValueName="PrimLangLoadId"
|
||
|
|
Value="2924"/></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Directory list in PRDLOD</th>
|
||
|
|
<th align="left" valign="top">Files</th>
|
||
|
|
<th align="left" valign="top">/XYZ30/bin</th>
|
||
|
|
<th align="left" valign="top">
|
||
|
|
<pre>
|
||
|
|
<Files>
|
||
|
|
<Directory DirectoryName="/XYZ30/bin">
|
||
|
|
</Directory>
|
||
|
|
</Files>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Library list in PRDLOD</th>
|
||
|
|
<th align="left" valign="top">Files</th>
|
||
|
|
<th align="left" valign="top">QSMU</th>
|
||
|
|
<th align="left" valign="top">
|
||
|
|
<pre>
|
||
|
|
<Files>
|
||
|
|
<Directory
|
||
|
|
DirectoryName="/QSYS.LIB/QSMU.LIB">
|
||
|
|
</Directory>
|
||
|
|
</Files>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Supported</th>
|
||
|
|
<th align="left" valign="top">Supported</th>
|
||
|
|
<th align="left" valign="top">Y</th>
|
||
|
|
<th align="left" valign="top"><ExtendedData Supported="1" ...></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">n/a</th>
|
||
|
|
<th align="left" valign="top">UninstallInfo</th>
|
||
|
|
<th align="left" valign="top">n/a</th>
|
||
|
|
<th align="left" valign="top"><ExtendedData UninstallInfo="DLTLICPGM
|
||
|
|
5722SS1" ...></th>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><a name="Bot_Of_Page"></a></p>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|