Before on-premise clients can run reports in Report Gateway, a system administrator must configure each platform and its data sources. A platform is a unique MRISystem database installation, also sometimes referred to as an MRI "environment". A data source is the MRI application database for that platform.
It is recommended that you have the MRI Security Console open to the Authentication Configuration > Settings tab as you configure platforms and data sources in Report Gateway. You will need to generate and enter values in both applications concurrently.
Note
Platforms must all use the same identity provider.
To add a platform, follow these steps:
1. Go to Admin Settings > Platforms and Data Sources.
2. Click Add Platform.
3. Complete the following Platform Settings fields:
a. Platform name—Enter a descriptive name for the platform that will help identify it to users.
b. Platform type—Select the platform type. For MRI platforms, select PropertyManagement. For non-MRI platforms such as on-premise data sources, select Other.
c. Allow Reports—Select this check box to allow reports to be run on this platform.
d. Allow Publishing—Select this check box to allow users to publish reports directly to this platform through the report sharing functionality.
e. SSRS Secondary Data Source Name—If you want to pull data from a secondary data source using the report definitions you specified during your SQL Server Reporting Services (SSRS) setup, enter the name of that data source in this field. If the data source you enter here is the only data source your platform will use, select the Is Secondary Only check box. Note that selecting this check box disables several of the other fields in this section, so you should skip those steps below.
f. URL—Enter the URL at which the platform is located.
Note
This must match the MRIWeb URL that is configured in Security Console > Authentication Configuration. For more information about Security Console configuration, refer to the System Administration Guide.
To validate this URL, click the Go to link to open it in a new browser tab.
g. API Cache Lifetime—Enter the number of minutes that data is cached on the server before it expires and is retrieved again by an API.
h. API Cache Refresh Window—Enter the number of minutes before the cache expiration time to serve as a refresh window, based on the API Cache Lifetime value above. If a call is made to an API within this window, the API asynchronously updates the cache and extends the new expiration time to the API Cache Lifetime value.
Example
If the API Cache Lifetime is set to 5 and the API Cache Refresh Window is set to 2, and an API is called at the 4-minute mark, the current cached results are returned, the API executes asynchronously and updates the cache, and the new expiration time is reset to 5 minutes in the future.
Note
A user may clear their cache manually at any time by clicking the Help menu on the menu bar, and then selecting Clear Cache.
At this point, open Security Console > Authentication Configuration > Settings tab and click Generate Reporting Settings.
i. Identifier—Enter the identifier for the platform, as generated in the Security Console Identifier field.
j. OAuth2ClientId—Enter the client ID used by OAuth2 authentication, as generated in the Security Console External Id field.
k. OAuth2Secret—Enter the secret used by OAuth2 authentication, as generated in the Security Console External Secret field.
l. Enable system services APIs—Select this check box to allow this platform to call APIs that can manipulate data like users, data sources, and reports.
m. Disable report syncing—Select this check box to prevent this platform from syncing external reports, such as ReportDesign reports.
4. Click Generate OAuth Settings to generate values in the Reporting Client Id and Reporting Client Secret fields. Then, copy these values into the Reporting Id and Reporting Secret fields in Security Console and click Save. For more information about Security Console configuration, refer to the System Administration Guide.
5. Click Add Data Source. Then, complete the following Data Sources fields:
a. Name—Enter the name of the data source. This must match the Server Database Name that is configured in Security Console.
b. Alias—Enter a descriptive name for the data source that will help identify it to users. This must match the Platform Database Name that is configured in Security Console.
c. Server—Enter the server name on which the data source is located.
d. Connection String—Enter the connection string for connecting to this data source, in the format User ID=[SQL user credentials];Password=[SQL user password].
Note
The connection string only includes the user name and password, not the server or database name.
e. Client ID—Enter the client that this data source is for.
6. Repeat step 5 for any additional data sources for this platform.
7. Click Save.
8. Perform an IIS reset to finalize the platform addition.
To modify a platform, follow these steps:
1. Go to Admin Settings > Platforms and Data Sources.
2. Click the platform that you want to edit. The Platform Settings page appears.
3. Modify the platform settings as needed.
4. To change data source information, enter the new information in the Data sources fields.
5. To add a new data source, click Add Data Source, and complete the data source fields as documented above.
6. To delete a data source, click Delete in the row of the data source that you want to delete.
Note
You will not be asked to confirm the deletion. The data source will be deleted immediately.
7. Click Save.
8. Perform an IIS reset to finalize the platform changes.
Note
Deleting a platform will delete all associated data sources and reports for that platform.
To delete a platform, follow these steps:
1. Go to Admin Settings > Platforms and Data Sources.
2. Click the platform that you want to delete. The Platform Settings page appears.
3. Click Delete platform.
4. Click OK to confirm.
5. Perform an IIS reset to finalize the platform deletion.