Doorgaan naar de website
OCLC Support

Notifications

Use this screen to set up and configure notifications.

Tipasa offers the ability for libraries to send automated notifications to patrons at various events in the request life span, and also the option to send notices about a specific request at any time while using the staff user interface. Automated notifications to patrons will be sent via email and/or Short Message Service (SMS), depending on the patron's preferences.

A total of 28 event-specific notifications are available in OCLC Service Configuration which can be customized by your library to include your ILL name, department email address, and contact information. In addition to customizing the event-specific "standard" notifications, your library can create as many as 50 "custom" notifications, all of which can be emailed to the desired recipient using the staff user interface.

 Notes:  

  • By default, patrons will receive email messages. 
  • Text message notifications are turned off by default. To enable the ability to send SMS notifications for patrons, turn on Send SMS for Notifications.
    • Enable Send SMS for automated notifications to display text message options to library users in the View Profile section of My Account. Library users will need to opt into SMS notifications from the View Profile screen. 
    • It is recommended that libraries outside the United States and Canada do not enable SMS notifications.
    • Add the Phone field to your Request Forms to allow patrons to receive SMS notifications for their requests.  See Request Form fields for more information.

Set up Notifications

Notifications are set up in OCLC Service Configuration. By default, no notifications are turned on. There are 28 event-specific notifications you can configure, in addition to 50 custom notifications.

You can turn SMS notifications off or on by checking the Send SMS for automated notifications box. Enable Send SMS for automated notifications to display text message options to library users in the View Profile section of My Account. Library users will need to opt into SMS notifications from the View Profile screen. 

  • If Send SMS for automated notifications is not enabled, text message options will not display to library users in My Account.

 Note: It is recommended that libraries outside the United States and Canada do not enable SMS notifications.

You can select notifications to appear in the Tipasa interface for manual sending and/or for them to be automatically sent out when an action occurs within the system. Not all notifications allow for automated sending. For a description of all notifications and when automated notifications are sent out, see Notification types. Notifications can be sent to patrons as email and/or SMS messages, depending on what they have selected in My Account.

Notifications - Image

Screenshot showing configuration screen for borrowing library to patron notifications

Determine notifications to send

You should review the Notification types and decide which notifications you want to enable before configuring the notifications. You will have to customize each notification with your library's information. There is no way to batch edit notifications.

Libraries using WorldShare Circulation should work with their circulation department to evaluate the library's circulation notification policy and determine whether to use notifications from WorldShare Circulation or from Tipasa. This will prevent patrons from receiving multiple notifications for items about to be due, overdue or available for pickup.

Configure notifications

Once you have decided on the notifications your library will use, you can begin customizing each notification.

To set up notifications:

  1. Sign in to Service Configuration.
  2. On the left navigation, click WorldShare ILL > Notifications.
  3. On the Notifications screen, for every notification you want to turn on:
    1. In the row of the notification, click Edit.
    2. Fill in the fields with your library's information. You should customize your notifications in order for your patrons to recognize the notification is coming from your library. See Edit email and SMS notifications for details.
    3. Click Save All Changes.
    4. A confirmation message appears. Click Click to edit if you want to make any additional changes.
  4. Optional. To preview the email and SMS notification, click Preview in the row of the notification you want to preview.
  5. Optional. To test the email or SMS notification:
    1. Click Send Test Email or Send Test SMS in the row of the notification you want to test.
    2. Enter the Recipient Email or Recipient Phone Number, respectively.
    3. Click Send.
  6. For every notification you want to turn on, select the Manual sending in WorldShare check box and/or the Automated check box.
  7. At the bottom of the screen, click Save.

Notification History

Automated notifications for a request are tracked in a Notification Log.

To view the Notification Log:

  1. Locate the request you need to review in the Borrowing Requests queue.
  2. Click on the request ID or Title.
  3. Expand the Request History accordion.
    Note: It may take several minutes for the Notification Log to update after a notification is sent.
Request History - Image

Screenshot showing notification history for a request in the staff interface

Edit and send notifications

Every notification has a default template. You should customize each notification with your library's information in order for your patrons to recognize the notification is coming from your library. On the Edit screen for a notification, you can edit the email and SMS message templates.

Edit email notification template

