Retrieval Request Parameters

The Retrieval Request group of parameters is used by the web server to establish a connection to the Retrieval Request root directory. When a digital resource is not available for immediate download (for example, not found in the location defined by the mapping rule), the user has an opportunity to create a retrieval request that will be sent to the Archivist. The Archivist uses the Retrieval Request root directory as a destination location for all processed retrieval requests, i.e. copies of the requested digital resources. In its turn, the web server will scan this root directory for newly created digital resources and make them available by moving to the user’s downloads area.

Setting Retrieval Request Parameters

1. Open the Image Portal Configuration Page.

2. Scroll down to the section marked “Retrieval Request Parameters”.

3. Select a protocol for the Image Portal Web Server to use to access the Retrieval Requests root directory. Available options are SMB and AFP.

4. Type the path to the Retrieval Request root directory: either “\\<Server_Name>\<Share_Name>” for SMB protocol or “<Server_Name>:<Share_Name>” for AFP protocol.

5. In the user name and password fields for the Retrieval Requests root directory, type the access credentials you want the web server to use when accessing the Retrieval Requests root directory. Depending on the security and share settings of the Retrieval Requests root directory, name and password may not be required. This can be any directory you want to create and share for the purposes of processing files associated with Retrieval Requests.

6. Click Test to test the retrieval request parameters defined thus far. A new browser window will open (below left).

Click the hyperlink in the initial test window. This will attempt to access the download directory based on the download parameters specified in this section of the configuration page. If the test is successful, continue on to the next step. If the test is not successful, check your retrieval request parameters to see if there is an error in any of the fields and test again once you have made any changes.

7. Type the HTTP address of the MetaCommunications Image Portal. This will be used by an external SQL Server Agent job responsible for informing the web server of digital resources added to the Retrieval Requests root directory and ready to be moved to the downloads area.

8. Type the text you want to appear in email notification “From” fields. Email notifications sent to users retrieving files from Image Portal have this text in the email’s “From” field.

9. Type the text you want to appear in email notification “Subject” fields. Email notifications sent to users retrieving files from Image Portal have this text in the email’s Subject line.

10. Modify the email notification message text in the Email Notification Body field. This text contains special variables:

@web_root : Displays the location on which the files requested to be retrieved reside.

@files : Lists the files requested for retrieval.

@archive_name : Displays the name of the retrieval request archive package.

@download_link: Displays a link to the Retrieval Request Root Directory for accessing the archive package.

@request_id : The ID number of the Retrieval Request.

@requested_date : The date on which the Retrieval Request was created.

11. Save the Retrieval Request Parameters settings by clicking Save. Continue on to “Additional Parameters”.