> ## Documentation Index
> Fetch the complete documentation index at: https://developers.techwolf.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# File-based output integrations

export const DeprecatedBadge = () => {
  return <span style={{
    backgroundColor: '#ff0000',
    color: 'white',
    padding: '2px 8px',
    borderRadius: '4px',
    fontSize: '12px',
    fontWeight: '500',
    display: 'inline-flex',
    alignItems: 'center',
    gap: '4px'
  }}>
      Deprecated
    </span>;
};

We provide a host of
[standard exports in our API](/reference/latest/Export/ExportEmployeesSkillClusters/overview)
to return useful information in bulk. These API exports have the following
properties:

* The data contained in the API export is a reflection of the data at the time
  of the request (i.e., live data).
* The output will always be given in the default JSON format of the API.
* Most exports use pagination, returning the data piece by piece instead of in
  bulk.
* Especially when working with large amounts of data, the export API requests
  can often take some time to complete.

As an alternative to these API exports, we provide a similar host of file-based
exports. These standard file-based output exports are triggered according to a
configurable schedule (e.g. daily), transform the data to a desired format (e.g.
CSV) and are uploaded to a desired, easily accessible location (e.g. S3). As
such, these export integrations have the following advantages:

* No time-consuming live generation required: the last export is always readily
  available on the desired location (i.e. S3, SFTP server).
* No need to handle data tranformation.
* No need to handle pagination.

<Note>
  We prefer CSV files in a specific format. See [our formatting
  reference](/integrations/reference/file-guidelines#csv) for more info.
</Note>

## Prerequisites

To have access to the file-based output integrations, regardless of type, at
least the following prerequisites must be met:

* You have the appropriate TechWolf API licenses.
* You have the appropriate SkillEngine API credentials, which include:
  * Tenant ID
  * Tenant secret
  * Tenant name
  * Region (Europe or United States)
* You have a TechWolf API tenant set up that contains the relevant information
  for the requested output integration.
* Both you and TechWolf have access to the agreed output location.

## Supported output formats

Currently supported output formats for all exports are

* CSV
* XLSX

<Note>
  The XLSX format supports a maximum of **1,048,576 rows per worksheet**, including the header row.

  When the export exceeds this limit:

  * The data is split across multiple worksheets in the same XLSX file.
  * Each worksheet includes the header row, followed by up to 1,048,575 data rows.
  * This ensures large datasets are fully exported across multiple sheets in the same XLSX file, without data loss.
</Note>

## Supported export types

See [Standard exports](/integrations/file-based-output/standard-exports) and
[Visier exports](/integrations/file-based-output/visier-exports) for more
information.

## Supported output locations

### AWS Simple Storage Service (S3)

We support the use of [Amazon S3 buckets](https://aws.amazon.com/s3/) as the
location the above-mentioned output integrations can be shared. These buckets
are owned and managed by TechWolf, but will be made accessible to you to fetch
the export files.

Export output files will be located on your bucket, named
`techwolf-<customer name>`, under the `<environment>/<external>/output/exports`
directory (this directory can slightly alter in some cases).

The names of the files can be configured per file type. It is possible to
include the date at which they were created in one of the supported date
formats. For compatibility reasons, names cannot contain semicolons (':') or
periods ('.').

#### Replication support

To easily integrate with our customers who use AWS, we support replication of
the export files to your own AWS S3 bucket. This way, you can fetch the export
files from your own bucket, with replication being handled securily by AWS.

To set up replication, you will need to provide the following details:

* The destination bucket name
* The region of the destination bucket
* The AWS account ID where the bucket lives

We will create an IAM role with the necessary permissions to access the source
bucket and replicate the files to your own bucket. We will provide you with the
ARN of this IAM role, which you can then allow access to in your own AWS
account.

### TechWolf SFTP server

We support the use of the [TechWolf SFTP server](/integrations/reference/sftp/sftp)
as the location the above-mentioned output integrations can be shared. These
buckets are owned and managed by TechWolf, but will be made accessible to you to
fetch the export files.

See [TechWolf SFTP server](/integrations/reference/sftp/sftp) for more information.

### Private SFTP server

We also support the use of a private SFTP server to share the above-mentioned
output integrations. You are free to set up and manage an SFTP server on your
end, and you may specify the destinition folder where the integration files
should be stored. To establish the connection with your SFTP server, please
provide the following details:

* **Host** (servername or IP address)
* **Username** for authentication
* **Destination folder** for placing the files

We support two authentication methods:

* **Password authentication**: You provide the password associated with the
  specified username.
* **Key-based authentication**: We will generate and store a private SSH key
  securely within our system and provide you with the corresponding public SSH
  key. You will need to install this public key on your SFTP server (e.g., in
  the authorized\_keys file) to enable access.

## Encryption

The exports can be PGP (Pretty Good Privacy) encrypted. To enable this, provide
your TechWolf representative with the public key and passphrase.

## Standard export relation diagram

The full entity-relationship diagram across every standard export is too wide
to render usefully inline. Open it in a new tab to pan and zoom freely. For
field-level detail per export, see
[Standard exports](/integrations/file-based-output/standard-exports).

<Card title="Open the standard exports ERD" icon="diagram-project" href="./images/standard-exports-erd.png">
  Full entity-relationship diagram, opens in a new tab. Scroll to pan, use
  Cmd/Ctrl + scroll (or browser zoom) to zoom.
</Card>