Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Diagram

Unable to render 'XSD Viewer' macro

Could not find the given XSD (xsd_macro411c0bc89cc11c85159110482f718981.png) on page (JADE Parameter Reference - HTTPFragment)

Elements

HTTPFragment
References Notes

This element includes the parameters for an HTTP file transfer connection including BasicAuthentication and URLConnection configuration items.

Any number of fragments can be configured and are distinguished by YADE according to their name attribute.

A fragment is referenced by a transfer profile using the value of the HTTPFragmentRef ref attribute.

name

This attribute identifies the current fragment. Any number of fragments can be used and are distinguished by YADE according their name.

A fragment is referenced by a transfer profile using the value of this attribute.

Element Type Required Description
Attribute: name NMTOKEN
Required

This attribute identifies the current fragment. Any number of fragments can be used and are distinguished by YADE according their name.

A fragment is referenced by a transfer profile using the value of this attribute.

URLConnection [URLConnectionType]
  • Occurrence: 1
Required
References Notes

A URL connection specifies parameters such as a Hostname, Port, Account by which a connection is established within the URL.

The use of URLs depends on the server system, e.g. the following protocols and configuration items could be used:
http|https :// [ account [ : password ] @ ] hostname [ : port ]
If the port is empty, the default ports will be used:

  • HTTP: 80
  • HTTPS: 443
URLConnectionType / URL anyURI
  • Min: 1
  • Whitespace: collapse
  • Occurrence: 1
Required
References Notes

A URL connection specifies parameters such as a Hostname, Port, Account by which a connection is established within the URL.

The use of URLs depends on the server system, e.g. the following protocols and configuration items could be used:
http|https :// [ account [ : password ] @ ] hostname [ : port ]
If the port is empty, the default ports will be used:

  • HTTP: 80
  • HTTPS: 443
BasicAuthentication [BasicAuthenticationType]
  • Occurrence: 0..1
Optional
References Notes

The BasicAuthentication element specifies the credentials for authentication with a server, e.g. using an FTP protocol or a Proxy Protocol. Child elements include:

  • Account for authentication. For Windows Systems an account could include the domain.
  • Password for authentication. Passwords are not displayed in the YADE log files.

BasicAuthentication is available for a number of File Transfer Protocols and Proxy Protocols. The drawback with BasicAuthentication is that passwords are stored directly in configuration files. In order to avoid this you could switch to using File Transfer Protocols that allow SSHAuthentication, e.g. SFTP.

BasicAuthenticationType / Account string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

Account for authentication at one of the systems involved in file transfer, e.g. an FTP or SFTP server. Usually the account corresponds to a user name.

Should the respective server system be part of a Windows domain then the syntax domain\account can be used.

Support for KeePass versions 1 and 2.

Note: Availability starting with YADE-464.

Referencing CredentialStore fields.

Note: Availability starting with YADE-481.

Referencing a field in the CredentialStore is effected by the following syntax:

        cs://[entry_path]@entry_field

where

  • cs://         is a constant prefix that is used by YADE to identify this setting to be a reference to a CredentialStore.
  • entry_path      specifies the path to an entry within the CredentialStore database. Folders (groups) within a path are separated by a slash "/". This setting is optional. If ommitted then the value of the CSEntryPath configuration item is used.
  • entry_field          is one of the standard fields available in a CredentialStore:
    • title
    • user
    • password
    • url
    • notes
    • attachment
    or the custom fields.

<Hostname> element:

  • Usage like the examples below.
  • If the entry field value is defined with host:port, YADE sets the <Hostname> and <Port> automatically.

Examples

  • Examples for fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://sos/mft_server/srv001@title
      • cs://sos/mft_server/srv001@user
      • cs://sos/mft_server/srv001@password
      • cs://sos/mft_server/srv001@url
      • cs://sos/mft_server/srv001@notes
      • cs://sos/mft_server/srv001@my_custom_field
    • <AuthenticationFile> element:
      • cs://sos/mft_server/srv001@attachment - the first attachment
      • cs://sos/mft_server/srv001@my_custom_field - a specified attachment
  • Examples without fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://@title
      • cs://@user
      • cs://@password
      • cs://@url
      • cs://@notes
      • cs://@my_custom_field
    • <AuthenticationFile> element:
      • cs://@attachment - the first attachment
      • cs://@my_custom_field - a specified attachment
