Skip to end of metadata
Go to start of metadata

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.

Libraries can configure different types of allowed manual charges per Fee/fine owner.

Considerations for Implementation

When applying manual charges, staff will select a fee/fine owner, and then select a fee/fine type. The fee/fine type list will pull both from the selected fee/fine owner, and from the Shared fee/fine owner. If you want the drop down to differentiate (they aren't allowed to have the same names, but the list otherwise isn't always obvious which belongs to which owner,) you'll need to distinguish those lists with your naming conventions.

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.

Associated permissions (as of Goldenrod) include:

  • Settings (Users): Can create, edit and remove all feefines-related entries
  • Settings (Users): Can create, edit and remove fee/fine settings
  • Settings (Users): Can create, edit and remove feefines

It's unclear from available documentation what the distinction is between these three permissions. More information is needed.

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

  • There is an in-app report in the Users App called the Overdue Loans Report, run from the Actions Menu, that contains information about items that may generate fines when actually returned.

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

  • No labels