Parsing of XML files in CDM

Release version: Washingtondc

Updated February 1, 2024

2 minutes to read

Summarize

Summarized using AI

Summary of Parsing of XML files in CDM

The CDM XML parser facilitates the parsing of attribute key-value pairs in XML files, enabling seamless uploads of configuration data into CDM. This feature allows customers to easily identify attributes in the CDM editor or list view. Note that starting with the Washington DC release, DevOps Config will be deprecated but will remain supported for existing instances.

Show full answer Show less

Key Features

Converts XML attributes and text into a JSON format during import, making it easier to manage configuration data.
Identifies XML attributes with an "@" prefix and enclosing text with a "#text" key in JSON.
Supports validation of imported CSV data with attributes for deployment.

Key Outcomes

Customers can efficiently upload existing configuration data from XML files, ensuring attributes are accurately represented in JSON format. The parsing process simplifies the differentiation of attributes in the CDM editor and allows for proper maintenance of data integrity when exporting back to XML format.

The CDM XML parser enables the parsing of attribute key-value pairs in XML files, so when you upload config data from an XML file into CDM, you can easily identify the attributes of each element in the CDM editor or list view.

Important:

Starting with the Washington DC release, DevOps Config is being prepared for future deprecation. It will be hidden and no longer installed on new instances but will continue to be supported. For details, see the Deprecation Process [KB0867184] article in the Now Support Knowledge Base.

This parsing of attribute key-value pairs from an XML file to a JSON format in CDM helps you in the following ways:

Uploading existing config data from an XML file, including the attributes of XML elements as appropriate key-value pairs in JSON.
Differentiating attributes from the config data items easily in the CDM editor.
Validating imported CSV data with attributes in CDM for deployment.
Converting attribute key-value pairs in JSON format as XML element attributes in XML file.

Parsing of XML to JSON during import

When you import an XML file to upload your config data into CDM, the parser converts attributes and enclosing text in XML elements to the JSON format as follows:

Adds the @ prefix to all key names corresponding to attributes of XML elements.
Adds a #text key for the enclosing text value of XML elements that have both attributes and enclosing text.

These options help in identifying attributes and enclosing text in the Editor panel and List view while reviewing the config data.

The following example shows how the conversion looks between XML and JSON formats:

XML format

<app>
     <components>
           <paymentService type="B2C">
                     <provider region="EMEA">ABCPay</provider>
                     <service>XYZPay</service>
           </paymentService>
     </components>
<app>

JSON format

{
   "app" : {
         "components" : {
                 "paymentService" : { //key-value pair for XML elements with attributes
                          "@type" : "B2C", // @ prefix for attribute
                          "provider" : {
                                "@region" : "EMEA", // @ prefix to key name for attribute 
                                "#text" : "ABCPay"  // #text key name for enclosing text
                            },
                  "service" : "XYZPay" //key-value pair for XML elements without attributes
                  }
           }
   }
}

Parsing of JSON to XML during export

To keep the XML attributes and enclosing text in their original format when exporting the config data to an XML file format, you must update the config data as follows:

Add the @ prefix to all key names to make them parse as attributes of XML elements.
Add keys named #text to CDIs that should be parsed as the enclosing text value of XML elements, when both attributes and enclosing text are present.