Skip to content

dcm:deployment policy element

Rich Groot edited this page May 19, 2016 · 1 revision

DCM Definition File: dcm:deployment-policy element

The <dcm:deployment-policy> element defines DP deployment policies to apply while importing a .zip export file:

<dcm:deployment-policy>
  [ <black-list .../> ]
  [ <white-list .../> ]
  [ <add-property .../> ]
  [ <delete-property .../> ]
  [ <modify-property .../> ]
</dcm:deployment-policy>

These child elements are translated internally into <AcceptedConfig>, <FilteredConfig>, and <ModifiedConfig> elements. The advantage of the child elements defined here is that they are much less ugly to read or write.

Note that unlike all other DCM elements, these do not have a namespace.

Optional Child Elements:

<black-list>
<white-list>
<add-property>
<delete-property>
<modify-property>

black-list

The <black-list> element defines a pattern for objects in the .zip file to ignore:

<black-list [device="..."] [domain="..."] [type="..."] [name="..."] [prop-name="..."]>

The attributes select which objects to ignore.

Optional Attributes:

device - default '*'
domain - default '*'
type - default '*'
name - default '*'
prop-name - default '*'

Here is an example that will prevent the importation of any default object:

<black-list name="default"/>

Note that <black-list> with no attributes will ignore all objects and is probably not very useful, though it is permitted.


white-list

The <white-list> element defines a pattern for objects in the .zip file to specifically import:

<white-list [device="..."] [domain="..."] [type="..."] [name="..."] [prop-name="..."]>

Optional Attributes:

device - default '*'
domain - default '*'
type - default '*'
name - default '*'
prop-name - default '*'

The attributes select which objects to specifically include in the import.


add-property

The <add-property> element defines a property to add to an object:

<add-property new-prop-name="..." new-prop-value="..." [device="..."] [domain="..."] [type="..."] [name="..."] [prop-name="..."]>

Required Attributes:

new-prop-name - name of the new property (e.g. UserSummary)
new-prop-value - value of the new property (e.g. Alice and Bob)

Optional Attributes:

device - default '*'
domain - default '*'
type - default '*'
name - default '*'
prop-name - default '*'

The optional attributes select which objects to add the property to while the required attributes specify the new property and its value.


delete-property

The <delete-property> element defines a property to delete from an object:

  <delete-property prop-name="..." [device="..."] [domain="..."] [type="..."] [name="..."]>

Required Attributes:

prop-name - name of property to delete (e.g. UserSummary)

Optional Attributes:

device - default '*'
domain - default '*'
type - default '*'
name - default '*'

The attributes specify which property to delete from which objects.


modify-property

The <modify-property> element defines the replacement of the value of an existing of an object:

<modify-property new-prop-value="..." [device="..."] [domain="..."] [type="..."] [name="..."] [prop-name="..."] [prop-value="..."]>

Required Attributes:

new-prop-value - new value of the existing property

Optional Attributes:

device - default '*'
domain - default '*'
type - default '*'
name - default '*'
prop-name - default '*'
prop-value - default '*'

The optional attributes select which objects and property to modify while the required attribute specifies the new value for that property.