Destinations

• Destinations
  • Creating a new destination
  • Options
    • FTP Options
    • SFTP Options
    • Network Share Options
    • Amazon S3 - AWS SDK Options

Destinations

You can configure destinations to which publish job output is sent. Use the Configure | Destinations menu to manage destination configurations.

Creating a new destination

When adding a destination, the following fields are available.

Field	Description
ID	An auto-generated ID used to identify the destination
Name	A name for the destination
Alternative Names	Alternative names for the destination that can be used with Burst job output. Each name is on a new line.
Description	A description for the destination
Active	Whether the destination is active or not
Destination Type	The type of destination
Server	For FTP and SFTP destinations, the IP address or host name of the ftp or sftp server. For Network Share destinations, the IP address or hostname of the machine where the share is located.
Port	For FTP and SFTP destinations, the ftp or sftp port of the server. You can leave this as 0 to use the default port for the respective protocol.
User	The user to use to connect to the destination. For Amazon S3 destinations, this is the IAM user's access key id.
Password	The destination user's password. For Amazon S3 destinations, this is the IAM user's secret access key.
Private Key File	For SFTP destinations, the private key file to use if authenticating using public key authentication
Private Key Passphrase	For SFTP destinations, the passphrase of the private key file being used, if the private key file has a passphrase
Domain	For Network Share destinations, an optional specification of the user's domain
Path	The location of the destination. For Network Share destinations, this is the share name. For FTP and SFTP destinations, this is an optional directory path where files should be copied. For Amazon S3 destinations, this is the bucket name.
Sub-Directory	An optional sub-directory path within the destination where files should be copied
Create Directories	Whether directories in the path should be created before the file is copied. The user will need appropriate permissions for the creation of directories.
Options	Additional options for the destination

Note

• For Amazon S3 destinations, the IAM user needs the s3:GetBucketLocation permission in order for the file upload to be successful. In addition, the user will need at least the s3:PutObject permission on the bucket where the file is to be copied.

Options

Some destinations can have additional options that can be specified. These are included in the Options field using JSON syntax.

FTP Options

For FTP destinations, the following options are available.

Attribute	Data Type	Default	Description
connectTimeoutSeconds	Integer	60	The timeout (in seconds) to use when connecting to the server.
controlKeepAliveTimeoutSeconds	Long		The time period (in seconds) after which to send a keep alive (NOOP) message. Zero disables.

SFTP Options

For SFTP destinations, the following options are available.

Attribute	Data Type	Default	Description
sessionConnectTimeoutSeconds	Integer	0	The timeout (in seconds) to use when opening a session. Zero indicates "no timeout".

Network Share Options

For Network Share destinations, the following options are available.

Attribute	Data Type	Default	Description
timeoutSeconds	Integer	60	The timeout (in seconds) for read/write operations.
smbDialects	String[]		The smb dialects to use as per the SMB2Dialect enum e.g. "smbDialects": ["SMB_3_0"]. Normally you would not need to set this, but you can set it to use a particular smb version/dialect.

Amazon S3 - AWS SDK Options

For Amazon S3 - AWS SDK destinations, the following options are available.

Attribute	Data Type	Default	Description
region	String	us-east-1	The region that will process the requests. This is not necessarily the region where the bucket is located. You can set a region near where the ART server is in order to get faster operation. See the s3 regions documentation for a list of possible region values.