View | Details | Raw Unified | Return to bug 37539
Collapse All | Expand All

(-)a/source/cataloging.rst (-3 / +4 lines)
Lines 15-23 are all defined the way you want. Once in the cataloging module you will not be Link Here
15
able to add or remove fields and subfields, so your frameworks must be
15
able to add or remove fields and subfields, so your frameworks must be
16
ready before you start cataloging.
16
ready before you start cataloging.
17
17
18
You can also use OCLC Connexion to send records directly in to Koha. For
18
You can also use OCLC cataloging services like
19
more information on that please review the
19
`WorldShare Record Manager <https://www.oclc.org/en/worldshare-record-manager.html>`_ and
20
:ref:`OCLC Connexion Gateway <oclc-connexion-gateway-label>` setup appendix.
20
`Connexion <https://www.oclc.org/en/connexion.html>`_ to send records directly in to Koha.
21
For more information, see :ref:`OCLC Cataloging Services<oclc-cataloging-services-label>`.
21
22
22
.. _bibliographic-records-label:
23
.. _bibliographic-records-label:
23
24
(-)a/source/cron_jobs.rst (-16 / +23 lines)
Lines 1617-1637 Batches can also be processed through the UI. Link Here
1617
1617
1618
    This script is used for OCLC Connexion
1618
    This script is used for OCLC Connexion
1619
1619
1620
.. _cron-connexion-import-daemon-label:
1621
1622
Connexion import daemon
1623
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1624
1625
Script path: misc/bin/connexion\_import\_daemon.pl
1626
1627
Does: listens for OCLC Connexion requests and is compliant with
1628
OCLC Gateway specification. It takes requests with MARC XML and import batch
1629
parameters from a configuration file and forwards it to svc/import_bib
1630
1631
    **Note**
1632
1633
    This script is used for OCLC Connexion
1634
1635
.. _cron-delete-items-label:
1620
.. _cron-delete-items-label:
1636
1621
1637
Batch item deletion
1622
Batch item deletion
Lines 2551-2556 Daemons Link Here
2551
2536
2552
Daemons are continuously running tasks that help support Koha
2537
Daemons are continuously running tasks that help support Koha
2553
operation.  Your database and web-server are run as daemons.
2538
operation.  Your database and web-server are run as daemons.
2539
2540
Automatically started daemons
2541
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2542
2554
Newer versions of Koha start two different daemons for most koha instances:
2543
Newer versions of Koha start two different daemons for most koha instances:
2555
2544
2556
  - zebra - this is the index server
2545
  - zebra - this is the index server
Lines 2563-2569 These daemons are started by the script /etc/init.d/koha-common. Link Here
2563
.. _cron-koha-indexer-label:
2552
.. _cron-koha-indexer-label:
2564
2553
2565
Zebra indexer daemon
2554
Zebra indexer daemon
2566
~~~~~~~~~~~~~~~~~~~~
2555
^^^^^^^^^^^^^^^^^^^^
2567
2556
2568
Script path: /usr/sbin/koha-indexer (invoked from /etc/init.d/koha-common)
2557
Script path: /usr/sbin/koha-indexer (invoked from /etc/init.d/koha-common)
2569
2558
Lines 2575-2580 The advantage of this approach is a search system which is much more Link Here
2575
responsive to changes, compared to the
2564
responsive to changes, compared to the
2576
:ref:`cron job approach <cron-rebuild-index-label>`.
2565
:ref:`cron job approach <cron-rebuild-index-label>`.
2577
2566
2567
Other daemons
2568
~~~~~~~~~~~~~
2569
2570
These are not started automatically by Koha.
2571
You could run them manually, or create your own systemd unit to keep them running.
2572
2573
.. _cron-connexion-import-daemon-label:
2574
2575
OCLC Connexion import daemon
2576
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2577
2578
Script path: ``misc/bin/connexion_import_daemon.pl``
2579
2580
Does: Listens for requests from OCLC Connexion clients and is compliant with the
2581
OCLC Gateway specification.
2582
2583
See :ref:`Setting up the OCLC Connexion Daemon <setting-up-oclc-service-on-koha-label>` for more details.
2584
2578
Deprecated scripts
2585
Deprecated scripts
2579
--------------------
2586
--------------------
2580
2587
(-)a/source/images.rst (-1 / +19 lines)
Lines 3578-3583 Link Here
3578
3578
3579
.. APPENDICES
3579
.. APPENDICES
3580
3580
3581
.. third_party_software
3582
3583
.. third_party_software/oclc
3584
3585
.. |worldshare_user_preferences.png| image:: images/third_party_software/oclc/worldshare_user_preferences.png
3586
        :alt: Screenshot of "User Preferences" on the WorldShare web interface.
