Integrating Please Review with Quality Management (Professional)
Who is this article for?IT Administrators responsible for managing solution integrations.
Database, Administration module access and Local IT permissions are required.
To help you effectively manage Documents, we introduced an integration that allows Documents from Quality Management to be sent directly to Please Review for review. Once updated, they will then be checked back into Quality Management without the need for the files to be sent to the user's computer.
This article outlines the steps you need to take to be able to benefit from the integration.
1. Prerequisites
- Please Review v6.5.2 (or above)
- Quality Management v7.0 (or above)
- Quality Management Database display name
- Quality Management application server IP, hostname, or fully qualified domain name
- Quality Management database write access
2. Quality Management
To set up Quality Management for the integration, you need to:
- Create a user and grant it correct permissions to allow it access to the system.
- Add an entry to the Ideagen Quality Management database to communicate to the system that it's integrated with Please Review.
2.1. User account
To set up the user:
2.2. Database entry
To set up the database:
- Open Microsoft SQL Server Management Studio.
- Click the New Query button.
- Copy and paste the query below.
USE DBNAME -- Replace this with your Ideagen Quality Management database name
INSERT [dbo].[IntegrationSettings] ([Name], [Value], [Category],
[OptimisticLockField])
VALUES (N'CheckoutUrl',
N'https://<servername>/main/newreview.aspx?extsource=QPulse&extref={0}',
N'Please Review', 0)
-- Check the URL above to ensure the servername matches your Please Review server
-- or FQDN, ensure http is used for unsecured systems
SELECT * FROM IntegrationSettings;
GO
- Update the DBName and URL.
- Execute the query.
Your Quality Management setup is done!
3. Please Review
To set up Please Review for the integration, you need to:
- Configure systemconnectors.xml to add the Quality Management connector.
- Configure QPulseLogin.xml to include the credentials for the user account created earlier.
3.1. Systemconnectors.xml
To set up the connector:
- Navigate to the Please Review install folder.
- Edit systemconnectors.xml.q-pulse.
- Replace [[DB_DATABASE_NAME]] with the name of your database.
You can find this information on the Quality Management login screen. - Replace [[FriendlyName]] with a display name for your database.
This will appear on the Please Review login screen. - Save the file.
- Rename the file to remove the .q-pulse extension.
3.2. QPulseLogin.xml
To set up the login:
- Edit QPulseLogin.xml.sample.
- Replace [[QP_DATABASE_DISPLAYNAME]] with the name of your database.
- Replace [[DISPLAY_NAME]] with the name you'd like to see in Please Review dropdowns.
- Remove the "s" in https for <EndpointBaseAddress> (as necessary).
- Replace [[QP_PRUSER_USERNAME]] with the username you created earlier.
- Navigate to .../Please Review/runtime/bin.
- Open AdminClient.exe.
- Click System Utils.
- Select Password Encoder.
- Enter the password for the user you created earlier.
- Click Encode.
- Replace [[QP_PRUSER_PASSWORD]] with the encoded password.
- Save the file.
- Rename the file to remove the .sample extension.
3.3. Taraservice and Taraweb
Before you can use the integration, you need to restart Taraservice and Taraweb.
To restart Taraservice:
- Open Services.
- Locate TaraService.
- Select Restart.
To restart Taraweb:
- Open Internet Information Services (IIS).
- Expand the server.
- Select Application Pools.
- Highlight the Please Review app pool.
It may have a custom name. - Click Recycle on the right hand side.
Your Please Review setup is now complete!
4. Additional configuration
4.1. Multiple Ideagen Quality Management databases
You can connect additional databases once you have completed all of the above configuration steps.
To set up another database:
- Open QPulseLogin.xml.
- Copy everything between the <QPulseServer> tags.
- Paste this directly below </QPulseServer>.
- Replace the database and username information.
- Save the file.
- Open SystemConnectors.xml.
- Copy everything between the <LoginMethod> tags.
- Paste this directly below </LoginMethod>.
- Replace the database information.
- Save the file.
- Restart the server and application pool.
Repeat these steps for each additional database.
5. Troubleshooting
Currently, users must log in to PR using their native IQMP credentials, as automatic login is not included in the integration. External authentication methods for IQMP won't work with PR. Even if PR accepts the same external method, the integration will fail to retrieve necessary check in/out documents.
Therefore, users need to use their IQMP login details when accessing PR, ensuring they select the IQMP login option. To simplify this, a separate PR site can be created with only the IQMP login option, reducing confusion for users redirected from IQMP. Instructions for setting up a second site with a specific login method can be found here: Configuring Please Review in multiple sites.