Skip to end of metadata
Go to start of metadata
https://openlibraryfoundation.atlassian.net/issues/?jql=text%20~%20%22DCB-1092*%22%20or%20summary%20~%20%22DCB-1092*%22%20or%20key%20%3D%20DCB-1092%20ORDER%20BY%20created%20DESCDescription
This document is used to keep track of Host LMS data used in the DataGrids.
Field label - the label that the GraphGL data is displayed under.
GraphGL source - the JSON value where data is stored.
Translation key - the corresponding translation key, which is used to store the field label.
Missing - the value is currently not displayed in the datagrids
Host LMSs
Field label (column) | GraphQL source | Translation key | Example (source) |
|---|
Host LMS name | name
| | |
Host LMS code | code
| | |
Default agency | clientConfig.default-agency-code
| | |
Ingest enabled | clientConfig.ingest
| | |
Host LMS UUID | id
| | |
Host LMS by ID
Unused
Field label | GraphQL source | Example (source) |
|---|
UNUSED | clientConfig.["page-size"]
| |
UNUSED | clientConfig.["num-records-to-generate"]
| |
General
Field label | GraphQL source | Translation key | Example (source) |
|---|
Host LMS name | name
| hostlms.name
| |
Host LMS code | code
| hostlms.code
| |
Host LMS UUID | id
| hostlms.id
| |
LmsClientClass | lmsClientClass
| hostlms.lms_client
| |
Client Config
Field label | GraphQL source | Translation key | Example (source) |
|---|
Base application services URL | clientConfig.["base-url-application-services"]
| hostlms.client_config.base_application
| |
Base URL | clientConfig.["base-url"]
| hostlms.client_config.base
| |
Roles | clientConfig.["roles"]
| hostlms.client_config.roles
| |
Context hierarchy | clientConfig.["contextHierarchy"]
| hostlms.client_config.context_hierarchy
| |
Default agency code | clientConfig.["default-agency-code"]
| hostlms.client_config.default_agency_code
| |
API Key | clientConfig.apikey
| hostlms.client_config.api
| |
Access ID | clientConfig.["access-id"]
| hostlms.client_config.access_id
| |
Access key | clientConfig.["access-key"]
| hostlms.client_config.access_key
| |
Domain ID | clientConfig.["domain-id"]
| hostlms.client_config.domain_id
| |
Staff username | clientConfig.["staff-username"]
| hostlms.client_config.staff_username
| |
Staff password | clientConfig.["staff-password"]
| hostlms.client_config.staff_password
| |
Logon branch ID | clientConfig.["logon-branch-id"]
| hostlms.client_config.logon_branch_id
| |
Logon user ID | clientConfig.["logon-user-id"]
| hostlms.client_config.logon_user_id
| |
Secret | clientConfig.secret
| hostlms.client_config.secret
| |
Key | clientConfig.key
| hostlms.client_config.key
| |
Ingest | clientConfig.ingest
| hostlms.client_config.ingest
| |
Bib suppression ruleset | hostlms?.suppressionRulesetName
| hostlms.suppressionRulesetName
| |
Item suppression ruleset | hostlms?.itemSuppressionRulesetName
| hostlms.itemSuppressionRulesetName
| |
Record syntax | clientConfig.record-syntax
| hostlms.client_config.record_syntax
| |
Metadata prefix | clientConfig.metadata-prefix
| hostlms.client_config.metadata
| |
Item Config
Field label | GraphQL source | Translation key | Example (source) |
|---|
Barcode prefix | clientConfig.item.["barcode-prefix"]
| hostlms.client_config.barcode_prefix
| |
ILL Location ID | clientConfig.item.["ill-location-id"]
| hostlms.client_config.ill-location-id
| |
Fine code ID | clientConfig.item.["fine-code-id"]
| hostlms.client_config.fine
| |
Renewal limit | clientConfig.item.["renewal-limit"]
| hostlms.client_config.renewal_limit
| |
History action ID | clientConfig.item.["history-action-id"]
| hostlms.client_config.history_action_id
| |
Shelving scheme ID | clientConfig.item.["shelving-scheme-id"]
| hostlms.client_config.shelving_scheme_id
| |
Loan period code ID | clientConfig.item.["loan-period-code-id"]
| hostlms.client_config.loan_id
| |
PAPI Config
Field label | GraphQL source | Translation key | Example (source) |
|---|
PAPI app ID | hostlms.clientConfig.papi.["app-id"]
| hostlms.client_config.papi_app_id
| |
PAPI organisation ID | hostlms.clientConfig.papi.["org-id"]
| hostlms.client_config.papi_org_id
| |
PAPI language ID | hostlms.clientConfig.papi.["lang-id"]
| hostlms.client_config.papi_lang_id
| |
PAPI version | hostlms.clientConfig.papi_version
| hostlms.client_config.papi_version
| |
Services config
Field label | GraphQL source | Translation key | Example (source) |
|---|
Site domain | hostlms.clientConfig.services.["site-domain"]
| hostlms.client_config.services_site_domain
| |
Patron barcode prefix | hostlms.clientConfig.services.["patron-barcode-prefix"]
| hostlms.client_config.services_patron_barcode_prefix
| |
Product ID | hostlms.clientConfig.services.["product-id"]
| hostlms.client_config.services_product_id
| |
Workstation ID | hostlms.clientConfig.services.["workstation-id"]
| hostlms.client_config.services_workstation_id
| |
Organisation ID | hostlms.clientConfig.services.["organisation-id"]
| hostlms.client_config.services_organisation_id
| |
Version | hostlms.clientConfig.services.["services-version"]
| hostlms.client_config.services_version
| |
Language | hostlms.clientConfig.services?.language
| hostlms.client_config.services.language
| |