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 prerequisites for SearchService (EDSS) and Enemy Detection (EDQSS)

 Set up EDRS for single instance of ExamDeveloper

 ExamDeveloper setup home page

 

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. The application configuration is spread over five configuration files: connectionStrings.configappSettings.configmassTransit.configlog4net.config, and httpClients.config located in the <ExtractedFolder>\configs\ folder.
  2. Use Notepad or a suitable text editor to open the above configuration files where required.
  3. The application data folder <AppData>, which is C:\ExamDeveloperData\ in our example, is the location where the application Asset folder and log files will be stored. This is referenced in the appSettings.config file as the value for the key "DataRoot", as shown below.
    If you want, you can use any other folder, in which case, change the value of the "DataRoot" key, to the path of this folder.


    This folder (which can have any name) can be created on any volume and the full file path to it must be mentioned in the value of the "DataRoot" key of the application's appSettings.config.
    Grant read/write permissions for this folder to the IIS process user "Network Service" as detailed in Grant Write Access for the Application Data Folder to Network User. You also need to grant similar read/write permissions for this folder to the user "IIS_IUSRS".

     

    What's inside the DataRoot folder?

    Icon
    The Root Data folder contains the following sub-directories:
    1. Data directory - Holds application generated graphic files such as graphs from the reports generated from the User Tracking tab of a project.
    2. Logs directory - Holds application log files.
    3. temp directory - Holds any temporary files created by the application.
    4. uploads directory - Holds application related Assets files.

    The above mentioned sub-folders are automatically created by the application.

    Space Requirements

    Icon
    It is advisable to have a minimum of 1 GB to 2 GB to start with and preferably 5 GB to 10 GB of free space available to hold the files in the root data directory.

     

     

  4. Change the mail server information, as appropriate for your environment in the appSettings.config file:

    1. MailSender = the mail account on your server used to send mail from ExamDeveloper. This should be set to examdeveloper@pearson.com.
    2. SupportEmail = the mail account on your server, where all the support mail sent by the clients should be received. This should be set to examdeveloper@pearson.com.
    3. MailServer = the address of mail server, which is used by the application.
    4. MailPort = the port of the outgoing mail.
    5. MailUsername = the administrative username used to log into the mail server.
    6. MailPassword = the password for the administrative username used to log into the mail server.
  5. Insert the ExamDeveloper license key in the value of "licensekey" key and the license server URL in the value of "licenseServer" in the appSettings.config file.
     

  6. Change the values for the following keys related to the Report Server in the appSettings.config file, as specified:
    1. reportServerUrl = Report Server Web Service URL shown on the Web Service URL tab of the Reporting Services Configuration Manager.

       Where is the Report Server Web Service URL? Click to learn...
      Icon

      The Report Server Web Service URL can be found by clicking the Web Service URL link on the left as shown below. If the URL is too long, some part of the URL may not be visible. In such a case, you can hover the mouse cursor over the URL and note it down from the tool tip.

    2. reportServerPath = the folder name and path of the reporting services application folder created in step 7 of Setting up Reporting Services application folder, which is /ExamDeveloper/ in our example. (Note: For side-by-side (additional instance) installation, this will be different such as "ExamDeveloper_New" in our example.
    3. reportServerUserName = the administrative username used to log into the Report Manager, in step 8 of Setting up Reporting Services application folder.
    4. reportServerPassword = the password for the administrative username used to log into the Report Manager, in step 8 of Setting up Reporting Services application folder.
    5. reportServerDomainName = this specifies the domain or realm to which the user name belongs. Typically, this is the host computer name where the reporting services runs or the user domain for the user configured.
    Icon

    Step 7 is applicable only for ExamDeveloper version 7.1601.0.0 and above.

     

     

  7. Update the value of the key "EdrsOutputDirectory" of the appSettings.config file to the same value as that of the "outputDirectory" in the configuration file of EDRS as detailed later in step 2.b.iv of EDRS setup. This is the location where reports generated by  EDRS are stored.

    Icon

    Step 8 is applicable only for ExamDeveloper version 7.1604.0.0 and above.



  8. Values for the "ApiAuthenticationUserName" and "ApiAuthenticationPassword" must be updated in appSettings.config. These ExamDeveloper API credentials are used by various supporting services later.
  9. Change the value of the "connectionString" in the connectionStrings.config file, where:
    1. Data Source = Name of SQL Server instance. You can identify the name of the SQL Server instance being used for ExamDeveloper as detailed in SQL Server Database Setup.

      Icon
       To learn how to identify the SQL Server instance when there are more than one instances, click here to expand...

      If you have more than one instances of SQL Servers, then you must select the one you need to connect to use with ExamDeveloper as shown in the Connection window below.

      You can later identify the name of the SQL Server instance by right-clicking the Server node in the SQL Server, clicking Properties, then selecting General page in the left pane of the Server Properties page, and observing the Name in the right pane as shown below.

       

    2. Initial Catalog = ExamDeveloper (which is the ExamDeveloper Database).
    3. User ID = Username of the SQL Server User who owns the database. This was created during SQL Server Database Setup under SQL Server user management. In our example, this is "ExamDev".
    4. Password = Password of the SQL Server who owns the database. This was created during SQL Server Database Setup under SQL Server user management. In our example, this is "P@s$w0rd".

    Icon

    Step 10 is applicable only for ExamDeveloper version 7.1601.0.0 and above.

     

     

  10. The massTransit.config file needs to be updated as shown below:

    Update the massTransit/host/rabbit@hostAddress attribute to append the name of the Virtual Host similar to how it was done for the EDRS massTransit.config as detailed later in step 2.c of EDRS setup.
    e.g., if your Virtual Host is named ExamDeveloper, the hostAddress attribute value would become "rabbitmq://localhost/ExamDeveloper" username="examDeveloper" password="Password". In this case, the username "ExamDeveloper" and password "Password" are for the RabbitMQ user accessing the Virtual Host "ExamDeveloper".
    If RabbitMQ is installed on a separate server, then you must substitute "localhost" with the hostname of that server. If RabbitMQ-URL is the server hostname where RabbitMQ is installed, then the line will become as below:

    <rabbit hostAddress="rabbitmq://RabbitMQ-URL/ExamDeveloper" username="ExamDeveloper" password="Password"/>
     

    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 the Virtual Host name is specified exactly as it is in step 1 of Create a new Virtual Host and the RabbitMQ username and password are specified exactly as they are in the Create a RabbitMQ User for EDRS section of the RabbitMQ Setup and Configuration page.

    Icon

    Steps 11 is applicable only for ExamDeveloper version 7.1604.0.0 and above.

     

     

  11. The httpClients.config file needs to be updated as below.

    1. The values of "userName" and "password" in ExamDeveloper httpClients.config for the "EDRS" entry have to be same as those of "basicAuthUserName" and "basicAuthPassword" respectively in the EDRS appSettings.config as mentioned later in step 2.b.v of EDRS setup.
      You will also need to modify the value of the "url" key to the server hostname where the EDRS service is installed App-HostName with the EDRS service name appended to it. For example, if the server hostname where the EDRS service is installed (App-HostName) is examdevapp.pearsonvue.com and the EDRS service name is "UniqueEDRSServiceName" as in our example, then the value of the "url" will be:

      https://examdevapp.pearsonvue.com/UniqueEDRSServiceName

      It is important to ensure that you use "https" and not "http" in the "url" value.


    2. The values of "userName" and "password" in ExamDeveloper httpClients.config for the "ExamSection" entry have to be same as those of "basicAuthUserName" and "basicAuthPassword" respectively in the ExamService service appSettings.config as mentioned later in step 4 of ExamService setup.
      You will also need to modify the value of the "url" key to the server hostname where the ExamService service is installed App-HostName with the ExamService service name appended to it. For example, if the server hostname where the ExamService service is installed (App-HostName) is examdevapp.pearsonvue.com and the ExamService service name is "UniqueExamServiceName" as in our example, then the value of the "url" will be:

      https://examdevapp.pearsonvue.com/UniqueExamServiceName

      It is important to ensure that you use "https" and not "http" in the "url" value.


    3. The values of "userName" and "password" in ExamDeveloper httpClients.config for the "Itembank" entry have to be same as those of "basicAuthUserName" and "basicAuthPassword" respectively in the ItemBank service appSettings.config as mentioned later in step 4 of ItemBank service setup.
      You will also need to modify the value of the "url" key to the server hostname where the ItemBank service is installed App-HostName with the ItemBank service name appended to it. For example, if the server hostname where the ItemBank service is installed (App-HostName) is examdevapp.pearsonvue.com and the ItemBank service name is "UniqueIBServiceName" as in our example, then the value of the "url" will be:

      https://examdevapp.pearsonvue.com/UniqueIBServiceName

      It is important to ensure that you use "https" and not "http" in the "url" value.


    4. The values of "userName" and "password" in ExamDeveloper httpClients.config for the "User" entry have to be same as those of "basicAuthUserName" and "basicAuthPassword" respectively in the User service appSettings.config as mentioned later in step 4 of User service setup.
      You will also need to modify the value of the "url" key to the server hostname where the User service is installed App-HostName with the User service name appended to it. For example, if the server hostname where the User service is installed (App-HostName) is examdevapp.pearsonvue.com and the User service name is "UniqueUserServiceName" as in our example, then the value of the "url" will be:

      https://examdevapp.pearsonvue.com/UniqueUserServiceName

      It is important to ensure that you use "https" and not "http" in the "url" value.


    5. The values of "userName" and "password" in ExamDeveloper httpClients.config for the "Project" entry have to be same as those of "basicAuthUserName" and "basicAuthPassword" respectively in the Project service appSettings.config as mentioned later in step 4 of Project service setup.
      You will also need to modify the value of the "url" key to the server hostname where the Project service is installed App-HostName with the Project service name appended to it. For example, if the server hostname where the Project service is installed (App-HostName) is examdevapp.pearsonvue.com and the Project service name  is "UniqueProjectServiceName" as in our example, then the value of the "url" will be:

      https://examdevapp.pearsonvue.com/UniqueProjectServiceName

      It is important to ensure that you use "https" and not "http" in the "url" value.

 

Encrypting sensitive areas of various configuration files

Icon

When you enter various credentials in the various configuration files, they are stored as plain text and can be easily viewed if the file is opened with Notepad or a suitable text file editor, thus proving a security risk. It is, therefore, prudent to encrypt the <connectionStrings> and <appSettings> sections of the connectionStrings.config and appSettings.config files respectively, to keep the sensitive information such as credentials, away from prying eyes.

 Click to learn more about the encryption process at Encrypting ED configuration files containing sensitive information.

When you enter various credentials in the various configuration files, they are stored as plain text and can be easily viewed if the file is opened with Notepad or a suitable text file editor, thus proving a security risk. Therefore, it is prudent to encrypt the <connectionStrings> and <appSettings> sections of the respective configuration files (connectionStrings.config and appSettings.config) to keep the sensitive information such as credentials, away from prying eyes.

To do this, 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).

 

