The need to extend the default palette usually arises when additional driver configuration files need to be hooked up to existing applications or to new applications or drivers.
Adding to the palette is a very delicate process and only successful if followed exactly step by step. Each step needs to be adapted to your situation.
Copy the new driver configuration file into the driver_configs folder so that the configuration file is accessible (but not yet hooked up) from Designer.
In this example, the new driver configuration file is CustomDriver-IDM3_5_0-V1.xml.
Figure C-14 An Example New Driver Configuration File
Copy into the driver_configs folder all corresponding .xlf files that belong to CustomDriver-IDM3_5_0-V1.xml.
Continue with Section C.2.2, Creating the Group to connect the driver configuration file with the palette.
Before you place the new application Custom Application into the new Custom Applications group, you must first create the group.
Decide on the name of the new application that you want to create and the group that you want the new application to go into.
For this example, the following names are used:
New application: Custom Application
New group: Custom Applications
Add a group element to the defs/model_items/Palettes/Main.xml file.
Give the group element an ID attribute with an intuitive and unique value (for example, CustomApplications). Set the value of the element to %CustomApplications to make it localizable.
Save the file.
Continue to Section C.2.3, Adding a Key_Value Pair.
This is the properties file for the Main.xml file that you edited in Step 2.
Add a key/value pair (for example, CustomApplications = Custom Applications).
Save the file.
If you want to localize the group name into other languages, copy the properties file and rename it to Main_language_code.properties.
For an example of supported languages and their codes, view the .xlf files in the defs/driver_configs folder.
View the new group as an empty group in the palette by starting the copy of Designer that you are manipulating.
Continue with Section C.2.4, Creating a Driver Definition.
Create a driver configuration file CustomApplication.xml in the defs/model_items/Drivers folder.
The new configuration file must follow the Driver.dtd specifications in the folder that you just created. The easiest way to do this is to copy an existing driver definition file, rename the file, then modify it.
Edit the configuration file.
Provide an intuitive and unique type (for example, CustomApplication-Driver).
Set the primaryApp value to CustomApplication.
Set secondaryApp value to GenericApp.
Specify the app-dn-format that your application supports.
Leave the icons as they are. They are not driver-specific.
Specify the shims that your application supports.
Specify the driver configuration file to use for this driver.
Specify only the filename, without the versioning information.For example, if your driver configuration file is named CustomDriver-IDM3_5_0-v1.xml, you refer to it as Custom.xml).
Because Designer 2.0 M5 and later releases hide or display the user interface and features based on the version of the engine that you are working on, driver configuration filenames are important. You need to store the version information in the configuration filename, according to a well-defined format:
base name[-type]-idm engine version-configuration file version.xml
In the example filenames, the IDM element identifies the engine version. The IDM elements to date are the following:
The V element in the example filenames specifies the version of this particular configuration file. It is a number that is incremented with each release of a new configuration file version. The following are examples:
No requirement exists for a more complex numbering schema.
Modify the props/CustomApplication.properties localization file.
You might need to create this file. If so, the quickest way is to copy, rename, and edit the file.
Continue with Section C.2.5, Creating the Application.
The next step is to create the Custom Application application and place it in the new Custom Applications group.
Create a folder in the defs/model_items/Applications directory.
Name the folder the same name as the group ID. In this example, the name is CustomApplications, as specified in Step 2.
Create icons, icons/small, and props folders in the CustomApplications folder.
Create icons for the application.
You can copy existing icons and modify them so the transparency is correct. In this example, modify the existing Generic Application icons.
Copy defs/model_items/Applications/Tool/icons/generic_app.png to defs/model_items/Applications/CustomApplications/icons. Rename the file as customapplication.png.
Copy defs/model_items/Applications/Tool/icons/small/generic_app.gif to defs/model_items/Applications/CustomApplications/icons/small. Rename the file as customapplication.gif.
Create an application definition file (.xml) in the defs/model_items/Applications/CustomApplications folder.
The definition file follows the ItemDef.dtd specifications. (See Table C-1.)
The easiest way to create the file is to copy an existing application definition file (for example, GenericApp.xml), rename the file, then modify it.
The application definition file and the .properties file created in Step 5