XML parser step
Summarize
Summary of XML parser step
The XML parser step in ServiceNow's Workflow Studio enables you to extract and map structured data from an XML payload to a complex object output without scripting. This allows you to use the parsed data in subsequent steps or actions within your workflows. The step requires an active Integration Hub subscription and is designed to simplify XML data handling by automatically populating complex objects at runtime based on the XML input.
Show less
Key Features
- Integration Hub Requirement: The step is available after activating the necessary plugin and is accessible under Integrations.
- User Roles: Users with the
actiondesignerrole can create custom actions incorporating this step. - Payload Size Limits: At runtime, supports XML payloads up to 10 MB; for larger payloads, Data Stream actions are recommended. At design time, sample payloads up to 64,000 characters are supported.
- Source Data Configuration: Select or drag a data pill containing XML data (e.g., REST step response) as the Source. Example payloads help generate the complex object output structure.
- Supported XML Constraints: No XML namespaces in complex objects, no multiple namespaces, no multidimensional arrays, and restrictions on special characters and attribute values (e.g., no double colons "::"). Payloads larger than 2 MB cannot be saved as examples.
- Payload Views: Choose between Raw (editable XML) and Structured (tree view) to view and interact with the example payload; XPath for elements can be copied from the tree view for accurate mapping.
- Target Structure Generation: Automatically generate the output structure from the example payload or manually create and edit the complex object output. Child elements default to strings but can be customized.
- Element Configuration: Define labels, internal names (with naming restrictions), data types (String, Object, Array.String, Array.Object), mandatory flags for strings, and add nested child elements.
- Advanced Options: Save object structures as templates for reuse, and add max length, hints, and default values for string elements.
- XPath Mapping: Modify or input XPath expressions to control how XML elements map to complex object fields; conditional XPath expressions are not supported.
Practical Application for ServiceNow Customers
This step empowers customers to efficiently parse XML responses from integrations, such as REST APIs, into structured data that can be used throughout workflows without custom scripting. The automatic generation of complex object outputs speeds up integration development while providing flexibility to customize data mappings. Payload size limits and XML restrictions guide users to design compatible and performant workflows. Leveraging the XML parser step helps maintain clean, maintainable integration logic and accelerates automation processes involving XML data.
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.
Roles and availability
Available as an Workflow Studio 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 | In the Source data field, 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. Under Source data and in the scripting window, 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:
|
| Structured Payload View | Select a view for the example payload.
|
| Generate Target | Select Generate Target to create the step's output structure from your example payload. Your output data structure appears in the Target field. Child elements for each object are automatically generated as type String. Alternatively, you can manually create your target complex object by adding elements in the Target field. |
| Target | View or edit the XML payload's output structure. Create a structured output by clicking Generate Target, or manually add elements. Each element contains the following information in the Edit Object view:
Elements of type Object contain the Save as Template advanced option, which allows you to save your object's structure as a complex object template. You can then use this template to define the schema of an Object output for your action. For elements of type String, you can also add a max length, hint, and default value as advanced options. In the Target header, select Exit Edit Mode when you're
done making changes to your output's structure. You can then select the toggle
advanced inputs icon ( The XPath is the 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. |
) to add a nested child element.
) to view the