Customer_Mapping_XML parameter

This parameter defines the attributes to be used to identify the starting actual CIs for each customer. The starting actual CIs and actual CIs related by the configured rules will be associated with each customer.

This parameter contains an introductory stanza, which specifies parameters that govern the task as a whole, and a customer stanza for each customer, which specifies the rule for identifying the starting set of actual CIs for that customer. The following sections describe the schema elements you can use in these stanzas. See the example (below) to help you understand the elements.

Introductory stanza

The introductory stanza begins with the actcicustmap element, which identifies the file as one used for customer mapping. It contains these elements:

completionEmailTo

(optional) A comma-separated list of Internet addresses, to which an email message will be sent on completion of the mapping task that summarizes the results when all customer definitions are done. If not specified, no email will be sent upon completion.

completionEmailSubject

(optional) The subject of the email. You can use this if you have configured more than one cron task instance and want to easily identify which instance has completed.

deleteFilesQuickly

(optional) Deletes the CSV file when processing completes. The CSV file details the actual CIs newly identified for the customer.

When set to "false" the deleteFilesQuickly element will not delete the CSV file that contains the list of actual CIs newly associated with the customer. The default is "true".

See the resultsDirectory element for information about the CSV file directory.

ignoreIPAddressValues

(optional) A comma-separated list of IP addresses. Any actual CI whose classification is NET.IPADDRESS, NET.IPV4ADDRESS or NET.IPV6ADDRESS is not processed if its name is in the specified list of IP addresses. Nor are relationships of that actual CI processed.

This element is intended primarily for loopback IP addresses such as 127.0.0.1 and 0:0:0:0:0:0:0:1 that may be related to other actual CIs which you do not want mapped to a customer.

In the sample below, the cron task will not process any any NET.IPADDRESS, NET.IPV4ADDRESS or NET.IPV6ADDRESS actual CIs whose actciname is 127.0.0.1 or 0:0:0:0:0:0:0:1.

Use of the ignoreIPAddressValues element supersedes any rules defined in the Mapping_Control_XML parameter.

preview

(optional) A mode where the assignment process creates a list of assignments but does not modify the actual CI records. This enables you to test your configuration of the assignment process, verify that it maps actual CIs to the desired customers, and adjust your configuration as necessary. Set preview="true" to identify and view the actual CIs but not assign them to the customer. When the preview shows the correct assignments, set preview to "false". If not specified, "false" is the default.

requireItic

(optional) Set to either "true" or "false". When "true" (and preview="false"), the cron task will not identify actual CIs if the Integration Composer TADDM adapter has not been run since the last time the cron task instance was run. If not specified, it defaults to "true".

stopClassifications

(optional) A comma-separated list of actual CI classifications. Any actual CIs with one of the specified classifications is not processed. Nor are relationships of that actual CI processed.

This is a global setting. If you need finer control, see the stopClassifications setting in the relationRulesToFollow tag in the Mapping_Control_XML.

The specified classifications can contain an asterisk (*), which is used as a wildcard to represent zero or more characters. For example, using the stopClassifications element with a classification of *FILESYSTEM stops at all classifications that end in FILESYSTEM.

In the sample below, the XML will not process any actual CIs whose classification is APP.CONFIGFILE.

Use of the stopClassifications element supersedes any rules defined in the Mapping_Control_XML parameter.

The introductory stanza is followed by one or more customer stanzas. After the last customer stanza, the file is closed with the </actcicustmap> element.

Customer stanza

The customer stanza begins with the customer element and contains these elements:

name

The customer name, which must match a customer already defined in Control Desk. This customer will be set as the primary customer on the actual CIs.

completionEmailTo

(optional) A comma-separated list of Internet addresses, to which an email message will be sent on completion of the mapping task that summarizes the detailed results for that customer. An attachment will be included if there are actual CIs newly identified as belonging to the customer. If not specified, no email will be sent upon completion.

completionEmailSubject

(optional) The email subject.

secondaryCustomers

(optional) A comma-separated list of secondary customers. They must already be defined in Control Desk. Each will be added as a secondary customer on the actual CIs.

attribute

Defines the attribute of the starting actual CI that can be used to identify it as belonging to the customer:

name: The attribute name as defined in Control Desk.
type: (optional) Indicates the data type of the attribute. You can specify "alnvalue" or "numvalue". The default is "alnvalue".
ignoreCase: (optional) You can specify "true" or "false". The default is "false". This only applies for the setting type="alnvalue".
comparison type: The valid comparison types are: equals, startswith, endswith, and like. Each comparison type requires a comparison type="" setting that sets the comparison value; for example:
startswith="1.2.35."

You can use a combination of AND, OR, and NOT logic to identify the starting actual CIs, but only by nesting the AND, OR, and NOT within a single logic block per customer. For example, the following (nested) use of AND and OR is valid:

<AND>
  <attribute name="IPADDRESS_ADDRESSSPACE"><equals="SPACE1"></attribute>
  <OR>
    <attribute name="COMPUTERSYSTEM_FQDN"><startswith="FQDN1"></attribute>
    <attribute name="COMPUTERSYSTEM_FQDN"><startswith="FQDN2"></attribute>
  </OR>
</AND>

But this (not nested) use of AND and OR is not valid:

<AND>
  <attribute name="IPADDRESS_ADDRESSSPACE"><equals="SPACE1"></attribute>
</AND>
<OR>
  <attribute name="COMPUTERSYSTEM_FQDN"><startswith="FQDN1"></attribute>
  <attribute name="COMPUTERSYSTEM_FQDN"><startswith="FQDN2"></attribute>
</OR>

resultsDirectory

(optional) A directory in which to save the CSV file detailing the actual CIs newly identified for the customer. You must ensure that space and write privileges exist for the resultsDirectory or no result files will be saved.

Sample Customer_Mapping_XML parameter content

  
<?xml version="1.0" encoding="UTF-8" ?>
<actcicustmap
   preview="true"
   requireItic="true"
   stopClassifications=APP.CONFIGFILE"
   ignoreIPAddressValues="127.0.0.1,0:0:0:0:0:0:0:1"
 >
<customer
     name="ACCOUNT1"
      completionEmailTo=
"you@your.company,yourassistant@your.company"
     secondaryCustomers="ACCT1SUB1"
     resultsDirectory="/serverDir/ACCOUNT1/SUBACCOUNT1"
>
<AND>
   <attribute 
      name="IPADDRESS_ADDRESSSPACE"
     >
    <equals="SPACE1" />
   </attribute>
   <attribute name="IPADDRESS_STRINGNOTATION" >
      <startswith="1.2.35." />
    </attribute>
</AND>
</customer>

<customer
     name="ACCOUNT1"
      completionEmailTo=
"you@your.company,anotherassistant@your.company"
     secondaryCustomers="ACCT1SUB2"
     resultsDirectory="/serverDir/ACCOUNT1/SUBACCOUNT2"
>
<AND>
   <attribute 
      name="IPADDRESS_ADDRESSSPACE"
     >
    <equals="SPACE1" />
   </attribute>
   <attribute name="IPADDRESS_STRINGNOTATION" >
      <startswith="1.2.77" />
    </attribute>
</AND>
</customer>

</actcicustmap>

Feedback