Snapshot web module configuration

These configuration items apply to Liberator’s snapshot web module.

The snapshot web module is invoked when a client application sends Liberator an HTTP request to obtain a container snapshot in a CSV-format or XLSX-format file.

When you use Liberator’s built-in BlotterExport Config blade to enable the container snapshot capability, Liberator is 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.

You must put these configuration items in Liberator’s snapshot.conf file. In the Deployment Framework, 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 configuration item.

For a detailed explanation of how to use the add-translation configuration item, see Translating field values using the translate: formatter in How can I…​ Format fields for export to a CSV or XLSX file.

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

Type: array of strings

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

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 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

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.

Also see the HTTP request parameters section of How can I…​ Obtain a container snapshot in a CSV or XLSX file.

Since: Liberator 6.2.4

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.

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.

Since: Liberator 6.2.5

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).

See also: