Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »


Institution is the highest level of the Location hierarchy.

FOLIO libraries will need at least one institution created to be able to populate elements down the hierarchy like campus, library and location.

The four pieces of the location hierarchy are available criteria to use in circulation rules.

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.

Institutions that need to support multiple timezones should monitor  UXPROD-592 - Getting issue details... STATUS . Currently there is one timezone setting per tenant so multiple timezones are not supported in a single-tenant implementation.


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.

Institutions are created through a settings table (that may look familiar as this is similar to other areas of Settings.)

Available Institution fields


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.

There is no default search function in the GUI for Institution records. 

Functional workflows

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.


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

  • No labels