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