The Purchase Request platform creates a unified workflow for a library to receive, consider and process book purchase requests. The primary goals are:
- to get more patron input on book purchase requests, from multiple sources
- to assist selectors in evaluating the requests
- and to assist technical services staff in acting on them.
Several clients are available to source purchase requests, both explicit and implied, from both patrons and library staff.
This Workflow Proxy Server component:
- centralizes incoming purchase requests from all clients
- saves the requests into a platform where librarian selectors can review each request and approve or deny it
- enriches them with information from various sources to help selectors with the decision
- routes approved requests to external system(s) for reporting or for acquisitions & cataloging steps on an approved request
flowchart LR
%% FormClient["Library Website Client"] --> Server
%% ReturnsClient["Returns Client"] --> Server
%% DuplicateRequestsClient["Duplicate Requests Client"] --> Server
%% LostItemsClient["Lost Items Client"] --> Server
%% BrowserPluginClient["Browser Plug-in Client"] --> Server
Clients["Client(s)"] --> Server["Workflow Proxy Server"]
Server --> Workflow[("Storage & Workflow")]
Server --> Enrichment["Enrichment Sources"]
Server -- After Decisions --> Output["Reporting & PO Creation Systems"]
The WorkflowService interface defines a system that stores purchase requests and can notify listeners when a request is accepted or rejected.
Supplied implementations:
-
JiraWorkflowServicesupports both Jira Cloud (which offers a free tier that should suit this use case). Out-of-the-box, this supports simple manual decision making, such as using a Kanban board to drag a request from a New column to one representing Approved requests. Jira workflows can also support automatic decision-making based on the metadata of the request.JiraWorkflowServicedoes not support the discontinued Jira Server product. -
RestyaboardWorkflowServicesupports the Restyaboard Kanban board software. This is provided as an open source alternative to Jira for a simple, manual workflow.
EnrichmentService implementations enrich a purchase request with information that will help selectors to consider the purchase request. Enrichment data may also support automated workflows or post-decision processing.
Individual enrichments can be selectively enabled in configuration. As needed an order of enrichments can be specified.
Supplied implementations:
| Enrichment | Description | Data Source (API) Requirements |
|---|---|---|
| Local Holdings | Identify existing local holdings, and link to them in the ILS/LSP or online catalog. See also Matching Pre-Submission. | FOLIO or OCLC WorldCat |
| Consortial Holdings | Identify holdings at consortia with borrowing relationships. | OCLC WorldCat |
| Pricing | Gather list price information. | OASIS, Amazon, IsbnDB, and/or DOAB |
| Requester | Identify the patron's university role (i.e. faculty, undergraduate) and department as provided by the university's directory information. | LDAP |
| Librarian Selector | Identify the librarian(s) who should decide the purchase request, based on the item's call number. | Librarian Call Numbers |
| Budget Codes | Set budget codes to use if the purchase is approved, based on the librarian enrichment. | FOLIO |
| Identifiers | For use by the other enrichments, use supplied title & contributor to suggest (if not already supplied) an OCLC number and Dewey call number from Library of Congress holdings. | OCLC WorldCat |
| Links | Provide links to quickly query additional data sources. | No requirements. Links to Google Scholar. |
| Priority | Set a priority based on factors determined from the purchase request and prior enrichments, such as the academic role of the requester and the urgency of the request. | -- |
Client modules are available from separate repositories, as linked below. See also Client User Management.
- Website Form. Proof-of-concept of a traditional website form for explicit patron input on book purchases.
- Returns Client. Handles patron purchase requests on the return slips for interlibrary and consortial loan items.
- Duplicate Requests Client (TBD). Detects multiple, recent requests for the same interlibrary or consortial loan items, that suggest a purchase be considered.
- Lost Items Client. Detects items marked (definitively) lost in the ILS/LSP, perhaps following a patron request for the item, that should be considered for replacement.
- Browser Plug-in. Aimed at librarian selectors, a browser plug-in for easily submitting library purchase requests from book review sites or anywhere else.
The WorkflowServiceListener interface supports actions that take place after new purchase requests are submitted or after a status update to the request within the workflow system. Specific trigger points are:
- Purchase Requested
- Purchase Approved
- Purchase Denied (TBD)
Supplied implementations:
| Listener | Description | Dependencies |
|---|---|---|
| Emails configurable recipients about a purchase request when its status changes. See Email Listener. | Librarian enrichment | |
| Full Record Spreadsheet | Exports full details of a new or approved request to a spreadsheet, adding a row. | Google Sheets |
| MatchMARC Spreadsheet | Exports identifier and budget code metadata to a spreadsheet, adding a row, that is intended to be used with MatchMARC to create a FOLIO Purchase Order. | Google Sheets, MatchMARC |
The EmailListener sends an email based on the new status of a purchase request:
- Requested: To the librarian identified by Librarian Enrichment and to
workflow.email.purchase-requested-address. - Approved: To
workflow.email.purchase-approved-address. - Denied: To
workflow.email.purchase-denied-address. - Arrived: To the requester and to
workflow.email.purchase-arrived-address.
The body text of the email is defined by a template file {statusName}.txt within a mail subfolder of the configuration folder where application.properties is located. For Arrived, there is an additional template arrived-electronic.txt template for purchased items with electronic access, so the email may include a link to the item.
The template uses Thymeleaf's TEXT mode and supports interpolation of any PurchaseRequest object properties as seen in the example files. Emails about denied purchase requests can also include a configurable reason for the decision.
A matching service, available for clients to use before submitting a purchase request, searches local holdings for title, contributor and/or ISBN matches similar to Local Holdings enrichment. This allows a client application to inform the patron potential local matches, linking to the catalog, where they may access the resource immediately.
Like Local Holdings Enrichment, multiple data sources are supported.
The Workflow Proxy Server is a Java Spring Boot application. See Dependencies.
The Maven configuration generates a .war file that can be run standalone (equivalent to a .jar), or deployed to Jetty (tested) or another web application server like Tomcat.
In either case, it requires the application.properties configuration file to be available where the application can find it.
Recommended only as a development instance, as this runs the server over insecure HTTP. In that context, it's simplest to just store the application.properties in the same directory as the .war file.
To run in the foreground:
java -jar purchase-request-workflow-proxy-server.war
... or for background execution on Linux, logging to nohup.out:
nohup java -jar purchase-request-workflow-proxy-server.war &
When using the Email Listener, add to the classpath the extra folder containing the templates folder:
java -cp ./extra_classpath:./purchase-request-workflow-proxy-server.war org.springframework.boot.loader.WarLauncher
... or for background execution:
nohup java -cp ./extra_classpath:./purchase-request-workflow-proxy-server.war org.springframework.boot.loader.WarLauncher &
Intended for a production environment. Set up a web server to handle secure (HTTPS) requests and direct them to Jetty.
Tested with Jetty 9 and Apache Web Server.
Deploy the .war file in Jetty's webapps folder (or as otherwise configured). To point to the configuration file, create an descriptor .xml file with otherwise the same filename as the .war, and set the extraClasspath variable to point to a folder with with the application.properties. Example:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd">
<Configure class="org.eclipse.jetty.webapp.WebAppContext">
<Set name="contextPath">/pr-server</Set>
<Set name="war">/path/to/jetty9/webapps/purchase-request-workflow-proxy-server.war.war</Set>
<Set name="extraClasspath">/path/to/config/stuff/pr-server-conf</Set>
</Configure>
- Java SE. Tested on Java SE 11 (LTE).
- MySQL or equivalent. Tested with MariaDB. Uses Spring Data so a different DB driver could presumably be included with appropriate Maven configuration.
- Additional dependencies needed for a workflow service and individual enrichments. See configuration.
-
Set up the configuration file.
-
If using the Email Listener, copy or rename each email template file (removing ".example") and edit as needed.
-
Uncomment this property to the configuration file before starting the application is run for the first time, to create the database schema. Then re-comment or remove it:
# spring.jpa.hibernate.ddl-auto=create-drop
Client applications access the Workflow Proxy Server via an API, using Basic Authentication over HTTPS. These are stored (encrypted) in the database.
Scripts are available to add and remove client credentials. They utilize the same purchase-request-workflow-proxy-server.war built via Maven, and the same configuration file.
In the project home directory, run:
scripts/add_client.sh username password
In the project home directory, run:
scripts/delete_client.sh username
Copy/rename application.properties.example to application.properties and configure its parameters. See example values in that file.
| Property | Description | Required |
|---|---|---|
| workflow.enabled | Enable the application. Must be 'true'. | Y |
| workflow.storage | Storage & workflow engine used. Must be 'jira' or 'restyaboard'. | Y |
Comment out (precede with '#') both of these properties if deploying as a standalone application.
Enable both properties if deploying to a separate application server.
A linked MySQL database. The database is used only for local authentication credential storage.
| Property | Description | Required |
|---|---|---|
| workflow.db.host | Database hostname | Y |
| workflow.db.name | Database schema name | Y |
| workflow.db.username | Database username | Y |
| workflow.db.password | Database password | Y |
Keep these properties as-is in your application.config:
spring.datasource.url=jdbc:mysql://${workflow.db.host:localhost}:3306/${workflow.db.name}
spring.datasource.username=${workflow.db.username}
spring.datasource.password=${workflow.db.password}
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect
For use with JiraWorkflowService implementation, connecting via Jira's API as the purchase requests storage and workflow engine.
Note: In order for Jira users to be set as the reporter or assignee of an issue, that user must already be an existing reporter, assignee or commenter of some issue in the configured Jira project. This is a limitation due to new restrictions from Jira's GDPR protections, and will hopefully go away once a solution is found.
| Property | Description | Required |
|---|---|---|
| workflow.jira.url | URL for the Jira API | If workflow.storage is jira |
| workflow.jira.username | Username for the Jira API | If workflow.storage is jira |
| workflow.jira.token | API token for the Jira account | If workflow.storage is jira |
| workflow.jira.project | Jira project key | If workflow.storage is jira |
| workflow.jira.issueTypeId | ID of the Jira issue type to use for purchase requests. Find the ID via an API call or via the Jira UI | If workflow.storage is jira |
| workflow.jira.maxSearchResults | Maximum results to return when retrieving issues in bulk. | If workflow.storage is jira |
| workflow.jira.multipleLibrariansUsername | Username of a Jira user / librarian to assign a purchase request to via Librarian Enrichment, if the enrichment determines that more than one librarian is interested in the item's call number. Intended to be a username that forwards email to all librarian selectors. | If workflow.storage is jira |
| workflow.jira.defaultReporterUsername | Username of a Jira user to set as the reporter of each purchase request where the client has not specified a reporter. Intended to be used for automated clients such the Lost Items Client. Jira will email this user with every comment and status update, so a dedicated API user account may be preferred. | If workflow.storage is jira |
These parameters define the IDs and names of Jira statuses and the transitions between them.
| Property | Description | Required |
|---|---|---|
| workflow.jira.deferredStatusName | Name of the Jira status used to identify purchases that the librarian selectors want to review at a later date. If omitted, the server cannot transition requests to that status when set on newly submitted requests. See approvedStatusId for finding value. |
N |
| workflow.jira.deferredStatusTransitionId | ID of the Jira transition that takes an issue from New to the Deferred status. See approvedStatusTransitionId for finding value. |
If workflow.jira.deferredStatusName is set |
| workflow.jira.approvedStatusId | ID of the Jira status to use identify approved purchases. Find the ID via an API call or via the Jira UI. | If workflow.storage is jira |
| workflow.jira.approvedStatusName | Name of the Jira status used to identify approved purchases. See approvedStatusId for finding value. |
If workflow.storage is jira |
| workflow.jira.approvedStatusTransitionId | ID of the Jira transition that takes an issue from New to Approved. Find the ID via an API call | If workflow.storage is jira |
| workflow.jira.deniedStatusId | ID of the Jira status to use identify denied purchase requests. If multiple Jira status values signify a denied request, this property may be a comma-separated list. See approvedStatusId for finding value. |
If workflow.storage is jira |
| workflow.jira.arrivedStatusId | ID of the Jira status to use identify purchases that have arrived at their destination. See approvedStatusId for finding value. |
If workflow.storage is jira |
Each of the following configuration parameters defines the Jira ID of a custom field used to store purchase request data. Find the ID via an API call or via the Jira UI.
| Property | Description | Required |
|---|---|---|
| workflow.jira.contributorFieldId | Stores the contributor (author) name. | If workflow.storage is jira |
| workflow.jira.isbnFieldId | Stores the ISBN. | If workflow.storage is jira |
| workflow.jira.oclcNumberFieldId | Stores the OCLC number. | If workflow.storage is jira and workflow.identifiers is set |
| workflow.jira.callNumberFieldId | Stores the Dewey call number. | If workflow.storage is jira and workflow.identifiers is set |
| workflow.jira.formatFieldId | Stores the requested book format (i.e. print, electronic). | If workflow.storage is jira |
| workflow.jira.speedFieldId | Stores the requested delivery speed. | If workflow.storage is jira |
| workflow.jira.destinationFieldId | Stores the requested destination of the item after purchase. | If workflow.storage is jira |
| workflow.jira.clientNameFieldId | Stores the name of the client application that submitted a purchase request. | If workflow.storage is jira |
| workflow.jira.requesterUsernameFieldId | Stores the email / LDAP username of the patron or staff member who requested an item. | If workflow.storage is jira |
| workflow.jira.requesterRoleFieldId | Stores the role, department and/or other description of the requester, as provided by LDAP. | If workflow.storage is jira and workflow.requester is set |
| workflow.jira.fundCodeFieldId | Stores the requested budget fund code to assign to an item purchase. | If workflow.storage is jira and workflow.enrichment.budget-code is set |
| workflow.jira.objectCodeFieldId | Stores the requested budget object code to assign to an item purchase. | If workflow.storage is jira and workflow.enrichment.budget-code is set |
| workflow.jira.postPurchaseIdFieldId | Stores the unique ID of a purchased item, for use in emails about Arrived purchase requests. | If workflow.storage is jira |
| workflow.jira.decisionReasonFieldId | Stores the selector-indicated reason behind a purchase decision, for use in emails about decided purchase requests. | If workflow.storage is jira |
For use with RestyaboardWorkflowService implementation, connecting via Restyaboard's API as the purchase requests storage and workflow engine.
| Property | Description | Required |
|---|---|---|
| workflow.restyaboard.base-url | URL for the Restyaboard API | If workflow.storage is restyaboard |
| workflow.restyaboard.username | Username for the Restyaboard API | If workflow.storage is restyaboard |
| workflow.restyaboard.password | Password for the Restyaboard API | If workflow.storage is restyaboard |
| workflow.restyaboard.board-id | ID of the Restyaboard board to use for purchase requests. The ID is in the URL when viewing the board. | If workflow.storage is restyaboard |
| workflow.restyaboard.new-request-list-id | ID of the list to which new purchase requests should be added. Find the ID via an API call. | If workflow.storage is restyaboard |
| Property | Description | Required |
|---|---|---|
| workflow.core-data.title.isbn-only-prefix | If no title is provided, the ISBN will be used as the purchase request title, prefixed by this value. | Y |
| Property | Description | Required |
|---|---|---|
| workflow.identifiers | OCLC to enable Identifiers Enrichment |
N |
| Property | Description | Required |
|---|---|---|
| workflow.budget-code | FOLIO to enable Budget Code Enrichment |
N |
OCLC APIs are used by various holdings enrichment steps and the match service.
| Property | Description | Required |
|---|---|---|
| workflow.oclc.wsKey | API wsKey from OCLC with access to the WorldCat API. | Y |
| workflow.oclc.secret | API secret from OCLC to use with the wsKey | Y |
| workflow.oclc.localInstitutionSymbol | Three-letter OCLC institutional symbol | Y |
| workflow.oclc.classification-type | dewey or other key available in the classification result from an OCLC search, present in records cataloged by the Library of Congress (DLC). Used by the Librarian Service. |
Y |
| Property | Description | Required |
|---|---|---|
| workflow.localHoldings.dataSource | FOLIO or OCLC to enable Local Holdings Enrichment. Determines which source and algorithm is used to identify any local holdings. |
N |
| workflow.localHoldings.linkTo | VuFind or FOLIO. Determines which destination the local holdings search results should link to. |
If workflow.localHoldings.dataSource is set |
| Property | Description | Required |
|---|---|---|
| workflow.groupHoldings.dataSource | OCLC to enable Group Holdings Enrichment. |
N |
| workflow.groupHoldings.oclcSymbols | Comma-separated list of OCLC group symbols representing consortia that the institution belongs to. The application will check and report separately on holdings for each group. | If workflow.groupHoldings.dataSource is set |
For connecting to the FOLIO API.
Note: The specified FOLIO user account should have the following permissions:
- Inventory: View instances, holdings, and items
- Users: Can view user profile (only required for Budget Enrichment)
| Property | Description | Required |
|---|---|---|
| workflow.folio.username | Username for the FOLIO API. See permissions required above. | Y |
| workflow.folio.password | Password for the FOLIO API. | Y |
| workflow.folio.tenantId | Tenant ID for the FOLIO server environment. | Y |
| workflow.folio.okapiBaseUrl | Base URL for FOLIO OKAPI API calls. | Y |
| workflow.folio.websiteBaseUrl | Base URL for the FOLIO UI. Used to format links to FOLIO local holdings. | Y |
| workflow.folio.isbnIdentifierType | FOLIO UUID for the identifier type representing an ISBN. Determine from the FOLIO Get /identifier-types API. | If workflow.match.data-source is FOLIO. |
| workflow.folio.oclcNumberIdentifierType | FOLIO UUID for the identifier type representing an OCLC Number. Determine from the FOLIO Get /identifier-types API. | If workflow.match.data-source is FOLIO. |
| Property | Description | Required |
|---|---|---|
| workflow.vu-find.base-url | Base URL for the VuFind catalog UI. Used to format links to VuFind local holdings. | Y |
Used for information about the patron requesting a purchase.
| Property | Description | Required |
|---|---|---|
| workflow.requester | ldap to enable requester enrichment |
N |
| spring.ldap.urls | URL for LDAP queries. | If workflow.requester is set |
| spring.ldap.base | Base string for LDAP queries. | If workflow.requester is set |
| workflow.ldap.username-query-field | Parameter representing the username in the LDAP query. Generally uid. |
If workflow.requester is set |
| workflow.ldap.info-result-field | LDAP search result field containing information about the requester, including their role and potentially other data like academic department. Generally description. |
If workflow.requester is set |
| workflow.ldap.requester-info-role-pattern | Java regular expression to extract the role from the full value returned in the workflow.ldap.info-result=field. The role should be identified in the regular expression by a named group "ROLE". If supplied, this property be used later for Priority Enrichment. |
N |
workflow.ldap.info-result-overrides.username |
Skip the LDAP query for a specific user, based on the purchase request's requesterUsername, and return a pre-configured info field string. This property can be defined multiple times for different usernames. Useful for testing the effect of different user roles on Priority Enrichment. |
N |
Pricing Enrichment providers retrieve the list price(s) and related information of a requested purchase. They may also link to the item page on the vendor website.
The IsbnDB API is is a commercial service, but relatively affordable (~ $10/m).
| Property | Description | Required |
|---|---|---|
| workflow.isbn-db.enabled | true to enable pricing enrichment from IsbnDB |
N |
| workflow.isbn-db.method | title or isbn. Two methods are available to search IsbnDB. Title search is recommended, as the odds of a given ISBN being present in the database are lower. |
If workflow.isbn-db.enabled is true |
| workflow.isbn-db.api-key | API key provided by IsbnDB. | If workflow.isbn-db.enabled is true |
| workflow.isbn-db.title-search.filter-on-contributor | true or false. If true, title search results are filtered by the requested contributor name. |
If workflow.isbn-db.method is title |
Axesso offers an API via the RapidAPI platform to search Amazon websites for product information. It's also relatively affordable with a free tier.
| Property | Description | Required |
|---|---|---|
| workflow.amazon-axesso.enabled | true to enable Amazon pricing enrichment via Axesso |
N |
| workflow.amazon-axesso.api-key | Axesso API key for Amazon pricing information | If workflow.amazon-axesso.enabled is true |
| workflow.amazon-axesso.api-domain-code | Domain of the Amazon website to be searched, i.e. "com" for the U.S. based site. | If workflow.amazon-axesso.enabled is true |
| workflow.amazon-axesso.page-url-prefix | Prefix before the ASIN of a direct URL to an Amazon product page. | If workflow.amazon-axesso.enabled is true |
| workflow.amazon-axesso.max-products | Maximum number of matching Amazon product search results for which to display pricing info. | If workflow.amazon-axesso.enabled is true |
| workflow.amazon-axesso.quota-monitor.overage-allowed | Number of calls over the quota that are allowed (incurring overage charges). Note that counting this number resets when the server is restarted. Also note that the remaining quota is not known until after the first call, so a single call will proceed even if the overage allowed is zero and quota has already been reached. | If workflow.amazon-axesso.enabled is true |
ProQuest OASIS offers an API for pricing information.
| Property | Description | Required |
|---|---|---|
| workflow.oasis.enabled | true to enable OASIS pricing enrichment |
N |
| workflow.oasis.api-key | OASIS API Key | If workflow.oasis.enabled is true |
| workflow.oasis.local-currency | Three-letter currency code for which pricing should be retrieved, i.e. AUD, CAD. Search results that do have pricing listed in this currency will be skipped. | If workflow.oasis.enabled is true |
| workflow.oasis.max-results | Maximum number of matching OASIS results to display. | N. The default is 10. |
This enrichment searches the Directory of Open Access Books for available titles matching the title & contributor. The API is freely available. There is no actual "pricing" data as these books are free to read.
| Property | Description | Required |
|---|---|---|
| workflow.doab.enabled | true to enable DOAB availability enrichment |
N |
Links Enrichment generates a simple list of outgoing search links to additional sources like Google Scholar, that staff may want to consult to support the purchase decision. These may be useful if the data source has no API.
| Property | Description | Required |
|---|---|---|
| workflow.links.enabled | true to enable Links Enrichment |
N |
| workflow.links.google-scholar-enabled | true to link to a Google Scholar title search for the purchase request |
N |
Librarian Enrichment makes use of a separate Librarian Call Numbers web service which maps a call number to a list of librarians who are involved in selection for that range. It optionally assigns a default librarian if no call number has been identified.
| Property | Description | Required |
|---|---|---|
| workflow.librarian-call-numbers | service to enable librarian enrichment. |
N |
| workflow.librarian-call-numbers.base-url | Base URL of the Librarian Call Numbers service. | If workflow.librarian-call-numbers is set |
| workflow.librarian-call-numbers.no-call-number-username | Username of a librarian to assign if the request has no call number (after Identifiers Enrichment). | N |
Priority Enrichment set the priority of the purchase request based on other data supplied by the client application and/or determined through prior enrichments. Issue priorities should be visible within the workflow service and used there for filtering, sorting, etc. by library staff to address the most urgent requests first.
Priority values should be those understood by the workflow service API.
- For Jira, find the priority IDs via an API call.
| Property | Description | Required |
|---|---|---|
| workflow.priority.enabled | true to enable Priority Enrichment |
N |
workflow.priority.by-request-type.request_type__requester_role |
Priority value used by the workflow service. This priority will be applied to requests matching the given request_type, that also match the the given requester_role as determined by workflow.ldap.requester-description-role-pattern in Requester Enrichment. This property can be defined multiple times for different request_types and requester_roles. |
N |
workflow.priority.by-request-type.request_type__default |
Priority value used by the workflow service. This priority will be applied to requests matching the given request_type if no more specific priority is determined. This property can be defined multiple times for different request_types. |
N |
For reporting via the Email Listener.
| Property | Description | Required |
|---|---|---|
| spring.mail.host | Hostname of an SMTP server | Y |
| spring.mail.port | Port of the SMTP server | Y |
| workflow.email.enabled | true to enable email notifications to patrons and staff. |
N |
| workflow.email.subject-prefix | Prefix the subject line for all emails, such as to identify a test environment. | N |
| workflow.email.from-address | From address to use in reporting emails | Y |
| workflow.email.purchase-requested-address | Email address to send notification when a new purchase is requested, in addition to the emails of any associated librarians from Librarian Enrichment. | N |
| workflow.email.purchase-approved-address | Email address to send notification when a purchase is approved. | N |
| workflow.email.purchase-denied-address | Email address to send notification when a purchase is denied. | N |
| workflow.email.purchase-arrived-address | Email address to send notification when a purchase arrives at its destination, in addition to the requester's email. | N |
workflow.email.purchase-status-html |
true if the message template should be interpreted as HTML. The default, false, renders the text as a plain-text email. HTML email supports links and other formatting, but requires HTML whitespace management (i.e. line-breaks or paragraphs). |
N |
workflow.email.purchase-status-delay |
Delay after a purchase request enters status status (newly requested, approved, denied, or arrived) before any email is sent, if specified. Format as a Java 8 Duration. |
N |
workflow.email.purchase-denied-reasons.decisionReason |
Text to be inserted into the denied email template at the decisionReason template variable. This priority will be applied to requests with a reason matching the given decisionReason. (Before matching, the decisionReason in the request is converted to lowercase, and spaces are replaced by hyphens.) This property can be defined multiple times for different request_types. |
N |
For reporting to Google Sheets spreadsheets. See reporting and post-approval processing for additional details.
| Property | Description | Required |
|---|---|---|
| workflow.google-sheets.credentials-file-path | Path to the file containing the google-sheets-client-secret.json file provided by Google Cloud to the Google Workspace APIs. |
If any of the other workflow.google-sheets.* properties are set |
| workflow.google-sheets.match-marc.approved-spreadsheet-id | ID of a spreadsheet to use for reporting approved items in MatchMARC format. | N |
| workflow.google-sheets.full-record.requested-spreadsheet-id | ID of a spreadsheet to use for reporting newly requested items in full record format. | N |
| workflow.google-sheets.full-record.approved-spreadsheet-id | ID of a spreadsheet to use for reporting approved items in full record format. | N |
Determines the data source for the match service.
| Property | Description | Required |
|---|---|---|
| workflow.match.data-source | OCLC or FOLIO |
Y |
Load data from the LSP after a purchase is complete. Used by EmailListener.
| Property | Description | Required |
|---|---|---|
| workflow.post-purchase.data-source | FOLIO |
Y |
| workflow.post-purchase.proxy-prefix | Proxy server prefix for electronic access URLs. | N |
To optionally change the default SLF4J logging level from INFO.
| Property | Description | Required |
|---|---|---|
| logging.level.edu.lehigh.libraries.purchase_request | DEBUG, ERROR, etc. |
N |
In addition to these application.properties settings, a standard logback-spring.xml file can be used for additional configuration. For example, the included logback-spring.xml.example file can email ERROR log events to a specified recipient.