You can run the Configuration Reporter as a standalone utility. This allows you to generate configuration reports even if ATG is not running. Before you run the Configuration Reporter as a standalone utility, you need to create two files:
A file that contains a list of the components to include in the report. See Creating the Component File.
A file that contains the configuration path. See Creating the Configuration Path File.
In addition, you should also set certain properties in /atg/dynamo/service/ConfigurationReporter. See Configuring the Configuration Reporter.
Creating the Component File
You can create the component file by running the report on the Output Dynamo Component Hierarchy to File page at:
http://hostname:port/dyn/admin/atg/dynamo/admin/en/
config-reporter-output-hierarchy-titled.jhtml
Add the name of the file thus created to the componentFileName property of /atg/dynamo/service/ConfigurationReporter.
As an alternative, you can create a component file by hand. The component file format is as follows:
<component>/Initial</component>
<component></atg/dynamo/service/Scheduler</component>
A component file is not expected to be well-formed XML. Anything other than what is between the component start and end tags is ignored. Anything between the tags is treated as a component name. Folders can be included between component tags; the Configuration Reporter includes all components in such a folder. Add the name of the component file to the componentFileName property of /atg/dynamo/service/ConfigurationReporter.
Creating the Configuration Path File
You can create the configuration path file by running the CONFIGPATH report on the Output Configuration Path to File page at:
http://hostname:port/dyn/admin/atg/dynamo/admin/en/
config-reporter-conf-path-titled.jhtml
Add the name of the file thus created to the dynamoConfigurationPathFileName property of /atg/dynamo/service/ConfigurationReporter.
As an alternative, you can create a configuration path file by hand. The configuration path file format is as follows:
<configuration_path_item>c:\ATG\ATG9\DAS\config
</configuration_path_item>
<configuration_path_item>c:\ATG\ATG9\home\localconfig
</configuration_path_item>
<configuration_path_item>c:\ATG\ATG9\MyModule\config
</configuration_path_item>
A configuration path file is not expected to be well-formed XML. Anything other than what is between the <configuration_path_item> start and end tags is ignored. Anything between the tags is treated as an element of the Dynamo CONFIGPATH. Elements of the CONFIGPATH should be listed in the configuration path file in the order that they appear in the Dynamo CONFIGPATH. Add the name of the configuration path file to the dynamoConfigurationPathFileName property of /atg/dynamo/service/ConfigurationReporter.
Configuring the Configuration Reporter
As described in the previous sections, you need to set the componentFileName and dynamoConfigurationPathFileName properties of /atg/dynamo/service/ConfigurationReporter. In addition, set the serializedPropertiesFileName property to the pathname of the file you want to output.
You can set these properties using the ACC, or by adding a properties file like this at <ATG9dir>/home/localconfig/atg/service/ConfigurationReporter.properties:
$class=atg.service.configurationreporter.ConfigurationReader componentFileName= dynamoConfigurationPathFileName= serializedPropertiesFileName=
Running the Configuration Reader
To run the Configuration Reporter as a standalone utility, use the following command:
java atg.service.configurationreporter.ConfigurationReader
-savePropertiesconfig_directory
The config_directory argument is the directory that holds your ConfigurationReporter.properties file. A typical value would be localconfig.
This command generates a serialized output file. When you run this utility, the Configuration Reader reads the following input properties from properties file /atg/dynamo/service/ConfigurationReporter.properties.
| The name of a file that contains the Dynamo CONFIGPATH. |
| The name of the component file to read the list of Dynamo components from. |
| The name of the serialized file to output. |
After you run the Configuration Reader utility with the -saveProperties argument, you can run it in this form to output an XML representation of the properties report:
-outputRepresentationToXMLSourceFileOutputFileName
OutPutPropertyValues=true|false
The SourceFile argument is the name of the output file (serializedPropertiesFileName) and the OutputFileName argument is the name of the file where the Configuration Reader should output the XML representation of the serialized output file. Use the OutPutPropertyValues=true flag to output the property values as well as the component names; use the OutPutPropertyValues=false flag to omit the property values.
