Common QPR Authentication

From Mea Wiki
Jump to navigation Jump to search

Common authentication enables linking from one QPR Suite product to the other without the need of a separate login for the product that is the link target. When you are authenticated to one QPR Suite product, you are automatically authenticated all other QPR Suite products as well. It is possible to configure a common authentication between following QPR Suite products:

  • QPR ProcessAnalyzer Web Service
  • QPR ProcessAnalyzer Web Client
  • QPR MobileDashboard
  • QPR Portal
  • QPR Web Services

Common authentication needs to be setup for each QPR Suite product according to the following instructions.

In common authentication, "username" attribute is used to match user accounts between QPR products.

Configuring Common Authentication for QPR ProcessAnalyzer

The configuration file web.config in QPR ProcessAnalyzer Service is used for registering servers belonging to the common authentication server group. The servers can then share user sessions created for users.

To set up a common authentication server group:

  1. Create or change usernames in both the source and target QPR products, so that the usernames are identical in both products.
  2. Configure common authentication settings by adding the URL of the product where the linking is done from to the web.config file of the target product. For example, to link between QPR ProcessAnalyzer Web Client, QPR MobileDashboard, and QPR Portal, do as follows:
  • Add three groups, ServerGroupPA, ServerGroupMD, and ServerGroupMEA, to the web.config file under <Qpr.ProcessAnalyzer.Common.Properties.Settings> section. Specify the QPR ProcessAnalyzer service URLs for ServerGroupPA, the QPR MobileDashboard service URL(s) for ServerGroupMD, and the QPR Portal service URLs for ServerGroupMEA. See example below:
            <setting name="ServerGroupPA" serializeAs="Xml">
                <value>
                    <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                        xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                        <string>http://pa1.qpr.com</string>
                        <string>http://pa2.qpr.com</string>
                    </ArrayOfString>
                </value>
            </setting>
            <setting name="ServerGroupMD" serializeAs="Xml">
                <value>
                    <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                        xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                        <string>http://mobiledashboard:8080/EnticeServices/</string>
                    </ArrayOfString>
                </value>
            </setting>
            <setting name="ServerGroupMEA" serializeAs="Xml">
                <value>
                    <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                        xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                        <string>http://mea1.qpr.com/QPR/Portal/QPRIsapi.dll</string>
                        <string>http://mea2.qpr.com/QPR/Portal/QPRIsapi.dll</string>
                    </ArrayOfString>
                </value>
            </setting>

Configuring Common Authentication for QPR MobileDashboard

There are two ways to configure Common authentication for QPR MobileDashboard:

  1. During QPR MobileDashboard installation using the installation wizard
  2. After the installation directly the database using SQL

During QPR MobileDashboard installation

To add a URL, select the Service type (e.g. "QPR Portal") , define the Service URL (e.g. "http://<service_hostname>/QPR2016-1/Portal/QPR.Isapi.dll/"), and click Add. If you need to change an existing definition, you can either remove the latest definition by clicking Remove last or remove all the definitions by clicking Clear, and then define the definition(s) again.

After the installation to the database

  1. A setting change needs to be done to the QPR MobileDashboard database.
  2. Determine the needed setting string. It uses following format: PRODUCTNAME,URL;PRODUCTNAME,URL;... where PRODUCTNAME is either WAS, WS or PA. Example:
    WAS,http://SERVERNAME/QPR/Portal/QPR.Isapi.dll;WS,http://SERVERNAME/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/;
    SERVERNAME is the name of the corresponding server.
  3. Login to the QPR MobileDashboard's database in the SQL Server using SQL Server Management Studio.
  4. Open the database and query:
    SELECT VALUE_FIELD FROM CONFIGURATIONENTITY WHERE KEY_FIELD ='AUTHENTICATION_SERVICES';
    If the query returns something, store the result for backup.
  5. If the step 4 query didn't return anything, execute following query to make the setting change:
    INSERT INTO CONFIGURATIONENTITY(KEY_FIELD,VALUE_FIELD) VALUES ('AUTHENTICATION_SERVICES', 'SETTINGSTRING');
    (replace the SETTINGSTRING with the one determined in step 1).
  6. If the step 4 query returned something, execute following query to make the setting change:
    UPDATE CONFIGURATIONENTITY SET VALUE_FIELD = 'SETTINGSTRING' WHERE KEY_FIELD = 'AUTHENTICATION_SERVICES';
    (replace the SETTINGSTRING with the one determined in step 1).

