Automated Request Manager - Configuring ILLiad and OCLC Resource Sharing Settings

Print Friendly and PDF Follow

Note: The OCLC Automated Request Manager was formerly known as Direct Request.
For a brief overview of using this feature with ILLiad, see Automation with Direct Request and the Automated Request Manager.

Setting up ILLiad to use the OCLC Automated Request Manager (ARM) allows your ILL operation to implement unmediated ILL Borrowing for any ILLiad transactions that meet your criteria for automatic requesting. This article will provide an overview of the ARM workflow in ILLiad and the configuration steps necessary to implement this feature.


Workflow Overview

When using OCLC ARM with ILLiad, customer requests come in from any of the usual sources, such as the ILLiad web pages, OpenURL, etc., and are routed, either manually or automatically using a routing rule, to a status of Awaiting Direct Request Sending. The ILLiad Connection Manager then automatically selects any transactions at that status and sends them to various OCLC Lenders according to the preferences specified in your institution's OCLC ARM settings. This process works for both loans and articles, as OCLC will choose its lending string for articles based on the volume and issue of the serial request.

After a request is sent out to Lenders, the ILLiad transaction moves to a status of Awaiting Direct Request Lenders, where the ILLiad Connection Manager service assigns an ILL Number, OCLC Number, and the OCLC Lending String from the already sent OCLC request and adds this information to the ILLiad transaction record. The transaction is then moved to the status of Request Sent. As requested items arrive from Lenders, they may be processed and delivered to the requesting customers like any other incoming Borrowing requests.

Using the ILLiad WorkFormMapping Table with ARM

ILLiad will use entries in the WorkFormMapping table configured with the WorkFormTypes OCLC Article and OCLC Loan for direct requests sent to ARM. However, the WorkFormMapping table cannot be used to perform overwrites on bibliographic data for these direct requests as once the request is sent to OCLC, it will be matched with a record in the OCLC database and all bibliographic data for the request will be overwritten with the information in the OCLC record.

If Direct Request Sending to ARM Fails

Requests sent to ARM via the Awaiting Direct Request Sending queue may fail to send if there are problems with the ISBN/ISSN information attached to the ILLiad transaction, or if there is some other problem finding the correct information in the OCLC database. If this happens for a given transaction, OCLC will place the request into the review file and add a note to the record explaining the reason it failed to send. This note is added by OCLC directly into ILLiad and will be reflected in the ILLiad Transaction record immediately. The ILLiad Connection Manager will then download the review request, remove the review file entry for the item, add the OCLC number to the request, and move the transaction to Awaiting Request Processing for standard ILL processing.

Processing Article Requests Electronically through ARM

You can use the OCLC WorldCat Knowledge Base to process and fill article requests electronically through ARM. When an ARM Lender receives a request for an electronic article, ARM has already verified through the WorldCat Knowledge Base and License Manager that the Lender has access to the article and permission to provide it through ILL. The request contains a direct link to the article, which will appear in the Collections sub-tab located within the Detail tab on the request, and without additional checking, the Lender can employ its usual methods to supply the Borrowing library:

Collections_KB_.png


Configuration Overview

Before ILLiad can begin sending requests to the Automated Request Manager, you will need to configure your ARM settings within OCLC to handle ARM processing for loan and/or article requests. The required configuration steps for this process will vary based on whether you are setting up ARM to process loan requests or article requests. To configure ARM for both article and loan requests, both sets of instructions should be followed. Once the necessary OCLC settings have been configured, you will then need to configure several settings in ILLiad to activate these features and begin sending requests to ARM.


Configure OCLC Resource Sharing Settings to Use ARM

The following section will detail the process for configuring the necessary settings in OCLC to use the Automated Request Manager. The required configuration steps for this process will vary based on whether you are configuring ARM to process loan requests or article requests. To configure ARM for both article and loan requests, both sets of instructions should be followed.

Accessing OCLC Resource Sharing Settings from ILLiad

The OCLC Resource Sharing Settings interface (used to add or change Custom Holdings Paths, Custom Holdings Groups, Constant Data, etc.) was removed from within the ILLiad Client with the release of ILLiad 9.1 and replaced with a button that links out to the OCLC Interface where the updated settings are located. As a result, these settings are no longer configured in ILLiad. The OCLC interface to configure these settings can be accessed by clicking the OCLC Resource Sharing Settings button on the System ribbon of the ILLiad Client:

Resource Sharing Settings.png


Configuring OCLC ARM Settings for Loans

