Information in italics is intended to provide guidance while writing documentation and in general should be removed when a doc is at a v.1 stage.
The italics are suggestions to help guide what might go in a particular section. If you feel a section does not apply to the app or feature, please keep the section but just add that it does not apply.
If you feel it makes more sense for your documentation, you can move sections up and down.
Library is the third level of the Location hierarchy.
FOLIO libraries will need at least one institution, campus, and library to be able to create the final element of the location tree - Location.
The four pieces of the location hierarchy are available criteria to use in circulation rules.
There is one permission control currently implemented for this area of Settings:
- Settings (tenant): Can create, edit and remove locations
There are no action-based permissions currently implemented for this area of Settings. If that changes, please update this information.
Describe out of the box fields, including designed purpose, data requirements and validation, dependencies between fields.
Describe out of the box accordion menus, including purpose of the menus, customization options, and associated permission controls (if any)
Describe any workflows available through navigation menus, including purpose of the workflow, customization options, and associated permission controls.
When creating a new Library in the UI, you first select the Institution and Campus that you want to be above the new library in the hierarchy - e.g., where does this Library value fit in the hierarchy.
Out of the box fields in the UI include:
- Drop-down menu
- Populated from existing values
- Drop-down menu
- Populated from existing values associated with the Institution selected in the first drop-down.
Then you are presented the list of libraries associated with the Institution → Campus hierarchy.
Out of the box Library fields include:
- Text input
- Must be unique in the tenant.
- Text input
- Does not need to be unique?
Describe pathways for searching in the app/feature through the UI.
Describe fields that are indexed in the back end specifically for searching
Describe any advanced searching features and how they would work.
Describe available tasks that can be conducted in the app. To document those tasks, create a new page and link it to this page.
Describe action-based permissions that are connected to these functional workflows, if any.
- Create, Edit, Delete Library
Describe available in-app reports, including parameters for the reports, and associated permissions.
If there are developed LDP reports/queries for this app / area of FOLIO, describe those reports as well.
List any fields that may not be available in the LDP (e.g., for privacy reasons.)
Describe any APIs that interact with the app. Provide links to the API / module information in Github.
Describe integrations that individual libraries may wish to develop for this app / area of FOLIO, if relevant.
If existing integrations have been developed by adopting libraries, provide links to the integration in Github or wherever the information can be found.
Describe and include any permanent links such as a link structure to records, searches, etc
Considerations for Implementation
Describe decisions or implications that need to be considered when implementing this feature.
Include topics such as order of operations during implementation or affects of implementing in a certain way.