Xoom Set Special Form

Use xoom:set special form to deploy changes within items, for example to contained items.

Why do I need xoom:set special form?

In configuration, items are addressable and consequently when you make a deployment, it is items that are deployed and overwritten in the database.

However, there are often cases where items are contained within the body of other items. Examples of these contained items in Service Optimization include:

Agent types and Agent Instances, which are contained within the body of Agents Manager.
Rule and Objective types, which are contained within the body of a single Setting.
SXP Object References, which are contained within the body of Object Reference.

When deploying changes to a contained item, you only want to make changes to that part of the containing item, rather than overwriting the whole thing. To do that requires xoom:set special form.

Example

In Service Optimization, Rule types are contained within the <BODY> element of <Setting>. <Setting> is addressable and possesses a Xoom identity, in this case Setting[[Application]|Rule Types|Rule Types|].

<Setting xoom:id="Setting[[Application]|Rule Types|Rule Types|]">
      <Key>119408668</Key>
      <Owner>[Application]</Owner>
      <Category>Rule Types</Category>
      <SubCategory>Rule Types</SubCategory>
      <Name />
      <Body>
        <BODY>
          <TYPE>
            <Name>Match Constant Rule</Name>
            <Category>Match Rules</Category>
            <ProgId>W6CoreRules.W6MatchConstRule, W6CRules</ProgId>
            <UiProgId>W6SpecificUIs.W6MatchConstRuleUI</UiProgId>
            <AllowSeveralInstances>-1</AllowSeveralInstances>
            <ViolationString>Specifies that a task or engineer property should be compared to a constant value.</ViolationString>
            <UsedInExtendedPropagation>0</UsedInExtendedPropagation>
          </TYPE>
          <TYPE>
            <Name>Match Time Rule</Name>
            <Category>Time Rules</Category>
       …

Now imagine you want to make a change to the Rule type Match Constant Rule. If you were to make a normal deployment, the whole of <Setting xoom:id="Setting[[Application]|Rule Types|Rule Types|]"> would be overwritten. To deploy just the one Rule type you would need to use xoom:set special form.