Skip to end of metadata
Go to start of metadata

Purpose

This area allows libraries to configure the Licenses app, including creating "license terms" which can be used 

Permissions

The Licenses section of Settings has two permissions:

  • Settings (Licenses): Manage license terms
  • Settings (Licenses): Manage pick lists and values

UX/UI

License term and pick list/pick list value field documentation is available in the linked Google sheet

Terms

License Terms can be defined for the tenant. These typically describe any conditions related to the usage of the resource covered by the license. Once defined in the license settings, the license terms can be assigned values on each license. Terms have the following fields:

Name 

A license term 'name' is used when outputting the term data in a machine readable format. It is not intended to be displayed to users (staff or patrons). 

It should be a short text string that can be used by any external systems or programs that access the license term data. Use of camelCase is suggested but not required. Changes to the license term name would affect any external systems using license term data and changes should not be made without consulting those responsible for relevant external systems and software.

Label

A license term 'label' is used when displaying the term to users within Folio and in any other systems that display license terms to users. 

It should be a short text string that clearly communicates what information is recorded in the term. The Description should be used where further explanation of the term is required for display to users.

Description

A description of the license term which is used in the Folio license UI to give the user more information about the term than is contained in the label

Primary term

If marked "yes", the term appears as in the terms list by default when you create a new license. Terms that are marked "no" need to be added when creating a license.

Order weight

Terms will be displayed in the UI the Order weight will be used to sort the terms for display in ascending order (i.e. zero weight sorts to the top)

Default visibility

The default visibility for license term values for this license term (e.g. if set to Internal, when adding the term value to a license, the default visibility for that term value will be "Internal". The visibility of any particular term value can always be changed in the license when it is set, affecting just that term value).

Type

The type of data that will be accepted when setting a license term value

Pick list

Where the "type" is assigned "Pick list", the Pick List field determines which pick list should be used when setting values for the term on a license. This field only displays if "Pick list" is chosen in the Type field.

Pick lists

Where a license term has the "Type" of "Pick list", the specific pick list to be used must be defined. The Pick Lists area of the settings is where the available pick lists are setup. Pick lists have the following fields:

Description (desc)

This describes the pick list

Pick list values

Where a "Pick list" has been defined, the Pick list values are used to assign lists of values to be available in the pick list. Pick list values have the following fields:

Pick list

The pick list (defined in the Pick Lists setting) to which the value belongs

Label

The textual label for the pick list value that will appear in the UI

Searching

There is no search functionality in this part of FOLIO.

Functional workflows

  • Control the license terms supported in the tenant
  • Control any pick lists used in license terms supported in the tenant

No action-based permissions are currently known to exist in this area of FOLIO. If any are developed, please add them to this documentation.

Reporting

There are no in-app reports in this section of FOLIO.

Integrations

No existing integrations between this area of FOLIO and outside tools are currently known to have been developed. If any are developed, please add information on them to this documentation.



  • No labels