How to…

Typical 'how to' scenarios with step by step instructions.

Save configuration
Xoom Console, Settings Migration Tool, Xoom Explorer and Xoom Processor each allow you to save configuration as XoomXML.
Transport configuration
Xoom Console, Settings Migration Tool, and Xoom Processor each allow you to transport configuration, though only Settings Migration Tool allows you to review configuration changes beforehand.
Verify deployment
We recommend that, whichever tool you use to deploy configuration changes, you verify the deployment using Settings Migration Tool.
Undo a deployment or reset configuration to a baseline
The nature of deployment, in particular of Scheme changes, means that it is not possible to include simple 'undo' functionality in Xoom. However, it is possible to reset configuration using Xoom Reset Helper, provided you have a saved XoomXML snapshot of the desired, baseline state.
Compare configuration
Xoom provides several different means of comparing configuration. Choose the method that is appropriate to the task.
Generate a report
Xoom comes with a suite of reports which help you analyse, visualise and understand configuration. Reports can be generated using Xoom Explorer or Xoom Processor and in each, the steps are the same.
Transform a XoomXML file
As XoomXML is a dialect of XML, it can be transformed using XSLT stylesheets. This means XoomXML can be transformed in a systematic manner, either to generate reports or to, say, remove unwanted information. Transformations can be performed using Xoom Explorer or Xoom Processor, but some transformations require Xoom Processor. In all cases, the steps are as follows.
Verify configuration
Check whether configuration conforms with a baseline and/or best practices.
Version configuration
Configuration versioning is not only possible with Xoom, it is actively supported. Store regular snapshots of configuration in a repository. Use Xoom folders to track changes on a per-item basis.
Create a custom named query
The best way to understand how to create a custom named query is by example.
Verify installed files
Use named queries to verify which Service Optimization and Xoom files are installed on a particular Xoom server.
Use Xoom to transport files
The steps for transporting files are as follows.
Separate concerns so that teams can work independently on different parts of configuration
To separate concerns in this way, customise a set of named queries to retrieve non-overlapping subsets of configuration.
Perform a complete dependency analysis
Performing a regular dependency analysis enables you to check whether references between items are configured correctly, and to prevent bad references from accruing.
Find duplicated items
Duplicated items cause problems both for the managed system and for Xoom, the latter because it is unable to assign to each a unique Xoom identity. Settings Migration Tool enables you to locate duplicated items. We recommend you find and delete duplicated items as a regular part of configuration management.
Locate bad references in configuration
Use the Bad References report to find bad references in configuration. Bad references are those that cannot be resolved.
Perform a rename of items
Xoom Rename Helper is a custom command line tool that enables you to rename items consistently.
Send an SXP message
You can send an SXP message using the SendSXP custom command in Xoom Processor.
Deploy parameters
Although Xoom deploys changes at the item level, it is still possible to deploy changes at the parameter level using Xoom set special form. This is useful when you want to make changes to contained items.
Combine two XoomXML files
Combine two XoomXML files using the combine operator in Xoom Processor.
Explore configuration with XPath
Xoom Explorer lets you explore XML files with XPath expressions.
Stop or start Xoom service
Xoom service can be found in Windows Task Manager, in the Services tab, as ZanyAnts.Xoom.
Configure the behaviour of Xoom
Configure the behaviour of Xoom server by adjusting the Xoom parameters. These are contained in a file XoomParams.xml, installed as part of a typical Xoom server installation. Parameters can be changed directly, by altering and saving the XML file, or from the command line using Xoom Toolkit. Changing the password of Service Optimization credentials can only be done from the command line. Xoom service must be restarted following any parameter changes.

Parent topic: User guide