Sign in

Introducing

Ideagen Community

Introducing

Ideagen Community

Articles in this section

See more
  1. Q-Pulse
  2. Q-Pulse Windows
  3. IT Guide
  4. Installation

How to Set-up and Configure the Document Retrieval Service (DRS)

Alan Blair
  • Updated
Follow
Who is this article for?

 IT Personnel looking to install DRS to access Q-Pulse documents.

 Server access is required.

The Document Retrieval Service (DRS) is a free optional add-on that can be installed on your server in order to gain immediate access to your document attachments.  

This article does not provide any details on how to use the DRS and instead focuses on how to install the tool. For details on using DRS please visit How to Use the Document Retrieval Service (DRS)

This article is split into 5 sections:

  1. Minimum Requirements
  2. How to Install DRS
  3. How to Configure Authentication
  4. How to Update the Database Connected to DRS
  5. Further Reading

1. Minimum Requirements

The Document Retrieval Service is version specific, meaning you will need to ensure the version of DRS installed matches the version of Q-Pulse installed.

In order to install the DRS, you will require:

  • Q-Pulse Server version 5.70 or higher.
  • Internet Information Services (IIS) version 7.0 or later.

Please visit the DRS Download Centre to download the version of DRS compatible with your version of Q-Pulse.

2. How to Install DRS

To install the Document Retrieval Service:

  1. Download the installation files relevant to your version of Q-Pulse from the DRS Download Centre.
  2. Run the setup.exe file.
  3. When prompted, select the path to install the DRS. By default, this will be C:\inetpub\wwwroot\qpulsedocumentservice.

mceclip0.png

  1. Follow the on-screen instructions to specify the location of your Q-Pulse server.
Note: Once the installation has been completed you can access the DRS via http://<servername>/qpulsedocumentservice

3. How to Configure Authentication

The Document Retrieval Service can be configured with a few different authentication methods. It is important that these compliment the authentication method configured in your Q-Pulse system.

Example: If your Q-Pulse system is using Q-Pulse authentication then DRS cannot be configured to use Windows Prompted authentication. To confirm your authentication method please review your Settings and Defaults section of the Q-Pulse Administration module.

3.1. Windows Prompted Authentication

  1. Navigate to Control Panel, Administrative Tools, then open Internet Information Services (IIS) Manager.
  2. Locate the QPulseDocumentService entry under the ‘Sites’ virtual folder in the ‘Connections’ pane on the left.
  3. Open the ‘Authentication’ module.
  4. Enable Anonymous authentication and disable all other authentication methods.

3.2. Q-Pulse Authentication

  1. Navigate to Control Panel, Administrative Tools, then open Internet Information Services (IIS) Manager.
  2. Locate the QPulseDocumentService entry under the ‘Sites’ virtual folder in the ‘Connections’ pane on the left.
  3. Open the ‘Authentication’ module.
  4. Enable Anonymous authentication and disable all other authentication methods.

3.3.Windows Automatic Authentication

  1. Navigate to Control Panel, Administrative Tools, then open Internet Information Services (IIS) Manager.
  2. Locate the QPulseDocumentService entry under the ‘Sites’ virtual folder in the ‘Connections’ pane on the left
  3. Open the ‘Authentication’ module.
  4. Enable ASP.NET Impersonation and Windows Authentication and disable all other authentication methods.

3.4. Pre-Defined Q-Pulse Account

The DRS can be configured to use a pre-defined Q-Pulse user account.  If configured correctly, the user accessing documents via the DRS will not be asked for a username or password and will instead be able to see all of the documents available to the user account held in the configuration files.

Important Note: A pre-defined Q-Pulse username and password for the DRS can be used when either Q- Pulse authentication or Windows Authentication has been specified in the Q-Pulse client.

To configure a pre-defined account:

  1. Browse to the DRS installation directory.  By default, this will be C:\inetpub\wwwroot\qpulsedocumentservice.
  2. Locate the web.config file. 
  3. Backup this file to a safe place and then open the original with Notepad.
  4. Locate AnonymousUser and AnonymousPassword.
  5. Update each line with the appropriate Q-Pulse username and password.
  6. Search for the line:
<add key="Database" value="Default" />
  1. Change ‘Default’ to the correct display name of your QPulse database (e.g. ‘Live’).
  2. Save the web.config file
Note: If the display name for the Q-Pulse database is not “Default” then the Value for the “Database” parameter should be changed within the Application Settings list to match the display name of the Q-Pulse database that is to be accessed from DRS.

4. How to Update the Database Connected to DRS

The Document Retrieval Service will automatically point to the database with the display name of "Default". If you want to point the DRS to a different database (e.g. if your database is called "Live") you will need to update the configuration files.

To change the database:

  1. Browse to the DRS installation directory.  By default, this will be C:\inetpub\wwwroot\qpulsedocumentservice.
  2. Locate the web.config file. 
  3. Backup this file to a safe place and then open the original with Notepad
  4. Search for the line:
<add key="Database" value="Default" />
  1. Change ‘Default’ to the correct display name of your QPulse5 database (e.g. ‘Live’).
  2. Save the web.config file
Note: You can obtain the display name from the DBConnections.xml file located in your Q-Pulse 5 Server installation directory.

5. Further Reading

Article Comments

1 comment

Date Votes
  • Andy Bailey

    The video and the instructions contradict each other -

    Pointing DRS to a Different Database

    The video alters 'database'

    The instructions alter 'default'

    1
    Comment actions Permalink