The first step in creating your wizard is to create the base script to which you will add configuration functionality, validators, and other components.
To create a new CIM script, create a wizards.xml
file as shown:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE wizards SYSTEM "http://www.atg.com/dtds/wizard_1_0.dtd"> <wizards> <wizard id="ID"> <title resource-key="" resource-params="">Title</title> <detail resource-key="" resource-params="">Detail</detail> <process id="MyProcess"> <!-- steps here --> </process> </wizard> </wizards>
Note that the title
and detail
tags are referencing resource keys and parameters. Place the wizards.xml
file in the <ATG11dir>/cim/plugins/
plugin_name
/
directory, along with any supporting files for that plugin. Give the plugin_name
directory any name, but note that the name cannot include spaces. The wizard and process id
must both be unique and should be descriptive enough to identify the wizard’s function.
Note: The wizard-type
attribute for the <wizard>
element is used only by product configuration wizards, and should not be used in custom scripts. If this attribute is used, the script will not appear in the custom wizard launcher.
If you want your wizard to extend another wizard, use the following:
<wizard id="MyWizard" extends="OtherWizard">
When you extend a wizard, the following items are merged using XML-combine:
MyWizard XML with OtherWizard XML
Supporting files, including
tasks.xml
,validators.xml
,providers.xml
, andselectproviders.xml
, are combined if the two wizards are located in different plugins; if they are in the same plugin, they both use the same supporting files
MyWizard inherits everything included in the OtherWizard plugin. Note that it does not inherit items from other wizards that are defined in the same plugin as OtherWizard, but only inherits from OtherWizard itself. In addition, MyWizard can access Java classes used in the plugin that contains OtherWizard. See the XML File Combination section of the Platform Programming Guide for general information on XML-combine.
When you run the MyWizard plugin, a combined-MyWizard.xml
file containing the combined wizards is saved to the directory where MyWizard’s wizards.xml
file is located. This file is deleted if the wizard exits successfully, unless you have turned on debugging. To turn on debugging, edit the <ATG11dir>/CIM/config/GLOBAL.properties
file.
The title
and detail
are shown in CIM menus. For example:
Choose Wizard: *[0] OtherWizard – OtherWizard detail [1] MyWizard - MyWizard detail
The wizard
element contains one or more process
elements, which contain a logical grouping of steps and have no attributes of their own (see the Adding Steps to a Process section for step information).
For an example, see the Example CIM Plugin section of this chapter, or review the wizards.xml
file located at <ATG11dir>/CIM/plugins/base
in your Oracle Commerce Platform installation.