Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pr 1906 #34

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Pr 1906 #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d460040
PR-1876 Add item ID to fee in barcode
JanisSaldabols Aug 13, 2024
b5764e7
PR-1906 Add ILL request id to ILS request and loan
JanisSaldabols Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 21 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ NISO Circulation Interchange Protocol (NCIP) support in FOLIO
* (15) user.email.type (optional - will default to "electronic mail address" For LookupUser response)
* (16) cancel.request.reason.name Reason for request cancellation when different item is checkout (Settings -> Circulation -> Request cancellation reasons)
* (17) cancel.request.reason.patron.name Reason for request cancellation when patron did not checkout item (Settings -> Circulation -> Request cancellation reasons)
* (18) request.note.name Request note name. Default value "ILL note"
* (19) request.note.enabled Request note enabled. Will add ILL request ID to loan and ILS request. Default value "false"

Notes
* You can assign different values to these settings per Agency ID used in the NCIP requests. This approach lets you setup different values for different Agency IDs. For example, if Relais calls your NCIP server with the Agency ID of 'Relais' you can configure values for that agency. If ReShare calls your NCIP server using a different Agency ID, you can set up different configuration values to be used for ReShare requests. These settings have to exist for each Agency ID that will be used in the NCIP requests.
Expand Down Expand Up @@ -137,23 +139,25 @@ There are three types of settings that can exist in mod-configuration for the NC

#### NCIP Properties

| MODULE | configName (the AgencyID) | code | value (examples) |
| ------------- |:-------------:|:-------------------------------------|------------------:|
| NCIP | Relais | instance.type.name | RESHARE |
| NCIP | Relais | instance.source | RESHARE |
| NCIP | Relais | item.material.type.name | RESHARE |
| NCIP | Relais | item.perm.loan.type.name | RESHARE |
| NCIP | Relais | item.status.name | Available |
| NCIP | Relais | item.perm.location.code | RESHARE_DATALOGISK |
| NCIP | Relais | holdings.perm.location.code | RESHARE_DATALOGISK |
| NCIP | Relais | instance.custom.identifier.name | ReShare Request ID |
| NCIP | Relais | checkout.service.point.code | online |
| NCIP | Relais | checkin.service.point.code | online |
| NCIP | Relais | response.includes.physical.address | false |
| NCIP | Relais | user.priv.ok.status | OK |
| NCIP | Relais | user.priv.blocked.status | BLOCKED |
| NCIP | Relais | cancel.request.reason.name | Item Not Available |
| NCIP | Relais | cancel.request.reason.patron.name | Item Not Available |
| MODULE | configName (the AgencyID) | code | value (examples) |
|-----------|:-------------------------:|:-----------------------------------|-------------------:|
| NCIP | Relais | instance.type.name | RESHARE |
| NCIP | Relais | instance.source | RESHARE |
| NCIP | Relais | item.material.type.name | RESHARE |
| NCIP | Relais | item.perm.loan.type.name | RESHARE |
| NCIP | Relais | item.status.name | Available |
| NCIP | Relais | item.perm.location.code | RESHARE_DATALOGISK |
| NCIP | Relais | holdings.perm.location.code | RESHARE_DATALOGISK |
| NCIP | Relais | instance.custom.identifier.nam | ReShare Request ID |
| NCIP | Relais | checkout.service.point.code | online |
| NCIP | Relais | checkin.service.point.code | online |
| NCIP | Relais | response.includes.physical.address | false |
| NCIP | Relais | user.priv.ok.status | OK |
| NCIP | Relais | user.priv.blocked.status | BLOCKED |
| NCIP | Relais | cancel.request.reason.name | Item Not Available |
| NCIP | Relais | cancel.request.reason.patron.name | Item Not Available |
| NCIP | Relais | request.note.name | ILL note |
| NCIP | Relais | request.note.enabled | false |


You will need a set of these settings in mod-configuration for each individual Agency ID making NCIP requests. Example of an AgencyID in an NCIP request:
Expand Down
8 changes: 8 additions & 0 deletions src/main/java/org/folio/ncip/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
public class Constants {
public static final String BLOCKED = "BLOCKED";
public static final String OK = "OK";
public static final String ID = "id";
public static final String AUTH_UID = "Username";
public static final String AUTH_BARCODE = "Barcode Id";
public static final String ACTIVE = "ACTIVE";
Expand Down Expand Up @@ -100,11 +101,18 @@ public class Constants {
public static final String FEE_FINE_BY_OWNER_AND_TYPE = "/feefines?query=ownerId==$ownerId$%20and%20feeFineType=%22$feeType$%22&limit=1";
public static final String PATRON_GROUP_BY_ID = "/groups/";
public static final String ACCOUNT_URL = "/accounts";
public static final String NOTES_URL = "/notes";
public static final String ADD_STAFF_INFO_URL = "/circulation/loans/%s/add-info";

public static final String DEFAULT_TIMEOUT = "30000";
public static final String SERVICE_MGR_TIMEOUT = "service_manager_timeout_ms";
public static final String CHARGE_DEFAULT_PATRON_FEE = "charge-default-patron-fee";
public static final String DEFAULT_PAYMENT_STATUS = "Outstanding";
public static final String DEFAULT_FEE_STATUS = "Open";
public static final String BOOLEAN_TRUE = "true";
public static final String NOTE_DOMAIN_REQUESTS = "requests";
public static final String NOTE_TITLE_TEMPLATE = "ILL Request id: %s";
public static final String NOTE_LINK_TYPE_REQUEST = "request";
public static final String STAFF_INFO_TYPE = "staffInfoAdded";

}
Loading