Email Alert Fields
From WCN
OCLC implementations will configure Patron Alerts, Copyright and Request Emails for you if your workflow requires them. Because the Patron Alerts and Request Emails are highly configurable we have included below the valid database fields that can be use along with the formatting codes.
We don't expect you to submit a coded file; we only ask that you submit a mock email format in word file with the text and fields you would like in the email.
Although NRE can send an alert for every action this is rarely done. Here are some of the common alerts sent to patrons are;
- Inform not supplied - sent when the item is not found in the consortia, End of Rota or not found in consortia
- Overdue - sent to patrons when lenders notify the borrowing library the item is overdue
- Received - sent to patrons when an item is received by the borrowing library
- Forward to ILL - sent to ILL dept if the request is not managed in NRE
- Locally held - sent to patrons if their library owns the item and the request is not valid.
Setting up new patron alerts? Sample alerts can be found for each of the alert types above by clicking on the link. You can then copy an example that most fits your requirements. Then you can edit that example to fit your needs. Once you have a mock up of your alert completed send it to customer support to be configured.
[edit] Line Formatting Codes
I included this section for informational purposes, You are not requeired to submit your alerts already formatted. NRE support will do this for you.
F - Field Value. This should be followed by a string including one of the field values listed below. If none of the parameters are present in the Request then the line is not output.
S - Free text of the email. This should be followed by a string, useful for fixed strings. The format string is always output.
J - Outputs data to the Subject line at the top of the email. The format string is always output – if null, the format string is still output as ‘ILL Request’.
B - Blank lines. This should be followed by a number indicating how many blank lines to leave, or ‘| number’ - which means insert space to line <number> counting from line one of the message downwards.
In addition each string may contain text interspersed with ‘%s’. Each of these marks where the next parameter in the list is to be placed.
Each string should also be encased in double quotes (“).
[edit] Valid Email Format Fields
This table lists the valid email format fields that can be used in message formats. The list is up-to-date as of VDX 4.x
| Seq Number | Request Attribute | Email format field description |
| 1 | Action | Action (current) |
| 2 | AdminMinutesSpent | Administrator Minutes Spent |
| 3 | AdminTimeRate | Administrator Time Rate |
| 4 | AlternativeRotaUserId | Responder Rotat Alternative ID |
| 5 | AnsReasonCond | Answer Reason Conditional |
| 6 | AnsReasonLocs | Answer Reason Locations |
| 7 | AnsReasonRtry | Answer Reason Retry |
| 8 | AnsReasonUnfi | Answer Reason Unfilled |
| 9 | AnsReasonWsup | Answer Reason Will Supply |
| 10 | Answer | Answer |
| 11 | AnswerDate | Answer Date |
| 12 | AnswerEstimate | Answer Estimate |
| 13 | ArielWorkstation | Ariel Workstation |
| 14 | AuthorisationStatus | Authorisation Status |
| 15 | AuthorisedByName | Authorised by Name |
| 16 | BaseCost | Base Cost |
| 17 | BillATP | Billing Address Type |
| 18 | BillAddr | Billing Address |
| 19 | BillAddrCat | Billing Address Category |
| 20 | Bill_Email | Billing Email |
| 21 | Bill_Fax | Billing Fax |
| 22 | Bill_Ftp | Billing FTP |
| 23 | Bill_PostCode | Billing Post Code |
| 24 | Bill_Telephone | Billing Telephone |
| 25 | CanSendCheckedIn | Can Send Checked In |
| 26 | CanSendRecv | Can Send Received |
| 27 | CanSendRetn | Can Send Returned |
| 28 | CanSendShipped | Can Send Shipped |
| 29 | CheckInDate | Check In Date |
| 30 | CirculatingItem | Circulating Item |
| 31 | ClientAltBarcode | Client Alternate Barcode |
| 32 | ClientAuthService | Client Authorisation Service |
| 33 | ClientBarcode | Client Barcode |
| 34 | ClientBillATP | Client Billing Address Type |
| 35 | ClientBillAddr | Client Billing Address |
| 36 | ClientBillingMethod | Client Billing Method |
| 37 | ClientCopyrightType | Client Copyright Type |
| 38 | ClientDelATP | Client Delivery Address Type |
| 39 | ClientDelAddr | Client Delivery Address |
| 40 | ClientEmail | Client Email |
| 41 | ClientId | Client Id |
| 42 | ClientName | Client Name |
| 43 | ClientPassword | Client Password |
| 44 | ClientSeccode | Cient Second Code |
| 45 | ClientStatus | Client Status |
| 46 | ClientValidate | Client Validate |
| 47 | Client_Bill_Email | Client Billing Email |
| 48 | Client_Bill_Fax | Client Billing Fax |
| 49 | Client_Bill_Ftp | Client Billing FTP |
| 50 | Client_Bill_PostCode | Client Billing Postcode |
| 51 | Client_Bill_Telephone | Client Billing Telephone |
| 52 | Client_Del_Email | Client Delivery Email |
| 53 | Client_Del_Fax | Client Delivery Fax |
| 54 | Client_Del_Ftp | Client Delivery FTP |
| 55 | Client_Del_PostCode | Client Delivery Post Code |
| 56 | Client_Del_Telephone | Client Delivery Telephone |
| 57 | CopyRight | Copyright |
| 58 | CopyrightFee | Copyright Fee |
| 59 | CopyrightNotifications | Copyright Notifications |
| 60 | CopyrightStatus | Copyright Status |
| 61 | CostAdj | Cost Adj |
| 62 | CostCurrency | Cost Currency |
| 63 | CostToRequester | Cost to Requester |
| 64 | CostToUser | Cost to User |
| 65 | CurServiceTp | Current Service Type |
| 66 | DamagedUnits | Damaged Units |
| 67 | DateShipped | Date Shipped |
| 68 | DelATP | Delivery Address Type |
| 69 | DelAddr | Delivery Address |
| 70 | Del_Email | Delivery Email |
| 71 | Del_Fax | Delivery Fax |
| 72 | Del_Ftp | Delivery FTP |
| 73 | Del_PostCode | Delivery Postcode |
| 74 | Del_Telephone | Delivery Telephone |
| 75 | DeliveryAddrCat | Delivery Address Category |
| 76 | DeliveryLocator | Delivery Locator |
| 77 | DesiredDueDate | Desired Due Date |
| 78 | Direction | Direction |
| 79 | DueDate | Due Date |
| 80 | EnteredByName | Entered By Name |
| 81 | EntryDate | Entry Date |
| 82 | ErrorReportCode | Error Report Code |
| 83 | ErrorReportCorrel | Error Report Correl |
| 84 | ErrorReportString | Error Report String |
| 85 | ExpiryDate | Expiry Date |
| 86 | ExpiryType | Expiry Type |
| 87 | Forward | Forward |
| 88 | HasBeenRetried | Has Been Retired |
| 89 | HeldItem | Held Item |
| 90 | HeldMediumType | Held Medium Type |
| 91 | Hold | Hold |
| 92 | IfmResponseId | IFM Response ID |
| 93 | IfmTimestamp | IFM Timestamp |
| 94 | IllNotes | ILL Notes |
| 95 | IllPatronNotes | ILL Patron Notes |
| 96 | IllPrivateNotes | ILL Private Notes |
| 97 | InsuredCurrency | Insured Currency |
| 98 | LocalControlNumbers | Local Control Numbers |
| 99 | LocalDueDate | Local Due Date |
| 100 | LockId | Lock ID |
| 101 | MaterialType | Material Type |
| 102 | Message_Infotype | Message Infotype |
| 103 | NationalControlNumbers | National Control Numbers |
| 104 | NeedDate | Need by Date |
| 105 | NewStatus | New Status |
| 106 | OldStatus | Old Status |
| 107 | OlibDomain | OLIB Domain |
| 108 | OrigExpiryDate | Original Expiry Date |
| 109 | OrigServiceDate | Original Service Date |
| 110 | PMES1 | PMES1 |
| 111 | PMES2 | PMES2 |
| 112 | PatronMaxCost | Patron Max Cost |
| 113 | PatronMaxCostCurr | Patron Max Cost Currency |
| 114 | PaymentProvided | Payment Provided |
| 115 | PickupLocation | Pickup Location |
| 116 | ReasonNoReport | Reason No Report |
| 117 | RecDate | Received Date |
| 118 | RecipAgree | Reciprocal Agreement |
| 119 | Renewable | Renewable |
| 120 | RepeatedMessage | Repeated Message |
| 121 | ReqATP | Requester Address Type |
| 122 | ReqAccount | Requester Account |
| 123 | ReqAdditional | Requester Additional |
| 124 | ReqAddr | Requester Address |
| 125 | ReqAddrCat | Requester Address Categories |
| 126 | ReqAnswerLocs | Requester Answer Location |
| 127 | ReqAnswerLocsList | Requester Answer Locations List |
| 128 | ReqArticleAuthor | Requested Article Author |
| 129 | ReqArticleTitle | Requested Article Title |
| 130 | ReqAuthor | Requested Author |
| 131 | ReqBNR | Requested BNR |
| 132 | ReqBody | Sponsoring Body |
| 133 | ReqCDRNumber | Request CDR Number |
| 134 | ReqCDUitleenNumber | Request CD Uitleen |
| 135 | ReqCheckedIn | Request Checked In |
| 136 | ReqClassmark | Request Classmark |
| 137 | ReqCopyrightSubType | Request Copyright Sub Type |
| 138 | ReqCopyrightType | Request Copyright Type |
| 139 | ReqDediconNumber | Request Dedicon Number |
| 140 | ReqDelAddrCode | Requester Delivery Address Code |
| 141 | ReqDeliveryMethod | Requester Delivery Method |
| 142 | ReqDeliveryParam | Requester Delivery Parameter |
| 143 | ReqEdition | Requested Edition |
| 144 | ReqGroupId | Request Group ID |
| 145 | ReqISBN | Request ISBN |
| 146 | ReqISMN | Request ISMN |
| 147 | ReqISSN | Request ISSN |
| 148 | ReqIdString | Request ID String |
| 149 | ReqIssueTitle | Request Issue Title |
| 150 | ReqItemDescription | Request Item Description |
| 151 | ReqItemFormatCode | Request Item Format Code |
| 152 | ReqLanguageCode | Request Language Code |
| 153 | ReqMaxCostCurr | Request Max Cost Currency |
| 154 | ReqMediaCount | Request Media Count |
| 155 | ReqMediaType1 | Request Media Type Preferences 1 |
| 156 | ReqMediaType2 | Request Media Type Preferences 2 |
| 157 | ReqMediaType3 | Request Media Type Preferences 3 |
| 158 | ReqMediaType4 | Request Media Type Preferences 4 |
| 159 | ReqMediaType5 | Request Media Type Preferences 5 |
| 160 | ReqMediaType6 | Request Media Type Preferences 6 |
| 161 | ReqMediaType7 | Request Media Type Preferences 7 |
| 162 | ReqName | Requester Name |
| 163 | ReqNameType | Requester Name Type |
| 164 | ReqNumber | Request Number |
| 165 | ReqObjectTp | Request Object Type |
| 166 | ReqOrigIdStr | Request Original ID String |
| 167 | ReqOrigName | Request Original Name |
| 168 | ReqOrigNameType | Request Original Name Type |
| 169 | ReqOrigSymbol | Request Original Symbol |
| 170 | ReqOrigSymbolType | Request Original Symbol Type |
| 171 | ReqPPN | Requested PPN |
| 172 | ReqPagination | Request Pagination |
| 173 | ReqPartPubDate | Request Part Publication Date |
| 174 | ReqPassword | Request Password |
| 175 | ReqPerformer | Request Performer |
| 176 | ReqPubDate | Request Publication Date |
| 177 | ReqPubPlace | Request Publication Place |
| 178 | ReqPublisher | Request Publisher |
| 179 | ReqSerialTitle | Request Serial Title |
| 180 | ReqServiceCostSymbol | Request Service Cost Symbol |
| 181 | ReqShelf | Request Shelf |
| 182 | ReqShipped | Request Shipped |
| 183 | ReqSubTitle | Request Subtitle |
| 184 | ReqSymbol | Request Symbol |
| 185 | ReqTitle | Request Title |
| 186 | ReqUniversalProductCode | Request Universal Product Code |
| 187 | ReqVerifySource | Request Verify Source |
| 188 | Req_Dept | Requester Department |
| 189 | Req_Email | Requester Email |
| 190 | Req_Fax | Requester Fax |
| 191 | Req_Ftp | Requester FTP |
| 192 | Req_PostCode | Requester Post Code |
| 193 | Req_Telephone | Requester Telephone |
| 194 | RequestTerminated | Request Terminated |
| 195 | RequestTerminatedBanner | Request Terminated Banner |
| 196 | RequesterBillingMethod | Requester Billing Method |
| 197 | RequesterExtRefId | Requester External Refference ID |
| 198 | RequesterPaymenttp | Requester Payment Type |
| 199 | ResAccount | Responder Account |
| 200 | ResGroupId | Responder Group ID |
| 201 | ResPassword | Responder Password |
| 202 | ReservationID | Reservation ID |
| 203 | RespIdString | Responder ID String |
| 204 | RespName | Responder Name |
| 205 | RespNameType | Responder Name Type |
| 206 | RespSymbol | Responder Symbol |
| 207 | ResponderReceived | Responder Received |
| 208 | ResponderReturned | Responder Returned |
| 209 | ResultsExp | ResultsExp |
| 210 | RetCarrier | RetCarrier |
| 211 | Retry | Retry |
| 212 | ReturnDate | Return Date |
| 213 | ReturnToAddr | Return To Address |
| 214 | ReturnToAddrCat | Return to Address Category |
| 215 | ReturnTo_Email | Return to Email |
| 216 | ReturnTo_Fax | Return to Fax |
| 217 | ReturnTo_Ftp | Return to FTP |
| 218 | ReturnTo_PostCode | Return to Postcode |
| 219 | ReturnTo_Telephone | Return to Telephone |
| 220 | ReturnVia | Return Via |
| 221 | RotaUsed | Rota Used |
| 222 | RotaWaiting | Rota Waiting |
| 223 | SMES1 | SMES1 |
| 224 | SR_Author | SR_Author |
| 225 | SR_CurrentStatus | SR_CurrentStatus |
| 226 | SR_DateLastTrans | SR_DateLastTrans |
| 227 | SR_DateRequested | SR_DateRequested |
| 228 | SR_MRS | SR_MRS |
| 229 | SR_MRSDate | SR_MRSDate |
| 230 | SR_MRSInitIdStr | SR_MRSInitIdStr |
| 231 | SR_MRSInitName | SR_MRSInitName |
| 232 | SR_MRSInitNameTp | SR_MRSInitNameTp |
| 233 | SR_MRSInitSymbol | SR_MRSInitSymbol |
| 234 | SR_MRSNotes | SR_MRSNotes |
| 235 | SR_ShipServiceTp | SR_ShipServiceTp |
| 236 | SR_Title | SR_Title |
| 237 | SR_TranResults | SR_TranResults |
| 238 | ServiceLevel | Service Level |
| 239 | ServiceTimeDate | Service Time Date |
| 240 | ServiceTp1 | Service Type 1 |
| 241 | ServiceTp2 | Service Type 2 |
| 242 | ServiceTp3 | Service Type 3 |
| 243 | ServiceTp4 | Service Type 4 |
| 244 | ServiceTp5 | Service Type 5 |
| 245 | ShipCarrier | Ship |
| 246 | ShipConditions | Ship Conditions |
| 247 | ShipDeliveryMethod | Shipped Delivery Method |
| 248 | ShipObjectTp | Shipping Object Type |
| 249 | ShipServiceTp | Shipping Service Type |
| 250 | ShippedItem | Shipped Item |
| 251 | ShippedMediumType | Shipped Medium Type |
| 252 | ShippedUnits | Shipped Units |
| 253 | SipActionOk | SIP Action OK |
| 254 | SipProcessed | SIP Processed |
| 255 | Stq | STQ |
| 256 | SupIdString | Supplier String |
| 257 | SupName | Supplier Name |
| 258 | SupNameType | Supplier Name Type |
| 259 | SupSymbol | Supplier Symbol |
| 260 | SuppRefAuth | Supplier Reference Auth |
| 261 | SuppRefKey | Supplier Reference Key |
| 262 | TemporaryCopy | Temporary Copy |
| 263 | TerminationDate | Termination Date |
| 264 | Tgq | TGQ |
| 265 | Tq | TQ |
| 266 | TranResults | Transaction Results |
| 267 | TranType | Transaction Type |
| 268 | UserChargeAccount | User Charge Account |
| 269 | UserPaymenttp | User Payment type |
| 270 | UserRefAuth | User Reference Authority |
| 271 | UserRefKey | User Reference Key |
| 272 | UserWillPayFee | User Will Pay Fee |
| 273 | VatCode | Tax Code |
| 274 | VatCost | Tax Cost |
| 275 | VatRate | Tax Rate |
| 276 | WillPayFee | Will Pay Fee |
| 277 | iAuditNo | iAuditNo |
| 278 | iBlFormNo | iBlFormNo |
| 279 | iBorrower | iBorrower |
| 280 | iCharge | iCharge |
| 281 | iChargeUnits | iChargeUnits |
| 282 | iCorrespondingIllNo | iCorrespondingIllNo |
| 283 | iCost | iCost |
| 284 | iCostExVat | iCostExVat |
| 285 | iExpiryDays | iExpiryDays |
| 286 | iIllNo | ILL Number |
| 287 | iInsuredAmount | iInsuredAmount |
| 288 | iOrigIllNo | iOrigIllNo |
| 289 | iRejectedAuditNo | iRejectedAuditNo |
| 290 | iReqMaxCost | iReqMaxCost |
| 291 | iRotaPos | iRotaPos |
| 292 | iTitleNo | iTitleNo |
| 293 | iTotalCharge | iTotalCharge |
