DCB-1081 Patron Request data presentation and source

Description

This document is used to keep track of patron request 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.
For everything in the GraphQL source column, assume patronRequest is before each one.
Translation key - the corresponding translation key, which is used to store the field label.
Missing - the value is currently not displayed in the datagrids

Patron Requests

Field label (column)	GraphQL source	Translation key	Example (source)

Field label (column)	GraphQL source	Translation key	Example (source)
Request created	`dateCreated`	`details.request_created`	2024-04-29 14:48
Patron host LMS code	`patronHostlmsCode`	`details.patron_hostlms`
Patron barcode	`requestingIdentity.localBarcode`	-	[0077777777]
Title	`clusterRecord?.title`
Supplying agency	`suppliers[0].localAgency`	`details.supplying_agency_code`	6wmdp
Status	`status`	`details.status`	REQUEST_PLACED_AT_SUPPLYING_AGENCY
Error message	`errorMessage`	`-`	[empty]
Out of sequence	`outOfSequenceFlag`	`details.is_transition_out_of_sequence`	false
Polling count	`pollCountForCurrentStatus`	`details.polling_checks_in_status`	[empty]
Time in state	`elapsedTimeInCurrentStatus`	`details.time_in_status`	2024-04-29 14:48
Request updated	`dateUpdated`	`details.record_updated`	2024-04-29 14:48
Request ID	`id`	`details.request_id`	[UUID]
NOT USED	`pickupLocationCode`	`details.pickup_code`	[UUID]
missing	`nextScheduledPoll`	`details.next_poll`
missing	`patron.id`	`details.patron_id`
missing	`requestingIdentity.id`	`details.requestor_id`
missing	`requestingIdentity.localId`	`details.borrowing_patron_id`

Patron Request by ID

GQL Source

Field label	GraphQL source	Example (source)

