Who is this article for?

IT Administrators responsible for managing solution integrations.

Database write access, Administration module access and local IT permissions are required.

This article explains the Mazlan Home Single Sign-On (SSO) integration. It works like the legacy integration, but users log in via Ideagen Mazlan Home (AWS Cognito SSO) instead of Ideagen Quality Management credentials.

The legacy integration allows draft documents from Ideagen Quality Management to be sent to Ideagen Please Review for editing, then checked back in without downloading or using Ideagen Mazlan Home.

Legacy and modern integrations are mutually exclusive

If the modern integration (Mazlan Home-based) is enabled for a customer, the legacy Checkout to PleaseReview option will not appear, even if the legacy checkout URL is still configured.

If the checkout option missing for you, check whether the modern integration has been switched on.

This article outlines the steps you need to take to be able to benefit from the SSO variant of the integration.

Prerequisites

To configure the integration make sure you have set up the following:

• Ideagen Please Review v8.4 (or above)
• Ideagen Quality Management v7.9 (or above) with QPulse5WebServices installed
• Ideagen Quality Management tenant is onboarded to Mazlan Home (Cognito SSO login configured and Mazlan Home user synchronisation active).
• User Principal Name (UPN) must be set for each user.
  This is the Mazlan Home email address and is the key Ideagen Please Review uses to match the SSO identity. This is handled by the Ideagen Quality Management-side Mazlan Home autosync; verify it has run for the affected users.
• Integration Ideagen Quality Management user with a unique primary email set in the Windows client
• The modern integration must be disabled for this tenant

Considerations

Scenarios

There are two scenarios to bear in mind when trying to set up this variant:

• Hybrid - Ideagen Please Review is on Mazlan Home. Ideagen Quality Management is not on Mazlan Home.
• Unsupported - Ideagen Please Review is not on Mazlan Home. Ideagen Quality Management is on Mazlan Home.

They're explained in more detail below.

Hybrid scenario

Used when Ideagen Please Review has migrated to Mazlan Home but the Ideagen Quality Management instance has not. No new mechanism - it is the legacy and Mazlan Home configurations running side by side in Ideagen Please Review:

• The Ideagen Please Review login page displays both Mazlan Home and QPulse database options. Ideagen Quality Management users redirected from checkout select QPulse and log in with native credentials, as in the legacy integration.
• Mazlan Home registers only the single Ideagen Please Review instance; the QPulse source is configured locally and users are not created in Mazlan Home.
• The Ideagen Quality Management setup mirrors the legacy system: CheckoutUrl retains extsource=QPulse:<Database Display Name>.
  • If CheckoutUrl has extsource=QPulse: (no database name), users first select the system connector before login.
  • If CheckoutUrl includes extsource=QPulse:<Database Display Name>, users go directly to login without selecting a connector.
• Ideagen Please Review steps involve merging QPulse blocks into Mazlan Home’s systemconnectors.xml.
• When Ideagen Quality Management migrates to Mazlan Home, this becomes the full Mazlan Home setup.

Unsupported scenario

There is no configuration where a non-Mazlan Home instance of Ideagen Please Review accepts Mazlan Home SSO logins:

• A non-Mazlan Home Ideagen Please Review instance can only authenticate Ideagen Quality Management users via the QPulse endpoint using native credentials.
  If the tenant was onboarded to Mazlan Home with native login disabled (SSO-only), users lack a password and cannot log in after checkout redirect.
• Workarounds are limited: either keep native login enabled for affected users or, preferably, onboard Ideagen Please Review to Mazlan Home first for full support.

Terminology

An instance that is not on Mazlan Home is referred to as QPulse; once it is on Mazlan Home, it is referred to as IQMP (Ideagen Quality Management).

This carries into configuration: the checkout extsource is QPulse:<Database Display Name> for a non-Mazlan Home source and IQMP:<Database Display Name> for a Mazlan Home source. The value is case-sensitive.

Migration and cutover notes

Below are some migration notes to bear in mind:

extsource is case-sensitive

It changes from QPulse:<Database> to IQMP:<Database> when the source moves to Mazlan Home. The CheckoutUrl row in the Ideagen Quality Management database must be updated at cutover.

