Configuring Additional Settings for a Virtual Folder

Field

Description

Folder name

Type a different virtual folder name.

Partner

You can perform one of the following:

If you do not want to associate the virtual folder with a partner or your enterprise, select No partner.

If you want to associate the virtual folder with your enterprise, select Enterprise.

If you want to associate the virtual folder with a partner:

1. Select Partner.

2. Select a partner from the list or type a new partner name.

3. Click Create.

Location

This folder has a physical location

Select this option if you want to associate the virtual folder with a physical location.

Local file path

To specify a file path in your local file system, select this option, and type the complete file path or browse the file path location. For example, FILE://c:/ProjectFolder/download/ or FILE:////host/SharedFolder/.

Remote path

To specify a file path in a remote server, select this option, a protocol (transport mechanism) from the list, and type the file path location. For example, FTP://host:port/DestinationFolder/.

Type a User name and Password for the remote server.

If you select FTPES, FTPS, SFTP, or HTTPS protocol, type the certificate alias for the Keystore alias(Optional).

For FTP, FTPES, FTPS and SFTP protocols, use the Connection pool size option to restrict the number of connections to a third-party server at the VFS level. The default value is unlimited, and it allows any number of connections to be made using the VFS. Set the Connection pool size to a numeric value to restrict the number of connections made through that VFS across the server or actions.

For the SFTP protocol, select Two-factor authentication if you want ActiveTransfer to authenticate the user with both password and private key when establishing a connection with an SFTP server.

You can configure the preferred cipher from the list of supported cipher in Preferred cipher field. Additionally, if you want to remove a cipher from the supported cipher list, then you set configure it on the Excluded cipher field.

If you select SMB protocol, you can select the SMB version that you want to connect to. Additionally, you need to select SMB 2.0 to use the services of the SMB version 2.0 or later. The SMB protocol supports controlling of SMB dialect variants and encryption of data for SMB3. Dialects are versions of the SMB protocol that are defined based on additions and changes relative to a previous version. SMB client and server negotiate the matched set of capabilities based on the SMB dialect selected.

Fields	Description/Action
Dfs enabled	The Distributed File System (DFS) functions provide the ability to logically group shares on multiple servers and to transparently link shares into a single hierarchical namespace.
Data encryption enabled	Adds the capability to make data transfers secure by encrypting data.

Note:
You can add the property mft.smb.v2.dialect.default to the property.cnf file and assign any of the following dialects. However, the dialect selection on the ActiveTransfer user interface takes priority over this property file, if you have made a selection in the ActiveTransfer user interface.

SMB_2_0_2

SMB_2_1

SMB_3_0

SMB_3_0_2

SMB_3_1_1

If you want to configure the VFS with Amazon-S3 storage type, then use the following fields:

Fields	Description/Action
Bucket name	Specify the Amazon-S3 bucket name.
Folder path	Specify the folder path for the bucket which you define in the Bucket name. Note: If you do not specify the folder path, then the root of the bucket will be considered by default.
Region name	Choose the AWS ( Amazon Web Services ) region from the drop-down list. This is the location where your bucket resides.
Access key ID	Specify the access key id to access the Amazon-S3 bucket. .
Secret access key	Specify the secret key which corresponds to the Access Key ID that has the access to Amazon-S3 bucket.

If you want to configure the VFS with Hosted-S3 storage type, then use the following fields:

Fields	Description/Action
Bucket name	Specify the Hosted-S3 bucket name.
Folder path	Specify the folder path for the bucket which you define in the Bucket name. If you do not specify the folder path, then the root of the bucket will be considered by default.
Access key ID	Specify the access key id to access the Hosted-S3 bucket. .
Secret access key	Specify the secret key which corresponds to the Access Key ID that has the access to Hosted-S3 bucket.
Endpoint	Specify the Endpoint to access the Hosted-S3 bucket.
URL Style	Choose one of the following addressing models: Path. In this URL model, the hostname is s3-hosted.example.com and the bucket name is specified in the path as /bucket-name/. For example, https://s3-hosted.example.com/bucket-name/ Virtual host. This URL model involves including the bucket name as a subdomain of the hostname. For example, https://bucket-name.s3-hosted.example.com/

Note:
New remote protocols will be added to the Virtual folders page exclusively. Scheduled and post-processing actions can opt for a virtual folder option that directs to the remote location. This will be applicable from Hosted-S3 onwards.

If you want to configure the VFS with Azure storage type, then select the AZURE-FILE or AZURE-BLOB from the drop-down list.

Note:
ActiveTransfer currently supports only AZURE-FILE shares and AZURE-BLOB containers.

To configure the VFS with AZURE-FILE, use the following fields:

