For on-premise clients, a system administrator must configure Report Gateway before any users can run reports. The Configuration page contains settings for SSRS, report storage, messaging, and emailing scheduled reports.
To configure Report Gateway, follow these steps:
Note
You may partially complete these fields, save your progress, and then finish the configuration later. However, you will see a warning message stating "Not all of the configuration options have been setup" until you have completed all of the required fields.
1. Go to Admin Settings > Configuration.
2. Complete the following SSRS (SQL Server Reporting Services) fields:
a. SSRS Root Directory—Enter the directory where the SSRS reports are located. If all of your reports are saved at the root of your SSRS server, enter a forward slash (/) here. If you segment reports within your SSRS server, enter the specific directory for your Report Gateway reports.
b. SSRS Username—Enter the SSRS username that reports are run under.
c. SSRS Password—Enter the SSRS password that reports are run under.
d. SSRS Web Service URL—Enter the Web address of the SSRS server.
e. SSRS Request Timeout—Enter the maximum number of minutes a request can take before timing out.
f. SSRS Schema Version—Enter the version of the SSRS schema to use. These schemas are compatible with different versions of SQL:
▪ The 2016 Schema is compatible with SQL 2016 and all later versions of SQL, and also allows reports in the 2010 schema to be used. It is not compatible with SQL 2012 or 2014.
▪ The 2010 Schema is compatible with SQL 2014 and previous versions of SQL, as well as SQL 2016.
3. Complete the following Storage fields:
a. Storage Root Directory—Enter the directory where .pdf files and report design (.rdl) files are stored. This directory should be a network drive or other location accessible by all users and service accounts using Report Gateway.
b. Storage Expiration Days—Enter the number of days to store report files in the root directory before they are automatically deleted.
4. Select the messaging mechanism to use for Report Gateway.
a. Use RabbitMQ—Select this option to use RabbitMQ for messaging.
b. Use Microsoft Message Queueing (MSMQ)—Select this option to use MSMQ for messaging. This is the message queue manager used by MRI for the Web.
5. If you selected RabbitMQ for messaging, complete the following RabbitMQ fields:
a. Host URL—Enter the URL of the RabbitMQ server that is hosting the queue, in the format amqp://username:password@server:port/.
b. Messaging Domain—Enter the domain to use when naming your report queues. For example, entering a Messaging Domain of "my-reporting" would result in a report queue named "mri.my-reporting.report".
c. Retry Wait—Enter the time in milliseconds to wait between connection attempts if a connection issue occurs.
d. Retry Max—Enter the maximum number of attempts to reconnect if a connection issue occurs.
e. Retry Time Out—Enter the time in milliseconds a connection will wait on the server before timing out if a connection issue occurs.
f. Keep Connections Alive—Select this option to keep connections open during down time between asynchronous tasks.
g. Use SSL—Select this option if you want to use SSL for secure communication between the RabbitMQ server and the other servers in Report Gateway. Then, enter the SSL Server Name.
6. If you selected MSMQ for messaging, complete the following MSMQ fields:
a. Host URL—Enter the URL of the MSMQ server.
b. Retry Wait—Enter the time in milliseconds to wait between connection attempts if a connection issue occurs.
c. Retry Max—Enter the maximum number of attempts to reconnect if a connection issue occurs.
7. Complete the following SMTP fields:
a. SMTP Server—Enter the name or IP address of the SMTP server to use for emailing scheduled reports.
b. SMTP Port—Enter the port to use for emailing scheduled reports. Report Gateway connects to the SMTP Server on this port.
c. SMTP User—Enter the user account to use when emailing scheduled reports. When Report Gateway requires a user ID to send email messages, it uses this account as the sender.
8. Click Save.
9. Perform an IIS reset on each web server to finalize the configuration changes. Also, restart the MRI.Reporting.Messaging.Service on all application servers. These restarts will update any cached configuration data.