Product Knowledge Base

Space shortcuts

Page tree

Diagram

Elements

Fragments
References Notes

The branch element for reusable transfer configuration.

Subsequent fragments are used e.g. for file transfer specifications, notifications, mail server settings, that can be used in a number of file transfer Profiles.

A fragment specifies how a file transfer is carried out whereas a Profile specifies what should be transferred. Therefore multiple profiles can use the same fragments, e.g. to transfer different files from the same source or to reuse the same transfer specification as the source and the target in different transfer operations.

Element Type Required Description
ProtocolFragments
  • Occurrence: 1
Required
References Notes

Fragments are a means to organize file transfer settings in a reusable way:

  • Fragments are created to define settings that are specific for a file transfer protocol, e.g. FTP, SFTP, WebDAV.
  • File transfer protocols include settings for e.g. FTP BasicAuthentication, BasicConnection.
  • Such fragments do not include settings for an individual file transfer, e.g. the file Selection, as such settings are used in a Profile that specifies parameters for a file transfer Operation.
  • Each Profile references a fragment for the source and optionally for the target of a file transfer operation. Therefore multiple profiles can use the same connection that is specified in a fragment.

Any number of fragments can be configured. They are distinguished by their name attribute. References to a fragment use the value of the name attribute to identify the respective fragment.

NotificationFragments
  • Occurrence: 0..1
Optional
References Notes

Notification fragments are used to specifiy how notifications will be sent to recipients in case of file transfers.

CredentialStoreFragments
  • Occurrence: 0..1
Optional
References Notes

Fragments for credential stores are a means to organize secure settings in a reusable way:

  • Fragments are created to define settings that are specific for a file transfer protocol, e.g. FTP, SFTP, WebDAV.
  • Each Profile references a number of CredentialStoreFragments for secure settings in ProtocolFragments of a file transfer operation.
  • Multiple Profiles can use the same credential store that is specified in a fragment.
  • A Profile can reference multiple CredentialStoreFragment elements.

Any number of fragments can be configured. They are distinguished by their name attribute. References to a fragment use the value of the name attribute to identify the respective fragment.

MailServerFragments
  • Occurrence: 0..1
Optional
References Notes

Mail server fragments are used to specifiy by what mail server notifications will be sent to recipients in case of file transfers.

 

Explanations

  • The Fragments refer to that part of the configuration that describes how the transfer is to be carried out – i.e. per FTP proxy.
  • At least a minimum set of ProtocolFragment parameters has to be provided.

ProtocolFragment

  • The ProtocolFragment describes how the file transfer is to be carried out – i.e. per FTP proxy.

AlternativeFragments

  • Define how the transfer is to be carried out when either the connection or authentication specified in the ProtocolFragment cannot be made.
  • AlternativeFragments are not be called after a connection has been made and authenticated and an error occurs.

NotificationFragments

  • The NotificationFragments describe how notifications about the transfer are to be transmitted, e.g. by e-mail.

CredentialStoreFragements

  • A secure store can be used for credentials, e.g. KeePassX, and parameters can reference e.g. Account and Password from the secure store.
  • At run-time YADE replaces references to the credential store by the respective values from the store. This prevents e.g. passwords from being exposed in YADE configuration files.

 

  • No labels