Field label	GraphQL source	Example (source)
Request ID
Request updated	`dateUpdated`
Patron HostLMS code	`patronHostlmsCode`
Bib cluster ID	`bibClusterId`
Pickup location code	`pickupLocationCode`
Pickup patron ID	`pickupPatronId`
Pickup item ID	`pickupItemId`
Pickup item type	`pickupItemType`
Pickup item status	`pickupItemStatus`
Pickup request ID	`pickupRequestId`
Pickup request status	`pickupRequestStatus`
Status	`status`
Pickup request ID	`localRequestId`
Pickup request status	`localRequestStatus`
Virtual item ID	`localItemId`
Virtual item status	`localItemStatus`
Virtual item type	`localItemType`
Virtual Bib ID	`localBibId`
Description	`description`
Last check for updates	`nextScheduledPoll`
Error message	`errorMessage`
Previous status	`previousStatus`
Polling checks in status	`pollCountForCurrentStatus`
Status changed	`currentStatusTimestamp`
Next expected status	`nextExpectedStatus`
Transition out of sequence?	`outOfSequenceFlag`
Time in status	`elapsedTimeInCurrentStatus`
Patron ID	`patron.id`
Patron ID at requesting agency	`requestingIdentity.id`
Local patron ID	`requestingIdentity.localId`
missing	`requestingIdentity.homeIdentity`
Local patron barcode	`requestingIdentity.localBarcode`
missing	`requestingIdentity.localNames`
Local patron type	`requestingIdentity.localPtype`
missing	`requestingIdentity.canonicalPtype`	`
missing	`requestingIdentity.localHomeLibraryCode`
missing	`requestingIdentity.lastValidated`
missing	`audit.id`
missing	`audit.auditDate`
missing	`audit.briefDescription`
missing	`audit.fromStatus`
missing	`audit.toStatus`
missing	`audit.auditData`
missing	`clusterRecord.id`
Contributor title	`clusterRecord.title`
Selected bib	`clusterRecord.selectedBib`
missing	`clusterRecord.isDeleted`
missing	`clusterRecord.dateCreated`
Record updated	`clusterRecord.dateUpdated`
missing	`clusterRecord.members.id`
missing	`clusterRecord.members.dateCreated`
missing	`clusterRecord.members.dateUpdated`
missing	`clusterRecord.members.title`
Author	`clusterRecord.members.author`
missing	`clusterRecord.members.placeOfPlublication`
missing	`clusterRecord.members.publisher`
missing	`clusterRecord.members.dateOfPublication`
missing	`clusterRecord.members.edition`
missing	`clusterRecord.members.isLargePrint`
missing	`clusterRecord.members.clusterReason`
missing	`clusterRecord.members.typeOfRecord`
missing	`clusterRecord.members.canonicalMetadata`
missing	`clusterRecord.members.metadataScore`
missing	`clusterRecord.members.processVersion`
Source system ID	`clusterRecord.members.sourceSystemId`
Source record ID	`clusterRecord.members.sourceRecordId`
missing	`clusterRecord.members.sourceRecord.id`
missing	`clusterRecord.members.sourceRecord.hostLmsId`
missing	`clusterRecord.members.sourceRecord.remoteId`
missing	`clusterRecord.members.sourceRecord.json`
Request created	`dateCreated`
Active workflow	`activeWorkflow`
Requestor note	`requestorNote`
Supplier ID	`suppliers.id`
Canonical item type	`suppliers.canonicalItemType`
Date created	`suppliers.dateCreated`
Request updated	`suppliers.dateUpdated`
code	`suppliers.hostLmsCode`
isActive	`suppliers.isActive`
Local item ID	`suppliers.localItemId`
Local Bib ID	`suppliers.localBibId`
Local item barcode	`suppliers.localItemBarcode`
Local item location code	`suppliers.localItemLocationCode`
Local item status	`suppliers.localItemStatus`
Local item type	`suppliers.localItemType`
Local supplier request ID	`suppliers.localId`
Local request status	`suppliers.localStatus`
Supplying agency code	`suppliers.localAgency`
missing	`suppliers.virtualPatron.id`
Local ID	`suppliers.virtualPatron.localId`
missing	`suppliers.virtualPatron.homeIdeniity`
Local barcode	`suppliers.virtualPatron.localBarcode`
missing	`suppliers.virtualPatron.localNames`
Local patron type	`suppliers.virtualPatron.localPtype`
DCB patron type	`suppliers.virtualPatron.canonicalPtype`
missing	`suppliers.virtualPatron.localHomeLibraryCode`
missing	`suppliers.virtualPatron.lastValidated`

General

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key	Example (source)
Request ID	`id`	`details.request_id`	4b6e37e9-bdad-4c3e-b625-dd9a6336d372
Request created	`dateCreated`	`details.request_created`
Request updated	`dateUpdated`	`details.request_updated`

Bib record

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Bib cluster ID	`bibClusterId`	`details.bib_cluster_id`
Title	`clusterRecord.title`	`details.title`
Author	`clusterRecord.members.author`	`details.author`
Record created	`clusterRecord.dateCreated`	`details.record_created`
Record updated	`clusterRecord.dateUpdated`	`details.record_updated`
Selected bib	`clusterRecord.selectedBib`	`details.selected_bib`
Source record ID	`clusterRecord.members.sourceRecordId`	`details.source_record_id`
Source system ID	`clusterRecord.sourceSystemId`	`details.source_system_id`

Source Record

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key	Example (source)
Source record	`clusterRecord.members.sourceRecord`	`details.source_record`

Supplying

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Supplying agency code	`suppliers.localAgency`	`details.supplying_agency_code`
Supplier ID	`suppliers.id`	`details.supplier_id`
Canonical item type	`suppliers.canonicalItemType`	`details.supplier_ctype`
Date created	`suppliers.dateCreated`	`details.date_created`
Date updated	`suppliers?.dateUpdated`	`details.date_updated`
code	`suppliers.hostLmsCode`	`details.code`
isActive	`suppliers.isActive`	`details.active`
Local Bib ID	`suppliers.localBibId`	`details.local_bib_id`
Local supplier request ID	`suppliers.localId`	`details.local_supplier_id`
Local request status	`suppliers.localStatus`	`details.local_request_status`

Supplying - Item

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Local item ID	`suppliers.localItemId`	`details.local_item_id`
Local item barcode	`suppliers.localItemBarcode`	`details.local_item_barcode`
Local item location code	`suppliers.localItemLocationCode`	`details.local_item_loc`
Local item status	`suppliers.localItemStatus`	`details.local_item_status`
Local item type	`suppliers.localItemType`	`details.local_item_type`

Suppling - Virtual patron

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Local ID	`suppliers.virtualPatron.localId`	`details.local_id`
Local barcode	`suppliers.virtualPatron.localBarcode`	`details.local_barcode`
Local patron type	`suppliers.virtualPatron.localPtype`	`details.borrowing_patron_type`
DCB patron type	`patronRequest.suppliers.virtualPatron.canonicalPtype`	missing

Borrowing

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Pickup request ID	`localRequestId`	`details.borrowing_request_id`
Pickup request status	`localRequestStatus`	`details.borrowing_request_status`
Local item ID	`localItemId`	`details.local_item_id`
Host LMS code	`localItemStatus`	`hostlms.code`
Local Bib ID	`localBibId`	`details.local_bib_id`

Borrowing - Patron

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Patron ID	`patron.id`	`details.patron_id`
Patron HostLMS code	`patronHostlmsCode`	`details.patron_hostlms`
Patron ID at requesting agency	`requestingIdentity.id`	`details.requestor_id`
Local patron type	`requestingIdentity.localPtype`	`details.borrowing_patron_type`
Local patron ID	`requestingIdentity.localId`	`details.borrowing_patron_id`
Local patron barcode	`requestingIdentity.localBarcode`	`details.borrowing_patron_barcode`

Borrowing - Virtual item

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Virtual item ID	`localItemId`	`details.borrowing_virtual_id`
Virtual item status	`localItemStatus`	`details.borrowing_virtual_item_status`
Virtual item type	`localItemType`	`details.borrowing_virtual_type`
Virtual Bib ID	`localBibId`	`details.borrowing_virtual_bib_id`

Pickup

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Pickup location code	`pickupLocationCode`	`details.pickup_code`
Pickup patron ID	`pickupPatronId`	`details.pickup_patron_id`
Pickup request ID	`pickupRequestId`	`details.pickup_request_id`
Pickup request status	`pickupRequestStatus`	`details.pickup_request_status`

Pickup - Virtual patron (empty accordion)

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key	Example (source)
MISSING	missing	MISSING

Pickup - Virtual item

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Pickup item ID	`patronRequest.pickupItemId`	`details.pickup_item_id`
Pickup item status	`patronRequest.pickupItemStatus`	`details.pickup_item_status`
Pickup item type	`patronRequest.pickupItemType`	`details.pickup_item_type`

Audit log

Field label (column)	GraphQL source	Example (source)

Field label (column)	GraphQL source	Example (source)
Audit date	`audit.auditDate`
Description	`audit.briefDescription`
fromStatus	`audit.fromStatus`
toStatus	`audit.toStatus`

Audit Detail

Audit detail

Field label	GraphQL source	Translation key	Example (source)

Field label	GraphQL source	Translation key
Audit ID	`id`	`details.audit_id`
Audit date	`auditDate`	`details.audit_date`
Brief description	`audit.briefDescription`	`details.audit_description`
fromStatus	`audit.fromStatus`	`details.audit_from_status`
toStatus	`audit.toStatus`	`details.audit_to_status`
missing	`audit.auditData`	MISSING
Patron request ID	`audit.patronRequest.id`	`details.patron_request_id`