URL Options

Help Contents

Introduction

Some SCADA applications need to access files using a URL. For example:

A SCADA application that controls temperature and humidity might use weather forecast data to optimize operation. Fernhill SCADA provides a URL Scanner Tag, which can download a file from a URL and extract data fields from the file. Used with a web service that provides forecast data, the URL Scanner Tag can provide the data you need for your optimized application.
A SCADA application that monitors renewable energy production might be required to upload production data to an FTP server. Fernhill SCADA provides a Text Report Tag that can automatically upload the report output to a URL. You can configure the Text Report Tag to add the required data to a report and upload the report automatically.

URL Options allow you to configure how a file is transferred to a URL.

Where URL Options are Used

Fernhill SCADA uses URL Options in these areas:

In the UploadURLOptions property of the Text Report Tag. When the report output is uploaded to a URL, the URL Options are used to configure the transfer.
In the URLOptions property of the URL Scanner Tag. When the tag reads the file from the URL, the URL Options are used to configure the transfer.
In the Options Parameter of the TextDocFromUrl Function Block. When the Function Block reads the document from the URL, the URL Options are used to configure the transfer.

Supported URL Options

These URL options are supported:

URL Option	Description
--anyauth	Allow any HTTP authentication method.
--append	When uploading a file to a URL, the new content is appended to any existing file. If the remote file does not exist, it will be created. Note: This option is only supported with the FTP and SFTP file transfer protocols.
--basic	Allow HTTP basic authentication method.
--ciphers <list>	Set the list of ciphers to use with a secure connection.
--connect-timeout <Time>	Set the maximum time allowed for the connection in seconds.
--crlf	When uploading, convert a line feed to a line feed and carriage return combination.
--data <PostData>	For HTTP requests: The request type is changed to POST. PostData is sent in the message part of the request.
--digest	Allow HTTP digest authentication method.
--disallow-username-in-url	Fail the transfer is a username is used in the URL.
--ftp-port <Address>	Use PORT mode in FTP transfers instead of PASV.
--ftp-pret	Send an FTP PRE Transfer command (PRET) before sending the file with PASV.
--header <HttpHeader>	Add a custom header <HttpHeader> to an HTTP request.
--mail-auth <Address>	The originator address of the email. If used multiple times, the last <Address> is used.
--mail-from <Address>	The email is sent from this address. If used multiple times, the last <Address> is used.
--mail-rcpt <Address>	Set a recipient address for the email. Use once for each recipient.
--max-time <Time>	Set the maximum time allowed for the transfer in seconds.
--negotiate	Allow HTTP negotiate authentication method.
--ntlm	Allow HTTP ntlm authentication method.
--ntlm-wb	Allow HTTP ntlm authentication method with WINBIND.
--oauth2-bearer <Token>	Set the Oauth2 bearer token.
--path-as-is	Do not remove any back references '..' in the path.
--post301	Use POST after receiving an HTTP 301 redirect.
--post302	Use POST after receiving an HTTP 302 redirect.
--post303	Use POST after receiving an HTTP 303 redirect.
--proto-default <Protocol>	Set the default protocol to use when the protocol is not set in the URL: FTP, HTTP, SMTP, and so on.
--proxy <Address>	Set the address of the proxy server.
--proxy-header <HttpHeader>	Add the custom header <HttpHeader> to requests sent to an HTTP Proxy server.
--request <Type>	Changes to request code to <Type>.
--tcp-fastopen	Speed up following TCP connections using the TCP Fast Open option.
--tftp-no-options	Do not send any options in TFTP transfers.

Examples

--max-time 30
Allow no more than 30 seconds for the transfer.
--proxy http://userproxy:8080/
Route requests through a proxy server.
--header 'X-Auth-Token: ZZZZ-O25HVDg7bER2IW5Zci1nSk5DNHhRekE='
Adds a custom header to an HTTP request.
--data 'ReportType=CSV&TimeSpan=1h'
Sends an HTTP POST request with data 'ReportType=CSV&TimeSpan=1h'.

Further Information

Fernhill SCADA Concepts

To learn about other Fernhill SCADA Concepts.

Glossary

For the meaning of terms used in Fernhill SCADA.