ILLiad Customization Keys

Activates Billing functions for Borrowing.

The format for the citation field for each Borrowing transaction in the Billing Manager.

Example = <#LoanTitle><#PhotoJournalTitle>: <#LoanAuthor><#PhotoArticleTitle>

Word document for Billing Manager Borrowing invoice printing.

Example = BorrowingBillingManagerInvoice.doc

Indicate if the user should be shown the UserAccounts page after registration if a default billing account is added for the user. If the key is set to no, the user will be directed to their requested page as it normally would.

Contains the current Reasons for Cancellation information associated with Borrowing request processing.

*Reason numbers for each NVTGC location should be incremental, starting with zero, and should not contain any numerical gaps.

The number of days to subtract from the due date when printing the label. This allows you to back up Due Dates for ILL Customers to allow enough time for ILL to return items to the lender by the real Due Date.

Value for Allow Photocopies on the Check-In from Lending Library form.

Value for Allow Renewals on the Check-In from Lending Library form.

Value for Library Use Only on the Check-In from Lending Library form. A check-in the Library Use Only checkbox on the Borrowing Request form overrides the default setting of NO.

Enables/disables automatic searching of the Copyright Clearance Center database when a record is selected on the Process Copyright screen. This value defaults to Yes.

Specifies the number of pages to be used to request a quick price from the CCC if the transaction does not already specify this value.

Specifies the URL for the CCC Home Page button on the Copyright Processing form. Can instead point to any URL.

Example: http://www.copyright.com/

Specifies the Copyright Clearance Center Location ID to use for CCC order-related actions.

Specifies the Copyright Clearance Center password to use for CCC order-related actions.

Note: This is the same Password used to access the CCC web pages.

The URL for the Atlas Support page with CCC credentials documentation.

Specifies the Copyright Clearance Center Username for your institution to use for CCC order-related actions.

Note: This is the same Username used to access the CCC web pages.

Specifies the location of the Copyright file which holds the copyright query.

Note: This is used only if you are using a Copyright.txt file instead of the built-in copyright query. 

Example: c:\illiad

Specifies the Copyright Query method being used. If set to File, this tells the system to use the CopyrightFile key (above) to find the Copyright.txt file being used.

Example: None, File

Enables/disables the ability in Borrowing to delete invoice information (for invoices sent to you from the Lending Institution), once entered, from the General Update form.

If set to Yes, a delete button appears on the Invoice tab. If set to No, that delete button is not visible.

Specifies the OCLC field where configurable ARM matching criteria can be sent from ILLiad and stored when requests are sent to the Automated Request Manager from a custom ARM match field sending queue. 

Specifies the ISO IP address to use when sending Direct Requests.

Example: isoill.oclc.org:499

Only used if ArielType equals Query. Shows the location of the Ariel installation database in relation to the ILLiad Client. Defaults to (localhost) if importing from the Ariel machine.

Example: The legitimate IP Address or DNS for your Ariel database.

Points the ILLiad Client to the location of the Ariel In folder, from which it will pull Ariel documents into ILLiad.

Example: c:\ariel2\in\ (any local path to the Ariel In folder)

Used to differentiate between Ariel 4.1 and higher, and previous versions of Ariel.

Example: Query, File (Query is used for Ariel Version 4.1 and higher. File is used for earlier versions)

Used by the ILLiad DLL to locate the PDF folder.

If set to Yes, it looks for the PDF folder using the path specified in WebPDFPath. If set to No, the DLL automatically looks for PDFs in the PDF subfolder (/pdf/) where the DLL is running (ex. c:\inetpub\wwwroot\illiad\pdf).

When RemotePDFStorage is set to Yes, the WebPDFPath is used by the Odyssey Protocol as the location to move PDFs during Odyssey processing, and by the ILLiad DLL and the System Manager to locate PDF files.

Example: c:\inetpub\wwwroot\illiad\pdf\

Name of the Word document(s) to open if printing Borrowing Overdue Level 1 letters.

Example: BorrowingOverdueLetter1.doc

Name of the Word document(s) to open if printing Borrowing Overdue Level 2 letters.

Example: BorrowingOverdueLetter2.doc

Name of the Word document(s) to open if printing Borrowing Overdue Level 3 letters.

Example: BorrowingOverdueLetter3.doc

Name of the Word document(s) to open if printing Borrowing Reminder letters.

Example: BorrowingOverdueReminderLetter.doc

Specifies a single document or list of documents separated by commas that will be opened automatically when the notifications are printed in ILLiad.

Example: BorrowingNotify.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the ALA print process happens for an article in ILLiad.

Example: BorrowingALARequests.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the ALA print process happens for a loan in ILLiad.

Example: BorrowingALARequests.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Receives print process happens for an article in ILLiad.

Example: BorrowingArticleLabels.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Receives print process happens for a loan in ILLiad.

Example: BorrowingLoanLabels.doc, BorrowingLoanSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Returns print process happens for an article in ILLiad.

Example: BorrowingReturnAddressLabels.doc, BorrowingReturnSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Returns print process happens for a loan in ILLiad.

Example: BorrowingReturnSlips.doc, BorrowingReturnAddressLabels.doc

A single document or a list of documents separated by commas that will be opened automatically when printing a Borrowing request.

Example: PrintRequest.doc

Specifies the Default System ID that shows on the Request Form. This is typically set to the most frequently used Borrowing system.

Example: CLC, DOC (Docline), LOCL (Local), ISO (ISO ILL), OTH (Other)

Comma separated list of process types in which the title from the request form is copied to the clipboard for searching. Values can be Borrowing, Doc Del, Lending or any combination thereof.

Example: Borrowing, Doc Del, Lending

The format for the citation field for each Document Delivery transaction in the Billing Manager.

Example: <#LoanTitle><#PhotoJournalTitle>: <#LoanAuthor><#PhotoArticleTitle>.

Word document for Billing Manager Doc Del invoice printing.

Example: DocDelBillingManagerInvoice.doc

Specifies a single document or list of documents separated by commas that will be opened automatically when the notifications are printed in ILLiad.

Example: BorrowingNotify.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Stacks Search print process happens for an article in ILLiad.

Example: DocDelArticleSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Stacks Search print process happens for a Loan in ILLiad.

Example: DocDelLoanLabels.doc

A single document or a list of documents separated by commas that will be opened automatically when printing a Doc Del request.

Example: PrintRequest.doc

Contains the current Reasons for Cancellation information associated with Document Delivery request processing.

Important: Reason numbers for each NVTGC location should be incremental, starting with zero, and should not contain any numerical gaps.

Designates the Loan period for Document Delivery.

Note: This key is used for printing purposes only. Document Delivery items should be checked out using the normal Circulation system.

The format for the citation field for each Lending transaction in the Billing Manager.

Example: <#LoanTitle><#PhotoJournalTitle>: <#LoanAuthor><#PhotoArticleTitle>.

Word document for Billing Manager Lending invoice printing.

Example: LendingBillingManagerInvoice.doc

Contains the current reasons and associated values for which one might Cancel Lending requests. These reasons can be mapped to OCLC and Docline Reasons for No.

Important: Reason numbers for each NVTGC location should be incremental, starting with zero, and should not contain any numerical gaps.

Contains the current reasons and associated values for which one might Conditionalize Lending requests. These reasons can be mapped to OCLC and Docline Reasons for No.

Important: Reason numbers for each NVTGC location should be incremental, starting with zero, and should not contain any numerical gaps.

Specifies the values for the Received Via drop down on the Lending Add Request form.

Example: Any pipe separated list of values (Fax | Phone | Mail | ALA)

Specifies the values for the Document Type drop down on the Lending Add Request form.

Example: Any pipe separated list of values (Article | Book | Book Chapter)

Sets the Billing Category that will be assigned by default to new LenderAddresses(ALL) entries.

Example: Any legitimate Billing Category. Examples: Default, In State, etc.

Sets the Shipping Method to be assigned to new Lending Articles upon import by the ILLiad Connection Manager.

Example: Any legitimate Shipping Method. Example: Campus Courier

Sets the Shipping Method to be assigned to new Lending Loans upon import by the ILLiad Connection Manager.

Example: Any legitimate Shipping Method. Example: Campus Courier

Determines whether imported Lending article requests with Ariel in the imported record are automatically marked for delivery via Ariel.

Note: This key overrides the Default Shipping Article value in the Lender Address form.

Name of the Word document(s) to open if printing Lending Overdue Level 1 letters.

Example: LendingOverdueLetter1.doc

Name of the Word document(s) to open if printing Lending Overdue Level 2 letters.

Example: LendingOverdueLetter2.doc

Name of the Word document(s) to open if printing Lending Overdue Level 3 letters.

