1 <chapter id="administration">
2 <title>Administrating &zebra;</title>
3 <!-- ### It's a bit daft that this chapter (which describes half of
4 the configuration-file formats) is separated from
5 "recordmodel-grs.xml" (which describes the other half) by the
6 instructions on running zebraidx and zebrasrv. Some careful
7 re-ordering is required here.
11 Unlike many simpler retrieval systems, &zebra; supports safe, incremental
12 updates to an existing index.
16 Normally, when &zebra; modifies the index it reads a number of records
18 Depending on your specifications and on the contents of each record
19 one the following events take place for each record:
26 The record is indexed as if it never occurred before.
27 Either the &zebra; system doesn't know how to identify the record or
28 &zebra; can identify the record but didn't find it to be already indexed.
36 The record has already been indexed.
37 In this case either the contents of the record or the location
38 (file) of the record indicates that it has been indexed before.
46 The record is deleted from the index. As in the
47 update-case it must be able to identify the record.
55 Please note that in both the modify- and delete- case the &zebra;
56 indexer must be able to generate a unique key that identifies the record
57 in question (more on this below).
61 To administrate the &zebra; retrieval system, you run the
62 <literal>zebraidx</literal> program.
63 This program supports a number of options which are preceded by a dash,
64 and a few commands (not preceded by dash).
68 Both the &zebra; administrative tool and the &acro.z3950; server share a
69 set of index files and a global configuration file.
70 The name of the configuration file defaults to
71 <literal>zebra.cfg</literal>.
72 The configuration file includes specifications on how to index
73 various kinds of records and where the other configuration files
74 are located. <literal>zebrasrv</literal> and <literal>zebraidx</literal>
75 <emphasis>must</emphasis> be run in the directory where the
76 configuration file lives unless you indicate the location of the
77 configuration file by option <literal>-c</literal>.
80 <sect1 id="record-types">
81 <title>Record Types</title>
84 Indexing is a per-record process, in which either insert/modify/delete
85 will occur. Before a record is indexed search keys are extracted from
86 whatever might be the layout the original record (sgml,html,text, etc..).
87 The &zebra; system currently supports two fundamental types of records:
88 structured and simple text.
89 To specify a particular extraction process, use either the
90 command line option <literal>-t</literal> or specify a
91 <literal>recordType</literal> setting in the configuration file.
96 <sect1 id="zebra-cfg">
97 <title>The &zebra; Configuration File</title>
100 The &zebra; configuration file, read by <literal>zebraidx</literal> and
101 <literal>zebrasrv</literal> defaults to <literal>zebra.cfg</literal>
102 unless specified by <literal>-c</literal> option.
106 You can edit the configuration file with a normal text editor.
107 parameter names and values are separated by colons in the file. Lines
108 starting with a hash sign (<literal>#</literal>) are
113 If you manage different sets of records that share common
114 characteristics, you can organize the configuration settings for each
116 When <literal>zebraidx</literal> is run and you wish to address a
117 given group you specify the group name with the <literal>-g</literal>
119 In this case settings that have the group name as their prefix
120 will be used by <literal>zebraidx</literal>.
121 If no <literal>-g</literal> option is specified, the settings
122 without prefix are used.
126 In the configuration file, the group name is placed before the option
127 name itself, separated by a dot (.). For instance, to set the record type
128 for group <literal>public</literal> to <literal>grs.sgml</literal>
129 (the &acro.sgml;-like format for structured records) you would write:
134 public.recordType: grs.sgml
139 To set the default value of the record type to <literal>text</literal>
150 The available configuration settings are summarized below. They will be
151 explained further in the following sections.
155 FIXME - Didn't Adam make something to have multiple databases in multiple dirs...
163 <emphasis>group</emphasis>
164 .recordType[<emphasis>.name</emphasis>]:
165 <replaceable>type</replaceable>
169 Specifies how records with the file extension
170 <emphasis>name</emphasis> should be handled by the indexer.
171 This option may also be specified as a command line option
172 (<literal>-t</literal>). Note that if you do not specify a
173 <emphasis>name</emphasis>, the setting applies to all files.
174 In general, the record type specifier consists of the elements (each
175 element separated by dot), <emphasis>fundamental-type</emphasis>,
176 <emphasis>file-read-type</emphasis> and arguments. Currently, two
177 fundamental types exist, <literal>text</literal> and
178 <literal>grs</literal>.
183 <term><emphasis>group</emphasis>.recordId:
184 <replaceable>record-id-spec</replaceable></term>
187 Specifies how the records are to be identified when updated. See
188 <xref linkend="locating-records"/>.
193 <term><emphasis>group</emphasis>.database:
194 <replaceable>database</replaceable></term>
197 Specifies the &acro.z3950; database name.
198 <!-- FIXME - now we can have multiple databases in one server. -H -->
203 <term><emphasis>group</emphasis>.storeKeys:
204 <replaceable>boolean</replaceable></term>
207 Specifies whether key information should be saved for a given
208 group of records. If you plan to update/delete this type of
209 records later this should be specified as 1; otherwise it
210 should be 0 (default), to save register space.
211 <!-- ### this is the first mention of "register" -->
212 See <xref linkend="file-ids"/>.
217 <term><emphasis>group</emphasis>.storeData:
218 <replaceable>boolean</replaceable></term>
221 Specifies whether the records should be stored internally
222 in the &zebra; system files.
223 If you want to maintain the raw records yourself,
224 this option should be false (0).
225 If you want &zebra; to take care of the records for you, it
231 <!-- ### probably a better place to define "register" -->
232 <term>register: <replaceable>register-location</replaceable></term>
235 Specifies the location of the various register files that &zebra; uses
236 to represent your databases.
237 See <xref linkend="register-location"/>.
242 <term>shadow: <replaceable>register-location</replaceable></term>
245 Enables the <emphasis>safe update</emphasis> facility of &zebra;, and
246 tells the system where to place the required, temporary files.
247 See <xref linkend="shadow-registers"/>.
252 <term>lockDir: <replaceable>directory</replaceable></term>
255 Directory in which various lock files are stored.
260 <term>keyTmpDir: <replaceable>directory</replaceable></term>
263 Directory in which temporary files used during zebraidx's update
269 <term>setTmpDir: <replaceable>directory</replaceable></term>
272 Specifies the directory that the server uses for temporary result sets.
273 If not specified <literal>/tmp</literal> will be used.
278 <term>profilePath: <replaceable>path</replaceable></term>
281 Specifies a path of profile specification files.
282 The path is composed of one or more directories separated by
283 colon. Similar to <literal>PATH</literal> for UNIX systems.
289 <term>modulePath: <replaceable>path</replaceable></term>
292 Specifies a path of record filter modules.
293 The path is composed of one or more directories separated by
294 colon. Similar to <literal>PATH</literal> for UNIX systems.
295 The 'make install' procedure typically puts modules in
296 <filename>/usr/local/lib/idzebra-2.0/modules</filename>.
302 <term>index: <replaceable>filename</replaceable></term>
305 Defines the filename which holds fields structure
306 definitions. If omitted, the file <filename>default.idx</filename>
308 Refer to <xref linkend="default-idx-file"/> for
315 <term>sortmax: <replaceable>integer</replaceable></term>
318 Specifies the maximum number of records that will be sorted
319 in a result set. If the result set contains more than
320 <replaceable>integer</replaceable> records, records after the
321 limit will not be sorted. If omitted, the default value is
328 <term>staticrank: <replaceable>integer</replaceable></term>
331 Enables whether static ranking is to be enabled (1) or
332 disabled (0). If omitted, it is disabled - corresponding
334 Refer to <xref linkend="administration-ranking-static"/> .
341 <term>estimatehits:: <replaceable>integer</replaceable></term>
344 Controls whether &zebra; should calculate approximate hit counts and
345 at which hit count it is to be enabled.
346 A value of 0 disables approximate hit counts.
347 For a positive value approximate hit count is enabled
348 if it is known to be larger than <replaceable>integer</replaceable>.
351 Approximate hit counts can also be triggered by a particular
352 attribute in a query.
353 Refer to <xref linkend="querymodel-zebra-global-attr-limit"/>.
359 <term>attset: <replaceable>filename</replaceable></term>
362 Specifies the filename(s) of attribute set files for use in
363 searching. In many configurations <filename>bib1.att</filename>
364 is used, but that is not required. If Classic Explain
365 attributes is to be used for searching,
366 <filename>explain.att</filename> must be given.
367 The path to att-files in general can be given using
368 <literal>profilePath</literal> setting.
369 See also <xref linkend="attset-files"/>.
374 <term>memMax: <replaceable>size</replaceable></term>
377 Specifies <replaceable>size</replaceable> of internal memory
378 to use for the zebraidx program.
379 The amount is given in megabytes - default is 4 (4 MB).
380 The more memory, the faster large updates happen, up to about
381 half the free memory available on the computer.
386 <term>tempfiles: <replaceable>Yes/Auto/No</replaceable></term>
389 Tells zebra if it should use temporary files when indexing. The
390 default is Auto, in which case zebra uses temporary files only
391 if it would need more that <replaceable>memMax</replaceable>
392 megabytes of memory. This should be good for most uses.
398 <term>root: <replaceable>dir</replaceable></term>
401 Specifies a directory base for &zebra;. All relative paths
402 given (in profilePath, register, shadow) are based on this
403 directory. This setting is useful if your &zebra; server
404 is running in a different directory from where
405 <literal>zebra.cfg</literal> is located.
411 <term>passwd: <replaceable>file</replaceable></term>
414 Specifies a file with description of user accounts for &zebra;.
415 The format is similar to that known to Apache's htpasswd files
416 and UNIX' passwd files. Non-empty lines not beginning with
417 # are considered account lines. There is one account per-line.
418 A line consists of fields separate by a single colon character.
419 First field is username, second is password.
425 <term>passwd.c: <replaceable>file</replaceable></term>
428 Specifies a file with description of user accounts for &zebra;.
429 File format is similar to that used by the passwd directive except
430 that the password are encrypted. Use Apache's htpasswd or similar
437 <term>perm.<replaceable>user</replaceable>:
438 <replaceable>permstring</replaceable></term>
441 Specifies permissions (privilege) for a user that are allowed
442 to access &zebra; via the passwd system. There are two kinds
443 of permissions currently: read (r) and write(w). By default
444 users not listed in a permission directive are given the read
445 privilege. To specify permissions for a user with no
446 username, or &acro.z3950; anonymous style use
447 <literal>anonymous</literal>. The permstring consists of
448 a sequence of characters. Include character <literal>w</literal>
449 for write/update access, <literal>r</literal> for read access and
450 <literal>a</literal> to allow anonymous access through this account.
456 <term>dbaccess <replaceable>accessfile</replaceable></term>
459 Names a file which lists database subscriptions for individual users.
460 The access file should consists of lines of the form <literal>username:
461 dbnames</literal>, where dbnames is a list of database names, separated by
462 '+'. No whitespace is allowed in the database list.
468 <term>encoding <replaceable>charsetname</replaceable></term>
471 Tells Zebra to interpret the terms in Z39.50 queries as
472 having been encoded using the specified character
473 encoding. The default is <literal>ISO-8859-1</literal>; one
474 useful alternative is <literal>UTF-8</literal>.
480 <term>storeKeys: <replaceable>value</replaceable></term>
483 Specifies whether Zebra keeps a copy of indexed keys.
484 Use a value of 1 to enable; 0 to disable. If storeKeys setting is
485 omitted, it is enabled. Enabled storeKeys
486 are required for updating and deleting records. Disable only
487 storeKeys to save space and only plan to index data once.
493 <term>storeData: <replaceable>value</replaceable></term>
496 Specifies whether Zebra keeps a copy of indexed records.
497 Use a value of 1 to enable; 0 to disable. If storeData setting is
498 omitted, it is enabled. A storeData setting of 0 (disabled) makes
499 Zebra fetch records from the original locaction in the file
500 system using filename, file offset and file length. For the
501 DOM and ALVIS filter, the storeData setting is ignored.
511 <sect1 id="locating-records">
512 <title>Locating Records</title>
515 The default behavior of the &zebra; system is to reference the
516 records from their original location, i.e. where they were found when you
517 run <literal>zebraidx</literal>.
518 That is, when a client wishes to retrieve a record
519 following a search operation, the files are accessed from the place
520 where you originally put them - if you remove the files (without
521 running <literal>zebraidx</literal> again, the server will return
522 diagnostic number 14 (``System error in presenting records'') to
527 If your input files are not permanent - for example if you retrieve
528 your records from an outside source, or if they were temporarily
529 mounted on a CD-ROM drive,
530 you may want &zebra; to make an internal copy of them. To do this,
531 you specify 1 (true) in the <literal>storeData</literal> setting. When
532 the &acro.z3950; server retrieves the records they will be read from the
533 internal file structures of the system.
538 <sect1 id="simple-indexing">
539 <title>Indexing with no Record IDs (Simple Indexing)</title>
542 If you have a set of records that are not expected to change over time
543 you may can build your database without record IDs.
544 This indexing method uses less space than the other methods and
549 To use this method, you simply omit the <literal>recordId</literal> entry
550 for the group of files that you index. To add a set of records you use
551 <literal>zebraidx</literal> with the <literal>update</literal> command. The
552 <literal>update</literal> command will always add all of the records that it
553 encounters to the index - whether they have already been indexed or
554 not. If the set of indexed files change, you should delete all of the
555 index files, and build a new index from scratch.
559 Consider a system in which you have a group of text files called
560 <literal>simple</literal>.
561 That group of records should belong to a &acro.z3950; database called
562 <literal>textbase</literal>.
563 The following <literal>zebra.cfg</literal> file will suffice:
568 profilePath: /usr/local/idzebra/tab
570 simple.recordType: text
571 simple.database: textbase
577 Since the existing records in an index can not be addressed by their
578 IDs, it is impossible to delete or modify records when using this method.
583 <sect1 id="file-ids">
584 <title>Indexing with File Record IDs</title>
587 If you have a set of files that regularly change over time: Old files
588 are deleted, new ones are added, or existing files are modified, you
589 can benefit from using the <emphasis>file ID</emphasis>
590 indexing methodology.
591 Examples of this type of database might include an index of WWW
592 resources, or a USENET news spool area.
593 Briefly speaking, the file key methodology uses the directory paths
594 of the individual records as a unique identifier for each record.
595 To perform indexing of a directory with file keys, again, you specify
596 the top-level directory after the <literal>update</literal> command.
597 The command will recursively traverse the directories and compare
598 each one with whatever have been indexed before in that same directory.
599 If a file is new (not in the previous version of the directory) it
600 is inserted into the registers; if a file was already indexed and
601 it has been modified since the last update, the index is also
602 modified; if a file has been removed since the last
603 visit, it is deleted from the index.
607 The resulting system is easy to administrate. To delete a record you
608 simply have to delete the corresponding file (say, with the
609 <literal>rm</literal> command). And to add records you create new
610 files (or directories with files). For your changes to take effect
611 in the register you must run <literal>zebraidx update</literal> with
612 the same directory root again. This mode of operation requires more
613 disk space than simpler indexing methods, but it makes it easier for
614 you to keep the index in sync with a frequently changing set of data.
615 If you combine this system with the <emphasis>safe update</emphasis>
616 facility (see below), you never have to take your server off-line for
617 maintenance or register updating purposes.
621 To enable indexing with pathname IDs, you must specify
622 <literal>file</literal> as the value of <literal>recordId</literal>
623 in the configuration file. In addition, you should set
624 <literal>storeKeys</literal> to <literal>1</literal>, since the &zebra;
625 indexer must save additional information about the contents of each record
626 in order to modify the indexes correctly at a later time.
630 FIXME - There must be a simpler way to do this with Adams string tags -H
634 For example, to update records of group <literal>esdd</literal>
636 <literal>/data1/records/</literal> you should type:
638 $ zebraidx -g esdd update /data1/records
643 The corresponding configuration file includes:
646 esdd.recordType: grs.sgml
652 <para>You cannot start out with a group of records with simple
653 indexing (no record IDs as in the previous section) and then later
654 enable file record Ids. &zebra; must know from the first time that you
656 the files should be indexed with file record IDs.
661 You cannot explicitly delete records when using this method (using the
662 <literal>delete</literal> command to <literal>zebraidx</literal>. Instead
663 you have to delete the files from the file system (or move them to a
665 and then run <literal>zebraidx</literal> with the
666 <literal>update</literal> command.
668 <!-- ### what happens if a file contains multiple records? -->
671 <sect1 id="generic-ids">
672 <title>Indexing with General Record IDs</title>
675 When using this method you construct an (almost) arbitrary, internal
676 record key based on the contents of the record itself and other system
677 information. If you have a group of records that explicitly associates
678 an ID with each record, this method is convenient. For example, the
679 record format may contain a title or a ID-number - unique within the group.
680 In either case you specify the &acro.z3950; attribute set and use-attribute
681 location in which this information is stored, and the system looks at
682 that field to determine the identity of the record.
686 As before, the record ID is defined by the <literal>recordId</literal>
687 setting in the configuration file. The value of the record ID specification
688 consists of one or more tokens separated by whitespace. The resulting
689 ID is represented in the index by concatenating the tokens and
690 separating them by ASCII value (1).
694 There are three kinds of tokens:
698 <term>Internal record info</term>
701 The token refers to a key that is
702 extracted from the record. The syntax of this token is
703 <literal>(</literal> <emphasis>set</emphasis> <literal>,</literal>
704 <emphasis>use</emphasis> <literal>)</literal>,
705 where <emphasis>set</emphasis> is the
706 attribute set name <emphasis>use</emphasis> is the
707 name or value of the attribute.
712 <term>System variable</term>
715 The system variables are preceded by
720 and immediately followed by the system variable name, which
733 <term>database</term>
736 Current database specified.
753 <term>Constant string</term>
756 A string used as part of the ID — surrounded
757 by single- or double quotes.
765 For instance, the sample GILS records that come with the &zebra;
766 distribution contain a unique ID in the data tagged Control-Identifier.
767 The data is mapped to the &acro.bib1; use attribute Identifier-standard
768 (code 1007). To use this field as a record id, specify
769 <literal>(bib1,Identifier-standard)</literal> as the value of the
770 <literal>recordId</literal> in the configuration file.
771 If you have other record types that uses the same field for a
772 different purpose, you might add the record type
773 (or group or database name) to the record id of the gils
774 records as well, to prevent matches with other types of records.
775 In this case the recordId might be set like this:
778 gils.recordId: $type (bib1,Identifier-standard)
784 (see <xref linkend="grs"/>
785 for details of how the mapping between elements of your records and
786 searchable attributes is established).
790 As for the file record ID case described in the previous section,
791 updating your system is simply a matter of running
792 <literal>zebraidx</literal>
793 with the <literal>update</literal> command. However, the update with general
794 keys is considerably slower than with file record IDs, since all files
795 visited must be (re)read to discover their IDs.
799 As you might expect, when using the general record IDs
800 method, you can only add or modify existing records with the
801 <literal>update</literal> command.
802 If you wish to delete records, you must use the,
803 <literal>delete</literal> command, with a directory as a parameter.
804 This will remove all records that match the files below that root
810 <sect1 id="register-location">
811 <title>Register Location</title>
814 Normally, the index files that form dictionaries, inverted
815 files, record info, etc., are stored in the directory where you run
816 <literal>zebraidx</literal>. If you wish to store these, possibly large,
817 files somewhere else, you must add the <literal>register</literal>
818 entry to the <literal>zebra.cfg</literal> file.
819 Furthermore, the &zebra; system allows its file
820 structures to span multiple file systems, which is useful for
821 managing very large databases.
825 The value of the <literal>register</literal> setting is a sequence
826 of tokens. Each token takes the form:
828 <emphasis>dir</emphasis><literal>:</literal><emphasis>size</emphasis>
830 The <emphasis>dir</emphasis> specifies a directory in which index files
831 will be stored and the <emphasis>size</emphasis> specifies the maximum
832 size of all files in that directory. The &zebra; indexer system fills
833 each directory in the order specified and use the next specified
834 directories as needed.
835 The <emphasis>size</emphasis> is an integer followed by a qualifier
837 <literal>b</literal> for bytes,
838 <literal>k</literal> for kilobytes.
839 <literal>M</literal> for megabytes,
840 <literal>G</literal> for gigabytes.
841 Specifying a negative value disables the checking (it still needs the unit,
842 use <literal>-1b</literal>).
846 For instance, if you have allocated three disks for your register, and
847 the first disk is mounted
848 on <literal>/d1</literal> and has 2GB of free space, the
849 second, mounted on <literal>/d2</literal> has 3.6 GB, and the third,
850 on which you have more space than you bother to worry about, mounted on
851 <literal>/d3</literal> you could put this entry in your configuration file:
854 register: /d1:2G /d2:3600M /d3:-1b
859 Note that &zebra; does not verify that the amount of space specified is
860 actually available on the directory (file system) specified - it is
861 your responsibility to ensure that enough space is available, and that
862 other applications do not attempt to use the free space. In a large
863 production system, it is recommended that you allocate one or more
864 file system exclusively to the &zebra; register files.
869 <sect1 id="shadow-registers">
870 <title>Safe Updating - Using Shadow Registers</title>
872 <sect2 id="shadow-registers-description">
873 <title>Description</title>
876 The &zebra; server supports <emphasis>updating</emphasis> of the index
877 structures. That is, you can add, modify, or remove records from
878 databases managed by &zebra; without rebuilding the entire index.
879 Since this process involves modifying structured files with various
880 references between blocks of data in the files, the update process
881 is inherently sensitive to system crashes, or to process interruptions:
882 Anything but a successfully completed update process will leave the
883 register files in an unknown state, and you will essentially have no
884 recourse but to re-index everything, or to restore the register files
885 from a backup medium.
886 Further, while the update process is active, users cannot be
887 allowed to access the system, as the contents of the register files
888 may change unpredictably.
892 You can solve these problems by enabling the shadow register system in
894 During the updating procedure, <literal>zebraidx</literal> will temporarily
895 write changes to the involved files in a set of "shadow
896 files", without modifying the files that are accessed by the
897 active server processes. If the update procedure is interrupted by a
898 system crash or a signal, you simply repeat the procedure - the
899 register files have not been changed or damaged, and the partially
900 written shadow files are automatically deleted before the new updating
905 At the end of the updating procedure (or in a separate operation, if
906 you so desire), the system enters a "commit mode". First,
907 any active server processes are forced to access those blocks that
908 have been changed from the shadow files rather than from the main
909 register files; the unmodified blocks are still accessed at their
910 normal location (the shadow files are not a complete copy of the
911 register files - they only contain those parts that have actually been
912 modified). If the commit process is interrupted at any point during the
913 commit process, the server processes will continue to access the
914 shadow files until you can repeat the commit procedure and complete
915 the writing of data to the main register files. You can perform
916 multiple update operations to the registers before you commit the
917 changes to the system files, or you can execute the commit operation
918 at the end of each update operation. When the commit phase has
919 completed successfully, any running server processes are instructed to
920 switch their operations to the new, operational register, and the
921 temporary shadow files are deleted.
926 <sect2 id="shadow-registers-how-to-use">
927 <title>How to Use Shadow Register Files</title>
930 The first step is to allocate space on your system for the shadow
932 You do this by adding a <literal>shadow</literal> entry to the
933 <literal>zebra.cfg</literal> file.
934 The syntax of the <literal>shadow</literal> entry is exactly the
935 same as for the <literal>register</literal> entry
936 (see <xref linkend="register-location"/>).
937 The location of the shadow area should be
938 <emphasis>different</emphasis> from the location of the main register
939 area (if you have specified one - remember that if you provide no
940 <literal>register</literal> setting, the default register area is the
941 working directory of the server and indexing processes).
945 The following excerpt from a <literal>zebra.cfg</literal> file shows
946 one example of a setup that configures both the main register
947 location and the shadow file area.
948 Note that two directories or partitions have been set aside
949 for the shadow file area. You can specify any number of directories
950 for each of the file areas, but remember that there should be no
951 overlaps between the directories used for the main registers and the
952 shadow files, respectively.
958 shadow: /scratch1:100M /scratch2:200M
964 When shadow files are enabled, an extra command is available at the
965 <literal>zebraidx</literal> command line.
966 In order to make changes to the system take effect for the
967 users, you'll have to submit a "commit" command after a
968 (sequence of) update operation(s).
974 $ zebraidx update /d1/records
981 Or you can execute multiple updates before committing the changes:
987 $ zebraidx -g books update /d1/records /d2/more-records
988 $ zebraidx -g fun update /d3/fun-records
995 If one of the update operations above had been interrupted, the commit
996 operation on the last line would fail: <literal>zebraidx</literal>
997 will not let you commit changes that would destroy the running register.
998 You'll have to rerun all of the update operations since your last
999 commit operation, before you can commit the new changes.
1003 Similarly, if the commit operation fails, <literal>zebraidx</literal>
1004 will not let you start a new update operation before you have
1005 successfully repeated the commit operation.
1006 The server processes will keep accessing the shadow files rather
1007 than the (possibly damaged) blocks of the main register files
1008 until the commit operation has successfully completed.
1012 You should be aware that update operations may take slightly longer
1013 when the shadow register system is enabled, since more file access
1014 operations are involved. Further, while the disk space required for
1015 the shadow register data is modest for a small update operation, you
1016 may prefer to disable the system if you are adding a very large number
1017 of records to an already very large database (we use the terms
1018 <emphasis>large</emphasis> and <emphasis>modest</emphasis>
1019 very loosely here, since every application will have a
1020 different perception of size).
1021 To update the system without the use of the the shadow files,
1022 simply run <literal>zebraidx</literal> with the <literal>-n</literal>
1023 option (note that you do not have to execute the
1024 <emphasis>commit</emphasis> command of <literal>zebraidx</literal>
1025 when you temporarily disable the use of the shadow registers in
1027 Note also that, just as when the shadow registers are not enabled,
1028 server processes will be barred from accessing the main register
1029 while the update procedure takes place.
1037 <sect1 id="administration-ranking">
1038 <title>Relevance Ranking and Sorting of Result Sets</title>
1040 <sect2 id="administration-overview">
1041 <title>Overview</title>
1043 The default ordering of a result set is left up to the server,
1044 which inside &zebra; means sorting in ascending document ID order.
1045 This is not always the order humans want to browse the sometimes
1046 quite large hit sets. Ranking and sorting comes to the rescue.
1050 In cases where a good presentation ordering can be computed at
1051 indexing time, we can use a fixed <literal>static ranking</literal>
1052 scheme, which is provided for the <literal>alvis</literal>
1053 indexing filter. This defines a fixed ordering of hit lists,
1054 independently of the query issued.
1058 There are cases, however, where relevance of hit set documents is
1059 highly dependent on the query processed.
1060 Simply put, <literal>dynamic relevance ranking</literal>
1061 sorts a set of retrieved records such that those most likely to be
1062 relevant to your request are retrieved first.
1063 Internally, &zebra; retrieves all documents that satisfy your
1064 query, and re-orders the hit list to arrange them based on
1065 a measurement of similarity between your query and the content of
1070 Finally, there are situations where hit sets of documents should be
1071 <literal>sorted</literal> during query time according to the
1072 lexicographical ordering of certain sort indexes created at
1078 <sect2 id="administration-ranking-static">
1079 <title>Static Ranking</title>
1082 &zebra; uses internally inverted indexes to look up term frequencies
1083 in documents. Multiple queries from different indexes can be
1084 combined by the binary boolean operations <literal>AND</literal>,
1085 <literal>OR</literal> and/or <literal>NOT</literal> (which
1086 is in fact a binary <literal>AND NOT</literal> operation).
1087 To ensure fast query execution
1088 speed, all indexes have to be sorted in the same order.
1091 The indexes are normally sorted according to document
1092 <literal>ID</literal> in
1093 ascending order, and any query which does not invoke a special
1094 re-ranking function will therefore retrieve the result set in
1096 <literal>ID</literal>
1104 directive in the main core &zebra; configuration file, the internal document
1105 keys used for ordering are augmented by a preceding integer, which
1106 contains the static rank of a given document, and the index lists
1108 first by ascending static rank,
1109 then by ascending document <literal>ID</literal>.
1111 is the ``best'' rank, as it occurs at the
1112 beginning of the list; higher numbers represent worse scores.
1115 The experimental <literal>alvis</literal> filter provides a
1116 directive to fetch static rank information out of the indexed &acro.xml;
1117 records, thus making <emphasis>all</emphasis> hit sets ordered
1118 after <emphasis>ascending</emphasis> static
1119 rank, and for those doc's which have the same static rank, ordered
1120 after <emphasis>ascending</emphasis> doc <literal>ID</literal>.
1121 See <xref linkend="record-model-alvisxslt"/> for the gory details.
1126 <sect2 id="administration-ranking-dynamic">
1127 <title>Dynamic Ranking</title>
1129 In order to fiddle with the static rank order, it is necessary to
1130 invoke additional re-ranking/re-ordering using dynamic
1131 ranking or score functions. These functions return positive
1132 integer scores, where <emphasis>highest</emphasis> score is
1134 hit sets are sorted according to <emphasis>descending</emphasis>
1136 to the index lists which are sorted according to
1137 ascending rank number and document ID).
1140 Dynamic ranking is enabled by a directive like one of the
1141 following in the zebra configuration file (use only one of these a time!):
1143 rank: rank-1 # default TDF-IDF like
1144 rank: rank-static # dummy do-nothing
1149 Dynamic ranking is done at query time rather than
1150 indexing time (this is why we
1151 call it ``dynamic ranking'' in the first place ...)
1152 It is invoked by adding
1153 the &acro.bib1; relation attribute with
1154 value ``relevance'' to the &acro.pqf; query (that is,
1155 <literal>@attr 2=102</literal>, see also
1156 <ulink url="&url.z39.50;bib1.html">
1157 The &acro.bib1; Attribute Set Semantics</ulink>, also in
1158 <ulink url="&url.z39.50.attset.bib1;">HTML</ulink>).
1159 To find all articles with the word <literal>Eoraptor</literal> in
1160 the title, and present them relevance ranked, issue the &acro.pqf; query:
1162 @attr 2=102 @attr 1=4 Eoraptor
1166 <sect3 id="administration-ranking-dynamic-rank1">
1167 <title>Dynamically ranking using &acro.pqf; queries with the 'rank-1'
1171 The default <literal>rank-1</literal> ranking module implements a
1172 TF/IDF (Term Frequecy over Inverse Document Frequency) like
1173 algorithm. In contrast to the usual definition of TF/IDF
1174 algorithms, which only considers searching in one full-text
1175 index, this one works on multiple indexes at the same time.
1177 &zebra; does boolean queries and searches in specific addressed
1178 indexes (there are inverted indexes pointing from terms in the
1179 dictionary to documents and term positions inside documents).
1183 <term>Query Components</term>
1186 First, the boolean query is dismantled into its principal components,
1187 i.e. atomic queries where one term is looked up in one index.
1188 For example, the query
1190 @attr 2=102 @and @attr 1=1010 Utah @attr 1=1018 Springer
1192 is a boolean AND between the atomic parts
1194 @attr 2=102 @attr 1=1010 Utah
1198 @attr 2=102 @attr 1=1018 Springer
1200 which gets processed each for itself.
1206 <term>Atomic hit lists</term>
1209 Second, for each atomic query, the hit list of documents is
1213 In this example, two hit lists for each index
1214 <literal>@attr 1=1010</literal> and
1215 <literal>@attr 1=1018</literal> are computed.
1221 <term>Atomic scores</term>
1224 Third, each document in the hit list is assigned a score (_if_ ranking
1225 is enabled and requested in the query) using a TF/IDF scheme.
1228 In this example, both atomic parts of the query assign the magic
1229 <literal>@attr 2=102</literal> relevance attribute, and are
1230 to be used in the relevance ranking functions.
1233 It is possible to apply dynamic ranking on only parts of the
1236 @and @attr 2=102 @attr 1=1010 Utah @attr 1=1018 Springer
1238 searches for all documents which have the term 'Utah' on the
1239 body of text, and which have the term 'Springer' in the publisher
1240 field, and sort them in the order of the relevance ranking made on
1241 the body-of-text index only.
1247 <term>Hit list merging</term>
1250 Fourth, the atomic hit lists are merged according to the boolean
1251 conditions to a final hit list of documents to be returned.
1254 This step is always performed, independently of the fact that
1255 dynamic ranking is enabled or not.
1261 <term>Document score computation</term>
1264 Fifth, the total score of a document is computed as a linear
1265 combination of the atomic scores of the atomic hit lists
1268 Ranking weights may be used to pass a value to a ranking
1269 algorithm, using the non-standard &acro.bib1; attribute type 9.
1270 This allows one branch of a query to use one value while
1271 another branch uses a different one. For example, we can search
1272 for <literal>utah</literal> in the
1273 <literal>@attr 1=4</literal> index with weight 30, as
1274 well as in the <literal>@attr 1=1010</literal> index with weight 20:
1276 @attr 2=102 @or @attr 9=30 @attr 1=4 utah @attr 9=20 @attr 1=1010 city
1280 The default weight is
1281 sqrt(1000) ~ 34 , as the &acro.z3950; standard prescribes that the top score
1282 is 1000 and the bottom score is 0, encoded in integers.
1286 The ranking-weight feature is experimental. It may change in future
1294 <term>Re-sorting of hit list</term>
1297 Finally, the final hit list is re-ordered according to scores.
1305 Still need to describe the exact TF/IDF formula. Here's the info, need -->
1306 <!--to extract it in human readable form .. MC
1308 static int calc (void *set_handle, zint sysno, zint staticrank,
1311 int i, lo, divisor, score = 0;
1312 struct rank_set_info *si = (struct rank_set_info *) set_handle;
1314 if (!si->no_rank_entries)
1315 return -1; /* ranking not enabled for any terms */
1317 for (i = 0; i < si->no_entries; i++)
1319 yaz_log(log_level, "calc: i=%d rank_flag=%d lo=%d",
1320 i, si->entries[i].rank_flag, si->entries[i].local_occur);
1321 if (si->entries[i].rank_flag && (lo = si->entries[i].local_occur))
1322 score += (8+log2_int (lo)) * si->entries[i].global_inv *
1323 si->entries[i].rank_weight;
1325 divisor = si->no_rank_entries * (8+log2_int (si->last_pos/si->no_entries));
1326 score = score / divisor;
1327 yaz_log(log_level, "calc sysno=" ZINT_FORMAT " score=%d", sysno, score);
1330 /* reset the counts for the next term */
1331 for (i = 0; i < si->no_entries; i++)
1332 si->entries[i].local_occur = 0;
1337 where lo = si->entries[i].local_occur is the local documents term-within-index frequency, si->entries[i].global_inv represents the IDF part (computed in static void *begin()), and
1338 si->entries[i].rank_weight is the weight assigner per index (default 34, or set in the @attr 9=xyz magic)
1340 Finally, the IDF part is computed as:
1342 static void *begin (struct zebra_register *reg,
1343 void *class_handle, RSET rset, NMEM nmem,
1344 TERMID *terms, int numterms)
1346 struct rank_set_info *si =
1347 (struct rank_set_info *) nmem_malloc (nmem,sizeof(*si));
1350 yaz_log(log_level, "rank-1 begin");
1351 si->no_entries = numterms;
1352 si->no_rank_entries = 0;
1354 si->entries = (struct rank_term_info *)
1355 nmem_malloc (si->nmem, sizeof(*si->entries)*numterms);
1356 for (i = 0; i < numterms; i++)
1358 zint g = rset_count(terms[i]->rset);
1359 yaz_log(log_level, "i=%d flags=%s '%s'", i,
1360 terms[i]->flags, terms[i]->name );
1361 if (!strncmp (terms[i]->flags, "rank,", 5))
1363 const char *cp = strstr(terms[i]->flags+4, ",w=");
1364 si->entries[i].rank_flag = 1;
1366 si->entries[i].rank_weight = atoi (cp+3);
1368 si->entries[i].rank_weight = 34; /* sqrroot of 1000 */
1369 yaz_log(log_level, " i=%d weight=%d g="ZINT_FORMAT, i,
1370 si->entries[i].rank_weight, g);
1371 (si->no_rank_entries)++;
1374 si->entries[i].rank_flag = 0;
1375 si->entries[i].local_occur = 0; /* FIXME */
1376 si->entries[i].global_occur = g;
1377 si->entries[i].global_inv = 32 - log2_int (g);
1378 yaz_log(log_level, " global_inv = %d g = " ZINT_FORMAT,
1379 (int) (32-log2_int (g)), g);
1380 si->entries[i].term = terms[i];
1381 si->entries[i].term_index=i;
1382 terms[i]->rankpriv = &(si->entries[i]);
1388 where g = rset_count(terms[i]->rset) is the count of all documents in this specific index hit list, and the IDF part then is
1390 si->entries[i].global_inv = 32 - log2_int (g);
1397 The <literal>rank-1</literal> algorithm
1398 does not use the static rank
1399 information in the list keys, and will produce the same ordering
1400 with or without static ranking enabled.
1405 <sect3 id="administration-ranking-dynamic-rank1">
1406 <title>Dynamically ranking &acro.pqf; queries with the 'rank-static'
1409 The dummy <literal>rank-static</literal> reranking/scoring
1410 function returns just
1411 <literal>score = max int - staticrank</literal>
1412 in order to preserve the static ordering of hit sets that would
1413 have been produced had it not been invoked.
1414 Obviously, to combine static and dynamic ranking usefully,
1416 to make a new ranking
1417 function; this is left
1418 as an exercise for the reader.
1425 <literal>Dynamic ranking</literal> is not compatible
1426 with <literal>estimated hit sizes</literal>, as all documents in
1427 a hit set must be accessed to compute the correct placing in a
1428 ranking sorted list. Therefore the use attribute setting
1429 <literal>@attr 2=102</literal> clashes with
1430 <literal>@attr 9=integer</literal>.
1435 we might want to add ranking like this:
1437 Simple BM25 Extension to Multiple Weighted Fields
1438 Stephen Robertson, Hugo Zaragoza and Michael Taylor
1442 mitaylor2microsoft.com
1447 <sect3 id="administration-ranking-dynamic-cql">
1448 <title>Dynamically ranking &acro.cql; queries</title>
1450 Dynamic ranking can be enabled during sever side &acro.cql;
1451 query expansion by adding <literal>@attr 2=102</literal>
1452 chunks to the &acro.cql; config file. For example
1454 relationModifier.relevant = 2=102
1456 invokes dynamic ranking each time a &acro.cql; query of the form
1459 Z> f alvis.text =/relevant house
1461 is issued. Dynamic ranking can also be automatically used on
1462 specific &acro.cql; indexes by (for example) setting
1464 index.alvis.text = 1=text 2=102
1466 which then invokes dynamic ranking each time a &acro.cql; query of the form
1469 Z> f alvis.text = house
1479 <sect2 id="administration-ranking-sorting">
1480 <title>Sorting</title>
1482 &zebra; sorts efficiently using special sorting indexes
1483 (type=<literal>s</literal>; so each sortable index must be known
1484 at indexing time, specified in the configuration of record
1485 indexing. For example, to enable sorting according to the &acro.bib1;
1486 <literal>Date/time-added-to-db</literal> field, one could add the line
1488 xelm /*/@created Date/time-added-to-db:s
1490 to any <literal>.abs</literal> record-indexing configuration file.
1491 Similarly, one could add an indexing element of the form
1493 <z:index name="date-modified" type="s">
1494 <xsl:value-of select="some/xpath"/>
1497 to any <literal>alvis</literal>-filter indexing stylesheet.
1500 Indexing can be specified at searching time using a query term
1501 carrying the non-standard
1502 &acro.bib1; attribute-type <literal>7</literal>. This removes the
1503 need to send a &acro.z3950; <literal>Sort Request</literal>
1504 separately, and can dramatically improve latency when the client
1505 and server are on separate networks.
1506 The sorting part of the query is separate from the rest of the
1507 query - the actual search specification - and must be combined
1511 A sorting subquery needs two attributes: an index (such as a
1512 &acro.bib1; type-1 attribute) specifying which index to sort on, and a
1513 type-7 attribute whose value is be <literal>1</literal> for
1514 ascending sorting, or <literal>2</literal> for descending. The
1515 term associated with the sorting attribute is the priority of
1516 the sort key, where <literal>0</literal> specifies the primary
1517 sort key, <literal>1</literal> the secondary sort key, and so
1520 <para>For example, a search for water, sort by title (ascending),
1521 is expressed by the &acro.pqf; query
1523 @or @attr 1=1016 water @attr 7=1 @attr 1=4 0
1525 whereas a search for water, sort by title ascending,
1526 then date descending would be
1528 @or @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 @attr 7=2 @attr 1=30 1
1532 Notice the fundamental differences between <literal>dynamic
1533 ranking</literal> and <literal>sorting</literal>: there can be
1534 only one ranking function defined and configured; but multiple
1535 sorting indexes can be specified dynamically at search
1536 time. Ranking does not need to use specific indexes, so
1537 dynamic ranking can be enabled and disabled without
1538 re-indexing; whereas, sorting indexes need to be
1539 defined before indexing.
1547 <sect1 id="administration-extended-services">
1548 <title>Extended Services: Remote Insert, Update and Delete</title>
1552 Extended services are only supported when accessing the &zebra;
1553 server using the <ulink url="&url.z39.50;">&acro.z3950;</ulink>
1554 protocol. The <ulink url="&url.sru;">&acro.sru;</ulink> protocol does
1555 not support extended services.
1560 The extended services are not enabled by default in zebra - due to the
1561 fact that they modify the system. &zebra; can be configured
1563 search, and to allow only updates for a particular admin user
1564 in the main zebra configuration file <filename>zebra.cfg</filename>.
1565 For user <literal>admin</literal>, you could use:
1569 passwd: passwordfile
1571 And in the password file
1572 <filename>passwordfile</filename>, you have to specify users and
1573 encrypted passwords as colon separated strings.
1574 Use a tool like <filename>htpasswd</filename>
1575 to maintain the encrypted passwords.
1579 It is essential to configure &zebra; to store records internally,
1581 modifications and deletion of records:
1586 The general record type should be set to any record filter which
1587 is able to parse &acro.xml; records, you may use any of the two
1588 declarations (but not both simultaneously!)
1590 recordType: dom.filter_dom_conf.xml
1591 # recordType: grs.xml
1593 Notice the difference to the specific instructions
1595 recordType.xml: dom.filter_dom_conf.xml
1596 # recordType.xml: grs.xml
1598 which only work when indexing XML files from the filesystem using
1599 the <literal>*.xml</literal> naming convention.
1602 To enable transaction safe shadow indexing,
1603 which is extra important for this kind of operation, set
1605 shadow: directoryname: size (e.g. 1000M)
1607 See <xref linkend="zebra-cfg"/> for additional information on
1608 these configuration options.
1612 It is not possible to carry information about record types or
1613 similar to &zebra; when using extended services, due to
1614 limitations of the <ulink url="&url.z39.50;">&acro.z3950;</ulink>
1615 protocol. Therefore, indexing filters can not be chosen on a
1616 per-record basis. One and only one general &acro.xml; indexing filter
1618 <!-- but because it is represented as an OID, we would need some
1619 form of proprietary mapping scheme between record type strings and
1622 However, as a minimum, it would be extremely useful to enable
1623 people to use &acro.marc21;, assuming grs.marcxml.marc21 as a record
1630 <sect2 id="administration-extended-services-z3950">
1631 <title>Extended services in the &acro.z3950; protocol</title>
1634 The <ulink url="&url.z39.50;">&acro.z3950;</ulink> standard allows
1635 servers to accept special binary <emphasis>extended services</emphasis>
1636 protocol packages, which may be used to insert, update and delete
1637 records into servers. These carry control and update
1638 information to the servers, which are encoded in seven package fields:
1641 <table id="administration-extended-services-z3950-table" frame="top">
1642 <title>Extended services &acro.z3950; Package Fields</title>
1646 <entry>Parameter</entry>
1647 <entry>Value</entry>
1648 <entry>Notes</entry>
1653 <entry><literal>type</literal></entry>
1654 <entry><literal>'update'</literal></entry>
1655 <entry>Must be set to trigger extended services</entry>
1658 <entry><literal>action</literal></entry>
1659 <entry><literal>string</literal></entry>
1661 Extended service action type with
1662 one of four possible values: <literal>recordInsert</literal>,
1663 <literal>recordReplace</literal>,
1664 <literal>recordDelete</literal>,
1665 and <literal>specialUpdate</literal>
1669 <entry><literal>record</literal></entry>
1670 <entry><literal>&acro.xml; string</literal></entry>
1671 <entry>An &acro.xml; formatted string containing the record</entry>
1674 <entry><literal>syntax</literal></entry>
1675 <entry><literal>'xml'</literal></entry>
1676 <entry>XML/SUTRS/MARC. GRS-1 not supported.
1677 The default filter (record type) as given by recordType in
1678 zebra.cfg is used to parse the record.</entry>
1681 <entry><literal>recordIdOpaque</literal></entry>
1682 <entry><literal>string</literal></entry>
1684 Optional client-supplied, opaque record
1685 identifier used under insert operations.
1689 <entry><literal>recordIdNumber </literal></entry>
1690 <entry><literal>positive number</literal></entry>
1691 <entry>&zebra;'s internal system number,
1692 not allowed for <literal>recordInsert</literal> or
1693 <literal>specialUpdate</literal> actions which result in fresh
1698 <entry><literal>databaseName</literal></entry>
1699 <entry><literal>database identifier</literal></entry>
1701 The name of the database to which the extended services should be
1711 The <literal>action</literal> parameter can be any of
1712 <literal>recordInsert</literal> (will fail if the record already exists),
1713 <literal>recordReplace</literal> (will fail if the record does not exist),
1714 <literal>recordDelete</literal> (will fail if the record does not
1716 <literal>specialUpdate</literal> (will insert or update the record
1717 as needed, record deletion is not possible).
1721 During all actions, the
1722 usual rules for internal record ID generation apply, unless an
1723 optional <literal>recordIdNumber</literal> &zebra; internal ID or a
1724 <literal>recordIdOpaque</literal> string identifier is assigned.
1725 The default ID generation is
1726 configured using the <literal>recordId:</literal> from
1727 <filename>zebra.cfg</filename>.
1728 See <xref linkend="zebra-cfg"/>.
1732 Setting of the <literal>recordIdNumber</literal> parameter,
1733 which must be an existing &zebra; internal system ID number, is not
1734 allowed during any <literal>recordInsert</literal> or
1735 <literal>specialUpdate</literal> action resulting in fresh record
1740 When retrieving existing
1741 records indexed with &acro.grs1; indexing filters, the &zebra; internal
1742 ID number is returned in the field
1743 <literal>/*/id:idzebra/localnumber</literal> in the namespace
1744 <literal>xmlns:id="http://www.indexdata.dk/zebra/"</literal>,
1745 where it can be picked up for later record updates or deletes.
1749 A new element set for retrieval of internal record
1750 data has been added, which can be used to access minimal records
1751 containing only the <literal>recordIdNumber</literal> &zebra;
1752 internal ID, or the <literal>recordIdOpaque</literal> string
1753 identifier. This works for any indexing filter used.
1754 See <xref linkend="special-retrieval"/>.
1758 The <literal>recordIdOpaque</literal> string parameter
1759 is an client-supplied, opaque record
1760 identifier, which may be used under
1761 insert, update and delete operations. The
1762 client software is responsible for assigning these to
1763 records. This identifier will
1764 replace zebra's own automagic identifier generation with a unique
1765 mapping from <literal>recordIdOpaque</literal> to the
1766 &zebra; internal <literal>recordIdNumber</literal>.
1767 <emphasis>The opaque <literal>recordIdOpaque</literal> string
1769 are not visible in retrieval records, nor are
1770 searchable, so the value of this parameter is
1771 questionable. It serves mostly as a convenient mapping from
1772 application domain string identifiers to &zebra; internal ID's.
1778 <sect2 id="administration-extended-services-yaz-client">
1779 <title>Extended services from yaz-client</title>
1782 We can now start a yaz-client admin session and create a database:
1785 $ yaz-client localhost:9999 -u admin/secret
1789 Now the <literal>Default</literal> database was created,
1790 we can insert an &acro.xml; file (esdd0006.grs
1791 from example/gils/records) and index it:
1794 Z> update insert id1234 esdd0006.grs
1797 The 3rd parameter - <literal>id1234</literal> here -
1798 is the <literal>recordIdOpaque</literal> package field.
1801 Actually, we should have a way to specify "no opaque record id" for
1802 yaz-client's update command.. We'll fix that.
1805 The newly inserted record can be searched as usual:
1810 Received SearchResponse.
1811 Search was a success.
1812 Number of hits: 1, setno 1
1813 SearchResult-1: term=utah cnt=1
1820 Let's delete the beast, using the same
1821 <literal>recordIdOpaque</literal> string parameter:
1824 Z> update delete id1234
1825 No last record (update ignored)
1826 Z> update delete 1 esdd0006.grs
1827 Got extended services response
1832 Received SearchResponse.
1833 Search was a success.
1834 Number of hits: 0, setno 2
1835 SearchResult-1: term=utah cnt=0
1842 If shadow register is enabled in your
1843 <filename>zebra.cfg</filename>,
1844 you must run the adm-commit command
1850 after each update session in order write your changes from the
1851 shadow to the life register space.
1856 <sect2 id="administration-extended-services-yaz-php">
1857 <title>Extended services from yaz-php</title>
1860 Extended services are also available from the &yaz; &acro.php; client layer. An
1861 example of an &yaz;-&acro.php; extended service transaction is given here:
1864 $record = '<record><title>A fine specimen of a record</title></record>';
1866 $options = array('action' => 'recordInsert',
1868 'record' => $record,
1869 'databaseName' => 'mydatabase'
1872 yaz_es($yaz, 'update', $options);
1873 yaz_es($yaz, 'commit', array());
1876 if ($error = yaz_error($yaz))
1883 <sect2 id="administration-extended-services-debugging">
1884 <title>Extended services debugging guide</title>
1886 When debugging ES over PHP we recommend the following order of tests:
1892 Make sure you have a nice record on your filesystem, which you can
1893 index from the filesystem by use of the zebraidx command.
1894 Do it exactly as you planned, using one of the GRS-1 filters,
1895 or the DOMXML filter.
1896 When this works, proceed.
1901 Check that your server setup is OK before you even coded one single
1903 Take the same record form the file system, and send as ES via
1904 <literal>yaz-client</literal> like described in
1905 <xref linkend="administration-extended-services-yaz-client"/>,
1907 remember the <literal>-a</literal> option which tells you what
1908 goes over the wire! Notice also the section on permissions:
1913 in <literal>zebra.cfg</literal> to make sure you do not run into
1914 permission problems (but never expose such an insecure setup on the
1915 internet!!!). Then, make sure to set the general
1916 <literal>recordType</literal> instruction, pointing correctly
1917 to the GRS-1 filters,
1918 or the DOMXML filters.
1923 If you insist on using the <literal>sysno</literal> in the
1924 <literal>recordIdNumber</literal> setting,
1925 please make sure you do only updates and deletes. Zebra's internal
1926 system number is not allowed for
1927 <literal>recordInsert</literal> or
1928 <literal>specialUpdate</literal> actions
1929 which result in fresh record inserts.
1934 If <literal>shadow register</literal> is enabled in your
1935 <literal>zebra.cfg</literal>, you must remember running the
1944 If this works, then proceed to do the same thing in your PHP script.
1956 <!-- Keep this comment at the end of the file
1961 sgml-minimize-attributes:nil
1962 sgml-always-quote-attributes:t
1965 sgml-parent-document: "zebra.xml"
1966 sgml-local-catalogs: nil
1967 sgml-namecase-general:t