Navigation Menu

Click the "+" to see inside a chapter or use the search to the right.

.

Skip to end of metadata
Go to start of metadata

 Set up SearchService (EDSS) for single instance of ExamDeveloper

Set up ExamService for single instance of ExamDeveloper

 ExamDeveloper setup home page

 

Icon

EDQSS setup is optional, so you need to follow these steps only if you plan to use EDQSS. If EDQSS is not required, you can skip to ExamService setup.

Icon

Please ensure that the prerequisites for EDQSS have been properly set up before proceeding further.


The Enemy Detection micro service compares two Questions for the probability of Enemy relationship between the two and generates a Similarity Rating to help decide the relationship between the two. This service does this calculation for every Question pair in the Item Bank.

 

This page covers Enemy Detection (EDQSS) Setup and Configuration for Single or First Instance of ExamDeveloper. If you are running multiple instances of ExamDeveloper, you can go to Enemy Detection (EDQSS) installation and configuration for multiple instances of ExamDeveloper see Enemy Detection (EDQSS) Setup for Multiple Instances of ExamDeveloper.

 

Icon
The following is applicable only for ExamDeveloper version 7.1602.0.0 and above.

Caution

Icon

Please ensure that the RabbitMQ setup is already completed as mentioned in RabbitMQ Setup and Configuration.

Please ensure that the SearchService setup is already completed as mentioned in SearchService (EDSS) Setup for Single Instance of ExamDeveloper.

Please ensure that the the Question Similarity Search check box is selected for the application in the License Server configuration page. If this is not selected, you will not be able to use the Enemy Detection feature in the application.

If your current version of ExamDeveloper is less than 7.1602, and you are upgrading ExamDeveloper, please contact Pearson VUE Tech Support to ensure that the License Upgrade Script has been run.

 

Configuration of the Similarity service

 

Icon

It is important to ensure that all the values in the config files such as service name, URLs, username, and password are case-sensitive. ExamDeveloper may not run as expected if care is not taken to ensure that case sensitivity is maintained.

 

  1. Create a folder where you want to install Similarity service, such as C:\EDQSS\ExamDeveloper\ (henceforth known as <EDQSSinstallDir>) and copy all the contents of <SVNFolder>\EDQSS\ to this folder.
     

  2. Open the various configuration files for the Similarity service, located in C:\EDQSS\ExamDeveloper\configs\ (<EDQSSinstallDir>\configs\) - appSettings.configconnectionStrings.configmassTransit.config, and log4net.config - with Notepad or a suitable text file editor.
     

  3. Update the values related to the Similarity service in the appSettings.config file as shown below:


    where,
    UniqueSimilarityServiceName is the name of the Similarity service, UniqueSimilarityServiceDisplayName is the display name of the Similarity service, and UniqueSimilarityServiceDescription is the description about the Similarity service. The name and display name needs to be unique per install.


  4. Update the values related to the RabbitMQ in the appSettings.config file as shown below:


    Here, ExamDeveloper is the name of the Virtual Host created in step 1 of Create a new Virtual Host section of the RabbitMQ Setup and EDRS Configuration page.
    The values for the keys "MessagingQueueUserName" and "MessagingQueuePassword" are the username and password for the RabbitMQ user (having access to the Virtual Host ExamDeveloper), while the value of the "MessagingQueue" is the "hostAddress". Please ensure that the "MessagingQueue" value ends with a "/". These are created in the Create a RabbitMQ User for EDRS section of the RabbitMQ Setup and EDRS Configuration page, which in our example are ExamDeveloper and Password respectively.

    Icon
    If RabbitMQ is installed on a separate server, then you must substitute "localhost" of "MessagingQueue" with the hostname of that server. If RabbitMQ-URL is the server hostname where RabbitMQ is installed, then the line will become as below:

    <add key="MessagingQueue" value="rabbitmq://RabbitMQ-URL/ExamDeveloper/"/>
    Icon

    It is extremely important that the same RabbitMQ Virtual Host name should not be shared between different instances of ExamDeveloper, as this can result in issues such as data loss and security breach.

    It is important to ensure that the RabbitMQ Virtual Host name, username, and password are case-sensitive. You will encounter an error while trying to log into ExamDeveloper if care is not taken to ensure that both are specified exactly as they are in step 1 of Create a new Virtual Host and in the Create a RabbitMQ User for EDRS section of the RabbitMQ Setup and EDRS Configuration page.



  5. Update the values in the <connectionStrings> section of the connectionStrings.config file as shown below:


    Ensure that the "connectionString" value for "examdeveloper" matches the value from the EDRS connectionStrings.config file as in step 2.a of EDRS Installation and Configuration.
    The Initial Catalog name for "Similarity" is the same as in step 3 of Creating new databases for Similarity and Hangfire. The user name and password for "Similarity" is the same as in step 3 of SQL Server user management for Similarity and Hangfire.
    The Initial Catalog name for "Hangfire" is the same as in step 6 of Creating new databases for Similarity and Hangfire. The user name and password for "Hangfire" is the same as in step 6 of SQL Server user management for Similarity and Hangfire.

  6. Update the values in the <log4net> section of the log4net.config file as shown below to indicate the path where the log file for the Similarity service is to be located.


    By default, the log file QuestionSimilarityLog.log is saved to the Similarity service folder (C:\EDQSS\ExamDeveloper\ in our example). You can specify a different path to save it by modifying the value to something like "C:\ExamDeveloperData\Logs\Similarity\QuestionSimilarityLog.log" as shown above.

 

