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 record transformations</refpurpose>
24 <refsect1><title>DESCRIPTION</title>
26 This filter acts on Z39.50 present requests and Z39.50 search requests,
27 and let all other types of packages and requests pass untouched. Its
28 use is twofold: blocking Z39.50 present/search requests that the backend
29 server does not understand or can not honor, and transforming the present
30 syntax and elementset name according to the rules specified, to fetch
31 only existing record formats, and transform them on the fly to requested
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 Z39.50 identifier string.
47 The <literal><retrieval></literal> element and the content
49 <ulink url="&url.yaz.retrieval;">Retrieval Facility</ulink> section
53 From Metaproxy version 1.3.26 and onwards the backend conversion ma
54 also use <ulink url="&url.usemarcon;">USEMARCON</ulink>.
55 If USEMARCON is enabled, the <literal>backend</literal> may include
56 a <literal>usemarcon</literal> element with two attributes:
57 <literal>stage1</literal> and <literal>stage2</literal> that points to
58 conversion files as interpreted by USEMARCON. One or both must be given.
62 <refsect1><title>SCHEMA</title>
64 Schema is in two parts.. One for the filter itself and one for the
69 xi:href="../xml/schema/filter_record_transform.rnc"
71 xmlns:xi="http://www.w3.org/2001/XInclude" />
75 xi:href="../xml/schema/retrievalinfo.rnc"
77 xmlns:xi="http://www.w3.org/2001/XInclude" />
81 <refsect1><title>EXAMPLES</title>
83 A typical configuration looks like this:
85 <filter type="record_transform">
86 <retrievalinfo xmlns="http://indexdata.com/yaz" version="1.0">
87 <retrieval syntax="xml" name="dc"
88 identifier="info:srw/schema/1/dc-v1.1">
89 <backend syntax="usmarc" name="F">
90 <marc inputformat="marc" outputformat="marcxml"
91 inputcharset="marc-8"/>
92 <xslt stylesheet="../xml/xslt/MARC21slim2DC.xsl"/>
95 <retrieval syntax="opac"/>
96 <retrieval syntax="xml" name="opac">
97 <backend syntax="opac" name="F">
98 <marc inputformat="marc" outputformat="marcxml"
99 inputcharset="marc-8"/>
102 <retrieval syntax="usmarc">
103 <backend syntax="usmarc" name="F">
106 <retrieval syntax="usmarc" name="C">
107 <backend syntax="unimarc" name="F">
108 <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
118 <refsect1><title>SEE ALSO</title>
121 <refentrytitle>metaproxy</refentrytitle>
122 <manvolnum>1</manvolnum>
130 <!-- Keep this comment at the end of the file