All of the steps below must be followed before the OCLC ARM process will work with your ILLiad installation for loan requests:

Loan Configuration Process:

  1. Disable ILL Access in FirstSearch. See Disabling ILL Access in FirstSearch below for more guidance on this process.
  2. Set up an OCLC ARM automation profile for loans. See Setting Up an ARM Automation Profile for Loans below for more guidance on this process
  3. Set up rules governing your OCLC ARM Preferences (Custom Holdings Groups and Paths). See Setting Up ARM Preferences (Custom Holdings) for Loans below for more guidance on this process

Disabling ILL Access in FirstSearch

Disabling the FirstSearch ILL Form will remove this request option from the FirstSearch pages. If these pages are currently being used by your customers to submit requests, this will eliminate that method of requesting ILL materials in favor of using the OpenURL link under External Resources. As such, disabling this method of requesting should be done at the same time you enable OpenURL so your customers will not be overly inconvenienced.

To disable the FirstSearch ILL Form:

  1. Log on to the FirstSearch Administrative pages with your OCLC Authorization and Password
  2. Navigate to the Resource Sharing tab
  3. Locate the checkbox for ILL Access on the right side under the ILL Settings section and uncheck this option

Setting Up an ARM Automation Profile for Loans

You must have at least one Automated Request Manager automation profile for loans set up for OCLC. ARM automation profiles must be set up in the OCLC ARM configuration interface, which can be accessed using the OCLC Resource Sharing Settings button available on the System ribbon of the ILLiad Client, then navigating to Worldshare ILL | Automated Request Manager from the sidebar navigation menu within the OCLC interface (see screenshot below).

The ARM automation profile configured for loans should typically be a fairly simple profile containing few restrictions. It should allow requesting for loans (books) and it is recommended to exclude ARM use for duplicates and for items held by your institution. If multiple ARM automation profiles have already been set up for your institution, it is recommended to review those profiles and attempt to simplify and consolidate them into as few profiles as needed. Most institutions should not need more than two automation profiles -- one for monographs and one for serials.

Note: As patron data is not passed to OCLC from ILLiad, patron information can't be used as a match criterion in ARM. The Route Request to Review action is also unsupported at this time.
For more information on configuring Automated Request Manager automation profiles, see the OCLC documentation

ARM profile.png

Setting Up ARM Preferences (Custom Holdings) for Loans

Rules governing your OCLC ARM preferences (Custom Holdings Groups and Paths) must be set up in the OCLC WorldShare ILL configuration interface, which can be accessed using the OCLC Resource Sharing Settings button available on the System ribbon of the ILLiad Client, then navigating to Worldshare ILL | Custom Holdings Groups/Custom Holdings Paths from the sidebar navigation menu within the OCLC interface (see screenshot below).

For more information on configuring these settings, see the OCLC documentation for Custom Holdings Groups and Custom Holdings Paths

Custom Holdings OCLC.png


Configuring OCLC ARM Settings for Articles

All of the steps below must be followed before the OCLC ARM process will work with your ILLiad installation for article requests as a Borrower. If your institution only intends use ARM as a Lender, only the first 3 requirements apply:

Article Configuration Process:

  1. Disable ILL Access in FirstSearch if you have not done so already. See Disabling ILL Access in FirstSearch in the section above for more guidance on this process
  2. Send a request to OCLC to participate in ARM for articles
  3. Work with OCLC to add article holdings information to the WorldCat Knowledge Base
  4. Activate the link to holdings information in the Knowledge Base. See Activating the Link to Holdings in the Knowledge Base (KB) below for more guidance on this process

    Note: Article holdings information must be added to the Knowledge Base before you will be able to activate the link.
  5. Turn off the deflection of article requests. See Turning Off Deflection of Article Requests below for more guidance on this process
  6. Add or modify an ARM automation profile for articles. See Adding or Modifying the ARM Automation Profile for Articles below for more guidance on this process
  7. Add or modify your OCLC ARM preferences (Custom Holdings Groups and Paths) as needed for articles. See Adding or Modifying ARM Preferences (Custom Holdings) for Articles below for more guidance on this process

Activating the Link to Holdings in the Knowledge Base (KB)

Activate the link to the WorldCat Knowledge Base in the OCLC ILL Options interface, which can be accessed using the OCLC Resource Sharing Settings button available on the System ribbon of the ILLiad Client, then navigating to Worldshare ILL | Interlibrary Loan Options from the sidebar navigation menu within the OCLC interface. Check the On box under the Knowledge Base Active Link section and then scroll down and click Save.

