User Tools

You are here: start » public » bc_services_card
Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
public:bc_services_card [2023/03/17 22:03]
jeff [Patron information in Evergreen] 		public:bc_services_card [2024/05/09 05:04] (current)
Line 7: Line 7:
 Patrons are normally registered via the EG staff client, by staff at the circ desk ([[https://docs.evergreen-ils.org/eg/docs/latest/circulation/circulation_patron_records_web_client.html#_registering_new_patrons|docs]]). We also have custom scripts for importing patron records from student management systems for a few post-secondary libraries. There's no official API or process specifically intended to enable third-party applications to create/import/validate patron records (EG needs more third-party-friendly APIs generally), but there's a feature request to include a standard import script: [[https://bugs.launchpad.net/evergreen/+bug/1786524|LP#1786524]] Patrons are normally registered via the EG staff client, by staff at the circ desk ([[https://docs.evergreen-ils.org/eg/docs/latest/circulation/circulation_patron_records_web_client.html#_registering_new_patrons|docs]]). We also have custom scripts for importing patron records from student management systems for a few post-secondary libraries. There's no official API or process specifically intended to enable third-party applications to create/import/validate patron records (EG needs more third-party-friendly APIs generally), but there's a feature request to include a standard import script: [[https://bugs.launchpad.net/evergreen/+bug/1786524|LP#1786524]]
  
-Several other Evergreen consortia (PINES and KCLS) use Quipu's eCARD product which has some overlap with BC Services Card use cases. There's been some effort to bring their Quipu integration into mainline Evergreen, ideally in a generic way that could also support similar products: [[https://bugs.launchpad.net/evergreen/+bug/1902937|LP#1902937]]+Several other Evergreen consortia (PINES and KCLS) use Quipu's eCARD product which has some overlap with BC Services Card use cases. There's been some effort to bring their Quipu integration into mainline Evergreen, ideally in a generic way that could also support similar products: [[https://bugs.launchpad.net/evergreen/+bug/1902937|LP#1902937]] (there's some discussion here of account renewal requirements at non-Sitka libraries which may be of interest too).
  
-Evergreen also has a patron self-registration feature ([[https://docs.evergreen-ils.org/eg/docs/latest/circulation/circulation_patron_records_web_client.html#_patron_self_registration|main docs]] / [[https://docs.evergreen-ils.org/eg/docs/latest/admin/patron_self_registration.html|admin docs]]). We're not using it, but it's a good fit for this project; if nothing else, it provides a model for how to go about creating patron-initiated "pending" accounts in EG.+Evergreen also has a patron self-registration feature ([[https://docs.evergreen-ils.org/eg/docs/latest/circulation/circulation_patron_records_web_client.html#_patron_self_registration|main docs]] / [[https://docs.evergreen-ils.org/eg/docs/latest/admin/patron_self_registration.html|admin docs]]). <del>We're not using it, but</del> it's a good fit for this project; if nothing else, it provides a model for how to go about creating patron-initiated "pending" accounts in EG.
  
 There's also a feature request for patron address validation using third-party services: [[https://bugs.launchpad.net/evergreen/+bug/1569889|LP#1569889]] There's also a feature request for patron address validation using third-party services: [[https://bugs.launchpad.net/evergreen/+bug/1569889|LP#1569889]]
Line 32: Line 32:
   * Libraries can track additional information about their patrons using "statistical categories," which are found in actor.stat_cat and related tables. The library may use this to capture information not otherwise tracked in Evergreen, such as municipality or electoral district, residency status, student type, or gender. Each library defines its own categories and the permitted values for each category (the value is selected from a drop-down list, not a free text field).   * Libraries can track additional information about their patrons using "statistical categories," which are found in actor.stat_cat and related tables. The library may use this to capture information not otherwise tracked in Evergreen, such as municipality or electoral district, residency status, student type, or gender. Each library defines its own categories and the permitted values for each category (the value is selected from a drop-down list, not a free text field).
   * When patron self-registration is permitted, the data entered by the patron is initially stored in the staging tables shown on the far right of the diagram. Staff then have the ability to review this pending patron information and approve account creation.   * When patron self-registration is permitted, the data entered by the patron is initially stored in the staging tables shown on the far right of the diagram. Staff then have the ability to review this pending patron information and approve account creation.
 +
  
 ===== User stories for BCSC integration ===== ===== User stories for BCSC integration =====
Line 41: Line 42:
   - As a Co-op service manager, I want patron data to be validated so that I can use it as a basis for other services.   - As a Co-op service manager, I want patron data to be validated so that I can use it as a basis for other services.
   - As a malicious user, I want to create fake or unauthorized patron accounts so that I can access library resources illegitimately.   - As a malicious user, I want to create fake or unauthorized patron accounts so that I can access library resources illegitimately.
 +
 +
 +===== Creating a patron self-registration application =====
 +
 +Suppose we wanted to create an application that allowed patrons to request a library card using their BC Services Card. That is, instead of using EG's native patron self-registration UI, we'd have an external app that presents the user with a registration form, populates with their personal data based on their BC Services Card, and then submits that data to Evergreen to create a "pending" patron account (which would then be reviewed and approved by library staff within Evergreen, just like native self-registration).
 +
 +How does our application submit the patron data to Evergreen? Our best bet is to use the existing infrastructure for native patron self-registration as much as possible -- that is, create pending patron accounts in the same way that Evergreen itself does.
 +
 +Native self-reg uses the ''open-ils.actor.user.stage.create'' API. This endpoint accepts the following parameters:
 +  - user (stgu object)
 +  - mailing address (stgma object)
 +  - billing address (stgma object)
 +  - stat cats (array of stgsc objects)
 +  - user settings (array of stgs objects)
 +
 +Only the first parameter (user) is required, the others are optional. The object classes (stgu, stgma, stgsc, stgs) are defined by the [[https://docs.evergreen-ils.org/eg/docs/latest/development/intro_opensrf.html#_accepting_and_returning_evergreen_objects|fieldmapper]].
 +
 +How do we use this API? There are a few possibilities:
 +
 +1. We could use it directly, by submitting HTTP requests to the [[https://wiki.evergreen-ils.org/doku.php?id=osrfhttp:opensrf_gateway|OpenSRF gateway]], like so:
 +
 +<code>https://<domain>/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.user.stage.create&param=[<user object>]</code> 
 +
 +For this to work, our application would need to know how to instantiate Evergreen-specific fieldmapper objects (stgu, etc.) that will be accepted as such when passed to EG via the gateway, which is non-trivial. This is a brittle approach for an external application.
 +
 +2. We could build BC Services Card integration directly into Evergreen. This is probably not a good idea, since it requires developers to be knowledgeable about both Evergreen and BC Services Card. Also, we want to leave the door open to using our hypothetical patron self-registration application with non-Evergreen library systems.
 +
 +3. We could create a thin wrapper service in Evergreen that accepts patron data as a JSON blob, translates it into native Evergreen objects, and passes the result to the ''open-ils.actor.user.stage.create'' API. This would mean that our application doesn't have to know anything about Evergreen objects or the fieldmapper. The service could also include some kind of simple "API key" type mechanism that indicates which application provided the patron data; this could be leveraged to speed up the approval process, since BC Services Card-based account requests are presumed to be trustworthy. For simplicity's sake, the service could be exposed as another Evergreen API via the OpenSRF gateway. This would obviously require some Evergreen-specific development, but implementation would not be an enormous project for a knowledgeable Evergreen developer, and the actual self-registration application could be built separately by devs who don't need to have much experience with Evergreen.
 +
 +4. We could skip the API and allow the application to insert patron data directly into staging.user_stage and related tables in Evergreen's Postgres database.
 +
 +==== Matching existing accounts ====
 +
 +The staff interface for patron registration checks for duplicates during the registration process: it will present a notification if the provided name, email, or address already exists in Evergreen. The duplicate checks are performed using the ''open-ils.actor.patron.search.advanced'' API, which will return the IDs of any patron accounts where the fields you specify (e.g. email) are an exact match for the values you specify (e.g. "foo@example.com"). This API requires an auth token, which is basically the session token you receive upon authenticating. It is possible to obtain an auth token via the OpenSRF gateway ([[https://wiki.evergreen-ils.org/doku.php?id=newdevs:apis|see here]]), but you will need login credentials for a user that has permission to retrieve patron data; only patrons that are accessible to that user will be included in search results.
 +
 +Many BC public library patrons have their driver's license or BC Services Card number in the ident_value field, but this data is not controlled or validated and we can't guarantee its accuracy.
 +
 +==== Further information ====
 +
 +
 +[[https://docs.evergreen-ils.org/eg/docs/latest/integrations/web_services.html|More information about Evergreen web services (OpenSRF gateway etc.)]]. Some of this info may be outdated.
 +
 +[[https://docs.evergreen-ils.org/eg/docs/latest/development/intro_opensrf.html|Easing Gently into OpenSRF]] - an overview of how to write an OpenSRF service; provides a good introduction to some OpenSRF concepts and how to use them.
 +
 +[[https://wiki.evergreen-ils.org/doku.php?id=newdevs:start|Documentation for new Evergreen developers]] - very incomplete, but perhaps useful for orientation purposes.
  
 ---- ----
Line 54: Line 100:
     * Potential workflows:     * Potential workflows:
       - A new public library patron wants a library account. They go into their local library, go to the circ desk, and show their ID or proof of residency. Circ staff manually enter their info into the patron registration UI (city and province are auto-populated when they enter the postal code) and give the patron a physical library card with barcode.       - A new public library patron wants a library account. They go into their local library, go to the circ desk, and show their ID or proof of residency. Circ staff manually enter their info into the patron registration UI (city and province are auto-populated when they enter the postal code) and give the patron a physical library card with barcode.
-      - A new public library patron wants a library account. They pre-register for an account online. Circ staff review, approve the account, and send a notification to the patron. The patron goes into their local library and picks up their library card at the circ desk. Note that this workflow still involves manual intervention by staff for each new account registration. Sitka is not currently using this feature, but it is supported by Evergreen.+      - A new public library patron wants a library account. They pre-register for an account online. Circ staff review, approve the account, and send a notification to the patron. The patron goes into their local library and picks up their library card at the circ desk. Note that this workflow still involves manual intervention by staff for each new account registration. <del>Sitka is not currently using this feature, but it is supported by Evergreen.</del>  A dozen or so Sitka libraries are currently using this feature to allow patrons to "Request a Library Card."
       - An existing patron's account expires. They go into their local library to renew their account, or they discover their account is expired when they're already at the circ desk. Circ staff check their ID to verify their current personal information, and update the account if needed. NB: Some libraries may permit renewal over the phone rather than in-person, but staff approval is definitely required. Libraries may email patrons prior to account expiry as a form of customer engagement.       - An existing patron's account expires. They go into their local library to renew their account, or they discover their account is expired when they're already at the circ desk. Circ staff check their ID to verify their current personal information, and update the account if needed. NB: Some libraries may permit renewal over the phone rather than in-person, but staff approval is definitely required. Libraries may email patrons prior to account expiry as a form of customer engagement.
     * The above is based on Jeff's educated assumptions about how patron registration works. We should consult with a few of our libraries to verify the above and see if there's anything else we should take into account. We should also talk to non-Sitka libraries that are currently using ID verification services about how it fits into their workflows.     * The above is based on Jeff's educated assumptions about how patron registration works. We should consult with a few of our libraries to verify the above and see if there's anything else we should take into account. We should also talk to non-Sitka libraries that are currently using ID verification services about how it fits into their workflows.
 +    * During registration, the patron is assigned to a patron group/type/profile which determines their access to services. Current groups are:
 +      * PL Adult (default)
 +      * PL Juvenile
 +      * PL Teen
 +      * PL BC OneCard
 +      * PL Non Resident - Adult
 +      * PL Non Resident - Juvenile
 +      * PL Federation
 +      * PL Extended Loans
 +      * PL No-fines
 +      * PL Print Disabled
 +      * PL Home Services
 +      * PL Restricted Access
 +      * PL Custom
 +      * PL Temporary
 +      * PL New User
     * Identifiers collected (plus % of current BC public library patrons who have this info in their patron record):     * Identifiers collected (plus % of current BC public library patrons who have this info in their patron record):
       * legal name: 100%       * legal name: 100%
Line 69: Line 131:
         * Status Card: <1%         * Status Card: <1%
         * Other (unknown type): 5%         * Other (unknown type): 5%
 +    * Examples of other data gathered during patron registration for reporting purposes (a.k.a. statistical categories):
 +      * geographic area, residency, electoral district
 +      * gender (mostly unused now)
 +      * school, grade
 +      * age group
   * **When we say “record” what do we mean?**   * **When we say “record” what do we mean?**
     * A "patron record" is an account which exists as a row in the actor.usr table. This account is linked to the patron's circulations, holds, staff notes, user messages/notifications, fines, and other transactions or user activity recorded in the database.     * A "patron record" is an account which exists as a row in the actor.usr table. This account is linked to the patron's circulations, holds, staff notes, user messages/notifications, fines, and other transactions or user activity recorded in the database.
Line 100: Line 167:
 | |Vancouver Island Regional Public Library | | | |Vancouver Island Regional Public Library | |
 | |West Vancouver Memorial Library| | | |West Vancouver Memorial Library| |
-|SirsiDynix Horizon |Burnaby Public Library |x |+|{{ :public:web_services_for_horizon_6.2.2_setup_guide.pdf |SirsiDynix Horizon}} |Burnaby Public Library |x |
 | |Cranbrook Public Library | | | |Cranbrook Public Library | |
 | |New Westminster Public Library| | | |New Westminster Public Library| |
public/bc_services_card.1679090626.txt.gz · Last modified: 2023/03/17 22:03 by jeff

Page Tools

BC Libraries Coop wiki

Site Tools