Vignette Filter

From Okapi Framework
Jump to: navigation, search

Overview

The Vignette Filter is an Okapi component that implements the IFilter interface for export/import XML documents used with the Vignette Content Managment System.

The Vignette XML documents are the files generated by the vgnexport tool of Vignette.

Processing Details

Encodings

The input and output encodings are forced to UTF-8.

Entries to Extract

The entries to extract are defined by the value of the name attribute of the attribute element that contains the corresponding data. For example, if the content body of a Vignette document is stored in the "MYVCM-BODY" entry, in the XML export document it will appear as:

...
<attribute name="MYVCM-BODY">
<valueCLOB>data</valueCLOB>
</attribute>
...

Constraints

You must have an importContentInstance element for both the source and the target language in the export file to be able to extract the data. Entries that have only an importContentInstance for the source will not be extracted (but will be listed as warning). Conversely, entries that have no importContentInstance for the source will not be extracted, and will be listed as warning.

The relationship between the source and the target importContentInstance blocks is done with the source ID defined in the parameters: both blocks must have the same.

Those constrains do not apply when the Monolingual mode is used.

Parameters

Names of the <attribute> elements to extract — Enter the list of the values for the name attribute of the <attribute> elements to extract. The list must be comma-separated.

Corresponding filter configurations — Enter the list of the filter configurations to use for each extractable part. This list must be comma-separated. It also must contains the same number of entries as the list of the elements to extract, and be in the same order. Use 'default' to indicate no specific filter.

Monolingual mode — Set this option to process monolingual document, where all importContentInstance elements are to be extracted. When this option is set the filter does not used the source ID and the locale ID parameters.

Name for source ID element — Enter the value for the name attribute of the <attribute> element that contains the source ID for a given block.

Name for locale ID element — Enter the value for the name attribute of the <attribute> element that contains the locale ID for a given block.

Limitations

Very large documents may cause memory problem.