01fb8e9d550d9667d138af9fd4eaa76d88eb1274
[working/NCIPServer.git] / examples / oils_ncip.xml.example
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- Configuration for the Evergreen NCIPServer driver. -->
3 <ncip>
4   <!-- Information needed to authenticate with Evergreen -->
5   <credentials>
6     <!-- NCIPServer staff account -->
7     <username></username>
8     <!-- Password for the above -->
9     <password></password>
10     <!-- NCIPServer organizational unit shortname -->
11     <work_ou></work_ou>
12     <!-- Workstation registered for the URSA staff account -->
13     <workstation></workstation>
14   </credentials>
15   <!-- Path to opensrf_core.xml bootstrap configuration -->
16   <bootstrap></bootstrap>
17   <!-- Configurable options for created copies. -->
18   <items>
19     <!-- If you are on Evergreen version 2.7.0-alpha or later, you can
20          uncomment the following element to use precat copies instead
21          of making "short" bib records.  If you are on an older
22          version of Evergreen, enabling this setting will not work the
23          way you wish and will cause staff no end of confusion.
24     -->
25     <!-- <use_precats /> -->
26
27     <!-- The following setting will cause force holds to be placed on
28          copies created by the AcceptItem message. This will also
29          cause those copies not to be holdable. The latter only takes
30          effect when use_precats is not in operation, since there is
31          no other way to place holds on precat copies.
32     -->
33     <!-- <use_force_holds /> -->
34
35     <!-- The following setting is recommended if you do not use precat
36          copies.  If it is not present, a default of System Local will
37          be used.
38
39          It will be used as the bibliographic record source when the
40          "short" bibs are created.  Having a unique entry for this in
41          your database makes it easy to identify bibliographic records
42          created via NCIP.  It is highly recommended that you create
43          one just for this purpose.
44
45          The element can be set up empty with the cbs attribute
46          holding the database ID of the config.bib_source entry to
47          use.  You can optionally set the text value of the element to
48          the name of the bib_source.  If the cbs attribute is omitted,
49          then the text value name must be provided.  The example
50          provided below will use the System Local config.bib_source
51          that comes with Evergreen.
52     -->
53     <bib_source cbs="2">System Local</bib_source>
54
55     <!-- Add a stat_cat_entry element for each stat cat that you wish
56          to fill in when creating copies. If you aren't using
57          stat_cats or if you don't wish to create any for these, you
58          don't need to have stat_cat_entry elements. You could delete
59          the dummy entry in this case.  If you have any required stat
60          cats, then it is a good idea to have an entry here.
61
62          The stat_cat attribute is the numeric id of the stat_cat for
63          the entry.
64
65          The element's text node is used as the asset.stat_cat_entry's
66          value in the database.
67     -->
68     <!-- <stat_cat_entry stat_cat=""></stat_cat_entry> -->
69   </items>
70   <!-- Configurable options for patron retrieval/validation -->
71   <patrons>
72     <!-- You can block patrons by profile group in two ways:
73
74          The first is to enter a block_profile tag with a grp
75          attribute set to the value of the profile group's id, for
76          example:
77
78          <block_profile grp="20"/>
79
80          The second is to enter a block_profile tag with a text value
81          equal to the name of the profile group, for instance:
82
83          <block_profile>Local Use Only</block_profile>
84
85          In this case, the name must match exactly the case, spacing,
86          and punctuation (if any) of the profile group's name in the
87          permission.grp_tree table.
88
89          If you specify both the grp attribute and a text value with a
90          group name, then the value of the grp tag is used. The text
91          value will be ignored:
92
93          <block_profile grp="20">Local Use Only</block_profile>
94
95          You might want to do this in order to have slightly faster
96          configuration load times and still have the group name as a
97          reminder to the person that edits the configuration.
98     -->
99   </patrons>
100 </ncip>