Follow the instructions below to edit an email notification template.

To edit an email notification:

  1. In Service Configuration, on the left navigation, click WorldShare ILL > Notifications.
  2. On the Notifications screen, find the notification you want to edit. See Notification types for more information on the different notifications you can send.
  3. In the row of the notification, click Edit.
  4. On the Edit screen, edit the fields. Refer to Email fields below for more information.
  5. To represent information from the request, use Data Inserts. Place your cursor where you want to add the Data Insert, and click the Data Insert you want to add. For descriptions of all the Data Inserts, see Notification data inserts.
  6. At the bottom of the screen, click Save All Changes.
  7. If you are unhappy with your edits, you can revert to the default template at any time by clicking Reset to Standard. Note: This will revert both the email and SMS notification (if applicable).

To create a custom email notification:

  1. In Service Configuration, on the left navigation, click WorldShare ILL > Notifications.
  2. Open the Customaccordion and click "Create New Custom Notification".
  3. In the Create New Template window, type a Template Name.
  4. (Optional). Add a description of the template in the Template Description text box.
  5. Select a Recipient type.
  6. Click Create.
  7. The new template will now display below the Custom category and can be edited.

Email fields

You can edit the following fields for email notifications:

Email field Description
From Name The sender of the email notification. You should enter your library's name, department, or service name (e.g. Bobcat Document Delivery) in this field. You do not have to use the same From Name on each notification. For example, you can use a different from name on your interlibrary loan request notifications than your Document Delivery notifications.
Reply To Email

The email address patrons can reply to if they have any questions about their request or need more information. The OCLC-supplied email in the templates is not a monitored email. If you leave the default OCLC email in the Reply To Email field, patrons that reply to that email will not receive a response. If you want patrons to be able to email your library and receive responses, you should enter a monitored email for your library.

OCLC-supplied email address information
Data Center OCLC-supplied email address IP Address
United States Data Center notices@e.worldcat.org 129.33.239.222
Australia Data Centre
Canada Data Centre
Europe Data Centre
notices@e2.worldcat.org 208.73.7.73
Message Subject The subject of the email notification.
Message Body The body of the email notification.

How an email appears to your patrons

The following image depicts how an email notification will appear to patrons:

Screenshot show sample patron email notification

Edit SMS notification

Follow the instructions below to edit an SMS notification template. Note: Only automated notifications have SMS as an option.

To edit an SMS notification:

  1. In Service Configuration, on the left navigation, click WorldShare ILL > Notifications.
  2. On the Notifications screen, find the notification you want to edit. See Notification types for more information on the different notifications you can send.
  3. In the row of the notification, click Edit.
  4. On the Edit screen, scroll down to the SMS field.
  5. Edit the text in the SMS field. OCLC recommends limiting the notification to 160 characters and including the Request ID data insert in the message.
  6. To represent information from the request, use Data Inserts. Place your cursor where you want to add the Data Insert, and click the Data Insert you want to add. For descriptions of all the Data Inserts, see Notification data inserts.
  7. At the bottom of the screen, click Save All Changes.
  8. If you are unhappy with your edits, you can revert to the default template at any time by clicking Reset to Standard. Note: This will revert both the email and SMS notification (if applicable).

Preview your edits

You can preview your edits from the Notifications screen. When you preview a notification, it will show you both the email version and the SMS version.

To preview edits:

  1. In the row for the notification you want to preview, click Preview.
  2. The Preview Notification screen opens in a new tab.

 Note:  The preview notification will include a default data insert for My Account of http://mylib.account.worldcat.org/account.  This is not indicative of the link that will appear on real notifications sent from Tipasa, which will include your library's My Account URL.

If you send a test email or test SMS from within Service Configuration, it will include the http://mylib.account.worldcat.org/account URL.  If you want to see exactly how your notifications will appear to your patrons, send a notification from within Tipasa.

Send a manual notification

If you have enabled manual notifications, you can send these at any time in the Tipasa interface. Any notifications you have enabled as Manual sending in WorldShare interface will be available to send.