BasicAuthenticationType / Password string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Password for authentication at a server that is involved in file transfer, e.g. with an FTP or SFTP protocol or Proxy protocol that makes use of BasicAuthentication.

Passwords are not displayed in the YADE log files.

A drawback is that passwords are visible in YADE configuration files. In order to avoid this you could switch to using File Transfer Protocols that allow SSHAuthentication, e.g. SFTP.

Support for KeePass versions 1 and 2.

Note: Availability starting with YADE-464.

Referencing CredentialStore fields.

Note: Availability starting with YADE-481.

Referencing a field in the CredentialStore is effected by the following syntax:

        cs://[entry_path]@entry_field

where

  • cs://         is a constant prefix that is used by YADE to identify this setting to be a reference to a CredentialStore.
  • entry_path      specifies the path to an entry within the CredentialStore database. Folders (groups) within a path are separated by a slash "/". This setting is optional. If ommitted then the value of the CSEntryPath configuration item is used.
  • entry_field          is one of the standard fields available in a CredentialStore:
    • title
    • user
    • password
    • url
    • notes
    • attachment
    or the custom fields.

<Hostname> element:

  • Usage like the examples below.
  • If the entry field value is defined with host:port, YADE sets the <Hostname> and <Port> automatically.

Examples

  • Examples for fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://sos/mft_server/srv001@title
      • cs://sos/mft_server/srv001@user
      • cs://sos/mft_server/srv001@password
      • cs://sos/mft_server/srv001@url
      • cs://sos/mft_server/srv001@notes
      • cs://sos/mft_server/srv001@my_custom_field
    • <AuthenticationFile> element:
      • cs://sos/mft_server/srv001@attachment - the first attachment
      • cs://sos/mft_server/srv001@my_custom_field - a specified attachment
  • Examples without fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://@title
      • cs://@user
      • cs://@password
      • cs://@url
      • cs://@notes
      • cs://@my_custom_field
    • <AuthenticationFile> element:
      • cs://@attachment - the first attachment
      • cs://@my_custom_field - a specified attachment
CredentialStoreFragmentRef
  • Occurrence: 0..1
Optional
References Notes

This element references the fragment that is used to insert configuration items from a secure store into a file transfer configuration.

Any number of reusable CredentialStoreFragment elements can be configured and are distinguished by YADE based on their name attribute.

The reference to a fragment is based on the value of the ref attribute of this element to the corresponding name attribute of the CredentialStoreFragment element.

Support for a jump host.

Note: Availability starting with YADE-488.

ref

This attribute identifies the fragment that is used for inserting secure configuration items.

JumpFragmentRef
  • Occurrence: 0..1
Optional
References Notes

Any number of reusable JumpFragment elements can be configured and are distinguished by YADE based on their name attribute.

This element identifies the JumpFragment that is applied for use of a jump host in a file transfer.

The reference to a fragment is based on the value of the ref attribute of this element to the corresponding name attribute of the JumpFragment element.

ref

This attribute identifies the fragment that is used for a jump host.
ProxyForHTTP
  • Occurrence: 0..1
Optional

Proxies can make use of different protocols, a HTTPProxy - as the name suggests - will use the HTTP protocol

HTTP proxies optionally support authentication.
HTTPProxy [AuthenticatedProxyType]
  • Occurrence: 1
Required
References Notes

Proxies can make use of different protocols, a HTTPProxy - as the name suggests - will use the HTTP protocol

HTTP proxies optionally support authentication.
HTTPHeaders
  • Occurrence: 0..1
Optional
References Notes

HTTP headers let the client and the server pass additional information with an HTTP request or response.
YADE allows to specify HTTP headers individually per HTTP(S) transfer fragment or HTTP(S) transfer fragment reference.

HTTPHeader string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1..unbounded
Required
References Notes

This parameter specifies a HTTP header, which is used for a HTTP(S) file transfer.
Name and value are separated by the first space, e.g.:

  • Accept text/html
  • Content-Type application/json; charset=utf-8
  • Keep-Alive timeout=5, max=1000

Account

user name has to be stated in uppercase letters

Password

at least 8 characters have to be specified

  • No labels