3587
3588
.. |worldshare_user_preferences_export_biblio_format_utf8.png| image:: images/third_party_software/oclc/worldshare_user_preferences_export_biblio_format_utf8.png
3589
        :alt: Screenshot of setting the "Format" to "UTF-8" under the "General" export preferences.
3590
3591
.. |worldshare_user_preferences_export_biblio_tcp_ip.png| image:: images/third_party_software/oclc/worldshare_user_preferences_export_biblio_tcp_ip.png
3592
        :alt: Screenshot of setting the "TCP/IP" export preferences.
3593
3594
.. |worldshare_search.png| image:: images/third_party_software/oclc/worldshare_search.png
3595
        :alt: Screenshot of search results in the WorldShare web interface.
3596
3597
.. |worldshare_export_list.png| image:: images/third_party_software/oclc/worldshare_export_list.png
3598
        :alt: Screenshot of the "Export lists" page in the WorldShare web interface.
3599
3581
.. MISC
3600
.. MISC
3582
3601
3583
.. |image5| image:: images/admin/globalprefs/Google/2newproject.png
3602
.. |image5| image:: images/admin/globalprefs/Google/2newproject.png
Lines 4183-4186 Link Here
4183
        :alt: Activating call numbers browser in subfield o of field 952
4202
        :alt: Activating call numbers browser in subfield o of field 952
4184
.. |addauthvalue| image:: images/cataloging/addauthvalue.png
4203
.. |addauthvalue| image:: images/cataloging/addauthvalue.png
4185
        :alt: Adding a new authorized value from cataloguing
4204
        :alt: Adding a new authorized value from cataloguing
4186
(-)a/source/third_party_software.rst (-82 / +190 lines)
Lines 193-278 You can even undo the Import operation. Link Here
193
193
194
And within few minutes, we have imported around 10,000 records in Koha
194
And within few minutes, we have imported around 10,000 records in Koha
195
195
196
.. _oclc-connexion-gateway-label:
196
.. _oclc-cataloging-services-label:
197
197
198
OCLC Connexion Gateway
198
OCLC Cataloging Services
199
--------------------------------------------
199
------------------------
200
200
201
Koha can be set to work with the OCLC Connexion Gateway. This allows
201
Koha can be set to work with the OCLC cataloging services such as
202
libraries which subscribe to the paid OCLC cataloging services 
203
to use OCLC Connexion Client desktop software as their 
204
cataloging tool and simply send
205
those records to Koha with a single click. The following instructions
206
will help you set up the OCLC Connexion Gateway, if you have a system
207
administrator you will want to consult with them on this process.
208
202
209
.. _setting-up-oclc-service-on-koha-label:
203
- `WorldShare Record Manager <https://www.oclc.org/en/worldshare-record-manager.html>`_
210
204
- `Connexion <https://www.oclc.org/en/connexion.html>`_
211
Setting up OCLC service on Koha
212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213
214
First, you'll need to create a file somewhere on your system with
215
configuration information.  You could put this anywhere that is visible
216
to the account that will be running the service.
217
218
The file contains 11 lines. The first 6 will be about your Koha system:
219
220
::
221
222
    host: The IP address of your Koha server
