FTP Import Configurations

Spalten

• id: internal

• org_id: ID to organisation

• sub_org_id: internal

• server_url: internal

• username: internal

• password: internal

• is_active: boolean

• created_by: integer

• created_on: timestamp with time zone

• last_modified_on: timestamp with time zone

• is_deleted: boolean

• deleted_on: timestamp with time zone

• port: integer

• default_directory: internal

• ftp_type: internal

• token: internal

• file_name_matching_patterns: internal

• last_mtime: internal

• auth_failed_count: integer

• auth_message: text

• ignore_certificate: boolean

• move_after_import: boolean

• destination_directory: internal

• import_directory: internal

• include_subfolder_content: boolean

Analyse & Beschreibung

# FTP Import Configurations Table Documentation

## Introduction

The `public.ftp_import_configurations` table is designed to store configuration details for FTP import processes. This table includes information necessary for connecting to FTP servers, managing authentication, and handling file imports. It supports both FTP and SFTP protocols and includes fields for FTP server details, authentication credentials, and operational settings, such as whether to move files after import and whether to include subfolder content.

## Column Descriptions

### id
- **Meaning**: Unique identifier for each FTP import configuration record.
- **Role**: Primary key.
- **Typical Contents**: UUID format, e.g., `9862d8c6-bb61-4373-9616-d5f8c125eeb8`.

### org_id
- **Meaning**: Identifier for the organization associated with this configuration.
- **Role**: Foreign key.
- **Typical Contents**: UUID format.

### sub_org_id
- **Meaning**: Identifier for a sub-organization, if applicable.
- **Role**: Foreign key.
- **Typical Contents**: UUID format or `null` if not applicable.

### server_url
- **Meaning**: The URL or IP address of the FTP server.
- **Role**: Descriptive field.
- **Typical Contents**: Domain name or IP address, e.g., `sftp.it.doxee.com`.

### username
- **Meaning**: Username used for authentication with the FTP server.
- **Role**: Descriptive field.
- **Typical Contents**: Plain text username.

### password
- **Meaning**: Password used for authentication with the FTP server.
- **Role**: Descriptive field.
- **Typical Contents**: Encrypted password string.

### is_active
- **Meaning**: Indicates if the configuration is currently active.
- **Role**: Status flag.
- **Typical Contents**: `True` or `False`.

### created_by
- **Meaning**: Identifier for the user who created the configuration.
- **Role**: Foreign key.
- **Typical Contents**: Integer representing user ID.

### created_on
- **Meaning**: Timestamp when the configuration was created.
- **Role**: Audit field.
- **Typical Contents**: Datetime with timezone information.

### last_modified_on
- **Meaning**: Timestamp of the last modification of the configuration.
- **Role**: Audit field.
- **Typical Contents**: Datetime with timezone information.

### is_deleted
- **Meaning**: Indicates if the configuration has been marked as deleted.
- **Role**: Status flag.
- **Typical Contents**: `True` or `False`.

### deleted_on
- **Meaning**: Timestamp when the configuration was marked as deleted.
- **Role**: Audit field.
- **Typical Contents**: Datetime with timezone information or a default date for non-deleted records.

### port
- **Meaning**: Port number used to connect to the FTP server.
- **Role**: Descriptive field.
- **Typical Contents**: Integer, e.g., `22` for SFTP.

### default_directory
- **Meaning**: The default directory path on the FTP server.
- **Role**: Descriptive field.
- **Typical Contents**: Directory path string.

### ftp_type
- **Meaning**: Type of FTP protocol used (e.g., FTP, SFTP).
- **Role**: Descriptive field.
- **Typical Contents**: `FTP` or `SFTP`.

### token
- **Meaning**: Security token for additional authentication or identification.
- **Role**: Descriptive field.
- **Typical Contents**: Encrypted or encoded string.

### file_name_matching_patterns
- **Meaning**: Patterns used to match file names for import.
- **Role**: Descriptive field.
- **Typical Contents**: Pattern strings or `null`.

### last_mtime
- **Meaning**: Last modification time of files, used for filtering imports.
- **Role**: Descriptive field.
- **Typical Contents**: String representing a timestamp or `null`.

### auth_failed_count
- **Meaning**: Counter for failed authentication attempts.
- **Role**: Descriptive field.
- **Typical Contents**: Integer, e.g., `0` or `5`.

### auth_message
- **Meaning**: Message describing the result of the last authentication attempt.
- **Role**: Descriptive field.
- **Typical Contents**: Text message or `null`.

### ignore_certificate
- **Meaning**: Indicates if SSL certificate validation should be ignored.
- **Role**: Status flag.
- **Typical Contents**: `True` or `False`.

### move_after_import
- **Meaning**: Indicates if files should be moved after import is complete.
- **Role**: Status flag.
- **Typical Contents**: `True` or `False`.

### destination_directory
- **Meaning**: Directory path where files should be moved after import.
- **Role**: Descriptive field.
- **Typical Contents**: Directory path string or `null`.

### import_directory
- **Meaning**: Directory path from which files are imported.
- **Role**: Descriptive field.
- **Typical Contents**: Directory path string or `null`.

### include_subfolder_content
- **Meaning**: Indicates if content from subfolders should be included in the import.
- **Role**: Status flag.
- **Typical Contents**: `True` or `False`.

This documentation provides a comprehensive understanding of each column in the public.ftp_import_configurations table, explaining its purpose, role, and typical contents, based on the given data and column names.