Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Purpose

Describe the intended use of the app or part of FOLIO. This may be short or long, depending. You could describe things like common workflows that take place in the app; configuration options; whether an app has specific integrations with outside vendors.

Institution is the highest level of the Location hierarchy.

...

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

...

Considerations for Implementation

Describe permissions decisions or implications 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.
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 

Jira
serverFOLIO Issue Tracker
serverId6ccf3fe4-3301-368a-983e-20c466b11a49
keyUXPROD-592
. Currently there is one timezone setting per tenant so multiple timezones are not supported in a single-tenant implementation.

Permissions

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.

UX/UI

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

Searching

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 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.