Article holdings information must be added to the Knowledge Base (KB) before you will be able to activate the link in the Administrative Module.

KB Activation.png

Turning Off Deflection of Article Requests

Deflection settings are located in the OCLC Policies Directory, which can be accessed using the Policies Directory button available on the System ribbon of the ILLiad Client, then clicking Policies within the OCLC interface. Ensure your Deflection settings do not prevent you from sending articles (e-serials):

Adding or Modifying the ARM Automation Profile for Articles

You must set up an ARM automation profile for serials within OCLC to process article requests through ARM. ARM automation profiles must be set up in the OCLC ARM configuration interface, which can be accessed using the OCLC Resource Sharing Settings button available on the System ribbon of the ILLiad Client, then navigating to Worldshare ILL | Automated Request Manager from the sidebar navigation menu within the OCLC interface.

The ARM automation profile configured for serials should typically be a fairly simple profile containing few restrictions. It should allow requesting for copies (serials and/or e-serials) and it is recommended to exclude ARM use for duplicates and for items held by your institution. If multiple ARM automation profiles have already been set up for your institution, it is recommended to review those profiles and attempt to simplify and consolidate them into as few profiles as needed. Most institutions should not need more than two automation profiles -- one for monographs and one for serials.

Note: As patron data is not passed to OCLC from ILLiad, patron information can't be used as a match criterion in ARM. The Route Request to Review action is also unsupported at this time.
For more information on configuring Automated Request Manager automation profiles, see the OCLC documentation

ARM profile - Articles.png

Adding or Modifying ARM Preferences (Custom Holdings) for Articles

Rules governing your OCLC ARM preferences (Custom Holdings Groups and Paths) must be set up in the OCLC WorldShare ILL configuration interface, which can be accessed using the OCLC Resource Sharing Settings button available on the System ribbon of the ILLiad Client, then navigating to Worldshare ILL | Custom Holdings Groups/Custom Holdings Paths from the sidebar navigation menu within the OCLC interface (see screenshot below).

When adding lenders for articles to your Custom Holdings Groups and Paths, the KBIL group affiliate symbol is a good resource as it lists all libraries that have added information to OCLC's Knowledge Base.

For more information on configuring these settings, see the OCLC documentation for Custom Holdings Groups and Custom Holdings Paths

Custom Holdings OCLC.png


Configure ILLiad to Use ARM

Once you have configured the necessary OCLC ARM settings for loan and/or article requests, the following steps should be taken in ILLiad to activate the ARM features:

ILLiad Configuration Process:

  1. Configure customization keys affecting the OCLC ARM process. See Configuring Customization Keys Related to ARM below for more guidance on this process
  2. Configure routing rules to send requests to ARM from ILLiad. See Configuring ILLiad to Send Requests to ARM below for more guidance on this process

Configuring Customization Keys Related to ARM

There are two ILLiad customization keys that must be configured in the ILLiad Customization Manager to use ARM:

  • DirectRequestEnabled: Must be set to Yes. This key can be found in the Customization Manager under Borrowing | Direct Request
  • SystemIDOCLCSymbol: Must be set to your OCLC Symbol. This key can be found in the Customization Manager under System | General

Configuring ILLiad to Send Requests to ARM

Once the necessary customization keys have been configured, requests can be routed to the Awaiting Direct Request Sending queue and sent to ARM from ILLiad either manually through manual routing and/or automatically through routing rules configured in the ILLiad Customization Manager.

Manual Routing: Verify 'Awaiting Direct Request Sending' is in the Custom Queues Table

If staff should have the option to manually route requests to ARM via the Awaiting Direct Request Sending queue, a record for this queue must be present in the CustomQueues table in the ILLiad Customization Manager (located under System | Custom Queues). This queue will typically be in the CustomQueues table by default and will not need to be manually created, but can also be added manually if it is not present by following the steps below:

  1. Open the ILLiad Customization Manager
  2. Navigate to the CustomQueues table located under System | Custom Queues
  3. If the Awaiting Direct Request Sending queue is not already in the CustomQueues table, click New Record
  4. Fill out the following configuration settings:
    • QueueName: Awaiting Direct Request Sending
    • ProcessType: Borrowing
    • NVTGC: ILL or the specific NVTGC for which to configure the queue if using a shared server setup
  5. Click Save

Automatic Routing: Activate/Create Routing Rule(s) to Send Transactions to ARM

