Xoom Rename Helper is executed from the command line with XoomRenameHelper.exe. XoomRenameHelper.exe requires two
input files – a XoomXML file containing the fullest possible representation of
configuration to be renamed, and a rename file.
The grammar is:
XoomRenameHelper <xoom file> <rename file>
[<sxp out file>] [<sxp undo out file>] [<xoom set out file>]- <xoom file> is required and must be in XoomXML format. We recommend
generating the fullest possible representation of configuration using
the All named query. If you do not, it is possible
that some references will be missed. If there are any references to
renamed items that are not included in the XoomXML, then these will be
broken after the rename (for example, if the reference is by Name as opposed to Key).
- <rename file> is required and is an XML file that specifies all the renames
you wish to make. The file has the following structure:
<Renames>
<Rename>
<From>Background Optimization[Night BGO]</From>
<To>Background Optimization[Night Optimization]</To>
</Rename>
<Rename>
<From>Setting[[Application]|Background Optimization|Night BGO|]</From>
<To>Setting[[Application]|Background Optimization|Night Optimization|]</To>
</Rename>
</Renames>
There can be as many Rename elements as
required, though each must contain both the child elements, <From> and <To>. These respectively specify
the old and new Xoom identities for each item to be renamed. Be careful not
to rename items with names that already exist in configuration, as to
do so will duplicate Xoom identities. For example, Item A gets renamed as
A1, but an item named A1 already exists in
configuration.
Similarly, as renaming occurs in the order in which
items are specified, avoid introducing logical errors. For example, in the
following
rename:
Item A gets renamed as A1
Item B gets renamed as A
Were
you to rename
item B first, you would have two
items named A, that
would then get renamed as A1.
The
XoomRenameHelper.exe command produces the following
output files.
- <sxp out file>. Defaults to out_sxp.xml and contains the SXP
message that, when sent, performs the rename in the Service Optimization database. It is a single
SXPMultipleOperations.
- <sxp undo out file>. Defaults to out_sxp_undo.xml and contains the
SXP that, if sent, undoes the rename in the Service Optimization database (i.e. performs the reverse
operation from the SXP in <sxp out file>.
- <xoom set out file>. Contains the XoomXML file to be
deployed using Xoom once the rename has been performed. It defaults to
out_xoom_set.xml
To complete the rename:
- Send the <sxp out file>, for example using the Send SXP command in Xoom Processor.
- Deploy the <xoom set out file> to correct the
references that were affected by the rename.