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 EDRS for single instance of ExamDeveloper

 Set up EDRS for multiple instances of ExamDeveloper

 

Icon

The following is applicable only for ExamDeveloper version 7.1601.0.0 and above.

 

Details about the various keys in the EDRS configuration files with examples
 

Settings required to be modified for single instance installation

File name

XPath

Description (with example)

appSettings.config

//appSettings/add[@key="reportServerUrl"]/@value

The URL to connect to SSRS.

<add key="reportServerUrl" value="http://WIN-VSGF1NBSVPB:80/ReportServer" />

appSettings.config

//appSettings/add[@key="reportServerPath"]/@value

The path to the ExamDeveloper reports on the SSRS server.

<add key="reportServerPath" value="/ExamDeveloper/" />

appSettings.config

//appSettings/add[@key="reportServerUserName"]/@value

The username to connect to SSRS. Please ensure that this user, which EDRS uses to connect to SSRS ("edReporting" in our example), has been granted at least the Browser role as explained here. EDRS will not start if this user does not have this permission.

<add key="reportServerUserName" value="edReporting" />

appSettings.config

//appSettings/add[@key="reportServerPassword"]/@value

The password to connect to SSRS.

<add key="reportServerPassword" value="Password123" />

appSettings.config

//appSettings/add[@key="reportServerDomainName"]/@value

The domain of the user to connect to SSRS.

<add key="reportServerDomainName" value="WIN-VSGF1NBSVPB" />

appSettings.config

//appSettings/add[@key="outputDirectory"]/@value

The path where reports will be written. Both EDRS and the ExamDeveloper application must be able to access this directory.

<add key="outputDirectory" value="C:\ExamDeveloper\AppData\ExamDeveloper\Reports" />

appSettings.config//appSettings/add[@key="basicAuthUserName"]/@value

This should match the value of userName in the httpClients.config file of ExamDeveloper.

<add key="basicAuthUserName" value="examDeveloper"/>

appSettings.config//appSettings/add[@key="basicAuthPassword"]/@value

This should match the value of password in the httpClients.config file of ExamDeveloper.

<add key="basicAuthPassword" value="Dummy_Password"/>

appSettings.config//appSettings/add[@key="useSSL"]/@value

This should be set to "true" to use https for calling the service.

<add key="useSSL" value="true"/>

connectionString.config

//connectionStrings/add[@name="examDeveloper"]/@connectionString

The connection string to connect to the ExamDeveloper database.

<connectionStrings>
<add name="examDeveloper" connectionString="Data Source=(local);Initial Catalog=ExamDeveloper;Persist Security Info=True;User ID=ExamDev;Password=P@ssw0rd" />
</connectionStrings>

massTransit.config

//massTransit/host/rabbit/@hostAddress

The RabbitMQ host URL.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper" username="ExamDeveloper" password="Password" />

massTransit.config

//massTransit/host/rabbit/@username

The RabbitMQ username.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper" username="ExamDeveloper" password="Password" />

massTransit.config

//massTransit/host/rabbit/@password

The RabbitMQ password.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper" username="ExamDeveloper" password="Password" />

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"]/@url

The URL of the ExamDeveloper application.

<httpClientConfig name="ExamDev" url="https://ED-URL" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"]/@username

Username of the ExamDeveloper API login. This should match the value of ApiAuthenticationUserName in the appSettings.config of ExamDeveloper.

<httpClientConfig name="ExamDev" url="https://ED-URL" username="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"/@password

Password of the ExamDeveloper API login. This should match the value of ApiAuthenticationPassword in the appSettings.config of ExamDeveloper.

<httpClientConfig name="ExamDev" url="https://ED-URL" username="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@url

The URL of the User service.

<httpClientConfig name="UserService" url="https://ED-URL/UniqueUserServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@username

Username of the User service API login. This should match the value of basicAuthUserName in the appSettings.config of the User service.

<httpClientConfig name="UserService" url="https://ED-URL/UniqueUserServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@password

Password of the User service API login. This should match the value of basicAuthPassword in the appSettings.config of the User service.

<httpClientConfig name="UserService" url="https://ED-URL/UniqueUserServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@url

The URL of the Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL/UniqueProjectServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@username

Username of the Project service API login. This should match the value of basicAuthUserName in the appSettings.config of the Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL/UniqueProjectServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@password

Password of the Project service API login. This should match the value of basicAuthPassword in the appSettings.config of the Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL/UniqueProjectServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@url

The URL of the ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL/UniqueIBServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@username

Username of the ItemBank service API login. This should match the value of basicAuthUserName in the appSettings.config of the ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL/UniqueIBServiceName" userName="examDeveloper" password="Dummy_Password"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@password

Password of the ItemBank service API login. This should match the value of basicAuthPassword in the appSettings.config of the ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL/UniqueIBServiceName" userName="examDeveloper" password="Dummy_Password"/>

log4net.config//log4net/appender/file@value

Indicates the path where the log file for EDRS service is to be located.

<file value="C:\ExamDeveloperData\Logs\EDRS\ReportService.log" />

 

In addition to the above settings for single instance installation, the following settings are required to be modified for multiple instance installation

File name

XPath

Description (with example)

appSettings.config//appSettings/add[@key="serviceName"]/@value

The short name of the EDRS Windows service.

<add key="serviceName" value="UniqueEDRSServiceName_New" />

appSettings.config//appSettings/add[@key="serviceDisplayName"]/@value

The long name of the EDRS Windows service.

<add key="serviceDisplayName" value="UniqueEDRSServiceDisplayName_New" />

appSettings.config//appSettings/add[@key="basicAuthUserName"]/@value

This should match the value of userName in the httpClients.config file of the new instance of ExamDeveloper.

<add key="basicAuthUserName" value="examDeveloper_New"/>

