# Snapshot web module configuration

These configuration items apply to Liberator’s snapshot [web module](liberator-web-modules.md).

The snapshot web module is invoked when a client application sends Liberator an HTTP request to obtain a [container snapshot](liberator-obtain-a-container-snapshot-in-a-csv-or-xlsx-file.md) in a CSV-format or XLSX-format file.

When you use Liberator’s [built-in](../deployment-framework/cdf-built-in-blades.md) **BlotterExport** [Config blade](../deployment-framework/cdf-blade-types.md#config-blade) to enable the container snapshot capability, Liberator’s automatically configured to use the snapshot web module. Then you can use the configuration items documented here to change how the data in the exported file is formatted.

**📌 NOTE**\
You must put these configuration items in Liberator’s `snapshot.conf` file. In the [Deployment Framework](../deployment-framework/index.md), this file is in `<Framework-root>/global_config/overrides/servers/Liberator/etc/` (where `<Framework-root>` is the file path of the Deployment Framework’s topmost directory for the Platform installation).

## add-translation

`add-translation` specifies the translation of the values of individual fields into text in a specified language before they are exported to the CSV file. It’s used in conjunction with the [format-field](#format-field) configuration item.

**Syntax:** `add-translation "translation-specification" "translated-text"`

**Type:** array of strings

**Default value:** No translation is applied to the exported file(s).

**📌 NOTE**\
For a detailed explanation of how to use the `add-translation` configuration item, see [Translating field values using the translate: formatter](liberator-format-fields-for-export-to-a-csv-or-xlsx-file.md#translating-field-values-using-the-translate-formatter) in How can I... [Format fields for export to a CSV or XLSX file](liberator-format-fields-for-export-to-a-csv-or-xlsx-file.md).

## export-separator

`export-separator` allows container snapshots to be for multiple subjects at a time. The HTTP request that the client sends to Liberator to invoke the snapshot web module’s processing includes an `export` parameter. This parameter is a list of one or more [subjects](../datasource/datasource-subjects-symbols-and-fields.md) for which data is to be exported. The `export-separator` configuration item specifies the separator character that’s to be used between the subjects in the list. For example, here’s an an `export` parameter that uses the `export-separator` setting of `,` (comma):

```
export=/EXAMPLES/PRICING/CONTAINER/EQUITIES,/EXAMPLES/CONTAINER/EQUITIES2
```

Also see the [HTTP request parameters](liberator-obtain-a-container-snapshot-in-a-csv-or-xlsx-file.md#the-http-request-parameters) section of How can I... [Obtain a container snapshot in a CSV or XLSX file](liberator-obtain-a-container-snapshot-in-a-csv-or-xlsx-file.md).

**📌 NOTE**\
The export-separator configuration item is available in **Liberator 6.2.4 and later**.

**📌 NOTE**\
If you want your container snapshots to be for multiple subjects at a time, you must specify an `export-separator` character and use that character to separate the subjects in the HTTP request’s export parameter. If you don’t specify an `export-separator`, you can only put _one_ subject in the `export` parameter of the HTTP request, and then you can only obtain a snapshot of a single subject at a time.

**Syntax:** `export-separator <separator-character>`

**Type:** character

**Default value:** (none)

## format-field

`format-field` specifies the formatting to be applied to the container snapshot when it’s exported to the CSV-format or XLSX-format file.

**📌 NOTE**\
Formatting for XLSX-format files is only supported in **Liberator 6.2.5 and later**.

**Syntax:** `format-field "field-name" "CSV-format-specifications" "XLSX-format"`

**Type:** array of strings

**Default value:** No formatting is applied to the exported file(s).

**📌 NOTE**\
For a detailed explanation of how to use the `format-field` configuration item, see How can I... [Format fields for export to a CSV or XLSX file](liberator-format-fields-for-export-to-a-csv-or-xlsx-file.md).

---

**See also:**

* Features and Concepts: [Liberator web modules](liberator-web-modules.md)
* How can I... [Obtain a container snapshot in a CSV or XLSX file](liberator-obtain-a-container-snapshot-in-a-csv-or-xlsx-file.md)