223
    port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
224
    koha: The full URL of your staff client
225
    log: The location (full file specification) of your log for the service
226
    user: The default Koha username to use for importing
227
    password: The password that goes with that username
228
229
The remaining lines describe how to do the staging:
230
231
::
232
233
    match: The name of the matching rule from your system to use
234
    overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
235
    nomatch_action: "create_new" or "ignore"-- what to do if there is no match
236
    item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
237
    import_mode: "direct" or "stage"
238
239
A sample file would look like this:
240
205
241
::
206
This allows librarians to use the WorldShare Record Manager web interface or the OCLC Connexion Client desktop software
207
as their cataloging tool and send those records to Koha with a single click.
242
208
243
    host: 1.2.3.4
209
.. _setting-up-oclc-service-on-koha-label:
244
    port: 8000
245
    log: /home/koha/koha-dev/var/log/connexion.log
246
    koha: http://kohastaff.myuniversity.edu
247
    user: koha_generic_staff
248
    password: password
249
    match: 001
250
    overlay_action: replace
251
    nomatch_action: create_new
252
    item_action: ignore
253
    import_mode: direct
254
255
When choosing an 'import\_mode' if you use "direct" then the staged
256
record will be immediately imported into Koha, and should be searchable
257
after your indexes catch up.  If you choose "stage", then the record
258
will be placed in a staged batch for you to later go the :ref:`Manage Staged
259
MARC Records <staged-marc-record-management-label>` tool to finish the import.
260
261
If you import multiple records, they'll be in the same batch, until that
262
batch is imported, then a new batch will be created.
263
264
In "direct" mode, each record will be in its' own batch.
265
266
To start the service, run the script:
267
268
::
269
270
    /location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf
271
272
.. _setting-up-your-oclc-desktop-client-label:
273
210
274
Setting up your OCLC Connexion Client desktop software
211
Setting up the OCLC Connexion Daemon
275
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213
214
First, you will need to set up the :ref:`OCLC Connexion Daemon <cron-connexion-import-daemon-label>` on your server.
215
If you have a system administrator you will want to consult with them on this process.
216
217
1. Find the script on your server and view its documentation.
218
219
   .. code-block:: shell
220
   
221
        /usr/share/koha/bin/connexion_import_daemon.pl --help
222
223
2. Create a configuration file. You could put this anywhere that is visible to the account that will be running the
224
   service, e.g., ``/etc/koha/sites/my_instance/oclc_connexion.conf``. The output of the help command provides the
225
   details about what this file should contain. Here is an example:
226
   
227
   ::
228
   
229
       host: 0.0.0.0
230
       port: 5500
231
       log: /var/log/koha/my_instance/oclc_connexion.log
232
       koha: https://staff.mylibrary.example.com
233
       user: koha_staff_user_name
234
       password: koha_staff_user_password
235
       connexion_user: oclc_connexion_user_name
236
       connexion_password: oclc_connexion_user_password
237
       import_mode: direct
238
239
3. Since the configuration file contains passwords, make sure that it's only readable by the user running the script,
240
   and nobody else.
241
   
242
   .. code-block:: shell
243
   
244
         chmod 400 /etc/koha/sites/my_instance/oclc_connexion.conf
245
246
4. Run the script.
247
248
   - You can do this manually to test it out:
249
     
250
     .. code-block:: shell
251
     
252
         /usr/share/koha/bin/connexion_import_daemon.pl --config /etc/koha/sites/my_instance/oclc_connexion.conf
253
254
   - Or you can set up a ``systemd`` unit to keep the script running even when it crashes or the server reboots:
255
256
     1. Create a file at ``/etc/systemd/system/koha-oclc-connexion.service``:
257
     
258
        .. code-block::
259
        
260
            [Unit]
261
            Description=Koha OCLC Connexion Daemon
262
            After=network.target