Review are tied to their extsource

Do not switch a source from QPulse to IQMP while reviews are still open - drain existing reviews first, otherwise they lose their connection and become orphans.

Identity matching

Existing native Ideagen Quality Management-authenticated users in Ideagen Please Review must reconcile to their Mazlan Home (Ideagen Quality Management) identity.

The mapping key is the primary email/UPN. If the identifiers differ, the same person ends up with a duplicate Ideagen Please Review account and orphaned reviews - confirm the matching key before migrating.

Admin access

Once the Ideagen Please Review native login is replaced by Mazlan Home, sysadmins can no longer log in natively.

Make sure an admin identity in Mazlan Home maps to an Ideagen Please Review admin role before removing native login.

Switching variants

There is no Ideagen Quality Management code or feature switch specific to this variant.

On the Ideagen Quality Management side, it's the combination of two independent configurations:

• the tenant is onboarded to Ideagen Mazlan Home (Cognito SSO login, Mazlan Home user sync), and 
• the legacy Ideagen Please Review checkout URL is configured in the database

Configuring the integration

Ideagen Quality Management side

To set up Quality Management for the integration:

• 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 PleaseReview.

User account

To set up the user, 

1. Create a new user account.
2. Verify the autosync with Mazlan Home successfully set the UPN.

This is what Ideagen Please Review uses to match the SSO identity and shouldn't need to be triggered manually.

Database entry (SQL server)

To set up the database:

1. Open Microsoft SQL Server Management Studio.
2. Select your database.
   Alternatively, prefix the script with USE <database name>.
3. Copy and paste the query below.

-- Works on both SQL Server and PostgreSQL
INSERT INTO IntegrationSettings (Name, Value, Category, OptimisticLockField)
VALUES ('CheckoutUrl',
'https://<pleasereview-server>/main/newreview.aspx?extsource=IQMP:<DatabaseDisplayName>&extref={0}',
'PleaseReview', 0);

SELECT * FROM IntegrationSettings;

4. Execute the query.

Database entry (PostgreSQL)

To set up the database:

1. Connect to your database with psql or pgAdmin.
2. Copy and paste the query below.

-- Works on both SQL Server and PostgreSQL
INSERT INTO IntegrationSettings (Name, Value, Category, OptimisticLockField)
VALUES ('CheckoutUrl',
'https://<servername>/PleaseReview/main/newreview.aspx?extsource=QPulse&extref={0}',
'PleaseReview', 0);
-- Ensure the servername matches the PleaseReview server or FQDN.
-- Use http for unsecured systems.
-- The /PleaseReview path segment depends on the PleaseReview install; some environments use /main/newreview.aspx directly.

SELECT * FROM IntegrationSettings;

3. Execute the query.

Running the query

The statement deliberately avoids engine-specific syntax - no "USE/GO", no "[dbo]". brackets, no N'' prefixes, and no double quotes around identifiers.

On PostgreSQL the table is stored lowercase (integrationsettings), so unquoted names resolve correctly on both engines; adding double quotes ("IntegrationSettings") would break it on PostgreSQL.

ChekoutUrl row already exists

If the row already exists from a pre-Mazlan Home setup, update its value instead of inserting a second row - Name + Category is unique.

Your Ideagen Quality Management configuration is complete once this row exists. You should now see the Checkout to PleaseReview option for eligible draft documents in the Web client. If you can't see the option, make sure the modern integration is not enabled.

On version 7.10.1.0 or higher?

Go to Customisation settings and untick the Enable Ideagen Please Review Integration to finish the setup.

Ideagen Please Review side

After configuring the integration in Ideagen Quality Management, you need to set up the configuration in Ideagen Please Review.

We recommend following our article on configuring the Single Sign-On (SSO) Ideagen Quality Management integration, making sure you have the following handy:

• Ideagen Quality Management database display name (shown on the login screen)
• QPulse5WebServices base URL (for example: https://<iqmp-server>/qpulse5webservices/services/)
• integration user account credentials

Further reading

• Configuring the Ideagen Quality Management integration
• Troubleshooting the Ideagen Please Review integration