Icon

In Windows Server 2012 R2 (and other Windows versions without a Start button), press Windows and Q buttons simultaneously to open the search box that appears on the top right, 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.

 

In the command prompt window, navigate to C:\Windows\Microsoft.NET\Framework64\v4.0.30319\ by typing the command:

CD\Windows\Microsoft.NET\Framework64\v4.0.30319

 

To encrypt the <connectionStrings> section of the connectionStrings.config file, type the command:

aspnet_regiis -pef "connectionStrings" "<ExtractedFolder>"

(in our example, replace <ExtractedFolder> with C:\inetpub\wwwroot\ExamDeveloper\ and the command to be run becomes aspnet_regiis -pef "connectionStrings" "C:\inetpub\wwwroot\ExamDeveloper\")

To encrypt the <appSettings> section of the appSettings.config file, type the command:

aspnet_regiis -pef "appSettings" "<ExtractedFolder>"

(in our example, replace <ExtractedFolder> with C:\inetpub\wwwroot\ExamDeveloper\ and the command to be run becomes aspnet_regiis -pef "appSettings" "C:\inetpub\wwwroot\ExamDeveloper\")


The unencrypted (plain text) <appSettings> section of the appSettings.config file appears as below:

The same <appSettings> section of the appSettings.config file appears as below after the above encryption:

 

Icon

You will need to decrypt the encrypted the sections of the different configuration files, in case any setting in the file needs to be modified. This can be done as below:

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).

 

Icon

In Windows Server 2012 R2 (and other Windows versions without a Start button), press Windows and Q buttons simultaneously to open the search box that appears on the top right, 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.

 

In the command prompt window, navigate to C:\Windows\Microsoft.NET\Framework64\v4.0.30319 by typing the command:

CD\Windows\Microsoft.NET\Framework64\v4.0.30319

 

To decrypt the <connectionStrings> section of the connectionStrings.config file, type the command:

aspnet_regiis -pdf "connectionStrings" "<ExtractedFolder>"

(in our example, replace <ExtractedFolder> with C:\inetpub\wwwroot\ExamDeveloper\ and the command to be run becomes aspnet_regiis -pdf "connectionStrings" "C:\inetpub\wwwroot\ExamDeveloper\")

To decrypt the <appSettings> section of the appSettings.config file, type the command:

aspnet_regiis -pef "appSettings" "<ExtractedFolder>"

(in our example, replace <ExtractedFolder> with C:\inetpub\wwwroot\ExamDeveloper\ and the command to be run becomes aspnet_regiis -pdf "appSettings" "C:\inetpub\wwwroot\ExamDeveloper\")


You can now open and update the required information in plain text and save the file.

Once this is done, DO NOT FORGET to encrypt the files again as mentioned earlier on this page.

 

Click here to return to the top of the page.

 Set up EDRS for single instance of ExamDeveloper

 

  • No labels