Settings - Users - Address Types
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
User records have addresses, and within FOLIO, you can configure Address type. This allows you to have things an office address, a home address, a second office address, etc.
The address field is repeatable, but is not required.
Permissions
Permissions to access address types must be granted. The permission for this area is:
- Settings (Users): Can create, edit and remove address types
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.
To edit an Address Type
- Open the list of Address Types in Settings.
- Click the Pencil icon under Actions for the Address Type you wish to edit.
- Modify the Address Type and/or Description as desired.
- Click Save at the end of the row to save your changes.
To create an Address Type
- Open the list of Address Types in Settings
- Click New on the top right.
- Type in the name of the new Address Type. The name must not already exist as an Address Type.
- Type in a Description (optional).
- Click Save at the end of the row to save your changes.
To delete an Address Type
- Open the list of Address Types in Settings
- Click the Trash icon in the Actions column for the Address Type you want to delete.
- Click Delete to confirm deletion.
Reporting
There is no in-app reporting in this section of FOLIO.
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.
- Address types should be configured before bulk loading of patrons occurs, if mailing addresses are to be stored.