263
        
264
            [Service]
265
            Type=exec
266
            ExecStart=/usr/share/koha/bin/connexion_import_daemon.pl --config /etc/koha/sites/my_instance/oclc_connexion.conf
267
            Restart=always
268
        
269
            [Install]
270
            WantedBy=multi-user.target
271
  
272
     2. Enable and start the service:
273
274
        .. code-block:: shell
275
        
276
            systemctl enable koha-oclc-connexion
277
            systemctl start koha-oclc-connexion
278
279
     3. Check the status of the service:
280
281
        .. code-block:: shell
282
        
283
            systemctl status koha-oclc-connexion
284
285
WorldShare Record Manager
286
~~~~~~~~~~~~~~~~~~~~~~~~~
287
288
.. _setting-up-worldshare-record-manager-label:
289
290
Setting up
291
^^^^^^^^^^
292
293
1. Log in to your WorldShare account.
294
2. Go to the "Metadata" tab.
295
3. Select "Record Manager" in the sidebar.
296
4. Select "User Preferences" in the sidebar.
297
298
       **Note**
299
       
300
       Since these are *User* Preferences, they must be configured for each user who will be using the service.
301
   
302
   |worldshare_user_preferences.png|
303
   
304
5. Go to "Exporting – Bibliographic Records".
305
   
306
   The official documentation from OCLC for all settings under this heading is found at
307
   https://help.oclc.org/Metadata_Services/WorldShare_Record_Manager/Record_Manager_user_preferences/Exporting_Bibliographic_records#Set_preferences_for_TCP.2FIP_export .
308
   
309
6. Go to the "General" tab.
310
   
311
   |worldshare_user_preferences_export_biblio_format_utf8.png|
312
   
313
   1. Set the "Format" to "MARC 21 with UTF-8 Unicode", since Koha always uses UTF-8.
314
   2. Click "Save".
315
7. Go to the "TCP/IP" tab.
316
   
317
   |worldshare_user_preferences_export_biblio_tcp_ip.png|
318
   
319
   1. Enter the host name or IP address at which the OCLC connexion daemon service
320
      (configured :ref:`above <setting-up-oclc-service-on-koha-label>`) can be reached.
321
   2. Set the Authentication to "Login ID" and enter the ``connexion_user`` and ``connexion_password`` from the
322
      configuration file (created :ref:`above <setting-up-oclc-service-on-koha-label>`).
323
   3. Optionally set the connection delay, connection attempts, and other settings.
324
   4. Click "Save".
325
326
Using
327
^^^^^
328
329
.. _sending-record-from-worldshare-to-koha-label:
330
331
Sending a single record from the WorldShare Record Manager to Koha
332
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
333
334
1. Log in to your WorldShare account.
335
2. Go to the "Metadata" tab.
336
3. Select "Record Manager" in the sidebar.
337
4. Search for a record.
338
   
339
   |worldshare_search.png|
340
   
341
5. Click on the title of a record to open it.
342
6. Click on the "Record" dropdown menu, then "Send to", then "Local System (via TCP/IP)"
343
   
344
   |worldshare_record_menu_export.png|
345
   
346
7. After a while, depending on your "connection delay" settings, you should see the record in Koha.
347
   
348
   - If you used ``import_mode: direct`` in your configuration file, the record will be available in the catalog.
349
   - If you used ``import_mode: staged`` in your configuration file, the record will be
350
     :ref:`staged for import <stage-marc-records-for-import-label>`.
351
352
Sending multiple records from the WorldShare Record Manager to Koha
353
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
354
355
1. Log in to your WorldShare account.
356
2. Go to the "Metadata" tab.
357
3. Select "Record Manager" in the sidebar.
358
4. Search for a record.
359
   
360
   |worldshare_search.png|
361
   
362
5. Click on the title of a record to open it.
363
6. Click on the "Record" dropdown menu, then "Send to", then "Export List ...".
364
   Select a list to which to add the record.
