A person or entity in relationship to an authenticating OCLC
customer institution.
Contains the identifier for the person that will be provided
by a non-OCLC-managed authentication system. OCLC requires
this element to allow correlation with stored OCLC user data
at login time. Additionally, one or more identifiers from
systems other than one used for authentication may be
provided to enable correlation with an existing user record
for update as part of data ingest if a barcode or ILL
identifier is not provided or needs to be changed.
Correlation data, the WmsCircPatronInfo/barcode and the
WsILLInfo/illId are all compared against data stored in the
same fields in the OCLC User Data Service to determine
whether the record is meant to update an existing user or to
create a new user.
This is the user's login name for use only in OCLC-managed
authentication. This ignored if authentication for the user
is performed by the institution-managed IdP. Note that
during inital migrations the load may be using OCLC-managed
authentication. We recommend putting a unique identifier
here to ensure functionality with the OCLC provided IdP
before switching to the permanent IdP.
Circulation customers may request to have their OCLC
provided IdP configured to use WmsCircPatronInfo/barcode as
the username: they may then leave this blank.
The date on which the access to certain OCLC-provided
services expires; the user will no longer be authenticated
throuch OCLC provided IDPs or permitted to use services such
as circulation or ILL after this date. This has replaced the
circulation and authentication specific expiration dates.
Note that this element will not prevent authentication
performed by the institution or a third party. Note also
that not all OCLC services currently check for an expiration
date.
This is the record of the user's name. Institutions with
"preferred name policies" should consider whether the
library's needs may be met by loading the "givenName" field
with the institution's recorded perferred name for the
individual.
Future interfaces may use the canSelfEdit flag to allow users
to manage the value themselves. (Useful for systems other than
WMS Circulation.)
This is better known as the user's "preferred name"; the use
of "nickname" in the schema is to simplify transitions in
existing ETL implementations. The "nickname" will be used to
replace the "givenName" and "middleName" in some
systems. Institutions with "preferred name policies" should
consider whether the library's needs may be met by loading
the "givenName" field with the institution's recorded
perferred name for the individual.
Future interfaces may allow users to manage this value
themselves.
The data elements in this element are specifically for the
WMS Circulation product.
The data elements in this element are used across a variety of
OCLC products.
This element contains the contact information of record as
determined by institution policies. Multiple instances of
postal address, telephone number and email address are
permitted.
As of 2016 WMS Circulation uses the institution data to
deliver notifications.
ILL services will use the separate
notificationDeliveryDestination element, if present, to
deliver notifications. If no email is present in
notificationDeliveryDestination, notifications by email will
use the institutional email.
Password reset messages will use the separate
notificationDeliveryDestination element, if present, to
deliver notifications. If no email is present in
notificationDeliveryDestination, notifications by email will
use the institutional email.
Identity Data Load updates replace all data of the type in
the OCLC user data system. That is, if a single email is
included in the update record, all email addresses in the
UDS will be replaced by the single email in the
update. Similarly for phone numbers and addresses.
Optional. One or more destinations (e.g. email address, SMS)
to which notifications from various OCLC services are to be
delivered. These values may be updated by the end user.
Note that the user preferences must be expressed by the user
via the end user interface.
Existing notes will not be replaced or overwritten on update.
This field supports the use of additional information used
by various OCLC products that is not otherwise specified.
For institutional use, the admin panel provides editing
access to four specific fields. These may be loaded by
creating additionalInfo elements with
businessContext="Circulation_Info"; keys="customdata1",
"customdata2", "customdata3" and "customdata4".
Circulation customers may customize the labels for keys
customdata1 through 4 via a circulation configuration interface.
Any additional information provided by the institution need
not have a businessContext. Institution specific data should
be loaded with key names that are unlikely to be used for
product purposes in order to decrease risk that loaded data
will conflict with application data.
A URL that links to the user's photo. This photo is displayed
in the WMS Admin panel and may be displayed by other OCLC
services. OCLC does not currently store photos. The
institution may provide security for the photo by hosting it
on resources only available at the institution.
The OCLC Institution Registry id of the institution that
manages the user's record.
A name prefix or salutation such as "Mrs", "Professor",
"Sir", etc.
A first name, e.g. "Jeremiah". Use this element if the user
has only one name. Note that institutions with "preferred
name policies" should consider whether the library's needs
may be met by loading the "givenName" field with the
institutions' recorded perferred name for the individual.
A string containing one or more middle names and/or
initials, e.g. "Obadiah Jackenory", "O. J."
A last name or surname, e.g. "Jones"
A generation indicator such as Jr, III, and/or an epithet
such as PhD, FRS
Indicates that a user may manage the name
themselves. Setting this flag to true is appropriate only
for data loads from systems where the user entered their
name and the name was not derived from a formal document or
official source.
This is the barcode used by WMS Circulation. ILL processes
store the barcode in the ILL Identifier. This value is one
of several that are involved in matching an incoming record
with an existing record for update. See documentation on the
matching logic.
May be used with the SIP/NCIP service.
Category of borrower (patron type) provided by library.
NOTE: the 1.x schemas required a dateTime. This is now simply
a date.
The OCLC Institution Registry id of the user's home branch.
Blocked users have their library privileges suspended. Patron is not allowed to
borrow items.
Patron fines are not moved to collections (patron is exempt from having account
sent to collection agency).
For future functionality.
Indicates whether patron's identity established via acceptable ID (driver's license, etc.)
Stores checkout history if flag is set for future functionality.
A label indicating the nature or intended use of this
element. The administration panel provides elements stored
as "home","work", and "other" for all choices. The panel
also uses "mobile" for phone values. Dataloading of
alternative labels is supported, e.g "fax", and the UI
will display that label.
isInvalid = TRUE will prevent some OCLC processes from using
the contact information. E.g., a change of password email
will not be sent to a isInvalid = TRUE email address.
E.g., "125 Elm Street", or a house name used instead of a
street number: "Dunroamin".
Holds a second address line if needed. E.g., "Apartment
2b", "P.O. Box 511", "Wisteria Lane", "Room 52", etc.
A postal or zip code in the form specified by the local
postal authority. E.g. "94004", K0A 1A0", "1013 GE", "SE18
7QZ"
An indication that this address is the
user's primary address. A person may have a primary physical
location and a primary email and a primary
phone.
Indicates the address is good for an indefinite period of
time. Not currently used by any process.
Not currently used by any process; not visible in the user interface.
Not currently used by any process; not visible in the user interface.
This should be a valid SMTP email address. OCLC does not
currently validate the syntax of email addresses on ingest.
An indication that this email address is the user's primary
email. A person may have a primary physical location and a
primary email and a primary phone.
OCLC does not currently validate the syntax of this phone
number on ingest.
An indication that this number is the user's primary
telephone. A person may have a primary physical location
and a primary email and a primary phone
An entity id uniquely identifying the system providing
authentication or the system providing an additional
identifier for correlation - The value(s) to use should be
determined in consultation with the OCLC implementation
team.
The unique identifier for the user in the source system. See
the documentation for the element "correlationInfo".
Existing notes will not be replaced or overwritten on update.
If present use value "Circulation_Info".
If present use values, "customdata1", "customdata2", "customdata3", and "customdata4".
Can match predefined values in OCLC Service Configuration or be free text (not entered
in OCLC Service Configuration).
Custom data fields from ongoing data loads that are not identical to previously-loaded
fields, will replace the previously-loaded value.
Custom data fields from ongoing data loads that are identical to previously-loaded
fields are ignored.
Custom data fields left blank in ongoing data loads are ignored and the previous value,
if one exists, is maintained.
Custom data fields can be deleted in the WorldShare Admin or Circulation modules.
The value of destination must be an address appropriate for
the type of delivery service specified in
deliveryService. Only one value of each type is
supported. The current values of deliveryService are:
* deliveryService = "Email" with destination the user's
email address; and
* deliveryService = "SMS" with
destination the telephone number of the user's
SMS-capable device. The full international E.123 format is
required. e.g. "+1 232-456-7890" for a U.S. number or
"+44 20 4961 5678" for a UK number. If the + is missing there will
be errors. You may use the Admin UI's form for the SMS value to test
acceptable formats.
A unique identifier for the user for ILL processes. It may,
but need not be, the user's library barcode. WMS Circulation
customers (also) store the barcode in
persona.wmsCircPatronInfo.barcode. This value is one of
several that are involved in matching an incoming record
with an existing record for update. See documentation on the
matching logic.
This field is optional. Allows libraries to pre-approve or
block patrons for ILL via the patron load or change patrons'
approval status for ILL. Supported values are New, Approved,
or Blocked. If value is left blank, and there is an illId
value in the patron file, the default value will be set to
"New". If the value is left blank on an update to an existing
patron, the existing value set in the database will be retained.