The first few elements in the product definition file are used for identification of the product or products described in the file. The id attribute must uniquely identify the product. The title and detail can be shown in the user interface. The file must include the DTD declaration shown:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE product SYSTEM "http://www.atg.com/dtds/product_1_0.dtd">
<product id="commerce" >
<title>Core Commerce</title>
<detail>Configure Core Commerce</detail>
In addition to title and detail, product definition files can include the following elements:
<requires-addon-id id="ADDON_ID"/>
Identifies an add-on as required; the add-on is automatically selected if the product is selected. See the Product Add-Ons section of this chapter for information.<product-id-required id="PRODUCT_ID"/>
Identifies another product as required; the product is automatically selected if the main product is selected.<incompatible-product-id id="PRODUCT_ID"/>
Identifies a product as incompatible with this product. If the user selects both, the CIM UI displays an error message.<incompatible-addon-id id="ADDON_ID" />
Identifies a particular add-on as incompatible with this product. CIM automatically removes this add-on from the list, so that it cannot be selected.
You can extend an existing product by using the extends attribute. For example:
<product id="commerce" extends="platform">
When you extend one product with another, their product.xml files are merged using XML-combine. If multiple extensions are involved, the files are combined in extension order.
Note that product.xml files are also merged when end-users select multiple products to configure from the CIM menu, even if no extension is stated in the XML. The order in which the files are combined varies depending on the selections. If multiple products are selected that extend other products, the extensions are combined first, followed by the product selection combinations.
That means that any xml-combine arguments like xml-combine="remove" will only affect the combine with the “extends” and not with multiple products.
The final XML for combined products is placed in the same directory as the product.xml file that includes the extension and is called combine-product.xml. For example, if Product A has no extensions, and Product B extends Product A, after combination, the product.xml directory for Product B also contains a combine-product.xml.
See the Product DTD section of Appendix A, CIM DTDs for details on the product.xml elements and attributes.
