Documentation: Update EG upgrade instructions to 2.5 beta1
[working/Evergreen.git] / docs / acquisitions / vandelay_acquisitions_integration.txt
1 Load MARC Order Records
2 -----------------------
3 The Acquisitions Load MARC Order Record interface enables you to add MARC
4 records to selection lists and purchase orders and upload the records into the
5 catalog.  You can both create and activate purchase orders in one step from this
6 interface. You can also load bibs and items into the catalog.
7
8 Leveraging the match sets available in the cataloging MARC batch Import
9 interface, you can also utilize record matching mechanisms to prevent the
10 creation of duplicate records. 
11
12 For detailed instructions on record matching and importing, see
13 <<batchimport, Batch Importing MARC Records>>.
14
15 Basic Upload Options
16 ~~~~~~~~~~~~~~~~~~~~
17 . Click *Acquisitions* -> *Load MARC Order Records*.
18 . If you want to upload the MARC records to a new purchase order, then click
19 the check box adjacent to Create Purchase Order.
20 . If you want to activate the purchase order at the time of creation, then
21 click the check box adjacent to _Activate Purchase Order_.
22 . Enter the name of the *Provider*. The text will auto-complete.
23 . Select an org unit from the drop down menu. The context org unit is the org
24 unit responsible for placing and managing the order. It defines what org unit
25 settings (eg copy locations) are in scope, what fiscal year to use, who is
26 allowed to view/modify the PO, where the items should be delivered and the EDI
27 SAN. In the case of a multi-branch system uploading records for multiple
28 branches, choosing the system is probably best. Single branch libraries or 
29 branches responsible for their own orders should probably select the branch.
30 . If you want to upload the records to a selection list, you can select a list
31 from the drop down menu, or type in the name of the selection list that you
32 want to create.
33 . Select a *Fiscal Year* from the dropdown menu that matches the fiscal year
34 of the funds that will be used for the order. If no fiscal year is selected, the
35 system will use the organizational unit's default fiscal year stored in the
36 database. If not fiscal year is set, the system will default to the current
37 calendar year.
38
39 Record Matching Options
40 ~~~~~~~~~~~~~~~~~~~~~~~
41 Use the options below the horizontal rule for the system to check for matching
42 records before importing an order record.
43
44 . Create a queue to which you can upload your records, or add you records to an existing queue
45 . Select a *Record Match Set* from the drop-down menu.
46 . Select a *Merge Profile.* Merge profiles enable you to specify which tags
47 should be removed or preserved in incoming records.
48 . Selet a *Record Source* from the drop-down menu.
49 . If you want to automatically import records on upload, select one or more of
50 the following options.
51   .. *Import Non-Matching Records* - import any records that don't have a match
52   in the system.
53   .. *Merge on Exact Match (901c)* - use only for records that will match on
54   the 901c field.
55   .. *Merge on Single Match* - import records that only have one match in the
56   system.
57   .. *Merge on Best Match* - If more than one match is found in the catalog for
58   a given record, Evergreen will attempt to perform the best match as defined
59   by the match score.
60 . To only import records that has a quality equal to or greater than the
61 existing record, enter a *Best/Single Match Minimum Quality Ratio*.  Divide the
62 incoming record quality score, as determined by the match set's quality
63 metrics, by the record quality score of the best match that exists in the 
64 catalog. If you want to ensure that the inbound record is only imported when it
65 has a higher quality than the best match, then you must enter a ratio that is
66 higher than 1, such as 1.1. If you want to bypass all quality restraings, enter
67 a 0 (zero) in this field.
68 . Select an *Insufficient Quality Fall-Through Profile* if desired. This field
69 enables you to indicate that if the inbound record doees not meet the
70 configured quality standards, then you may still import the record using an
71 alternate merge profile. This field is typically used for selecting a merge
72 profile that allows the user to import holdings attached to a lower quality
73 record without replacing the existing (target) record with the incoming record.
74 This field is optional.
75 . If your order records contain holdings information, by default, Evergreen 
76 will load them as acquisitions copies. Select *Load Items for Imported Records*
77 to automatically load them as live copies that display in the catalog.
78
79 Default Upload Settings
80 ~~~~~~~~~~~~~~~~~~~~~~~
81
82 You can set default upload values by modifying the following settings in
83 *Admin* -> *Local Administration* -> *Library Settings Editor*:
84
85 - Upload Activate PO
86 - Upload Create PO
87 - Upload Default Insufficient Quality Fall-Thru Profile
88 - Upload Default Match Set
89 - Upload Default Merge Profile
90 - Upload Upload Default Min. Quality Ratio
91 - Upload Default Provider
92 - Upload Import Non Matching by Default
93 - Upload Load Items for Imported Records by Default
94 - Upload Merge on Best Match by Default
95 - Upload Merge on Exact Match by Default
96 - Upload Merge on Single Match by Default
97
98 Sticky Settings
99 ~~~~~~~~~~~~~~~
100
101 If the above default settings are not implemented, the selections/values used
102 in the following fields will be sticky and will automatically populate the
103 fields the next time the *Load MARC Order Records* screen is pulled up:
104
105 - Create Purchase Order
106 - Activate Purchase Order
107 - Context Org Unit
108 - Record Match Set
109 - Merge Profile
110 - Import Non-Matching Records
111 - Merge on Exact Match (901c)
112 - Merge on Single Match
113 - Merge on Best Match
114 - Best/Single Match Minimum Quality Ratio
115 - Insufficient Quality Fall-Through Profile
116 - Load Items for Imported Records
117
118 Use Cases for MARC Order Upload form
119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120
121 You can add items to a selection list or purchase order and ignore the record 
122 matching options, or you can use both acquisitions and cataloging functions. In
123 these examples, you will use both functions.
124
125 *Example 1*
126 Using the Acquisitions MARC Batch Load interface, upload MARC records to a
127 selection list and import queue, and match queued records with existing catalog
128 records.
129
130 In this example, an acquisitions librarian has received a batch of MARC records
131 from a vendor. She will add the records to a selection list and a Vandelay
132 record queue.
133
134 A cataloger will later view the queue, edit the records, and import them into
135 the catalog.
136
137 . Click *Acquisitions -> Load MARC Order Records*
138 . Add MARC order records to a *Selection list* and/or a *Purchase Order.* 
139 Check the box to create a purchase order if desired.
140 . Select a *Provider* from the drop-down menu, or begin typing the code for the provider, and the field will auto-fill.
141 . Select a *Context Org Unit* from the drop down-menu, or begin typing the code
142 for the context org unit, and the field will auto-fill.
143 . Select a *Selection List* from the drop down menu, or begin typing the name
144 of the selection list.  You can create a new list, or the field will auto-fill.
145 . Create a new record import queue, or upload the records to an existing
146 queue.
147 . Select a *Record Match Set*.
148 . Browse your computer to find the MARC file, and click *Upload*.
149 +
150 image::media/Vandelay_Integration_into_Acquisitions1.jpg[Vandelay_Integration_into_Acquisitions1]
151 +
152 . The processed items appear at the bottom of the screen.
153 +
154 image::media/Vandelay_Integration_into_Acquisitions2.jpg[Vandelay_Integration_into_Acquisitions2]
155 . You can click the link(s) to access the selection list or the import queue.
156 Click the link to *View Selection List*.
157 . Look at the first line item.  The line item has not yet been linked to the
158 catalog, but it is linked to a record import queue.  Click the link to the
159 *queue* to examine the MARC record.
160 +
161 image::media/Vandelay_Integration_into_Acquisitions3.jpg[Vandelay_Integration_into_Acquisitions3]
162 . The batch import interface opens in a new tab.  The bibliographic records
163 appear in the queue. Records that have matches are identified in the queue. You
164 can edit these records and/or import them into the catalog, completing the
165 process.
166
167 image::media/Vandelay_Integration_into_Acquisitions4.jpg[Vandelay_Integration_into_Acquisitions4]
168
169 *Example 2*: Using the Acquisitions MARC Batch Load interface, upload MARC
170 records to a selection list, and use the Vandelay options to import the records
171 directly into the catalog.  The Vandelay options will enable you to match
172 incoming records with existing catalog records.
173
174 In this example, a librarian will add MARC records to a selection list, create
175 criteria for matching incoming and existing records, and import the matching
176 and non-matching records into the catalog.
177
178 . Click *Acquisitions* -> *Load MARC Order Records*
179 . Add MARC order records to a *Selection list* and/or a *Purchase Order.* 
180 Check the box to create a purchase order if desired.
181 . Select a *Provider* from the drop down menu, or begin typing the code for the
182 provider, and the field will auto-fill.
183 . Select a *Context Org Unit* from the drop down menu, or begin typing the code for the context org unit, and the field will auto-fill.
184 . Select a *Selection List* from the drop down menu, or begin typing the name
185 of the selection list.  You can create a new list, or the field will auto-fill.
186 . Create a new record import queue, or upload the records to an existing queue.
187 . Select a *Record Match Set*.
188 . Select *Merge Profile* -> *Match-Only Merge*.
189 . Check the boxes adjacent to *Import Non-Matching Records* and *Merge on Best
190 Match*.
191 .  Browse your computer to find the MARC file, and click *Upload*.
192 +
193 image::media/Vandelay_Integration_into_Acquisitions5.jpg[Vandelay_Integration_into_Acquisitions5]
194 +
195 . Click the link to *View Selection List*  Line items that do not match
196 existing catalog records on title and ISBN contain the link, *link to catalog*.
197 This link indicates that you could link the line item to a catalog record, but
198 currently, no match exists between the line item and catalog records.  Line
199 items that do have matching records in the catalog contain the link, *catalog*.
200 +
201 image::media/Vandelay_Integration_into_Acquisitions6.jpg[Vandelay_Integration_into_Acquisitions6]
202 +
203 . Click the *catalog* link to view the line item in the catalog.
204
205 *Permissions to use this Feature*
206
207 IMPORT_MARC - Using batch importer to create new bib records requires the
208 IMPORT_MARC permission (same as open-ils.cat.biblio.record.xml.import). If the
209 permission fails, the queued record will fail import and be stamped with a new
210 "import.record.perm_failure" import error
211
212 IMPORT_ACQ_LINEITEM_BIB_RECORD_UPLOAD -  This allows interfaces leveraging 
213 the batch importer, such as Acquisitions, to create a higher barrier to entry.
214 This permission prevents users from creating new bib records directly from the
215 ACQ vendor MARC file upload interface.