# File Connector

### What is the File Connector in ZigiOps?

The **File Connector** is a generic ZigiOps connector designed to export integration data to structured files.

Unlike officially supported systems (such as Jira, ServiceNow, or monitoring tools), the File Connector is intended for:

* Systems that are not natively supported
* Custom-built internal applications
* File-based middleware integrations
* Data archival or auditing purposes

It enables ZigiOps to generate structured output files containing synchronized data from integration workflows. The File Connector acts as a flexible output mechanism within ZigiOps integrations.

### When should I use the File Connector?

Use the File Connector when:

* The target system supports file ingestion (such as CSV or JSON logs)
* You need to export integration payloads for auditing
* You are integrating with legacy or internal applications
* A middleware solution processes file-based data
* You want to decouple ZigiOps from downstream systems

### Are there any environmental prerequisites?

{% hint style="info" %}
Confirm the prerequisites of the corresponding integration configuration before continuing, as some integration flows may not require all parameters.
{% endhint %}

There are no version requirements for the File Connector. However, you must ensure:

* The specified output directory exists
* ZigiOps has write permissions to the directory
* Sufficient disk space is available
* The file retention policy aligns with your infrastructure standards

### How do I configure the File Connector in ZigiOps?

#### File Connector - Connected System Configuration

{% stepper %}
{% step %}
Log in to ZigiOps

Log in to your **ZigiOps** instance.
{% endstep %}

{% step %}
Add the File Connector

Navigate to **Connected Systems > Add New System > File Connector**.
{% endstep %}

{% step %}
Configure the parameters

Configure the following parameters:

**Output File Directory**\
Specify the directory where generated output files will be stored.\
Example: `/zigiops/platform/connector-logs/`

Ensure the directory exists and ZigiOps has write access.

**Output File Name**\
Define the file naming pattern.\
Example: `connector-{system_name}-{yy-mm-dd-hh:mm:ss}.log`

You can use dynamic placeholders to generate timestamped files.

**File Generation Mode**\
Select the desired file generation behavior:

* **Accumulated** - Multiple executions are stored within a single output file.
* **Not Accumulated** - Each execution generates a separate output file.

**Maximum Number of Output Files**\
Define the maximum number of generated output files retained.\
Default: `50`

When the maximum is reached, older files are rotated or removed according to system logic.

**Output Chunk Size**\
Set the desired output chunk size (number of records per write operation).\
Default: `10000`

This parameter controls batching behavior for large data exports.
{% endstep %}

{% step %}
Examine the settings
{% endstep %}

{% step %}
Save the system

Click **Save** to store the system.

Once saved, the File Connector becomes available as a target in integration workflows.
{% endstep %}
{% endstepper %}

### File Connector use case scenarios

#### Use case 1: Exporting monitoring events to a legacy system

A legacy application cannot consume REST APIs but supports file imports. ZigiOps synchronizes monitoring events and exports them as structured files, which are periodically imported by the legacy system.

#### Use case 2: Integration with internal custom applications

An internally developed application processes structured logs. The File Connector exports integration data into a predefined directory, where the internal application reads and processes it.

#### Use case 3: Compliance and audit logging

Organizations may require archival of integration payloads for compliance. The File Connector enables structured file output, preserving synchronization data for auditing purposes.

#### Use case 4: Middleware-based processing

A middleware solution (such as an ETL tool or enterprise bus) monitors a directory and processes new files. ZigiOps generates files that trigger automated downstream workflows.

### Limitations and scope

The File Connector:

* Does not provide prebuilt integration templates
* Does not validate target system schemas
* Does not enforce version compatibility
* Acts solely as a structured file export mechanism

Integration logic, mapping, and transformation are defined within ZigiOps integration configurations.

### Summary

The File Connector in ZigiOps provides:

* Generic file-based export functionality
* Flexible file naming and batching options
* Configurable accumulation behavior
* Rotation control via maximum file limits
* Support for legacy and internal system integrations

It is ideal for environments where API-based integration is not available or not desired.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.zigiwave.com/available-systems/file-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.