The CIM API is resource-aware, meaning that the CIM DTD supports resource bundles for text fields. This allows you to create localized resource bundles and add them to classes. Resource bundling is also used for localizing message, log and label string texts, as well as translating data.
The title
, detail
, label
and error-message
display tags in CIM are resource aware, and are the key fields used when localizing CIM scripts.
The information for these tags can be provided by resource keys and bundles. For example:
<title resource-key="MyProduct.name.title" resource-bundle="atg.cim. MyProductResources">My New Product</title>
Where the resource-key
attribute identifies the name of the key in the resource file and the resource-bundle
attribute identifies the name of the resource bundle. CIM will look for these resource files in the /cim/classes
directory. If either or both of the resources are not found, the value between the display tag is used, and an error will be thrown.
You can also use resource parameters within your resource file. For example, you could define a resource in the MyProductResources.properties
file, referenced above, that contains a resource parameter:
MyCimTest.details=configuring {0} server for server instance {1}
In your XML file, you would indicate the resource parameters:
<detail resource-key="MyCimTest.details" resource-bundle="atg.cim.MyProductResources" resource-params="Sandbox,Production"> Configuring Server Instance </detail>
As a result, the following would be displayed:
Configuring Sandbox server for server instance Production