Modify an SFTP (embedded) pickup or delivery

After you create an SFTP embedded server pickup or delivery, you can view and modify certain fields that define the object.

SFTP (embedded) settings tab (pickup)

  • Embedded SFTP server – The name of the Activator embedded server. A link is provided to view the settings for the embedded server. You also can change servers.
    • View settings for this embedded server – Click this link to open the Change this embedded server screen for this exchange. For a description of the fields you can view when you click this link, see SFTP (embedded) server fields.
  • Host – The name used by Activator for the computer running the embedded server. You cannot change this field.
  • Host used by partners – The fully qualified domain name or IP address your partners use pick up messages from this exchange. When you export your community profile as a partner profile, the host information becomes part of your exported partner profile.
  • You can change this field by clicking View settings for this embedded server (see above) and changing the External host or IP address field. If your network uses a load balancer or firewall, contact your network administrator for the correct value. Any change to this field affects all delivery exchanges that reference the server.

SFTP (embedded) settings tab (delivery)

  • Embedded SFTP server – The name of the server. A link is provided to view the settings for the embedded server. You also can change servers.
  • View settings for this application – Click this link to open the Modify Application Pickup screen for this exchange. This enables you to configure settings for the screens described below. For a description of the fields you can view when you click this link, see SFTP (embedded) transport configuration.
  • Host – The name used by Activator for the computer running the embedded server. You cannot change this field.
  • Host used by partners – The fully qualified domain name or IP address your partners use to send messages to this delivery exchange. When you export your community profile as a partner profile, the host information becomes part of your exported partner profile.
  • You can change this field by clicking View settings for application (see above) and changing the External host or IP address field. If your network uses a load balancer or firewall, contact your network administrator for the correct value. Any change to this field affects all delivery exchanges that reference the server.
  • Preserve original filenames – Select this option if you want original file names to be preserved when Activator delivers messages.
  • For binary messages, we recommend that you preserve original file names. Otherwise, Activator assigns a unique file name that does not readily identify the contents of the file. Preserving original file names also allows your back-end application to process binary messages based on their file names.
    • Overwrite duplicate filenames – An option when you choose to preserve original file names. If duplicate file names are detected, Activator overwrites the existing file.
    • Sequentially number duplicate filenames – An option when you choose to preserve original file names. If duplicate file names are detected, Activator appends a number to the new file. For SFTP, the appended number is hexadecimal and has the format: filename_c4.
  • Generate unique filenames – Select this option to have the system provide a unique file name instead of using the original name.
  • When this option is selected, files are given arbitrary names. The names always have less than 30 characters and often have less than 20 characters.
  • Appended to the file name is a hex representation of a monotonically increasing file name counter that is maintained in the database and guaranteed to be unique across all nodes in a cluster. In addition, if the original file name had an extension, the same extension is appended to the unique name the system generates.
  • The following are examples of unique file names generated by the system, one with the original file extension and one without:
    • dabeed45_4cb.edi
    • z47e4120_4ce

Directories tab (pickup)

On this tab you configure pickup directories associated with SFTP user accounts. Paths begin from the home directory of the SFTP user account. Activator places messages in these directories for the partners or for the back-end system to download.

If the partner or back-end system uses the same account to upload messages, you must configure a separate directory for uploads on a delivery exchange.

If no account exists, click Add to add an account and associated directory.

Directories tab (delivery)

On this tab you configure delivery directories associated with SFTP user accounts. Paths begin from the home directory of the SFTP user account. Activator places messages in these directories for the partners or for the back-end system to upload.

If the partner or back-end system uses the same account to pick up messages, you must configure a separate directory for pickups on a pickup exchange.

If no account exists, click Add to add an account and associated directory.

Advanced tab (pickup)

  • Allow SFTP clients to add, remove subdirectories – Enable subdirectory management on the client side.
  • Sequence consumed messages based on their delivery exchange – Select this option if you want messages that are consumed by this pickup to be delivered in their original consumption order per resolved destination delivery. When Activator consumes messages on this pickup that are delivered over multiple delivery exchanges, the messages are filtered and ordered in their consumed sequence for each delivery, and processed in parallel per delivery. For details about this functionality, see Sequential message delivery.
    • Timeout to apply for out of sequence messages (seconds) – Default = 60 seconds. Enter a time limit for Activator to wait for missing messages of a sequence before taking the appropriate action. This feature avoids the blocking of processing when a sequenced message is not available.
  • Backup files that go through this transport – Indicates whether the system backs up copies of the messages uploaded by partners or back-end applications through this embedded server.
  • Backing up files is strongly recommended. This is required for the system to perform fail-over operations such as attempting to send messages again (retries) in case of a transport connection failure. Without backups, a message in process cannot be recovered if the server or a processing node stops or restarts. Backups also are needed if you want the ability to resubmit messages to a back-end application or resend messages to partners.
  • Backup files are stored in <Activator_common_directory>\data\backup, unless you specify otherwise.
  • Encrypt backup files and prevent storage of non-encrypted data initiated through this transport – Select this option if you want to prevent the storage of non-encrypted backups (payloads) of messages processed through the system. This applies to packaged transports only.
  • If you select this option, encrypted backups are still stored unless the backup option on the pickup is disabled. Message Tracker records are always stored.
  • Restrict maximum file size for this transport – Use this option to specify the maximum size of files a transport can handle.
  • If the pickup consumes a file larger than the specified maximum, the file is rejected and a message is written to the events log.
  • Express the maximum size in bytes. Do not use commas. For example, a kilobyte is 1024 bytes, a megabyte is 1048576 bytes, a gigabyte is 1073741824 bytes. The smallest maximum allowed is 1000 bytes. On the opposite extreme, you can enter the largest number the field can accommodate.

Advanced tab (delivery)

  • Retries – (For partner trading delivery only.) The number of times Activator accepts retries to connect from the trading partner if the initial attempt to connect and download files fails.
  • Use custom retry intervals – Select this option to override the default retry intervals with intervals of your choice for this delivery exchange. Default intervals are 5, 10, 15, 30, and 60 minutes. When you select this option, you must enter at least one interval (in minutes) in the Custom retry intervals field. You can enter as many intervals as you like, separated by commas. Activator applies the intervals between successive retry attempts. If necessary, the last interval you list is repeated until either the delivery is successful or the number of permitted retries is reached.
  • Delete file after it is downloaded – Select this if you want the server to delete files after they have been downloaded from it.
  • Allow SFTP clients to add, remove subdirectories – Enable subdirectory management on the client side.
  • Back up the files that go through this transport – Indicates whether the system backs up copies of the messages downloaded by partners or back-end applications through this embedded server.
  • Backing up files is strongly recommended. This is required for the system to perform fail-over operations (retries) in case of a transport connection failure. Without backups, a message in process cannot be recovered if the server or a processing node stops or restarts. Backups also are needed if you want the ability to resubmit messages to back-end applications or resend messages to partners.
  • Backup files are stored in <Activator_common_directory>\data\backup, unless you specify otherwise.
  • Encrypt backup files and prevent storage of non-encrypted data initiated through this transport – Select this option if you want to prevent the storage of non-encrypted backups of messages processed through the system.
  • Post-processing script – The full path to an executable file that contains post-processing commands.
  • See Post-processing of consumed messages.

Related Links