Example: LendingOverdueLetter3.doc

Name of the Word document(s) to open if printing Lending Reminder letters.

Example: LendingOverdueReminderLetter.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Secondary print process happens for an Article in ILLiad.

Example: LendingArticleSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Secondary print process happens for a Loan in ILLiad.

Example: LendingLoanLabels.doc, LendingLoanSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Shipping Label print process happens for an Article in ILLiad.

Example: LendingArticleShippingLabels.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Shipping Label print process happens for a Loan in ILLiad.

Example: BorrowingLoanLabels.doc, BorrowingLoanSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Stacks Search print process happens for an Article in ILLiad.

Example: LendingArticleSlips.doc

Specifies a single document or a list of documents separated by commas that will be opened automatically when the Stacks Search print process happens for a Loan in ILLiad.

Example: LendingLoanLabels.doc, LendingLoanSlips.doc

A single document or a list of documents separated by commas that will be opened automatically when printing a Lending request.

Example: PrintRequest.doc

Determines whether to allow or disallow new institutions to send Odyssey documents to your server. If set to Automatic, your Odyssey server will accept articles from any institution that sends documents using the Odyssey Protocol. If set to Manual, your Odyssey server will ONLY accept articles from Odyssey senders ALREADY in the OdysseyAccess table. All others will be rejected.

Note: If OdysseyAccept is set to Manual, ALL senders, including any local ILLiad client machines would need to exist in the OdysseyAccess table before being allowed to send Odyssey documents to the ILLiad server.

Determines whether or not to add records to the OdysseyAccess table automatically for Odyssey Senders that have been accepted by the system (determined by the OdysseyAccept value).

Note: This key is used only when the value for the OdysseyAccept key is set to Automatic. If the OdysseyAccept value is later changed to Manual, Odyssey senders already in the OdysseyAccess table will still be accepted.

Contains the current list of institutions and associated IP addresses that will be used to transmit/receive Odyssey documents.

Warning: Shared System Table - Changes may affect other sites in Shared Server Systems.

Specifies the PDF coversheet file on the Odyssey server to be used for Odyssey Doc Del.

Example: ddcoversheet.pdf

Specifies the location on the Odyssey server of the PDF coversheet for Odyssey Doc Del.

Example: c:\illiad\elecdel\

Specifies the PDF coversheet file on the Odyssey server to be used for Odyssey Borrowing.

Example: coversheet.pdf

Specifies the location on the Odyssey server of the PDF coversheet for Odyssey Borrowing.

Example: c:\illiad\elecdel\

The location on the local workstation or remote share of those Doc Del files to be processed by the Electronic Delivery Utility.

Example: c:\illiad\images\

The location on the local workstation or remote share of those Lending files to be processed by the Electronic Delivery Utility.

Example: c:\illiad\images\

Specifies the IP address (recommended) or DNS name for your Odyssey Server.

Note: This is usually your ILLiad Web server.

Specifies the number of times Odyssey will reattempt delivery if the first delivery attempt fails.

Note: This is a global setting for shared server installations.

Specifies the number of seconds between each attempt to send an Odyssey document.

Note: This is a global setting for shared server installations.

Specifies the temporary location on the Odyssey server for the received documents coming from other libraries or from local ILLiad clients for local processing.

Example: c:\illiad\odyssey\receive\

Specifies the temporary location on the Odyssey server for scanned documents being sent to other libraries or to your own users for local processing.

Example: c:\illiad\odyssey\send\

Specifies your Odyssey Server IP address followed by your NVTGC code.

Example: If you are in a single server ILLiad system, that value is 123.123.123.123/ILL (where 123.123.123.123 is your Odyssey server IP address). If you are in a Shared Server ILLiad System, replace ILL in the above example with the appropriate NVTGC code for each site.

Turns on Odyssey Sending and Receiving.

Note: In Shared Server ILLiad systems when ANY NVTGC site(s) wish to use Odyssey, this must be set to Yes for the ILL site. Must be set to Yes for Odyssey to function.

If set to Always, all articles go directly to the customer without staff review. If set to Never, all articles must be reviewed by staff. If set to Trusted, only articles received from Trusted senders bypass staff review.

Example: Always, Never, Trusted

Comma-separated list of System ID's other than OCLC used to determine when to send Article Exchange delivery notifications.

Example: RAPID,OTH,DOC

Local path for Billing Manager print data files.