To automate this feature so that certain transactions are automatically routed to the Awaiting Direct Request Sending queue and sent to ARM, you will need to optionally modify and then activate the default ARM routing rule (below) in the ILLiad Customization Manager. 

Note: The default ARM routing rule in the ILLiad Customization Manager is configured to only send loan requests to ARM from ILLiad. To automate the sending of article requests to ARM from ILLiad, the default routing rule will need to be modified or a new routing rule created to also account for article requests.
The Default ARM Routing Rule (Single-Server)

The default ARM routing rule will route all requests with the request type "Loan" that contain a value in the ISSN field (this field is used to store both ISSN and ISBN data in ILLiad) to the Awaiting Direct Request Sending queue. This rule will exist in the ILLiad Customization Manager's Routing table by default although the RuleActive value will be set to No. To use this rule to send requests to the Awaiting Direct Request Sending queue for fulfillment through ARM, it must be activated by changing RuleActive to Yes (see Activating the Default ARM Routing Rule below for detailed instructions).

Modifying the Default ARM Routing Rule

The routing rule below is only the default routing rule for this function. This routing rule can be modified to use different criteria to determine which requests should be sent to ARM from ILLiad. For example, while the default routing rule limits the use of this feature to loan requests with an ISSN value, it is possible to modify the match string for the rule to also automatically send article requests or requests containing a value in the OCLC Number (ESPNumber) field to ARM as well. 

For more examples of routing rules that can be configured for use with this feature, see Sample Direct Request Routing Rules for the OCLC Automated Request Manager.

Field Name

Entry

RuleNo

0

RuleActive

No

ProcessType

Borrowing

TransactionStatus

Awaiting Request Processing

MatchString

Default value: t.ISSN > '' and t.RequestType = 'Loan' and (t.LendingString = '' or t.LendingString is NULL)

Description: Using this match string, only loan requests containing a value in the ISSN field without a pre-existing lending string will be routed to the Awaiting Direct Request Sending queue and sent to ARM for fulfillment. 

The ISSN field referenced by this match string is used to store both the ISSN value for articles and the ISBN value for loans in ILLiad.  

Note that the part of the match string that reads: and (t.LendingString = '' or t.LendingString is NULL) is necessary in order to prevent the transaction from becoming stuck in a circular logic process. Without this check to ensure that the request does not contain a lending string, it would be possible for requests to continuously cycle through the ARM process and waste system resources.

NewProcessType

Borrowing

NewTransactionStatus

Awaiting Direct Request Sending

RuleDescription

This rule moves all loan requests with a status of Awaiting Request Processing and a value in the ISSN field to Awaiting Direct Request Sending.

Modifying the Default Routing Rule for Shared Server Systems

If only certain sites within a shared server system are using this feature, the match string for the default ARM routing rule should be modified to reference the NVTGC field so that only requests for those sites are sent to ARM. For example, in a shared server system with symbols ABC, XYZ, and PDQ, if ABC and XYZ wanted to use ARM, but PDQ did not, the following should be added to the end of the routing rule's match string:

and u.NVTGC in ('ABC', 'XYZ')

After applying this modification, the entire default match string will be:

t.ISSN > '' and t.RequestType = 'Loan' and (t.LendingString = '' or 
t.LendingString is NULL) and u.NVTGC in ('ABC', 'XYZ')

This would allow the two designated sites (ABC and XYZ) to use this feature without forcing the third site to do so as well. If the above NVTGC reference is not added, the routing rule will affect all sites in the system.

Activating the Default ARM Routing Rule

To activate the default ARM routing rule (or the modified routing rule if you have applied any modification) and begin sending ILLiad requests to ARM for fulfillment:

Warning! Activating this routing rule will automatically send all requests meeting the rule's criteria to ARM for processing. Do not activate the ARM routing rule until you have completed the ARM configuration process in both ILLiad and OCLC.
  1. Open the ILLiad Customization Manager
  2. Navigate to the Routing table located under Routing | Routing
  3. Double-click the default entry in the Routing table for the Direct Request/ARM routing rule
  4. In the Edit Row table that opens at the bottom of the screen, change the RuleActive value from No to Yes
  5. Click outside of the RuleActive row to apply the change
  6. Click Save to activate the routing rule
  7. Requests meeting the routing rule's criteria will now automatically be routed to ARM via the Awaiting Direct Request Sending queue

 

Questions?

If this article didn’t resolve your issue, please contact Atlas Support for assistance:

Contact Support