365
7. Repeat from step 4 as needed.
366
8. Click on "Export Lists" in the sidebar.
367
9. Click on the name of a list to open it.
368
10. Click on the "Export" dropdown menu, then "Send to local system (via TCP/OP)".
369
   
370
   |worldshare_export_list.png|
371
   
372
11. After a while, depending on your "connection delay" settings, you should see the record in Koha.
373
   
374
   - If you used ``import_mode: direct`` in your configuration file, the record will be available in the catalog.
375
   - If you used ``import_mode: staged`` in your configuration file, the record will be
376
     :ref:`staged for import <stage-marc-records-for-import-label>`.
377
378
OCLC Connexion Client desktop software
379
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
380
381
.. _setting-up-the-oclc-desktop-client-label:
382
383
Setting up
384
^^^^^^^^^^
276
385
277
    **Note**
386
    **Note**
278
387
Lines 325-341 dialog will pop up, and you'll see Connexion attempting to talk to Koha. Link Here
325
including its biblio number, and a URL that you can copy into your web
434
including its biblio number, and a URL that you can copy into your web
326
browser to jump straight to the record.
435
browser to jump straight to the record.
327
436
328
.. _using-the-oclc-connexion-gateway-label:
437
.. _using-the-oclc-connexion-desktop-software-label:
329
438
330
Using the OCLC Connexion Gateway
439
Using
331
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440
^^^^^
332
441
333
Records can be exported from Connexion either in a batch or one by one.
442
Records can be exported from Connexion either in a batch or one by one.
334
443
335
.. _exporting-records-one-by-one-label:
444
.. _exporting-records-one-by-one-label:
336
445
337
Exporting records one by one
446
Exporting records one by one
338
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
447
''''''''''''''''''''''''''''
339
448
340
To export bibliographic records one by one, be sure your "Batch" options
449
To export bibliographic records one by one, be sure your "Batch" options
341
are correct: from the "Tools" menu, select "Options", and select the
450
are correct: from the "Tools" menu, select "Options", and select the
Lines 359-365 If the record was overlaid, you will see a message to that effect in the Link Here
359
.. _exporting-records-in-a-batch-label:
468
.. _exporting-records-in-a-batch-label:
360
469
361
Exporting records in a batch
470
Exporting records in a batch
362
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
471
''''''''''''''''''''''''''''
363
472
364
To export bibliographic records in a batch, be sure your "Batch" options
473
To export bibliographic records in a batch, be sure your "Batch" options
365
are correct: from the "Tools" menu, select "Options", and select the
474
are correct: from the "Tools" menu, select "Options", and select the
Lines 387-393 report (depending on your Client options for that). Link Here
387
.. _items-in-oclc-label:
496
.. _items-in-oclc-label:
388
497
389
Items in OCLC
498
Items in OCLC
390
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
499
'''''''''''''
391
500
392
If you'd like to create your item records in OCLC you can do so by
501
If you'd like to create your item records in OCLC you can do so by
393
adding a 952 for each item to the bib record you're cataloging. 
502
adding a 952 for each item to the bib record you're cataloging. 
Lines 426-432 you'd like. Most libraries will enter a call number in subfield o and a Link Here
426
barcode in subfield p as well. Review the :ref:`Location and item information <952-location-item-information-label>` cataloging guide for a full list of subfields and values.
535
barcode in subfield p as well. Review the :ref:`Location and item information <952-location-item-information-label>` cataloging guide for a full list of subfields and values.
427
536
428
Overlaying a bib record from OCLC
537
Overlaying a bib record from OCLC
429
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
538
'''''''''''''''''''''''''''''''''
430
539
431
To overlay a bib record from OCLC, include a 999__$c in 
540
To overlay a bib record from OCLC, include a 999__$c in 
432
the record with the Koha record number of the Koha 
541
the record with the Koha record number of the Koha 
433
- 

Return to bug 37539