Example: c:\ILLiad\Print\

If UserPassword is not working for your site, you may experiment with MD5 based on your SMTP server.

Example: UserPassword, MD

Specifies the email server that ILLiad should use to send email notifications and custom emails.

Example: Any legitimate SMTP server to which you have the appropriate permissions and rights to use for sending ILLiad emails.

Specifies the password for ILLiad to use to send email.

Example: Any legitimate password required to access your SMTP Server for sending emails

Specifies the userid for ILLiadto use to send email.

Example: Any legitimate userid that has the appropriate permissions and rights to access your SMTP Server for sending emails

Optionally specifies a central addon repository via UNC path or mapped drive. If present, ILLiad will update its local addon directory with newer versions from this location.

Allows you to configure mappings that will transform the submitted values for specified fields on incoming ILLiad requests before they are stored in the ILLiad database when receiving new transactions from an external application or system through the ILLiad Web Platform.

For more information on configuring this table, see Transforming Incoming Transaction Field Values Using the ApiRequestMapping Table.

This table holds the default dropdown fields that display on the web pages and forms within the client. The Location (NVTGC) field in the client is an exception as it is pulled from the DeliveryLocations table.

Example: Default Values exist for Department, NTVGC, State, and StatusGroup. The Location (NVTGC) field in the client is an exception as it is pulled from the DeliveryLocations table.

Contains all of the Delivery Locations that exist in your ILLiad system. The Location (NVTGC) field in the client is populated from here as well as the Delivery Location field used in Alerts.

Warning: Shared System Table - Changes may affect other sites in Shared Server Systems.

Setting this key to Yes will allow patrons to choose their delivery method for articles each transaction. If set to No (the default), ILLiad will use the delivery method (for articles) associated with a patron's user account and not allow them to choose per transaction.

Note: Previous to ILLiad 8.6, this key was previously named LocalRouting.

Determines is a password expiration is required. If set to Yes, lenders will be prompted to change their password after a certain number of days. If set to No, users will not be prompted to change passwords on a scheduled basis.

Note: If a password change is required, lenders will not be able to navigate away from the password change form. If they attempt to click on any other links in the Web, they will be redirected to the password change form.

Specifies the path to the ILLiad print document templates from the ILLiad Client. This path is then used by the ILLiad Client to auto-open the appropriate print documents for most ILLiad print processes.

Example: \\ILLiadShareprint\, c:\illiad\print\

The directory the client should check for saved custom search files.

Example: Either a local folder or network share

Regular Expression that staff passwords should adhere to. Staff administrators have the option to override password requirements when creating new staff accounts with initial password.

Criteria: (8 characters: 1 uppercase, 1 lowercase, 1 number), Example: (?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,}$

URL used for staff proxies logging into the web as a patron. Defaults to the value of the WebURL key if this key is empty. (The Logon to Web feature was removed from ILLiad 8.3 in version 8.3.2.0; it will be reintroduced in  ILLiad 8.4.)

Example: http://illiad.library.edu/illiad/

Specifies whether or not incoming ISO ILL requests will overwrite the shipping address in the LenderAddresses(ALL) table with the address information given in the request.

Designates the type of currency being used.

Example: USD

Designates whether or not IFM will be used for ISO ILL Borrowing.

This is an ISO ILL system setting. Do not change.

Designates whether or not IFM will be used for ISO ILL Lending.

This is an ISO ILL system setting. Do not change.

Designates whether IFM will be used to pay fees.

Note: This key is only used if you are communicating directly with OCLC via ISO ILL.

Determines if ILLiad automatically attempts to send to the new referred site or if it waits for staff intervention. A Yes value allows the potential lender to route an ISO ILL request locally within a Shared Server system to another site in that system that can supply the requested item. A No value prohibits this.

Note: This key is ignored in Single-Server ILLiad systems.

Specifies your ISO server's IP address and port for return ISO messages.

Example: 123.123.123.123:1611

If you are using SMTP transport for ISO ILL processing, this is the email address that will be used to send and receive ISO ILL requests.

Note: The specified address should be used only for sending and receiving ISO ILL requests.

Specifies the email server that ILLiad should use to send and receive ISO ILL requests.

Example: Any legitimate SMTP server to which you have the appropriate permissions and rights to use for sending and receiving ISO ILL requests.

If you are using SMTP transport for ISO ILL processing, this is the POP password used for checking the email address listed as your ISOSMTPReplyTo address.