Configuring Common Authentication for QPR Portal and QPR Web Services

  1. In QPR server, open file C:\ProgramData\QPR Software\QPR 201X\201X.1\Servers\Settings\QPR_Servers.ini (where X is the QPR Suite version).
  2. In section [UMS Settings] set EnableSSOForPortal=1 (if EnableSSOForPortal setting already exists, change it; if doesn't, create it as a new line).
  3. If you need to add common authentication to QPR MobileDashboard, in section [WAS Settings] add AuthenticationService_1=ENTICE,http://SERVERNAME:8080 (SERVERNAME is the name of QPR MobileDashboard server that is used when accessing QPR MobileDashboard). If you also need to add common authentication to QPR ProcessAnalyzer, add also AuthenticationService_2=PA,http://SERVERNAME as a new line. Note the increasing number in the setting name.
  4. Restart QPR service.

For more information, see the detailed instructions: http://kb.qpr.com/qpr2016-1/index.html?common_qpr_authentication.htm

Linking between QPR Products

Common QPR authentication enables opening links, such as QPR ProcessAnalyzer reports in QPR Portal, without additional authentication.

QPR ProcessAnalyzer in QPR Portal

To view an analysis created with QPR ProcessAnalyzer in QPR Portal, do as follows:

  1. In QPR ProcessAnalyzer Excel Client, open the analysis you want to view.
  2. To save the current analysis view as a bookmark, click the Portal Bookmarks.pngBookmark button, select New Bookmark and in the Bookmark Properties dialog that opens, click OK.
  3. Find out the Id of the bookmark you just created by opening the Bookmark Properties dialog for the bookmark you created and see the Id in the Statistics group of that dialog.
    Optionally, in Manage Bookmarks dialog, right click a column title, select Column Chooser from the popup and drag the Id column to the table.
  4. In QPR Portal, create a new bookmark. Paste the bookmark Id to the end of a URL that is formatted as follows:
    http://<QPR ProcessAnalyzer server>/#bookmark=<bookmark id>&ui=1&XSESSION={#sys:sessionId}
    Do not make changes to the {#sys:sessionId} tag, just copy it exactly like it is written above.
    For example: http://pa.qpr.com/#bookmark=1&ui=1&XSESSION={#sys:sessionId}.
    Note that using the "&ui" parameter with the value "1" will open the bookmark in Full Screen Mode inside the web page it was embedded in.
  5. In QPR Portal, open the bookmark you created in the previous step and you will see the analysis without additional authentication.

QPR ProcessAnalyzer in QPR MobileDashboard

To view an analysis created with QPR ProcessAnalyzer in QPR MobileDashboard, do as follows:

  1. In QPR ProcessAnalyzer Excel Client, open the analysis you want to view.
  2. To save the current analysis view as a bookmark, click the Portal Bookmarks.pngBookmark button, select New Bookmark and in the Bookmark Properties dialog that opens, click OK.
  3. Find out the Id of the bookmark you just created by opening the Bookmark Properties dialog for the bookmark you created and see the Id in the Statistics group of that dialog.
    Optionally, in Manage Bookmarks dialog, right click a column title, select Column Chooser from the popup and drag the Id column to the table.
  4. In QPR MobileDashboard, add a new External Content presentation object to the view, and define its URL as:
    http://<QPR ProcessAnalyzer server>/#bookmark=<bookmark id>&ui=1&XSESSION={#sys:sessionId}
    Do not make changes to the {#sys:sessionId} tag, just copy it exactly like it is written above.
    For example: http://pa.qpr.com/#bookmark=1&ui=1&XSESSION={#sys:sessionId}.
    Note that using the "&ui" parameter with the value "1" will open the bookmark in Full Screen Mode inside the web page it was embedded in.

Note: you can also show tabular QPR ProcessAnalyzer analyses in QPR MobileDashboard by using the Table presentation object.

QPR Portal in QPR MobileDashboard

QPR Portal can be embedded into QPR MobileDashboard using External Content presentation object. When setting its url (External Content URL field), add the following parameter to the url:
&xsession={#sys:sessionId}

When the session id is passed to QPR Portal, user is automatically authenticated to QPR Portal using the common authentication.

Retrieved from "https://wiki.onqpr.com/mea/index.php?title=Common_QPR_Authentication&oldid=4050"