Setting Up Similarity Windows Service and Hangfire Scheduler

 

Installing the Similarity Windows service

  1. Open an Administrator command prompt (click the Start button, type "command" in the search box, right click Command Prompt in the search results that appear, and click Run as administrator from the context menu) and navigate to <EDQSSinstallDir>.
  2. Run the following command:

    EDQSS.exe install --sudo --localservice

    Here, EDQSS.exe is the name of the Similarity service executable file. This file may be available with any other name in the format [ApplicationName].exe such as EDQSS.exe.
    This installs the Similarity Windows service with the display name UniqueSimilarityServiceDisplayName set to start with Windows, but it doesn't start running right away.

Start Similarity Windows service

  1. Once the service is installed successfully, to start the Similarity Windows service, open the Administrator command prompt.
  2. Navigate to <EDQSSinstallDir> and run the following command:

    EDQSS.exe start

 

Icon

The installed service runs in the default Local Service account. If the service does not start, inspect the Windows application logs to understand the reason.

 

 

Ensure that the Similarity service is running before proceeding any further

Icon

Ensure that the Similarity service is running in the following way:

  1. Run "services.msc" (click Start  Run or Windows + R keys together, type "services.msc" in the Run dialog box, and click OK). Ensure that the Status for the Similarity service instance shows as Started and the Startup Type is Automatic.
  2. If you don't see as mentioned in step 1, then right click the Similarity service name in the list, which should appear as UniqueSimilarityServiceDisplayName, and click Properties to open its properties window.
  3. Select Automatic from the Startup type drop-down and click the Start button under Service status.
  4. This starts the Similarity service and sets it to start automatically at Windows startup.

 

 

 If you need to stop or uninstall the Similarity service, click here to learn how...

Stop the Similarity service

  1. Open the Administrator command prompt and navigate to <EDQSSinstallDir>.

  2. To stop installed service, run the following command:

    EDQSS.exe stop

Uninstall the Similarity service

  1. Open the Administrator command prompt and navigate to <EDQSSinstallDir>.

  2. First stop the service by running the following command:

    EDQSS.exe stop
     

  3. To uninstall the service, run command:

    EDQSS.exe uninstall --sudo --localservice

 

Hangfire Scheduler

The Hangfire Scheduler is also installed along with the Similarity service. Hangfire handles Enemy Detection jobs schedules.

 Click here to expand and learn more about using Hangfire Scheduler...
Icon

The Hangfire Dashboard is available at http://localhost:9000/hangfire/servers. Scheduled jobs are listed on Hangfire Dashboard.

The above four jobs are listed by default. Jobs added by the user are listed here in addition to the four default jobs.

It is possible to select and delete jobs by selecting the corresponding check box and clicking the Remove button.

It is also possible to immediately execute a job by selecting the corresponding check box and clicking the Trigger now button.

 

Icon

Since the above four default jobs are required by the Similarity service, they should not be deleted.

  • No labels