appSettings.config//appSettings/add[@key="basicAuthPassword"]/@value

This should match the value of password in the httpClients.config file of the new instance of ExamDeveloper.

<add key="basicAuthPassword" value="Dummy_Password_New"/>

appSettings.config//appSettings/add[@key="useSSL"]/@value

This should be set to "true" to use https for calling the service.

<add key="useSSL" value="true"/>

connectionString.config

//connectionStrings/add[@name="examDeveloper"]/@connectionString

The connection string to connect to the ExamDeveloper_New application database.

<connectionStrings>
<add name="examDeveloper" connectionString="Data Source=(local);Initial Catalog=ExamDeveloper_New;Persist Security Info=True;User ID=ExamDev_New;Password=P@ssw0rd_New" />
</connectionStrings>

massTransit.config

//massTransit/host/rabbit/@hostAddress

The RabbitMQ host URL.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper_New" username="ExamDeveloper_New" password="Password_New" />

massTransit.config

//massTransit/host/rabbit/@username

The RabbitMQ username.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper_New" username="ExamDeveloper_New" password="Password_New" />

massTransit.config

//massTransit/host/rabbit/@password

The RabbitMQ password.

<rabbit hostAddress="rabbitmq://localhost/ExamDeveloper_New" username="ExamDeveloper_New" password="Password_New" />

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"]/@url

The URL of new instance of ExamDeveloper application.

<httpClientConfig name="ExamDev" url="https://ED-URL_New" username="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"]/@username

Username of the new instance of ExamDeveloper API login. This should match the value of ApiAuthenticationUserName in the appSettings.config of the new instance of ExamDeveloper.

<httpClientConfig name="ExamDev" url="https://ED-URL_New" username="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ExamDev"]/@password

Password of the new instance of ExamDeveloper API login. This should match the value of ApiAuthenticationPassword in the appSettings.config of the new instance of ExamDeveloper.

<httpClientConfig name="ExamDev" url="https://ED-URL_New" username="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@url

The URL of the new instance of User service.

<httpClientConfig name="UserService" url="https://ED-URL_New/UniqueUserServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@username

Username of the new instance of User service API login. This should match the value of basicAuthUserName in the appSettings.config of the new instance of User service.

<httpClientConfig name="UserService" url="https://ED-URL_New/UniqueUserServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="UserService"]/@password

Password of the new instance of User service API login. This should match the value of basicAuthPassword in the appSettings.config of the new instance of User service.

<httpClientConfig name="UserService" url="https://ED-URL_New/UniqueUserServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@url

The URL of the new instance of Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL_New/UniqueProjectServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@username

Username of the new instance of Project service API login. This should match the value of basicAuthUserName in the appSettings.config of the new instance of Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL_New/UniqueProjectServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ProjectService"]/@password

Password of the new instance of Project service API login. This should match the value of basicAuthPassword in the appSettings.config of the new instance of Project service.

<httpClientConfig name="ProjectService" url="https://ED-URL_New/UniqueProjectServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@url

The URL of the new instance of ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL_New/UniqueIBServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@username

Username of the new instance of ItemBank service API login. This should match the value of basicAuthUserName in the appSettings.config of the new instance of ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL_New/UniqueIBServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

httpClients.config//httpClientsSection/httpClientConfigs/httpClientConfig[@name="ItemBankService"]/@password

Password of the new instance of ItemBank service API login. This should match the value of basicAuthPassword in the appSettings.config of the new instance of ItemBank service.

<httpClientConfig name="ItemBankService" url="https://ED-URL_New/UniqueIBServiceName_New" userName="examDeveloper_New" password="Dummy_Password_New"/>

log4net.config//log4net/appender/file@value

Indicates the path where the log file for the new instance of the EDRS service is to be located.

<file value="C:\ExamDeveloperData\Logs\EDRS_New\ReportService.log" />

Details about optional settings

File nameXPathDescription (with example)
appSettings.conf//appSettings/add[@key="maxReportAge"]/@valueThe amount of time reports will be retained on the storage media. EDRS deletes old reports periodically and reports are marked as eligible for deletion in the cleanup job, after the period of time from their generation, exceeds the amount of time value specified for this key. This setting is a time span written in the form “[d.]hh:mm:ss". The range for hours is 0-23, and for minutes and seconds is 0-59.
For example, you cannot use 24:00:00 to mean 24 hours or 00:75:00 to mean 75 minutes. Instead, you must use 1.00:00:00 or 01:15:00.
The default value for this setting is 2 days.
<add key="maxReportAge" value="2.00:00:00" />
appSettings.conf//appSettings/add[@key="reportCleanupJobInterval"]/@valueThe amount of time between consecutive runs of the cleanup job. This setting is a time span written in the form “[d.]hh:mm:ss". The range for hours is 0-23, and for minutes and seconds is 0-59.
For example, you cannot use 24:00:00 to mean 24 hours or 00:75:00 to mean 75 minutes. Instead, you must use 1.00:00:00 or 01:15:00.
The default value for this setting is 1 day.
 <add key="reportCleanupJobInterval" value="1.00:00:00" />
appSettings.conf//appSettings/add[@key="reportServerTimeout"]/@valueThe duration of the timeout when running reports. Some SSRS reports take a very long time to run. This setting controls the duration of the timeout when running reports. If a report has not completed when the timeout is reached, the current attempt to run the report will be stopped, and the report request will go back into the queue based on the retry policy.
This setting is a time span written in the form “[d.]hh:mm:ss". The default value for this setting is 45 minutes.
<add key="reportServerTimeout" value="00:45:00" />

 

Return to the top of the page.

 Set up EDRS for single instance of ExamDeveloper

 Set up EDRS for multiple instances of ExamDeveloper


  • No labels