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
A Fee/fine owner is a FOLIO setting that represents the agent(s) or office(s) that manages fines for FOLIO transactions. Fee/fine owners collect fees/fines for FOLIO service points.
Libraries may name these in different ways:
- Individual service points (essentially duplicating their service point infrastructure, if each service point manages their own fines)
- Library departments (e.g., "Undergraduate Library Business Services")
- Staff roles (e.g., "Business Library Finance Assistant")
When configuring fines, fee/fine owners must be defined first, before other settings.
- A fee/fine owner may be connected to one or more service points.
- A service point may be connected to one and only one fee/fine owner.
Given that fee/fine owners are not directly connected to locations in configuration, it can be confusing to understand how fines accrue to an owner.
- When an item circulates, it does so through the FOLIO circulation rules. If a fine is applicable, it would need to be included in the circulation rule as an overdue or lost item policy.
- The item that circulates has an effective location when it is loaned to the patron.
- The fine is charged / accrued based on the effective location of the item that is loaned, even if the location tree is not part of the circulation rule that was triggered, or the effective location is not where the item was borrowed from.
So the fine traces back to the fee/fine owner through the system as
Item effective location → primary service point for the effective location → Fee/fine owner for that service point.
Permissions
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.
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.
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.
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.
Reporting
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.)
Integrations
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.
Permissions
.........
To Modify a Fee/fine Owner
- From Settings → Users, open the list of Fee/fine Owners.
- Click on the Pencil icon under Actions for the Fee/fine Owner you wish to modify.
- Input Changes to the Fee/Fine Owner record.
- Click Save on the end of the row to save the change.
To create a Fee/fine Owner
- From Settings → Users, open the list of Fee/fine Owners.
- Click New in the Top Right.
- Type in a name for the Fee/fine Owner. The name must not already exist as a Fee/fine owner.
- Type in a Description (Optional).
- Associate the Fee/fine Owner to a specific service point or multiple service points (Optional).
- Click Save on the end of the row to save the new Fee/fine Owner.
To Delete a Fee/fine Owner
- From Settings → Users, open the list of Fee/fine Owners.
- Click on the Trash icon under Actions for the Fee/fine Owner you wish to delete.
- Click Delete to confirm deletion.