Skip to content

Commit

Permalink
Updating documentation & permissions (#114)
Browse files Browse the repository at this point in the history
* Update NEWS.md release prep

* Update README.md - adding email config example

* Update README.md permission name typo

* Update ModuleDescriptor-template.json adding module permissions

* Update README.md mentioning new services
  • Loading branch information
mis306lu authored Oct 22, 2024
1 parent 9049ca9 commit 0894ba3
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## 1.15.3
## 1.15.3 2024-10-16
* [MODNCIP-75](https://folio-org.atlassian.net/browse/MODNCIP-75) inventory API version update (13.0 to 14.0)
* [MODNCIP-76](https://folio-org.atlassian.net/browse/MODNCIP-76) Upgrade `holdings-storage` to 8.0

## 1.15.2 2024-10-08
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ NISO Circulation Interchange Protocol (NCIP) support in FOLIO
## Preparation
1. The NCIP module requires a FOLIO user with the following permissions:
```
culation-storage.cancellation-reasons.collection.get
circulation-storage.cancellation-reasons.collection.get
circulation-storage.circulation-rules.get
inventory-storage.items.collection.get
manualblocks.collection.get
Expand Down Expand Up @@ -172,6 +172,7 @@ There are three types of settings that can exist in mod-configuration for the NC
| NCIP | Relais | request.note.name | ILL note |
| NCIP | Relais | request.note.enabled | false |
| NCIP | Relais | item.soft.delete | true |
| NCIP | Relais | user.email.type | mailto |


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 Expand Up @@ -266,6 +267,11 @@ Sample XML Request:

https://github.com/folio-org/mod-ncip/blob/master/docs/sampleNcipMessages/checkInItem.xml

##### Delete Item
##### Request Item
##### Cancel Request Item
##### Create User Fiscal Transaction

### About the Extensible Catalog NCIP Toolkit

The eXtensible Catalog (XC) NCIP Toolkit was developed as a stand-alone Web application that would receive NCIP requests, communicate with your ILS (via a ‘connector’) and send back an XML response.
Expand Down
8 changes: 8 additions & 0 deletions descriptors/ModuleDescriptor-template.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
"automated-patron-blocks.collection.get",
"addresstypes.collection.get",
"circulation.requests.item.post",
"circulation-storage.circulation-rules.get",
"circulation-storage.cancellation-reasons.collection.get",
"ui-circulation.settings.overdue-fines-policies",
"ui-circulation.settings.lost-item-fees-policies",
"inventory-storage.all",
Expand All @@ -29,13 +31,19 @@
"configuration.entries.item.get",
"usergroups.item.get",
"manualblocks.collection.get",
"note.types.collection.get",
"accounts.collection.get",
"circulation.check-out-by-barcode.post",
"circulation.check-in-by-barcode.post",
"circulation.loans.collection.get",
"circulation.requests.collection.get",
"inventory.instances.item.post",
"inventory.instances.item.delete",
"inventory-storage.holdings.item.delete",
"inventory.items.collection.get",
"inventory.items.item.delete",
"inventory.items.item.put",
"inventory.instances.collection.get",
"inventory.instances.item.delete",
"inventory-storage.holdings.item.post",
"inventory-storage.service-points-users.collection.get",
Expand Down

0 comments on commit 0894ba3

Please sign in to comment.