Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home New York Now Platform Capabilities Now Platform capabilities IntegrationHub Integration steps XML parser step

    XML parser step

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    XML parser step

    Identify structured data from an XML payload without having to write script. Map incoming XML elements to a complex object output that you can use in other steps or actions. At runtime, values from an XML payload populate the complex object output.

    To learn more about complex objects, see Complex data.

    Note: The XML parser step is not available in the base system and requires the IntegrationHub Standard Pack Installer.After the required plugin is activated, the step is visible under Integrations.

    Roles and availability

    • Available as an Action Designer action step. Users with the action_designer role can create a custom action with one or more action steps.

    Payload size limit

    At runtime, XML parser step supports payloads up to 10 MB. For larger payloads, create a Data Stream action. For more information, see Data Stream actions and pagination.

    At design time, XML parser step supports sample payloads up to 64,000 characters.

    Fields

    Field Description
    Source data Select or drag a data pill that contains the source XML data. For example, a REST step Response Body data pill. At runtime, values from the data source populate the complex object output.
    Payload view Select a view for the example payload.
    • Raw (edit mode): Displays editable XML.
    • Structured: Displays XML in a tree view. Click an element in the tree to copy the element XPath. If creating complex data in the Target field manually, you can paste the XPath into the target XPath field.
    Example payload

    Enter an example payload to generate a complex object. For example, if parsing the response from a REST API step that returns a list of users, enter the expected XML for a single user. This field accepts XML with the following limitations.

    • XML namespaces are not applied to the complex object. More than one namespace in an XML file is not supported and generates an error message.
    • Multidimensional arrays are not supported.
    • Some special characters are not supported, such as hyphen and period. Double colons (::) are not supported in attribute values.
    • Payloads larger than 64,000 characters cannot be saved and generate an error message. However, if working with a large example, you can generate the complex object and delete the example payload before saving the step.
    Generate Target Click to generate a complex object from the example payload. Review and edit the Target field as necessary. Child elements are generated as type String. Alternatively, manually create the target by adding items in the Target field.
    Target

    View the XML payload as a complex object. Generate structured data by clicking Generate Target, or manually add items. For more information, see Complex data.

    Each complex data variable contains this information.

    • Label: Data pill label. By default, the system uses the name of the XML element.
    • Preview: Sample value from the example payload.
    • Type: Data type, which must be String, Object, Array.String, or Array.Object. The top-level item must be an Object.
    • XPath: Path to the element. Modify the XPath to change how source data elements map to complex data variables. If manually adding complex data variables, you can copy the XPath from the Payload view field and paste it in a complex data variable XPath field to ensure the correct hierarchy. Conditional XPath expressions are not supported.

    Click Edit Object to:

    • Change the label, internal name, or data type
    • Add or remove complex data variables
    • Mark a variable mandatory

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      XML parser step

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      XML parser step

      Identify structured data from an XML payload without having to write script. Map incoming XML elements to a complex object output that you can use in other steps or actions. At runtime, values from an XML payload populate the complex object output.

      To learn more about complex objects, see Complex data.

      Note: The XML parser step is not available in the base system and requires the IntegrationHub Standard Pack Installer.After the required plugin is activated, the step is visible under Integrations.

      Roles and availability

      • Available as an Action Designer action step. Users with the action_designer role can create a custom action with one or more action steps.

      Payload size limit

      At runtime, XML parser step supports payloads up to 10 MB. For larger payloads, create a Data Stream action. For more information, see Data Stream actions and pagination.

      At design time, XML parser step supports sample payloads up to 64,000 characters.

      Fields

      Field Description
      Source data Select or drag a data pill that contains the source XML data. For example, a REST step Response Body data pill. At runtime, values from the data source populate the complex object output.
      Payload view Select a view for the example payload.
      • Raw (edit mode): Displays editable XML.
      • Structured: Displays XML in a tree view. Click an element in the tree to copy the element XPath. If creating complex data in the Target field manually, you can paste the XPath into the target XPath field.
      Example payload

      Enter an example payload to generate a complex object. For example, if parsing the response from a REST API step that returns a list of users, enter the expected XML for a single user. This field accepts XML with the following limitations.

      • XML namespaces are not applied to the complex object. More than one namespace in an XML file is not supported and generates an error message.
      • Multidimensional arrays are not supported.
      • Some special characters are not supported, such as hyphen and period. Double colons (::) are not supported in attribute values.
      • Payloads larger than 64,000 characters cannot be saved and generate an error message. However, if working with a large example, you can generate the complex object and delete the example payload before saving the step.
      Generate Target Click to generate a complex object from the example payload. Review and edit the Target field as necessary. Child elements are generated as type String. Alternatively, manually create the target by adding items in the Target field.
      Target

      View the XML payload as a complex object. Generate structured data by clicking Generate Target, or manually add items. For more information, see Complex data.

      Each complex data variable contains this information.

      • Label: Data pill label. By default, the system uses the name of the XML element.
      • Preview: Sample value from the example payload.
      • Type: Data type, which must be String, Object, Array.String, or Array.Object. The top-level item must be an Object.
      • XPath: Path to the element. Modify the XPath to change how source data elements map to complex data variables. If manually adding complex data variables, you can copy the XPath from the Payload view field and paste it in a complex data variable XPath field to ensure the correct hierarchy. Conditional XPath expressions are not supported.

      Click Edit Object to:

      • Change the label, internal name, or data type
      • Add or remove complex data variables
      • Mark a variable mandatory

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login