Summary
The Default Integration settings define one shared SFTP connection and one schedule that every automated import and export job reuses. You configure the SFTP connection once, set when jobs run, and the platform then moves files to and from your server without manual steps. This gives you a single, consistent place to control automated file exchange.
Introduction
The Default Integration is part of the KnowledgeCity Integrations product. It holds the connection details for your SFTP server together with a reusable schedule, so that import jobs (files the platform reads in) and export jobs (files the platform sends out) all share the same transport and timing rules.
This configuration is normally set up by a KnowledgeCity Super Admin, often working with the administrator who manages your SFTP server and can supply the correct host, credentials, and paths. It solves the problem of configuring the same connection over and over: instead of defining separate transport details for each job, you set them once and let every scheduled job reuse them.
Key Concepts
- Default Integration: the master configuration that must be turned on before any child import or export job runs. When it is off, all scheduled jobs are ignored.
- SFTP connection: the shared connection defined by Host, Port, Username, and a private key, used by every import and export job. KnowledgeCity connects over SFTP (SSH), so authentication uses a key rather than a password.
- Path: the directory on your SFTP server that jobs read from or write to. It can be relative or absolute, so confirm the correct value with your server administrator.
- File Name: the name pattern used for transferred files. It can include a date pattern so each run produces a dated file.
- Schedule: the reusable timing rule built from an interval type and an interval value, which together control how often jobs run.
- Import and export jobs: the automated tasks that reuse the shared SFTP connection and schedule to exchange files with your server.
- Super Admin: the KnowledgeCity role required to open Integrations settings and configure the default SFTP connection and schedule.
Steps to Follow
Open the default SFTP settings
Sign in to KnowledgeCity as a Super Admin and open the Integrations settings. Locate the Default Integration section, which holds the shared SFTP connection and schedule that all automated import and export jobs use.
Enable the default integration
Turn on the master switch for Default Integration. This switch must be enabled first, because every import and export job is ignored while it is off. With it on, the connection and schedule settings below take effect.
Configure the SFTP connection
Enter the connection details for your SFTP server:
- Host: the address of your SFTP server.
- Port: the port the server listens on. SFTP uses port 22 by default, so confirm the value with your server administrator if it differs.
- Username: the account name used to authenticate.
- Private key: the SSH private key that authorizes the connection. Paste the key your server administrator provides. Treat it like a password and keep it secure, because it authenticates every transfer.
Set the file options
Choose where files are placed:
- Set the Path to the directory on the server that jobs should read from or write to. A path can be relative or absolute, so confirm the correct value with your server administrator.
- Set the File Name pattern for transferred files. You can include a date token so each run produces a dated file, for example a file that carries the run date in the format
Ymd.
Define the schedule
Use the schedule to control when jobs run. Set the interval type (how often a job repeats, for example hourly, daily, or weekly) and the interval value that sets the frequency within that type. Because this schedule is shared, the timing you set here drives every automated import and export job that relies on the default configuration.
Save and verify
Save the configuration to apply the connection and schedule. Confirm that the Default Integration switch is on, that the Host, Port, Username, and private key are correct, and that the Path and File Name point to the intended location. If a job does not run as expected, recheck the master switch, the schedule settings, and the connection details with your server administrator.
Conclusion
By configuring the default SFTP connection and schedule once, you give every automated import and export job in Integrations a single, consistent connection and timing. You can return to the Default Integration settings at any time to update credentials, adjust the Path or File Name, or change the schedule as your file exchange needs evolve.