Note: Depending on the request, the list of templates enabled for manual sending will be pre-filtered:

  • Borrowing Library to Patron - These notifications are available when viewing an interlibrary request as a Borrower. The To Email defaults to the patron's email.
  • Lending Library to Borrowing Library - These notifications are available when viewing an interlibrary loan request as a Lender. The To Email must be entered.
  • Document Delivery Library to Patron - These notifications are available when viewing a Document Delivery request. The To Email defaults to the patron's email.
  • Other - The Full Request Details (the default Tipasa template) and the Custom notifications are always available. The To Email must be entered.

To send a manual notification:

  1. In the Tipasa interface, locate the request you want to send a notification about.
  2. Open the request and click Email.

    Screenshot showing request in staff interface, with email button called out
  3. On the Send Message window, click Choose a template.
  4. All applicable notifications that you have enabled for Manual sending in the WorldShare interface will appear in the list. Standard notifications appear first (in order of the workflow), followed by custom notifications (in alphabetical order). Select the notification you want to send.
  5. The message information is populated with the customized data you supplied for the notification in Service Configuration.
  6. You can edit the message and add any information you want before sending the notification.
  7. Click Send.

Note: Sending a manual notification will not override automated notifications. If a manual notification is sent to alert the patron of an event, the system will also automatically generate a notification to the patron when the status of the item changes.

Troubleshoot notifications

The notifications that are sent to patrons are collected into the Notification Log that appears in the Request History accordion of a request. The Log records all manual and automated notifications sent about the request, including details on when they were sent, how they were sent, and their status. The notification name is linked to the text of the message that was sent or attempted to be sent. You can resend any of the email notifications listed in the log by clicking Resend. SMS notifications cannot be resent. My Account also shows the notifications that were successfully delivered, but patrons cannot view the content of the notifications that were sent to them. See My Account for more information. 

Screenshot showing notification history in staff interface

Notification status

The notification status in the Notification Log indicates whether any errors occurred while sending the notification or if it was successfully delivered. The following table includes all statuses that can occur and how to proceed if you see the status in the Notification Log:

