Connection Details¶
Connections List View¶
The Connections list view includes the following fields.
- Name
- The name for the connection.
- Description
- A description of the connection.
- Type
- The type of connection: S3 or SFTP.
- Partner
- The partner who owns the connection.
- Status
- The status of the connection: valid or invalid.
- Last Tested At
- The date and time the connection was last tested.
- Last Updated By
- The username of the person who last updated the connection.
- Actions
-
Icons are enabled depending on the privileges of your role:
- Edit (): Opens the connection in edit mode.
- Delete (): Deletes the connection.
- Test (): Tests the connection.
Integrations Section¶
The Integrations section includes the following fields for integrations that use the highlighted connection.
- Name
- The name of the integration using the selected connection.
- Description
- The description of the integration using the selected connection.
- Template Name
- The name of the template used in the integration.
- Status
-
The status of the integration:
- Paused: The published integration was paused. While paused, any scheduled integrations don't run. The integration can't be edited or deleted.
- Publish Failed: The publish operation failed. The integration can be copied, edited, deleted or published.
- Publish Pending: The publication operation is in progress. The integration can't be edited, deleted, or run, but it can be copied.
- Published: The integration has been published and can be copied, run, or paused.
- Revision: The integration can be copied, edited, deleted, or published.
- Actions
- Icons in the Actions column are enabled depending on the integration's
- status and the privileges of your role:
-
- Copy (): Enables you to copy the integration.
-
- **Edit** (:fontawesome-solid-pen-to-square:): Opens the integration in edit mode. -
- **Delete** (:material-trash-can:): Deletes the integration. -
- **Publish** (:material-check-circle-outline:): Publishes the integration. -
- **Run Once** (:material-play-circle-outline:): Runs the integration immediately. -
- **Pause** (:material-pause-circle-outline:): Pauses the integration. Any -
scheduled integration runs are paused until the integration is resumed. -
- **Resume** (:material-clock-time-ten-outline:): Resumes a paused integration. -
Scheduled runs continue normally. -
- **Unpublish** (:material-cancel:): Unpublishes an integration so you can edit it. -
- **Upload File** (:material-tray-arrow-up:): Enables you to upload an input -
file to the storage location. You can then click **Run Once** to run the -
integration on that file.
Connection Details View¶
The Connection Details view includes the following fields. Required fields have an asterisk (*).
- Connection Name *
- The name for the connection. Max length: 50 characters.
- Partner *
- The partner who owns the connection.
- Description *
- A description of the connection. Max length: 255 characters.
- Connection Type *
- The type of connection: S3 or SFTP.
- URL *
- The host address (SFTP) or bucket name (S3). Max length: 500 characters.
SFTP¶
- Username *
- Username for SFTP file transfer.
- Authentication Type *
- The type of authentication: password or key file.
- Password *
- The password for the Password authentication type.
- Key File *
- If Authentication Type is Key File, enables you to upload the private key file.
- Passphrase *
- If Authentication Type is Key File, the passphrase for the connection.
S3¶
- Access Key ID *
- The access key ID provided for the S3 bucket.
- Secret Access Key *
- The secret access key provided for the S3 bucket.
- Region *
- The AWS region where the S3 bucket is located.
Encryption¶
If the file contents are encrypted, enables you to configure the parameters.
- Encryption Algorithm *
-
The encryption algorithm:
- AES-256
- GPG
- AES-256-gcm
- Encryption Key
- For the GPG algorithm, the key file used to decrypt the input files.
- Passphrase *
- Type the passphrase for FeedXChange to decrypt the files. If using GPG, the passphrase also decrypts the encryption key.
Compression¶
If the file contents are compressed, enables you to configure the parameters.
- Compression Algorithm *
-
The file compression algorithm:
- BZip2
- Deflate
- GZIP
- LZMA
- Snappy
- TAR
- ZIP
- ZSTD
- Compression Level *
-
The compression level:
- BZip2: supports a block size parameter from 1–9
- Deflate: supports 0–9, where 0 is no compression
- GZIP: supports 0–9, where 0 is no compression
- LZMA: range varies depending on implementation
- Snappy: compression level is ignored
- TAR: compression level is ignored
- ZIP: supports 0–9, where 0 is no compression
- ZSTD: supports 1–19
See also: