Software components DTD

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:

• ValueName

Optionally it may contain one of each of the following attributes:

• ValueID
• Value

<AdditionalValue ValueName="PrimLangLoadId" Value="2924"/>

A user who wants to retrieve this value can use the list API and include the following in the input:

<AdditionalValue ValueName="PrimLangLoadId" Value=""/>

<AdditionalValue ValueName="PrimLangLoadId" />

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:

1. 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).

   <AdditionalValue ValueName="State" Value="Registered"/>
   

2. 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".

   <AdditionalValue ValueName="State" Value="DirsCreated"/>
   

3. The installer copies all files to the corresponding directories and calls the update API to set the "State" tag to "FilesCopied"

   <AdditionalValue ValueName="State" Value="FilesCopied"/>
   

4. The installer creates some user profiles to finish its installation and then calls the update API to update the "State" to "Complete".

   <AdditionalValue ValueName="State" Value="Complete"/>
   

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.

The CCSID for the values specified in the attribute and element values.

This element describes a software component - a separately installable piece of an application. This element must contain the following attributes:

• ProductName
• ComponentName

This element may contain the following attributes:

• ComponentVersion
• Instance
• FeatureName
• ComponentVendor
• PackagedProduct

This element may also contain an ExtendedData element.

The name of the component. It is composed of character data and its length must not be greater than 256 UCS-2 characters.

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.

The version of the component. It is composed of character data and its length must not be greater than 64 UCS-2 characters.

The version of the DTD the XML document should be validated against.

This element identifies a directory and optionally a set of files that are part of the software component. This element has to contain a DirectoryName attribute and zero or more FileName elements.

When FileName elements are specified it means they belong in the directory named in the DirectoryName attribute of the Directory element where they were specified.

The following is an example of how a user could specify this element.

Suppose a user wants to register the following:

    /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)

The Files element in the XML document could be specified as follows:

 <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>

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.

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:

• Installed
• Supported
• UninstallInfo
• LastFixPackApplied
• InstallerType
• CCSID

It may also contain a Shared element, a ProductDescription element, a Files element and zero or more AdditionalValue elements.

The component feature. It is composed of character data and its length must not be greater than 64 UCS-2 characters.

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.

This element contains the list of directories and files belonging to the software component. It is composed of 1 to n Directory elements.

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 installed.

The type of installer used to install this software component. It is composed of character data. Some types of installers are ISJE and RSTLICPGM.

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.

The last fix pack applied for the component. It is composed of character data.

The identifier of the message that describes the product option. Its length must not be greater than 7 UCS-2 characters.

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.

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.

This attribute indicates if the component is a native IBM i License Program Product including the IBM i Operating System. It can be the character value "0" which means the component is not a native IBM i License Program Product or it can be "1" which means it is. When this attribute is not present then the default value is "0".

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.

This element contains the description of the product. It has to contain the following attributes:

• MessageLibrary
• MessageFile
• MessageID

This is the root element of the DTD. There must be 1 of these elements in each XML object. This element must contain a DTDVersion attribute and may contain 1 or more Component elements.

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.

This element identifies the component user of this component. This element has to contain the following attributes:

• ProductName
• ComponentName

Optionally it may contain one of each of the following attributes:

• ComponentVersion
• Instance
• FeatureName
• ComponentVendor

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.

This attribute can be used to describe how to uninstall the component. It is composed of character data.

This attribute contains additional information related to the software component and it is identified by the ValueName attribute.

This attribute should be used to differentiate among additional values (AdditionalValue elements) with the same value name (ValueName attribute).

This attribute identifies a user defined piece of information. Its length should not be greater than 256 UCS-2 characters.