Fields	Description/Action
Authentication type	Specifies the authentication information that must be sent to the Azure storage type for authorizing the access to specific resources. File shares supports Shared Key and Shared access signature (SAS) authentication type. Choose one of the following ways to provide the authentication information: Shared Key: The shared key type passes a header with each request that is signed using the respective storage account access key. Enter the values for the following fields: Account name: Specify the account name that corresponds to the Azure account for the AZURE-FILE location. Account key: Specify the key which you create at the Azure portal for the corresponding Account name. Shared access signature (SAS): The shared access signature type provides secure delegated access to resources in your storage account without compromising the security of your data. Additionally you can control what resources the client may access, what permissions they have on those resources, and how long the SAS is valid, among other parameters. Account name: Specify the account name that corresponds to the Azure account for the AZURE-FILE location. SAS token: The SAS token is a string that you generate in the Azure portal for an account.
Location	Specify the location where the folder for the file shares resides.

To configure the VFS with AZURE-BLOB, use the following fields:

Fields	Description
Authentication type	Specifies the authentication information that must be sent to the Azure storage for authorizing the access to resources. The AZURE-BLOB supports Shared Key, Shared access signature (SAS), and Anonymous public access authentication types. Choose one of the following ways to provide the authentication information: Shared Key: The shared key type passes a header with each request that is signed using the respective Storage Account Access Key. Enter the values for the following fields: Account name: Specify the account name that corresponds to the Azure account for the blob location. Account key: Specify the key which you create at the Azure portal for the corresponding Account name. Shared access signature (SAS): The shared access signature type provides secure delegated access to resources in your storage account without compromising the security of your data. Additionally you can control what resources the client may access, what permissions they have on those resources, and how long the SAS is valid, among other parameters. Account name: Specify the account name that corresponds to the Azure account for the blob location. SAS token: The SAS token is a string that you generate in the Azure portal for an account. Anonymous public read access: The anonymous public read access type provides you with read access within a publicly accessible container without authorizing the request.
Storage sub-type	The below mentioned are the two types of storage sub-type: Block Blob: It stores the unstructured data such as files, media, images, documents, and so on in blocks. Append Blob: It appends the unstructured data such as files, media, images, documents and so on.
Location	Specify the Azure container folder path for the Location field.
Upload Options
Storage size	Specifies the size of each part of the file which gets uploaded to the blob container.
Azure headers	Add the additional header parameters to set the extra metadata for the blob container. Click to add the Header key and Header value information. The list below provides the supported headers: cacheControl contentType contentEncoding contentLanguage contentDisposition

Note:
For more information on AZURE-FILE shares and AZURE-BLOB containers, refer Azure documentation.

Note:
For a list of known endpoint specific limitations, see Limitations.

If you want to configure the VFS with Google Cloud Platform (GCP) storage type, then use the following fields:

Fields	Descritption/Action
Service account private key	Specify the encoded private key (a JSON file) for a service account. This key is used to authenticate the service account and authorize it to access GCP resources. Open your Google Cloud console settings. Go to IAM & Admin > Service Accounts. Click Create service account. Provide the configured email address. Click keys tab and add the JSON key. Refer Google Cloud documentation for more information.
Bucket name	Specify the GCP bucket name.
Folder path	Specify the folder path for the bucket. If you do not specify the folder path, then the root of the bucket is considered by default.

Select Use proxy if you want to route file transfers to remote servers through a proxy server, and select one of the following options:

Global proxy settings: If you want ActiveTransfer to use the default proxy server alias set up in Integration Server or ActiveTransfer.

Select proxy alias: If you want to use a specific proxy server alias for the virtual folder, then select the appropriate proxy server alias to use from the available list.

Click Test Connection to check the connection to the remote location.

Select High availability download recovery if you want ActiveTransfer Server to recover from a download that was not completed.

Select Passive if you want to enable ActiveTransfer Server to connect to a remote server using the passive mode. ActiveTransfer Server uses the active mode by default. This option is applicable for FTP, FTPS, and FTPES protocols.

Select Force CWD to extract directory if the FTP server you are connecting to allows file operations only on the current directory. Enabling this option forces a change to the target directory before executing the file operations.

Note:
Sending MKDIR or CWD to a directory with no files results in error.

Note:
Sending RMD after deleting all files in a directory results in error.

Permissions

Add a user, role, or group to the virtual folder and configure the following permissions as required: User name, Role name, or Group name for a user, role, and group respectively, View, Download, Upload, Delete, Create folder, Delete folder, Rename, Resume, Share/Publish, or Quota limit (MB). Support for these permissions is dependent on the specific VFS that you are configuring.

Note:
The Share/Publish permission is disabled for remote path locations by default.

For more information about users, roles, or groups to associate with virtual folders, see Overview.

Encryption/Decryption

File-based encryption

Select the public PGP certificate alias in the Public PGP Key alias box.

Note:
When a file is uploaded, it gets encrypted.

File-based decryption

Select the private PGP certificate alias in the Private PGP Key alias box.

Note:
When the same file is downloaded, it gets decrypted.