Email Alert Fields

From WCN

Jump to: navigation, search

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 NumberRequest AttributeEmail format field description
1ActionAction (current)
2AdminMinutesSpentAdministrator Minutes Spent
3AdminTimeRateAdministrator Time Rate
4AlternativeRotaUserIdResponder Rotat Alternative ID
5AnsReasonCondAnswer Reason Conditional
6AnsReasonLocsAnswer Reason Locations
7AnsReasonRtryAnswer Reason Retry
8AnsReasonUnfiAnswer Reason Unfilled
9AnsReasonWsupAnswer Reason Will Supply
10AnswerAnswer
11AnswerDateAnswer Date
12AnswerEstimateAnswer Estimate
13ArielWorkstationAriel Workstation
14AuthorisationStatusAuthorisation Status
15AuthorisedByNameAuthorised by Name
16BaseCostBase Cost
17BillATPBilling Address Type
18BillAddrBilling Address
19BillAddrCatBilling Address Category
20Bill_EmailBilling Email
21Bill_FaxBilling Fax
22Bill_FtpBilling FTP
23Bill_PostCodeBilling Post Code
24Bill_TelephoneBilling Telephone
25CanSendCheckedInCan Send Checked In
26CanSendRecvCan Send Received
27CanSendRetnCan Send Returned
28CanSendShippedCan Send Shipped
29CheckInDateCheck In Date
30CirculatingItemCirculating Item
31ClientAltBarcodeClient Alternate Barcode
32ClientAuthServiceClient Authorisation Service
33ClientBarcodeClient Barcode
34ClientBillATPClient Billing Address Type
35ClientBillAddrClient Billing Address
36ClientBillingMethodClient Billing Method
37ClientCopyrightTypeClient Copyright Type
38ClientDelATPClient Delivery Address Type
39ClientDelAddrClient Delivery Address
40ClientEmailClient Email
41ClientIdClient Id
42ClientNameClient Name
43ClientPasswordClient Password
44ClientSeccodeCient Second Code
45ClientStatusClient Status
46ClientValidateClient Validate
47Client_Bill_EmailClient Billing Email
48Client_Bill_FaxClient Billing Fax
49Client_Bill_FtpClient Billing FTP
50Client_Bill_PostCodeClient Billing Postcode
51Client_Bill_TelephoneClient Billing Telephone
52Client_Del_EmailClient Delivery Email
53Client_Del_FaxClient Delivery Fax
54Client_Del_FtpClient Delivery FTP
55Client_Del_PostCodeClient Delivery Post Code
56Client_Del_TelephoneClient Delivery Telephone
57CopyRightCopyright
58CopyrightFeeCopyright Fee
59CopyrightNotificationsCopyright Notifications
60CopyrightStatusCopyright Status
61CostAdjCost Adj
62CostCurrencyCost Currency
63CostToRequesterCost to Requester
64CostToUserCost to User
65CurServiceTpCurrent Service Type
66DamagedUnitsDamaged Units
67DateShippedDate Shipped
68DelATPDelivery Address Type
69DelAddrDelivery Address
70Del_EmailDelivery Email
71Del_FaxDelivery Fax
72Del_FtpDelivery FTP
73Del_PostCodeDelivery Postcode
74Del_TelephoneDelivery Telephone
75DeliveryAddrCatDelivery Address Category
76DeliveryLocatorDelivery Locator
77DesiredDueDateDesired Due Date
78DirectionDirection
79DueDateDue Date
80EnteredByNameEntered By Name
81EntryDateEntry Date
82ErrorReportCodeError Report Code
83ErrorReportCorrelError Report Correl
84ErrorReportStringError Report String
85ExpiryDateExpiry Date
86ExpiryTypeExpiry Type
87ForwardForward
88HasBeenRetriedHas Been Retired
89HeldItemHeld Item
90HeldMediumTypeHeld Medium Type
91HoldHold
92IfmResponseIdIFM Response ID
93IfmTimestampIFM Timestamp
94IllNotesILL Notes
95IllPatronNotesILL Patron Notes
96IllPrivateNotesILL Private Notes
97InsuredCurrencyInsured Currency
98LocalControlNumbersLocal Control Numbers
99LocalDueDateLocal Due Date
100LockIdLock ID
101MaterialTypeMaterial Type
102Message_InfotypeMessage Infotype
103NationalControlNumbersNational Control Numbers
104NeedDateNeed by Date
105NewStatusNew Status
106OldStatusOld Status
107OlibDomainOLIB Domain
108OrigExpiryDateOriginal Expiry Date
109OrigServiceDateOriginal Service Date
110PMES1PMES1
111PMES2PMES2
112PatronMaxCostPatron Max Cost
113PatronMaxCostCurrPatron Max Cost Currency
114PaymentProvidedPayment Provided
115PickupLocationPickup Location
116ReasonNoReportReason No Report
117RecDateReceived Date
118RecipAgreeReciprocal Agreement
119RenewableRenewable
120RepeatedMessageRepeated Message
121ReqATPRequester Address Type
122ReqAccountRequester Account
123ReqAdditionalRequester Additional
124ReqAddrRequester Address
125ReqAddrCatRequester Address Categories
126ReqAnswerLocsRequester Answer Location
127ReqAnswerLocsListRequester Answer Locations List
128ReqArticleAuthorRequested Article Author
129ReqArticleTitleRequested Article Title
130ReqAuthorRequested Author
131ReqBNRRequested BNR
132ReqBodySponsoring Body
133ReqCDRNumberRequest CDR Number
134ReqCDUitleenNumberRequest CD Uitleen
135ReqCheckedInRequest Checked In
136ReqClassmarkRequest Classmark
137ReqCopyrightSubTypeRequest Copyright Sub Type
138ReqCopyrightTypeRequest Copyright Type
139ReqDediconNumberRequest Dedicon Number
140ReqDelAddrCodeRequester Delivery Address Code
141ReqDeliveryMethodRequester Delivery Method
142ReqDeliveryParamRequester Delivery Parameter
143ReqEditionRequested Edition
144ReqGroupIdRequest Group ID
145ReqISBNRequest ISBN
146ReqISMNRequest ISMN
147ReqISSNRequest ISSN
148ReqIdStringRequest ID String
149ReqIssueTitleRequest Issue Title
150ReqItemDescriptionRequest Item Description
151ReqItemFormatCodeRequest Item Format Code
152ReqLanguageCodeRequest Language Code
153ReqMaxCostCurrRequest Max Cost Currency
154ReqMediaCountRequest Media Count
155ReqMediaType1Request Media Type Preferences 1
156ReqMediaType2Request Media Type Preferences 2
157ReqMediaType3Request Media Type Preferences 3
158ReqMediaType4Request Media Type Preferences 4
159ReqMediaType5Request Media Type Preferences 5
160ReqMediaType6Request Media Type Preferences 6
161ReqMediaType7Request Media Type Preferences 7
162ReqNameRequester Name
163ReqNameTypeRequester Name Type
164ReqNumberRequest Number
165ReqObjectTpRequest Object Type
166ReqOrigIdStrRequest Original ID String
167ReqOrigNameRequest Original Name
168ReqOrigNameTypeRequest Original Name Type
169ReqOrigSymbolRequest Original Symbol
170ReqOrigSymbolTypeRequest Original Symbol Type
171ReqPPNRequested PPN
172ReqPaginationRequest Pagination
173ReqPartPubDateRequest Part Publication Date
174ReqPasswordRequest Password
175ReqPerformerRequest Performer
176ReqPubDateRequest Publication Date
177ReqPubPlaceRequest Publication Place
178ReqPublisherRequest Publisher
179ReqSerialTitleRequest Serial Title
180ReqServiceCostSymbolRequest Service Cost Symbol
181ReqShelfRequest Shelf
182ReqShippedRequest Shipped
183ReqSubTitleRequest Subtitle
184ReqSymbolRequest Symbol
185ReqTitleRequest Title
186ReqUniversalProductCodeRequest Universal Product Code
187ReqVerifySourceRequest Verify Source
188Req_DeptRequester Department
189Req_EmailRequester Email
190Req_FaxRequester Fax
191Req_FtpRequester FTP
192Req_PostCodeRequester Post Code
193Req_TelephoneRequester Telephone
194RequestTerminatedRequest Terminated
195RequestTerminatedBannerRequest Terminated Banner
196RequesterBillingMethodRequester Billing Method
197RequesterExtRefIdRequester External Refference ID
198RequesterPaymenttpRequester Payment Type
199ResAccountResponder Account
200ResGroupIdResponder Group ID
201ResPasswordResponder Password
202ReservationIDReservation ID
203RespIdStringResponder ID String
204RespNameResponder Name
205RespNameTypeResponder Name Type
206RespSymbolResponder Symbol
207ResponderReceivedResponder Received
208ResponderReturnedResponder Returned
209ResultsExpResultsExp
210RetCarrierRetCarrier
211RetryRetry
212ReturnDateReturn Date
213ReturnToAddrReturn To Address
214ReturnToAddrCatReturn to Address Category
215ReturnTo_EmailReturn to Email
216ReturnTo_FaxReturn to Fax
217ReturnTo_FtpReturn to FTP
218ReturnTo_PostCodeReturn to Postcode
219ReturnTo_TelephoneReturn to Telephone
220ReturnViaReturn Via
221RotaUsedRota Used
222RotaWaitingRota Waiting
223SMES1SMES1
224SR_AuthorSR_Author
225SR_CurrentStatusSR_CurrentStatus
226SR_DateLastTransSR_DateLastTrans
227SR_DateRequestedSR_DateRequested
228SR_MRSSR_MRS
229SR_MRSDateSR_MRSDate
230SR_MRSInitIdStrSR_MRSInitIdStr
231SR_MRSInitNameSR_MRSInitName
232SR_MRSInitNameTpSR_MRSInitNameTp
233SR_MRSInitSymbolSR_MRSInitSymbol
234SR_MRSNotesSR_MRSNotes
235SR_ShipServiceTpSR_ShipServiceTp
236SR_TitleSR_Title
237SR_TranResultsSR_TranResults
238ServiceLevelService Level
239ServiceTimeDateService Time Date
240ServiceTp1Service Type 1
241ServiceTp2Service Type 2
242ServiceTp3Service Type 3
243ServiceTp4Service Type 4
244ServiceTp5Service Type 5
245ShipCarrierShip
246ShipConditionsShip Conditions
247ShipDeliveryMethodShipped Delivery Method
248ShipObjectTpShipping Object Type
249ShipServiceTpShipping Service Type
250ShippedItemShipped Item
251ShippedMediumTypeShipped Medium Type
252ShippedUnitsShipped Units
253SipActionOkSIP Action OK
254SipProcessedSIP Processed
255StqSTQ
256SupIdStringSupplier String
257SupNameSupplier Name
258SupNameTypeSupplier Name Type
259SupSymbolSupplier Symbol
260SuppRefAuthSupplier Reference Auth
261SuppRefKeySupplier Reference Key
262TemporaryCopyTemporary Copy
263TerminationDateTermination Date
264TgqTGQ
265TqTQ
266TranResultsTransaction Results
267TranTypeTransaction Type
268UserChargeAccountUser Charge Account
269UserPaymenttpUser Payment type
270UserRefAuthUser Reference Authority
271UserRefKeyUser Reference Key
272UserWillPayFeeUser Will Pay Fee
273VatCodeTax Code
274VatCostTax Cost
275VatRateTax Rate
276WillPayFeeWill Pay Fee
277iAuditNoiAuditNo
278iBlFormNoiBlFormNo
279iBorroweriBorrower
280iChargeiCharge
281iChargeUnitsiChargeUnits
282iCorrespondingIllNoiCorrespondingIllNo
283iCostiCost
284iCostExVatiCostExVat
285iExpiryDaysiExpiryDays
286iIllNoILL Number
287iInsuredAmountiInsuredAmount
288iOrigIllNoiOrigIllNo
289iRejectedAuditNoiRejectedAuditNo
290iReqMaxCostiReqMaxCost
291iRotaPosiRotaPos
292iTitleNoiTitleNo
293iTotalChargeiTotalCharge
Personal tools