Example: Any legitimate password required to access your SMTP Server for sending receiving ISO ILL requests.

If you are using SMTP transport for ISO ILL processing, this is the port used for checking the email address listed as your ISOSMTPReplyTo address.

Example: Any legitimate port used by the email server for sending emails.

If you are using SMTP transport for ISO ILL processing, this is the email address that will sent as a part of the encoded file as the address to which replies will be sent. Note: While this address will typically be identical to the address used for the ISOSMTPFrom key, it is theoretically possible for this to be set to a different address if there is a need to do so.

Example: Any legitimate email address. Note: The specified address should be used only for sending and receiving ISO ILL requests.

If you are using SMTP transport for ISO ILL processing, this is the account/username checked when checking the email address listed as your ISOSMTPReplyTo address.

Example: Any legitimate userid that has the appropriate permissions and rights to access your SMTP Server for sending emails.

The default constant data value used for all article requests sent automatically to OCLC.

Example: DEFAULT

The default constant data value used for all loan requests sent automatically to OCLC.

Example: DEFAULT

Allows the system to automatically choose the constant data record to be used by the ILLiad Client for the sending of Articles.

If this key is used, set cd (Where is the actual name of a legitimate constant data record.) Otherwise this key value will be blank.

Specifies the order of searches attempted by the automatic background search for articles.

Example: OCLC, ISSN, AuthorTitle, DerivedTitle, Keyword, ScanTitle

Specifies the order of searches attempted by the automatic background search for loans.

Example: OCLC, ISSN, AuthorTitle, DerivedTitle, Keyword, ScanTitle

Optional command to choose the constant data record to be used by the ILLiad Connection Manager for Borrowing updating.

If this key is used, set cd (Where is the actual name of a legitimate constant data record.) Otherwise this key value will be blank.

Optional command to choose the constant data record to be used by the ILLiad Connection Manager for Lending updating.

If this key is used, set cd (Where is the actual name of a legitimate constant data record.) Otherwise this key value will be blank.

Allows the system to automatically choose the constant data record to be used by the ILLiad Client for the sending of Loans.

If this key is used, set cd (Where is the actual name of a legitimate constant data record.) Otherwise this key value will be blank.

A single document or a list of documents separated by commas that will be opened automatically when printing a lender address.

Example: PrintAddress.doc

A single document or a list of documents separated by commas that will be opened automatically when printing a user.

Example: PrintUser.doc

The URL location of the Rapid Web Service. Rapid Manager connects to this to process requests.

Example: http://rapid2.library.colostate.edu/rapidapi/apiservice.asmx

This value is used to identify the Borrower and Lender for Odyssey processing. It informs the Borrower which library or institution filled a request. Currently used only for Odyssey transactions, the value is displayed as RAPID: RapidCode with RapidCode being the three-letter symbol assigned by Rapid.

Example: RAPID:XXX

Contains all of the values that govern the automatic routing (System Routing) of transactions to other statuses or Custom Queues.

Warning: Shared System Table - Changes may affect other sites in Shared Server Systems.

This key tells ILLiad which platform configuration entry to use when trying to talk to its own web platform, such as when the ILLiad client needs to use the platform to retrieve external information. The key value should be set to the ID value for the WebPlatformConfig table entry that identifies the ILLiad web platform.

This key determines if the Web Platform requests require the use of SSL. Note: For Shared Servers, this key can't be set individually per site.

Allows you to specify a default service type that can be stored in the transaction record of a request in the Wanted by field. This table is used for printing, processing, and for statistics in Lending and is not a true Billing function.

Note: This table is not typically populated.

The variable ILLiad looks for within the header if RemoteAuthSupport is set to Yes.

Example: HTTP_REMOTE_USER

The URL to send users who are logging out of ILLiad with RemoteAuthSupport set to Yes.

Example: http://www.library.edu/logout.html

The local web path for the directory controlled by remote authentication.

Example: c:\inetpub\wwwroot\illiad\

Tells ILLiad which type of authentication is being used for web users. If the WebAuthType is anything other than ILLiad, the value will be Default. Checking the ILLiad Authentication checkbox on the User form sets the user's AuthType to ILLiad.

Example: ILLiad, Default

Limits access to the ILLiad web to a known list of users. The ILLiad web verifies against the entries in the UserValidation table before allowing users to register or login. (Note that the Blocked field found in this table is NOT USED).