1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3 <!ENTITY copyright SYSTEM "copyright.xml">
4 <!ENTITY % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-record_transform">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>record_transform</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>record_transform</refname>
21 <refpurpose>Metaproxy Module that performs Z39.50 presentResponse record transformations</refpurpose>
24 <refsect1><title>DESCRIPTION</title>
26 This filter acts only on Z3950 present requests, and let all
27 other types of packages and requests pass untouched. It's use is
28 twofold: blocking Z3950 present requests, which the backend
29 server does not understand and can not honor, and transforming
30 the present syntax and elementset name according to the rules
31 specified, to fetch only existing record formats, and transform
32 them on the fly to requested record syntaxes.
35 The allowed record present syntax and
36 element name are described in multiple
37 <literal><retrieval></literal> elements inside the
38 <literal><retrievalinfo></literal>
39 element. The <literal>syntax</literal> attribute is mandatory, but
40 the <literal>name</literal> attribute
41 may be omitted, in which case any
42 element name is accepted. An additional
43 <literal>identifier</literal> attribute can be added to explicitly
44 describe the Z3950 identifier string.
47 Record transformations are invoked when the optional attributes
48 <literal>backendsyntax</literal> and <literal>backendname</literal>
49 as well as the <literal><convert></literal> element are specified.
50 Record conversions come in two flavors:
51 <literal><marc></literal> binary conversions between different
52 binary MARC formats and MarcXML formats, and
53 <literal><xslt></literal> stylesheet transformations performed
54 on any kind of XML records. These conversions can be stacked in any
55 order, and are performed linearly in file order.
58 The binary MARC record transformations
59 <literal><marc></literal> are defined using the following
60 attributes: <literal>inputformat</literal>, <literal>outputformat</literal>,
61 <literal>inputcharset</literal> and <literal>outputcharset</literal>.
64 XML <literal><xslt></literal> transformation instructions
65 accept only one mandatory <literal>stylesheet</literal> attribute,
66 which is either an absolute path, or a relative path from the
67 working directory of <literal>metaproxy</literal> to the location
68 of the requested XSLT stylesheet.
72 <refsect1><title>EXAMPLES</title>
74 A typical configuration looks like this:
76 <filter type="record_transform">
78 <retrieval syntax="grs-1"/>
79 <retrieval syntax="usmarc" name="F"/>
80 <retrieval syntax="usmarc" name="B"/>
81 <retrieval syntax="xml" name="marcxml"
82 identifier="info:srw/schema/1/marcxml-v1.1"
83 backendsyntax="usmarc" backendname="F">
85 <marc inputformat="marc" outputformat="marcxml"
86 inputcharset="marc-8"/>
89 <retrieval syntax="xml" name="danmarc"
90 backendsyntax="usmarc" backendname="F">
92 <marc inputformat="marc" outputformat="marcxchange"
93 inputcharset="marc-8"/>
96 <retrieval syntax="xml" name="dc"
97 identifier="info:srw/schema/1/dc-v1.1"
98 backendsyntax="usmarc" backendname="F">
100 <marc inputformat="marc" outputformat="marcxml"
101 inputcharset="marc-8"/>
102 <xslt stylesheet="xml/xslt/MARC21slim2DC.xsl"/>
112 <refsect1><title>SEE ALSO</title>
115 <refentrytitle>metaproxy</refentrytitle>
116 <manvolnum>1</manvolnum>
124 <!-- Keep this comment at the end of the file
129 sgml-minimize-attributes:nil
130 sgml-always-quote-attributes:t
133 sgml-parent-document:nil
134 sgml-local-catalogs: nil
135 sgml-namecase-general:t