File/URI Property | Description |
|---|---|
AWS Region | Region that hosts the specific S3 bucket. The component will be configured to use this bucket. For more information about AWS regions, availability zones, and other related topics, see |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |
Authentication Type | Specify the means by which identity is provided to AWS. Select one of the following: • Default Credential Provider Chain: (Default) Select this option to use the "default" credentials provider chain that is provided in the AWS SDK. For information about the standard mechanism that AWS client-side automation tools use to obtain user credentials, see New and Standardized Way to Manage Credentials in the AWS SDKs. • Access Keys: Select this option to use access keys which are long-term credentials for an IAM user or the AWS account root user. Access keys are created in pairs that consist of the following (displayed as additional options): – Access Key ID: Provide the access key ID. – Secret Access Key: Provide the secret access key. Note: If the Access Keys authentication type is selected, the component will not search for additional means by which the credentials are provided. |
Object Key | Specify the object key that must be downloaded from the S3 bucket. The key is unique within the S3 bucket and may include separator characters, such as a forward slash symbol (/) to emulate folders. This property is mandatory. |
File/URI Property | Description |
|---|---|
Azure Storage Service Type | Select one of the following options for interacting with the selected container: • Blob Storage Service: (Default) Component uses Microsoft Azure's Blob-specific APIs to interact with the selected storage account and container. For more information, see Introduction to Azure Blob Storage. • ADLS File System Service: Component uses Microsoft Azure's Data Lake Storage Gen2 hierarchical namespace-specific APIs to interact with the selected storage account and container. For more information, see Azure Data Lake Storage Gen2 hierarchical namespace. |
Storage Account Name | Name of a pre-existing storage account that is created within a Microsoft Azure account. For more information, see Storage account overview. |
Container Name | Name of a pre-existing container within the selected storage account. |
Azure Storage Authentication Type | Select the authentication scheme that the component will use: • Storage Shared Access Keys: (Default) Azure generates two 512-bit storage account access keys when you create a storage account. These keys can be used to authorize access to data in your storage account through Shared Key authorization. When selected, the following additional option is displayed: – Access Key: Provide one of the two 512-bit storage account access keys that was automatically generated by Microsoft Azure when the storage account was created. • Azure Active Directory Service Principal With Client Secret: Customer applications, which embed the Azure Storage Component, can be integrated with the Microsoft identity platform by registering it with an Azure Active Directory tenant. After this, a client secret can be generated from the registered application and it can be used for authentication. For more information, see Microsoft’s How to page. Actian Data Platform COPY VWLOAD directly supports this type of registration and authentication. When selected, the following additional options are displayed: – Application (Client) ID: Identity assigned to the application after registration. It is the service principal assigned to the application. – Directory (tenant) ID: Provide the tenant ID. A tenant is a representation of an organization in Azure Active Directory. Applications are registered relative to a tenant within Azure Active Directory. – Client Secret: Specify the client secret value. After an application or service principal is created, you can upload a certificate or create a client secret to be used for authentication. |
Object Name | The name of the object that you intend to download from the configured Azure Storage container. If the component is interacting with the container using the blob service, then the name represents the blob name. If the component is interacting with the container through the file system service, then the name represents the full path to the file including directory elements separated by the "/" character. |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |
File/URI Property | Description |
|---|---|
Host Name | The name of the server to connect to. |
User Name | The username for connecting to the server. |
Password | The password for authenticating the above user name. |
Port number | The port number on the server. The default is 21. |
Path | The path to the remote file or resource. |
File/URI Property | Description |
|---|---|
Server Name | The name of the server to connect to. |
User Name | The username for connecting to the server. |
Password | The password for authenticating the above user name. |
Port | The port number on the server. |
Path | The path to the remote file or resource. |
FTP Connection Mode | Choose from the following FTP Connection Mode types: • Active • Passive (default) |
FTPS Encryption | Choose from the following FTPS Encryption types: • EXPLICIT - (default) Explicit FTPS is the newer method of FTPS transfer and is supported by majority of FTP servers. In Explicit FTPS the client "explicitly" requests the server to create a secured session, using SSL/TLS. • IMPLICIT - Implicit FTPS was the first method created to encrypt data sent via FTP and in this connection the SSL encryption is “implied”. As soon as a connection is established between the FTPS client and the file transfer server, both command and data channels are automatically protected with SSL encryption. Thus the entire FTP session is encrypted, in contrast to flexibility you have when using explicit FTPS. However, implicit FTPS is considered a deprecated protocol, meaning that it not the current standard. |
Encoding Type | You can specify ISO8859-1 (default) or UTF-8. |
Binary Indicator | Indicates whether the files being read must be opened in binary mode. You can specify True or False (default). |
Retry Count | Number of attempts the server tries to establish connection when the connection times out or fails. Default value is “0”. |
Truststore | Path to trust store file. The system compares the server certificate against the certificates in the specified truststore file. If the server certificate is not already in the truststore file, it results in an error. The file type of the truststore is Java key store (JKS). |
Truststore Password | Password associated with the Truststore. |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |
File/URI Property | Description |
|---|---|
Bucket Name | GCP Storage bucket that will be used to upload and retrieve stored objects. The value must match the name of an existing GCP Storage bucket for which the service account has appropriate privileges. If the name does not match an existing bucket, then an error occurs unless the Create Missing Bucket property is set to True. For more information about GCP Storage buckets, see https://cloud.google.com/storage/docs/key-terms. |
Create Missing Bucket | If set to True, the component creates the specified bucket (if it is missing) when attempting to upload (PutMessage action) content to the specified bucket. This setting has no effect if the component is only downloading content. The default value is False. |
Authentication Type | Select one of the following authentication types: • Use path in environment variable (GOOGLE_APPLICATION_CREDENTIALS): (Default) Instructs the component to find the service account key file using the GOOGLE_APPLICATION_CREDENTIALS environment variable. If the environment variable is set, then its value is expected to be the path to the file. If the environment variable is not set, then an error occurs. • Provide path to service account key file: Displays the Service Account Key File property to specify the complete path of the service account key file. • Directly provide service account key: Allows you to directly provide the service account keys. This is a non-file-based authentication method. When selected, the following additional properties are displayed: – Service Account Email Address: (Required) Client email address of the service account from the GCP console. – PKCS8 formatted private key: (Required) RSA private key object for the service account in PKCS#8 format. – Service Account Client ID: (Optional) Service account client ID. – Private key ID: (Optional) Private key identifier for the service account. |
Object Name | Name of the object to retrieve from GCP Storage bucket. The name is unique within the bucket and may include separator characters, such as a forward slash symbol (/) to emulate folders. This option is required. |
Relative Path | Specifies whether the path portion of the URL is absolute or relative to the home directory of the currently logged in user. When True, the path portion of the URL is treated as relative to the current home directory, and leading forward slash symbols (/) are excluded from the generated URI. |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |
File/URI Property | Description |
|---|---|
Token Folder | Local directory that will be used to store an OAuth token after the owner of the Google Drive account has granted the requested permissions to the component. Click Browse and select a folder. You can also right-click and use the Paste Macro option to specify the token folder. After specifying this folder, you must test the connection and obtain a valid token for connecting to Google Drive. For the steps, see Obtaining Valid Token for Connecting to Google Drive. The connection is successful if a valid token file is created in the Token Folder. |
Test Connect Timeout | Maximum amount of time in seconds before "Test Connection" will time out. The default value is 60. |
Delete Uploaded Files When Finished | When set to True, all the uploaded files are automatically deleted after the process is completed. The default value is False. |
Google Drive File | The name of the file to retrieve from Google Drive. You can specify the full path to the file if it is a folder within one or more directories. For example, if the accounts.txt file is within the data directory, which is in a another directory called company, then the path to the file is company/data/accounts.txt. |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |
File/URI Property | Description |
|---|---|
Host Name | The name of the server to connect to. |
User Name | The username for connecting to the server. |
Password | The password for authenticating the above user name. |
Port number | The port number on the server to connect to. The default value is 80. |
Path | The complete directory path for the proxy file to be used. |
Query part | Additional query parameters needed to connect to the server. Parameters must be separated with & characters. Example: http://user:password@actian.com:80/?parameter=value&another=value |
File/URI Property | Description |
|---|---|
Host Name | The name of the server to connect to. |
User Name | The username for connecting to the server. |
Password | The password for authenticating the above user name. |
Port number | The port number on the server to connect to. The default value is 443. |
Path | The complete directory path for the proxy file to be used. |
Query part | Additional query parameters needed to connect to the server. Parameters must be separated with & characters. Example: http://user:password@actian.com:80/?parameter=value&another=value |
File/URI Property | Description |
|---|---|
Server Name | The name of the server to connect to. |
User Name | The username for connecting to the server. |
Password | The password for authenticating the above user name. |
Port | The port number on the server to connect to. |
Path | The path to the remote file or resource. |
Proxy Type | You can select: • None (default) • HTTP - Routes only HTTP/HTTPS traffic between your device and the internet. • SOCKS5 - A more versatile proxy that supports all internet traffic types (HTTP, FTP, etc.) with no traffic modification, ideal for diverse applications. |
Proxy Username | The authentication user name for connecting to the proxy server. |
Proxy Password | The password associated with the proxy user name. |
Proxy Server | The proxy server name. |
Proxy Port | The port number on the proxy server through which client requests are forwarded. |
Binary Indicator | Indicates whether the files being read must be opened in binary mode. You can specify True or False (default). |
Retry Count | Number of attempts the server tries to establish connection when the connection times out or fails. Default value is “0”. |
Private Key File | Path to private key file. This file enables encryption and decryption of data, ensuring secure connections and verifying the identity of the sender. |
Private Key Passphrase | Password associated with the private key file. |
Temporary File Location | Specifies the directory (and the drive if needed) in which the temporary local file is stored. The temporary local file is used for reading and writing. |