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 4 Next »

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.


This area of Settings lists calendars for FOLIO service points hat allow libraries to set open and closed hours for those service points.

There is one calendar for every service point, available under Library hours.

You do not create calendars directly. You create a Service Point, and then FOLIO creates an associated calendar for you to manage.

Library calendars must be set / configured for any service point that serves as a primary service point for one or more locations where items are held.

If a service point is not 


Describe permissions that apply to the app or section you are outlining. Include default permissions and permission sets; dependencies that exist with permissions in other apps/parts of FOLIO. 
Describe action-based permissions (if any) that apply to the app or section you are outlining, including permission dependencies and associated functional workflows.
Describe what each permission does, in language accessible to non-IT library staff.

The Calendar section of Settings has basic CRUD permissions:

  • Settings (Calendar): Can view calendar events
  • Settings (Calendar): Can create, view, edit, and remove calendar events.
  • Settings (Calendar): Can create, view, and edit calendar events


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.

All Service point calendars are listed under Library Hours. 

  • Each Service Point has a corresponding calendar with the same name.
  • When you select that calendar, you will also see the service point code and discovery display name.

Then you have two options for creating / modifying hours for that service point.

  • Regular library hours
  • Actual library hours

The idea is that a library would create "Regular library hours" for specified time periods, and that would be the hours the library expects to be open. When a time period is created, it will be listed on the screen as Start Date - End Date.

Libraries must set regular library hours in order for due dates to be calculated correctly.

Then, libraries would use the "Actual library hours" option to add exceptions to the regular library hours, such as weather closings, or expanded hours for exams.


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.

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.

  • No labels