# Beam File Definition

## Beam File Definition

### Description

![folder](/files/PcvKwJXleFoFsHoA3ubw)

A Beam File Definition describes a file layout in a Beam pipeline and specifies the file layout (name, field definitions, enclosure and separator) to be used in Beam Pipelines.

### Related Plugins

Transforms:

* [Beam File Input](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/beamfileinput.md)
* [Beam File Output](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/beamfileoutput.md)

### Options

| Option            | Description                                                                                                  |
| ----------------- | ------------------------------------------------------------------------------------------------------------ |
| Name              | The name to be used for this Beam file definition                                                            |
| Description       | The description to be used for this Beam file definition                                                     |
| Field Separator   | separator used between fields in the file definition                                                         |
| Enclosure         | field enclosure used for fields in the file definition                                                       |
| Field Definitions | List of field name, type, format, length and precision. Describes the file layout for this field definition. |

### Samples

* beam/pipelines/complex.hpl
* beam/pipelines/generate-synthetic-data.hpl
* beam/pipelines/input-process-output.hpl
* beam/pipelines/switch-case.hpl
* beam/pipelines/unbounded-synthetic-data.hpl


---

# 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.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/index-2/beam-file-definition.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.