Box Tasks

Properties   Configuration Settings  

The Box Component allows easy uploading and downloading to and from the Box service.

Remarks

The Box Task provides a simple way to upload and download files from the Box service.

To begin, the adapter must first be configured to allow access to the Box using OAuth.

Open the OAuth Authorization dialog by clicking the ellipses (...) button of the OAuthAuthorization property at design time. This will open a dialog. Within the dialog specify the ClientId, ClientSecret, and CallbackURL values for the registered application.

After specifying the necessary values press the Authorize button to authorize the application. This will launch a browser and prompt the user to grant access. After access is granted the task will populate the following values:

All necessary values will be saved in the CacheLocation for use in subsequent requests by the task. The task will use the cached values and will automatically refresh the token if needed. In this way any user interaction is only required at design time, not at runtime.

Box Receive Task

At runtime the task will connect to the Box service and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the SSIS Package as individual messages.

In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode to remove files from the server that have been downloaded. Alternatively DownloadCacheFile may be used to keep a list of files which have already been downloaded.

Box Send Task

The task will connect to the Box service whenever it has a message to send. The task will attempt to upload to the specified RemotePath. If Overwrite is set to True, the task will delete or overwrite remote files as necessary to complete the operation.

Receiver Property List


The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.

DirListString denoting the name of the variable which contains the last directory listing entries.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FileMaskIndicates the type of files to download from the server.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
LocalDirectoryThe directory on the local machine to write downloaded files to.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
OAuthAuthorizationOAuth Authorization Information.
OperationThe operation which will be executed by the component.
OtherDefines a set of configuration settings to be used by the component.
OverwriteWhether or not the component should overwrite files during transfer.
RemotePathThe current path on the server.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the component to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the component.

Sender Property List


The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.

EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
LocalFileThe path to a local file for upload.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the component.
OverwriteWhether or not the component should overwrite files during transfer.
RemoteFileThe name of the remote file.
RemotePathThe current path on the server.
RuntimeLicenseSpecifies the component runtime license key.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the component to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the component.

Configuration Settings


The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.

DateFormatThe date format of the file time.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparisonWhether the receive component should consider metadata differences when deciding whether to download a file again.
LocalFileThe name of the LocalFile to which the remote file will be saved.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 8319]