Saltar al contenido principal
waffle.svg
Domo

XML Advanced Connector

Version 2

 

Important: When referencing this page outside of Knowledge Base, use this link: http://knowledge.domo.com?cid=xmladvanced
 

Intro

Extensible Markup Language (XML) is a simple, very flexible text format. The Domo XML connector allows you to access XML files you have uploaded to an SFTP server.

Note: Due to security concerns, Domo no longer permits uploading data using FTP. If necessary, please update your server settings to support SFTP instead of FTP. 

You can also import files via HTTPS calls. For more information about XML, see http://www.w3.org/TR/xml/ .

You connect to your XML account in the Data Center. This topic discusses the fields and menus that are specific to the XML connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Primary Use Cases

Pulling XML data into Domo.

Primary Metrics

N/A

Primary Company Roles

IT

Average Implementation Time

3 hours

Ease of Use (on a 1-to-10 scale with 1 being easiest)

5

Prerequisites

To connect to your XML account and create a DataSet, you must have credentials for the server in which the XML file is found.

You must also whitelist a number of IP addresses on your database server on the port you want to connect to. For the full list of IP addresses, see Whitelisting IP Addresses.

For more information about whitelisting, see Whitelisting IP Addresses.

Connecting to Your XML Account

This section enumerates the options in the  Credentials and Details  panes in the XML Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your XML account. The following table describes what is needed for each field:  

Field

Description

Username Enter the username for the server where the XML file is located.
Password Enter the password for the server where the XML file is located.

Once you have entered valid XML credentials, you can use the same account any time you go to create a new XML DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Details Pane

In this pane you specify the server/SFTP site to connect to, the name of the XML file, and other configuration settings.

Menu

Description

Connection Method

Select whether you want to connect to your XML file via file transfer (SFTP file) or HTTP request.

  • Select File Transfer (SFTP file) if your XML file is on an SFTP server.

  • Select HTTP Request if you need to access your XML file using an HTTP GET request. The request is triggered by the use of a unique URL parameter defined by the service providing the XML file.

URL to Your XML File

Enter the URL for the XML file. Supported protocols are HTTPS and SFTP.

Note: Due to security concerns, Domo no longer permits uploading data using FTP. If necessary, please update your server settings to support SFTP instead of FTP. 

You must provide the URL as well as the fully qualified path including the filename. For example: sftp://hostname/home/text/file.xml

You can also specify the file to process by using our date function. Name your file using the following date format:

file_[yyyyMMdd]_suffix.xml

Additionally you can select the most recent file by using this naming convention:

[latest].xml

Data Tag

Enter the tag for the data in your XML text.

Do You Require Additional Options?

Select Yes if you need to exclude fields or use XPath.

Fields to Exclude (Optional)

Provide a comma-separated list of fields to exclude from the XML import.

Enter XPath Expression (Optional) Enter your XPath query using standard XPath syntax as defined by the World Wide Web Consortium. (http://www.w3.org/TR/2014/REC-xpath-30-20140408/)
HTTPS Headers

Enter additional headers for an HTTPS XML URL. Please provide these in the following format:

headerName1 = 'headerValue1' and headerName2 = 'headerValue2'

HTTPS Body

Enter additional request body for an HTTPS XML URL. Please provide these in the following format:

name1 = 'Value1' and name2 = 'Value2'

Query Parameters

Enter additional query parameters for an XML URL. Please provide these in the following format:

paramName1 = 'paramValue1' and paramName2 = 'paramValue2'

Date Query Parameters

Enter additional date query parameters for an XML URL. Please provide these in the following format :

paramName1 = 'paramValue1' and paramName2 = 'paramValue2'. Specify paramValue as X, XDay or XDays, where X is a positive integer. For example: 30Days

Date Format for Date Query Parameters

Enter the required date format for your date query parameters.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.

Troubleshooting

  • Make sure the XML data is valid and that the credentials are up-to-date.

  • Whitelist necessary IP addresses.