Status What to do?
Duplicate message The system does not allow more than one message with the exact same content to be sent to the same user within an hour. OCLC recommends that you customize your email and SMS notification templates so that each notification contains unique information (such as the requested item's Title or Request ID). For information on customizing your notification, see Edit email and SMS notifications.
Failed to parse the template Sign in to Service Configuration (WorldShare ILL > Notifications) and preview the notification template. Correct any errors you find. See Edit email and SMS notifications for details.
Incomplete contact information for patron Check the patron's account and notification preferences and verify they have a valid email address and phone number with country code listed.
Message delivered The notification was successfully delivered to the recipient.

Missing or invalid field(s)

Verify that the required fields are present in the notification and resend the request manually.
Outdated message; cancelled

You may receive this status if you have first enabled overdue notifications and have requests that meet the criteria for the first, second, and third item overdue notices at the same time. In this case, the system will only send out the latest (third overdue) notification. The first and second overdue notifications will not be sent out, and they will appear in the Notification Log as outdated.

Additionally, if you were using the second overdue notice, and you turned it off, for example, any notifications that were queued up for future sending would be canceled. For a list of all available notifications, see Notification types.

SMS messaging not supported for country SMS notifications for the country is not supported at this time. Only phone numbers with a country code of +1 (United States and Canada) can receive SMS notifications.
A system error has occurred Depending on why there was a system error, you can attempt to resend the notification. If the problem persists, and occurs on multiple notifications and the notification cannot be resent, contact OCLC Support .
Unable to deliver to mail address Check if the patron has entered a valid email address. You should check: the request, the Delivery Notification section in the patron's account, and the Library Record section in the patron's account. It may also mean that the email was sent to the email domain, but the patron's email address was not found.
Unable to deliver: mailbox full The email domain has responded that the patron's inbox is full. Contact the patron using a method other than email.

Email notifications delivered to spam or junk folder

If you are using the OCLC-supplied Reply To Email, you may need to whitelist this address to prevent Tipasa notifications from appearing in your patron's spam or junk folder.  To do so, please see the information below:

Data Center OCLC-supplied email address IP Address
United States Data Center notices@e.worldcat.org 129.33.239.222
Australia Data Center
Canada Data Center
Europe Data Center
notices@e2.worldcat.org 208.73.7.73

Custom notifications

Tipasa libraries can create up to 50 custom email notifications.  Custom notifications are used to communicate with patrons, departments within their library or other libraries.  

For example, the library might create custom notifications for patrons, to explain why a request has been canceled or to alert them of fines on their account, to suggest that Acquisitions purchase an item requested on ILL, or to notify other libraries about the status of specific requests.

Custom notifications - Image

Screenshot showing configuration screen for custom patron notifications

To create a custom email notification:

After a custom email notification has been added, you will need to sign in to the Tipasa staff interface again for the new notification to appear.  

  1. In Service Configuration, navigate to WorldShare ILL > Notifications.
  2. Open the Custom accordion and click Create New Custom Notification.
  3. In the Create New Template window, type a Template Name. 
  4. (Optional). Add a description of the template in the Template Description text box.
  5. Select a Recipient type. This will indicate to the system from which queues the notification will be available to select:
  • ANY: Send to patrons, borrowing libraries and lending libraries
  • PATRON: Send to patrons
  • REQUESTER: Send to borrowing libraries
  • SUPPLIER: Send to lending libraries
  • BRANCH: Send to branch locations
  1. Click Create.
  2. The new template will now display below the Custom category.
  3. Check the Manual sending in WorldShare box so that the notification will be available to select in Tipasa.
  4. Click Edit and provide the information for the following fields:
  • From Name: The sender of the email notification.  You should enter your library's name, department, or service name (e.g. Bobcat Document Delivery) in this field.  You do not have to use the same From Name on each notification.  For Example, you can use a different from name on your interlibrary loan request notifications than your Document Delivery notifications.
  • Reply to Email: The email address patrons can reply to if they have any questions about their request or need more information.  The OCLC-supplied email in the templates (notices@e.worldcat.org) is not a monitored email.  If you leave the default OCLC email in the Reply To Email field, patrons that reply to that email will not receive a response.  If you want patrons to be able to email your library and receive responses, you should enter a monitored email for your library.
  • Message Subject: The subject of the email notification.
  • Message Body: The body of the email notification.

Data inserts can be used to customize the message.              

                          Note:   SMS messaging is not available for custom notifications.  Leave the default message in the SMS box.

  1. Click Save All Changes.  The custom notification is available to send as a manual notification.
  2. (Optional) Preview your edits.
  3. Use the Edit Settings button to change the template name, description and recipient type.  To delete a custom notification click the Delete button.

Notification types

Use custom notifications that you can set up in Service Configuration:

Borrowing Library to Patron

Notification type Description

Manual sending?

(Email only)

Auto sending?

(Email/SMS)

 

Auto message sent out
Newly registered user approved

Patron account has been approved for ILL requesting.

This notification only applies if you have patron approval turned on.

See Turn on patron approval for more information.

Ja

 

Ja

When the patron is approved by a staff member in the Tipasa interface. The patron must be approved from their request in order for the notification to be sent.

Note: This notification will not be automatically sent if you approve the patron from their account in the WorldShare Admin module or by using Find Patrons on the left navigation.

For more information on approving patrons, see Approve patrons.

New request acknowledged Confirmation to patron that their request was received.

Ja

Ja

When a patron initiated request is assigned a request ID. If staff create a request for a patron in the system, the patron will not receive this notification.
Additional information required Request for the patron to provide more information about their request or the item desired.

Ja

Nee NA
Request cancelled confirmation Confirmation to patron that their request has been canceled.

Ja

Ja

When the request's status becomes Closed (Cancelled).
Article available in Article Exchange Message to patron that item is available in Article Exchange with instructions for retrieval.

Ja

Ja

When a Copy request is fulfilled with an Article Exchange link and is marked as received by the borrowing library.
KB link available in user portal

Message to patron that item is available in the Knowledge Base with instructions for retrieval.

The link to the item will be available in My Account.

Ja

Nee

Note: The automated notification cannot be used at this time.

When a Copy request is fulfilled with a knowledge base link.

Open Access link available in user portal

Message to patron that item is available on the Open Internet with instructions for retrieval.

The link to the item will be available in My Account.

Ja

Nee

Note: The automated notification cannot be used at this time.

When a Copy request is fulfilled with an Open Access link.

Printed copy available for pickup Message alerting patron that their item is ready to pickup at their chosen Pickup Location.

Ja

Ja

When a Copy request is fulfilled without a URL link and is marked as received by the borrowing library and the amount of time you selected has passed.

You can select for the notification to be sent out up hours, days, or weeks after the item has been received.

Loan available for pickup Message alerting patron that their item is ready to pickup at their chosen Pickup Location.

Ja

Ja

When a Loan request is marked as received by the borrowing library and the amount of time you selected has passed.

You can select for the notification to be sent out hours, days, or weeks after the item has been received.

Renewal request submitted Message alerting patron that their renewal request was submitted. 

Ja

Ja

If automated delivery is selected, this notification is sent upon submission of the renewal request by either the patron or ILL staff member to the lender.

If manual delivery is selected, the ILL staff person can send the notification by using the Email button within the request and selecting the appropriate notification template.

Renewal request approved Message alerting the patron that their renewal request has been approved.

Ja

Ja

If automated delivery is selected, this notification is sent when the lender agrees to renew the loan.

If manual delivery is selected, the ILL staff person can send the notification by using the Email button within the request and selecting the appropriate notification template.

Renewal request denied Message alerting the patron that their renewal request has been denied.  

Ja

Ja

If automated delivery is selected, this notification is sent if the lender denies the renewal.

If manual delivery is selected, the ILL staff person can send the notification by using the Email button within the request and selecting the appropriate notification template.

Item about to be due Reminder to patron that the due date for an item is approaching.

Ja

Ja

When the patron due date is within the amount of time you select.

You can select for the notification to be sent out days or weeks before the patron due date.

Item overdue - 1st notice Reminder to patron that an item is overdue.

Ja

Ja

When the patron due date has occurred and the amount of time you selected has passed.

You can select for the notification to be sent out days or weeks after the patron due date.

Item overdue - 2nd notice Reminder to patron that an item is very overdue.

Ja

Ja

When the patron due date has occurred and the amount of time you selected has passed.

You can select for the notification to be sent out days or weeks after the patron due date.

Item overdue - 3rd notice Reminder to patron that an item is very, very overdue and additional recourse may be necessary.

Ja

Ja

When the patron due date has occurred and the amount of time you selected has passed.

You can select for the notification to be sent out days or weeks after the patron due date.

Lending Library to Borrowing Library 

Notification type Description

Manual sending?

(Email only)

Auto sending?

(Email/SMS)

Auto message sent out
Additional information required Request for the borrowing library to provide more information about the request or the item desired. Ja Nee NA
Item about to be due Reminder to borrowing library that the due date for an item is approaching. Ja Nee NA
Item overdue - 1st notice Reminder to borrowing library that an item is overdue. Ja

Ja

(Email Only)

When the due date has occurred and the amount of time you selected has passed.

You can select for the notification to be sent out days or weeks after the patron due date.

Item overdue - 2nd notice Reminder to borrowing library that an item is very overdue. Ja

Ja

(Email Only)

When the due date has occurred and the amount of time you selected has passed.

You can select for the notification to be sent out days or weeks after the patron due date.

Item overdue - 3rd notice Reminder to borrowing library that an item is very, very overdue and additional recourse may be necessary. Ja Nee NA

 

Off-System Automated Messages

Notification type Description

Manual sending?

(Email only)

Auto sending?

(Email/SMS)

Auto message sent out
Can you supply? Message the lending library to inquire if they can supply an item. Ja Ja When a request is sent to an off-system partner via an automation-built lender string.
Cancel Message to the off-system lender that they no longer need to supply the requested item. Ja Ja When the Need Before date or Days to Respond has been reached.

Item overdue

 

Message to the borrowing library when an off-system request moves to the overdue status. 

 

Ja

Ja

When an off-system borrowing request moves to the overdue status at 14 days overdue.

Document Delivery Library to Patron

Notification type Description

Manual sending?

(Email only)

Auto sending?

(Email/SMS)

Auto message sent out
New request acknowledged Confirmation to patron that their request was received.

Ja

Ja

When a patron initiated request is assigned a request ID and a Document Delivery Fulfillment Type. If staff create a request for a patron in the system, the patron will not receive this notification.
Request cancelled confirmation Confirmation to patron that request has been canceled.

Ja

Ja

When the Document Delivery request's status becomes Closed (Cancelled).
Printed copy available for pickup Message alerting patron that their item is ready to pickup at their chosen Pickup Location.

Ja

Ja

When a Document Delivery Copy request is fulfilled without a URL link and is marked as complete and the amount of time you selected has passed.

You can select for the notification to be sent out hours, days, or weeks after the item has been received.

Loan available for pickup Message alerting patron that their item is ready to pickup at their chosen Pickup Location.

Ja

 

Ja

When a Document Delivery Loan request is marked as complete and the amount of time you selected has passed.

You can select for the notification to be sent out hours, days, or weeks after the item has been received.

Article available in Article Exchange Message to patron that item is available in Article Exchange with instructions for retrieval.

Ja

Ja

When a Document Delivery Copy request is fulfilled with an Article Exchange link and is marked as complete.
KB link available in user portal

Message to patron that item is available in the Knowledge Base with instructions for retrieval.

The link to the item will be available in My Account.

Ja

Ja

When a Document Delivery Copy request is fulfilled with a knowledge base link and is marked as complete.
Open Access link available in user portal

Message to patron that item is available on the Open Internet with instructions for retrieval.

The link to the item will be available in My Account.

Ja

Ja

When a Document Delivery Copy request is fulfilled with an Open Access link and is marked as complete.

Other

Notification type Description

Manual sending?

(Email only)

Auto sending?

(Email/SMS)

 

Auto message sent out
Custom Custom message defined by institution. Ja Nee NA

Notification data inserts

Data inserts represent information that is pulled from the request. For example, if you include ${Title!} and ${RequestId!} in the body of a notification, the title and request ID of the request will be substituted in the data inserts' place. The following table describes the Data Inserts that can be added to email and SMS notifications:

Notification data inserts
Data insert Description Request field in Tipasa
${ArticleAuthor!} The author of the requested article. Article Author
${ArticleTitle!} The title of the requested article. Article Title
${Author!} The author of the requested item. Author
${BillingAddressShipTo!} The bill to information for the requested item. Bill To
${BillingAddressLine1!} The first address line for the billing information for the requested item.     Billing - Address 1
${BillingAddressLine2!} The second address line for the billing information for the requested item.    
 
Billing - Address 2
${BillingAddressLocality!} The city information for billing for the requested item. Billing - City
${BillingAddressPostalCode!} The postal code information for billing for the requested item.     Billing - Postal Code
${BillingAddressRegion!} The State or Provence information for billing for the requested item.     Billing - State/Provence
${BillingAddressCountry!} The country information for billing for the requested item.     Billing - Country
${CreateDate!} The date the request was created. Requested on
${DeliveryAddressShipTo!} The ship to information for the requested item.     Ship To
${DeliveryAddressLine1!} The first address line for shipping. Shipping - Address 1
${DeliveryAddressLine2!} The second address line for shipping.     Shipping - Address 2
${DeliveryAddressLocality!} The city information for shipping. Shipping - City
${DeliveryAddressPostalCode!} The postal code information for shipping.     Shipping - Postal Code
${DeliveryAddressRegion!} The State or Provence information for shipping.     Shipping - State/Provence
${DeliveryAddressCountry!} The country information for shipping.     Shipping - Country
${DeliveryAddressEmail!} The email information for shipping. Shipping - Email
${DOI!} The Digital Object Identifier of the article. DOI
${DueDate!} The lender's due date for the requested item. Due Date
${EditionNote!} The edition of the item. Edition
${EditionType!} The preferred edition of the item. Preferred edition
${Format!} The material type of the requested item. Format
${ISBN!} The International Standard Book Number of the requested item. ISBN
${ISSN!} The International Standard Serial Number of the requested item. ISSN
${Issue!} The issue number of the requested item. Issue/No
${IssueDate!} The issue date of the requested item (only for articles and book chapter requests). Issue Date
${Language!} The language of the requested item. Language
${LenderString!} The lender string used in the request. Lender String
${LendingRestrictions!} The lending restrictions of the requested item. Lending Restrictions
${LinkUserPortal!} A direct link to My Account. NA
${LocalID!} The local shelving information of the item Local ID
${MaxDays!} The maximum number of days after a document is first viewed that a patron can access a copy document as configured in Article Exchange Retention Settings.  
${MaxViews!} The maximum number of views allowed per copy document as configured in Article Exchange Retention Settings.  
${NeedBeforeDate!} The date the patron needs the requested item before. Need Before
${OCLCNumber!} The OCLC number of the requested item. OCLC
${OffSystemRequesterName!}
 
The name of the off-system borrower. Borrower Name
${OffSystemSupplierName!} The name of the off-system lender. Lender Name
${PMID!} The PubMed Identifier of the requested item. PMID
${Pages!} The page numbers of the requested item. Pages
${PatronAddresse1!} The first line of the patron's address. Patron - Address 1
${PatronAddresse2!} The second line of the patron's address.     Patron - Address 2
${PatronAddressLocality!} The patron's city. Patron - City
${PatronAddressPostalCode!} The patron's postal code. Patron - Postal Code
${PatronAddressRegion!} The patron's State or Provence. Patron - State/Provence
${PatronAddressCountry!} The Patron's country. Patron - Country
${PatronDueDate!} The patron's due date for the requested item. NA
${PatronEmail!} The patron's email address. Email (Patron)
${PatronName!} The patron's name. Name
${PatronNote!} Any notes the patron supplied in the request. Notes
${PatronStatus!} The patron's status (e.g., faculty, student). Status (Patron)
${PickupLocation!} The patron's preferred pickup location. Pickup Location
${Publisher!} The publisher of the requested item (includes city of publication, publisher name, and publication date). Publisher
${Renewals!} The number of times the lender has provided a renewal. Renewals
${Renewed!} The requests renewed status. Renewals
${RequestId!} The request's request ID. Request ID
${RequestStatus!} The status of the request. See ILL statuses for more information. Status (Request Details)
${RequestType!} The type of request (e.g., Copy or Loan). Type
${RequestedDueDate!}  The due date requested by the borrower. Due Date
${RequesterBillingNote!} The billing note supplied by the borrower. Billing Notes
${RequesterEmail!} The borrower's email address. Email (Borrowing Information)
${RequesterMaxCost!} The borrower's max cost.

For borrowers:
Maximum Cost
Use IFM

 

For lenders:
Max Cost

${RequesterNote!} Any notes the borrower added to the request. Borrowing Notes
${RequesterOffSystemReferenceld!} The off-system requester's local Request ID is stored when an OCLC supplier responds to a request from an off-system requester. Requester Reference ID
${RequesterShipVia!} The borrower's shipping method. Ship Via
${RequesterSymbol!} The symbol of the borrower. Borrower
${ReturnAddressReturnTo!} The return to information in Lending Information. Lending Information - Return To
${ReturnAddressLine1!} The first return address line in Lending Information.    
 
Lending Information - Address 1
${ReturnAddressLine2!} The second return address line in Lending Information.    
 
Lending Information - Address 2
${ReturnAddressLocality!} The return city in Lending Information.     Lending Information - City
${ReturnAddressPostalCode!} The return postal code in Lending Information.     Lending Information - Postal Code
${ReturnAddressRegion!} The return region in Lending Information.     Lending Information - State/Province
${ReturnAddressCountry!} The return country in Lending Information. Lending Information - Country
${ReturnedDate!} The date the item is returned. Return Date
${SupplierltemBarcode!} The item barcode from the supplier.  Supplier's item Barcode
${SupplierCharge!} Supplier charge for lending the item.  
${SupplierNote!} Notes entered into the request. Staff Note
${SupplierOffSystemReferenceld!} The local Request ID provided by the off-system supplier for the transaction when an OCLC requester requests from an off-system supplier. Supplier Reference ID
${SupplierShippedDate!} The date the lender shipped the requested item. Shipped Date
${SupplierSymbol!} The symbol of the lender.

Lenders

Supplier (Request History)

${Title!} The title of the requested item. Title / Journal
${Title20!} The first twenty characters of the title of the requested item. Title / Journal
${UniformTitle!} The uniform title of the requested item. Uniform Title
${UrlAddress!} The supplied URL for the fulfilled request.

AE Alert

URL

${UrlPassword!} The password for the URL where the request item is located. Password
${Verified!} How the requested item was found (e.g., WorldCat Discovery) Verification
${Volume!} The volume number of the requested item. Volume