| Both sides previous revisionPrevious revision | |
| xul:birds_eye_view [2025/07/26 16:50] – ↷ Page moved from mozilla-devel:birds_eye_view to xul:birds_eye_view sleary | xul:birds_eye_view [2025/07/26 17:23] (current) – adding returned object IDs in parentheses to headings, for quick skimming of the TOC sleary |
|---|
| After the user is logged in, we start grabbing data that we'd like to cache in the client. Things like organization hierarchy, a list of copy locations, ID types, etc. | After the user is logged in, we start grabbing data that we'd like to cache in the client. Things like organization hierarchy, a list of copy locations, ID types, etc. |
| |
| ==== open-ils.search.actor.user.session ==== | ==== open-ils.search.actor.user.session (au) ==== |
| This method returns most of the user data for the person logged in (the user associated with the session key). This data is returned as a fieldmapper object with the shortname of "au", but otherwise known as **Fieldmapper::actor::user** on the server side of Evergreen. In the following table, *'s indicate "virtual" fields, which are usually just empty placeholders to hang other fieldmapper objects. A "fleshed" fieldmapper object is one where some or all of these virtual fields are filled in. | This method returns most of the user data for the person logged in (the user associated with the session key). This data is returned as a fieldmapper object with the shortname of "au", but otherwise known as **Fieldmapper::actor::user** on the server side of Evergreen. In the following table, *'s indicate "virtual" fields, which are usually just empty placeholders to hang other fieldmapper objects. A "fleshed" fieldmapper object is one where some or all of these virtual fields are filled in. |
| |
| |au|usrname|OPAC/staff client login name for this user| | |au|usrname|OPAC/staff client login name for this user| |
| |
| ==== open-ils.actor.groups.retrieve ==== | ==== open-ils.actor.groups.retrieve (pgt) ==== |
| This method returns an array of **Fieldmapper::permission::grp_tree** (or "pgt") objects. These objects are a hierarchal set of permission groups that users may belong to, such as Patrons, Staff, Catalogers, and Circulators. | This method returns an array of **Fieldmapper::permission::grp_tree** (or "pgt") objects. These objects are a hierarchal set of permission groups that users may belong to, such as Patrons, Staff, Catalogers, and Circulators. |
| |
| |pgt|parent| | |pgt|parent| |
| |
| ==== open-ils.actor.user.ident_types.retrieve ==== | ==== open-ils.actor.user.ident_types.retrieve (cit) ==== |
| This method returns an array of **Fieldmapper::config::identification_type** (or "cit") objects. These classify various types of identification that can be associated with a user, such as Driver's License or SSN. | This method returns an array of **Fieldmapper::config::identification_type** (or "cit") objects. These classify various types of identification that can be associated with a user, such as Driver's License or SSN. |
| |
| |cit|name| | |cit|name| |
| |
| ==== open-ils.actor.standings.retrieve ==== | ==== open-ils.actor.standings.retrieve (cst) ==== |
| This method returns an array of **Fieldmapper::config::standing** (or "cst") objects. These are used to describe a user's standing for the purpose of granting library priveledges. Currently we have "Good" and "Barred". | This method returns an array of **Fieldmapper::config::standing** (or "cst") objects. These are used to describe a user's standing for the purpose of granting library priveledges. Currently we have "Good" and "Barred". |
| |
| |cst|value| | |cst|value| |
| |
| ==== open-ils.search.config.copy_location.retrieve.all ==== | ==== open-ils.search.config.copy_location.retrieve.all (acpl) ==== |
| This method returns an array of **Fieldmapper::asset::copy_location** (or "acpl") objects. These are copy locations associated with items. The only PINES-wide default is "Stacks". | This method returns an array of **Fieldmapper::asset::copy_location** (or "acpl") objects. These are copy locations associated with items. The only PINES-wide default is "Stacks". |
| |
| |acpl|owning_lib|Id for the "aou" associated with this location| | |acpl|owning_lib|Id for the "aou" associated with this location| |
| |
| ==== open-ils.search.config.copy_status.retrieve.all ==== | ==== open-ils.search.config.copy_status.retrieve.all (ccs) ==== |
| This method returns an array of **Fieldmapper::config::copy_status** (or "ccs") objects. These are statuses associated with items, such as Checked Out, Lost, Missing, In Process, In Transit, etc. | This method returns an array of **Fieldmapper::config::copy_status** (or "ccs") objects. These are statuses associated with items, such as Checked Out, Lost, Missing, In Process, In Transit, etc. |
| |
| |ccs|name| | |ccs|name| |
| |
| ==== open-ils.actor.org_tree.retrieve ==== | ==== open-ils.actor.org_tree.retrieve (aou) ==== |
| This method returns a "fleshed" **Fieldmapper::actor::org_unit** (or "aou") object containing the whole organization tree for the consortium. The objects are linked through the parent_ou field (points to a single "aou") and the children field (contains an array of "aou" objects). | This method returns a "fleshed" **Fieldmapper::actor::org_unit** (or "aou") object containing the whole organization tree for the consortium. The objects are linked through the parent_ou field (points to a single "aou") and the children field (contains an array of "aou" objects). |
| |
| |aou|shortname| | |aou|shortname| |
| |
| ==== open-ils.actor.org_types.retrieve ==== | ==== open-ils.actor.org_types.retrieve (aout) ==== |
| This method returns an array of **Fieldmapper::actor::org_unit_type** (or "aout") objects, which classify the different types of "aou"'s. We currently have "Consortium", "System", "Branch", "Bookmobile", and "Sub-lib". | This method returns an array of **Fieldmapper::actor::org_unit_type** (or "aout") objects, which classify the different types of "aou"'s. We currently have "Consortium", "System", "Branch", "Bookmobile", and "Sub-lib". |
| |
| |aout|parent| | |aout|parent| |
| |
| ==== open-ils.actor.org_unit.full_path.retrieve ==== | ==== open-ils.actor.org_unit.full_path.retrieve (aou) ==== |
| This method returns a flat array of **Fieldmapper::actor::org_unit** (or "aou") objects associated with the sessioned user. For example, a user with a home org unit of ARL will have all the ARL-branch libraries in this list, as well as the PINES consortium as the top-level org unit. | This method returns a flat array of **Fieldmapper::actor::org_unit** (or "aou") objects associated with the sessioned user. For example, a user with a home org unit of ARL will have all the ARL-branch libraries in this list, as well as the PINES consortium as the top-level org unit. |
| |
| ==== open-ils.circ.stat_cat.actor.retrieve.all ==== | ==== open-ils.circ.stat_cat.actor.retrieve.all (actsc) ==== |
| This method returns an array of **Fieldmapper::actor::stat_cat** (or "actsc") objects associated with the sessioned user's home org unit. These objects are Statistical Categories defined by the libraries and intended for local reporting, and these in particular get associated with patrons. | This method returns an array of **Fieldmapper::actor::stat_cat** (or "actsc") objects associated with the sessioned user's home org unit. These objects are Statistical Categories defined by the libraries and intended for local reporting, and these in particular get associated with patrons. |
| |
| | open-ils.circ | open-ils.circ.checkout.barcode | session key, item barcode, "au" id | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods/OpenILS/Application/Circ/Rules.pm|Perl]] | | | open-ils.circ | open-ils.circ.checkout.barcode | session key, item barcode, "au" id | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods/OpenILS/Application/Circ/Rules.pm|Perl]] | |
| |
| ==== open-ils.actor.user.fleshed.retrieve_by_barcode ==== | ==== open-ils.actor.user.fleshed.retrieve_by_barcode (au) ==== |
| |
| The checkout interface needs to retrieve the "au" object for the patron. If this has not already been provided (by say, a different interface), we can use this method to retrieve the patron by their library card barcode. The "fleshed" part is the au's .cards(), .addresses(), and .stat_cat_entries() fields. | The checkout interface needs to retrieve the "au" object for the patron. If this has not already been provided (by say, a different interface), we can use this method to retrieve the patron by their library card barcode. The "fleshed" part is the au's .cards(), .addresses(), and .stat_cat_entries() fields. |
| |record| | |record| |
| |
| === circ === | === circ (aoc) === |
| |
| The circ field contains a **Fieldmapper::action::open_circulation** (or "aoc") object. This represents the actual transaction for the circulating item, and contains information such as what circulation rules are associated with the checkout, the due date, the library that checked the item out, etc. In the database, open_circulations are technically a view of circulations, which is why the various checkin fields are listed. They should contain null's in this case. Similarly, .xact_finish() should be null. | The circ field contains a **Fieldmapper::action::open_circulation** (or "aoc") object. This represents the actual transaction for the circulating item, and contains information such as what circulation rules are associated with the checkout, the due date, the library that checked the item out, etc. In the database, open_circulations are technically a view of circulations, which is why the various checkin fields are listed. They should contain null's in this case. Similarly, .xact_finish() should be null. |
| |aoc|xact_start| | |aoc|xact_start| |
| |
| === copy === | === copy (acp) === |
| |
| The copy field contains a **Fieldmapper::asset::copy** (or "acp") object. This represents the actual item in the database, and has information such as the item's barcode, shelving location, stat cat entries, etc. | The copy field contains a **Fieldmapper::asset::copy** (or "acp") object. This represents the actual item in the database, and has information such as the item's barcode, shelving location, stat cat entries, etc. |
| |acp|status| | |acp|status| |
| |
| === record === | === record (mvr) === |
| |
| The record field contains a **Fieldmapper::metabib::virtual_record** (or "mvr") object. This is basically bibliographic data about the title record to which the copy belongs. It contains information such as the title and author of the work, the ISBN, subject headings, etc. | The record field contains a **Fieldmapper::metabib::virtual_record** (or "mvr") object. This is basically bibliographic data about the title record to which the copy belongs. It contains information such as the title and author of the work, the ISBN, subject headings, etc. |
