Defining a report data source connection and view access
A data source record in Remedy Smart Reporting contains the connection details that the system uses to access source data for reporting. Remedy Smart Reporting views use these connections to provide tables and fields. During the onboarding process, a data source is created by default, and only one source connection is available per client.
Through the Admin Console, you can create new data sources and associated views. In addition, you can manage the security access to these connections.
Remedy Smart Reporting supports many data sources for reporting. These include databases such as DB2, Oracle, SQL Server, Lotus Notes Domino, and Remedy Smart Reporting In-Memory.
Note
Remedy Smart Reporting license terms allow Remedy ITSM customers to generate reports with the Remedy AR System database (forms). You cannot integrate Remedy Smart Reporting directly with external data sources such as Microsoft Excel, CSV, or XML files; or with any other databases. However, you can integrate Remedy AR System with external data sources to make the data available in Remedy AR System forms, which can then be used for Remedy Smart Reporting.
To view defined data sources
- In Remedy Smart Reporting, in the left panel select Administration > Admin Console.
- Open the Data Sources panel.
All the available connections defined in the system are listed.
To add a new connection
Remedy Smart Reporting gets data from Remedy AR System database. You can create only one source connection per client org during the onboarding process. An error message appears if you try to create a new connection that exceeds the limit of total connections. You must procure an extended license from Yellowfin and then perform the following steps to create a new connection:
- In Remedy Smart Reporting, in the left panel select Administration > Admin Console.
- Open the Data Sources panel.
- Click Add.
- Enter the required connection parameters.
For information on the available options, see To configure parameters for a connection.
To edit a connection
- In Remedy Smart Reporting, in the left panel select Administration > Admin Console.
- Open the Data Sources panel.
- Click the connection.
- Adjust the connection parameters.
- Click Save.
To delete a connection
- In Remedy Smart Reporting, in the left panel select Administration > Admin Console.
- Open the Data Sources panel.
- Click the X on the right side of the row.
- On the confirmation page, review the list that displays the usage of the connection and the views that depend on the connection.
- Click OK.
Note
If the connection is deleted, any views and reports that depend on the connection are also removed.
To configure parameters for a connection
- In Remedy Smart Reporting, in the left panel select Administration > Admin Console.
- Open the Data Sources panel.
- Click the connection.
- Update the required parameters.
- Click Save.
Review the following sections to learn about each parameter.
Connection Description
The Name, Description, and Tags parameters define the basic metadata for the connection. You need these parameters to identify the connection when building content.
Connection Settings
Name | Description |
|---|---|
| Connection Method | The type of connection, for example, JDBC. |
Authentication Adapter | The type of authentication. You can select the standard database authentication method, or pass-through system user authentication to the database. |
| Database Type | The type of database that you want to connect to. |
| Include Schema in SQL | Option that designates whether to include the schema name while addressing the database tables in the SQL queries. |
| Database Host | The name of the Remedy AR System server that is hosting the database. |
| Database Port | The TCP/IP port number of the database. |
| Custom Parameters | The custom parameters, if any. For example, you can add the following custom parameters:
Separate the parameters by a semicolon(;); for example: refreshCache=10;DateTimeFormat=MM/dd/yyyy hh:mm:ss;rowLimit=10000 |
| JDBC Driver | The JDBC driver. |
| User Name | The database user name. This name must be the same as the one specified in Remedy AR System. |
| Password | The password for the database user. To change the password, click Click here to change password. |
| Schema | The schema to be used while connecting to the database. |
Connection Pool
Name | Description |
|---|---|
| Min Connections | The minimum number of connections that can be open simultaneously. |
| Max Connections | The maximum number of connections that can be open simultaneously. Important: The number of connections must not exceed the JDBCMaxCount value configured in the web.xml file. For more information on configuration values for performance tuning, see the knowledge base article at Configuration checklist. |
| Refresh Time | The connection refresh time interval. |
| Timeout | The time interval (in seconds) after which the connection is closed. |
| Use secondary pool | Option that designates whether to use a secondary connection pool for the database for running background tasks. |
When you change the connection pool settings, you do not have to restart the server.
Security
On the Security panel, you can define who has access to this data source connection for view creation, freehand SQL reports, and transformation flows.
The following options are available:
- Public—All users with required role permissions can access and use this connection to create views.
- Private—Only specified users with required role permissions can access and use this connection to create views.
If you set the data source to Private, define specific users or groups of users who can access the connection. Each user can be assigned one of the following levels of access:
- Read—Users can see views based on this data source in the data sources and views page, and when creating a report.
- Update—Users can create, edit, or copy a view based on this data source. They also have the Read level of access.
- Delete—Users can delete this data source connection. They also have the Read and Update levels of access.
Access Filters
In Access Filters panel, you can add new access filters or manage existing ones. For more information, see Restricting access to report data by defining an access filter on a data source and view.
Usage Parameters
Name | Description |
|---|---|
Max Rows Returned | The maximum number of rows returned by queries that are run on this connection. |
Max Rows Returned | The maximum number of rows returned by queries run on this connection when users run analysis queries such as Assisted Insights and Signal analysis. |
| Writable | Option that designates whether users are granted write access to the database. |
| CSV Default | If the connection is writable, defines whether the connection will be used for CSV imports by default. |
| Time zone | The time zone associated with this database connection and related schedules. |
| Broadcast | Option that designates whether users can broadcast the content created on this connection. Important: If you disable this parameter after enabling, the existing scheduled broadcast tasks, if any, get executed. However, disabling this parameter prevents you from creating new Broadcast tasks. |
| Subscribe | Option that designates whether users can subscribe to the content created on this connection. |
| Data Profiling | Option that designates whether data profiling is disallowed in the views that use the data source. |
Views and Content
The Views and Content panel lists the content that has been created based on this data source connection.
Note
You can edit only the source record for which you have access rights.
Comments
Please list all possible Connection Settings Custom Parameters and what are their actions.
Hello Jan Zacharjasiewicz,
Thank you for the feedback on the documetation. We shall make the required changes soon.
Regards,
Vrishali
Hello Jan Zacharjasiewicz,
We have updated the documentation based on your feedback.
Thanks & Regards,
Vrishali
So there are only 4 Custom Parameters?
Hello Jan Zacharjasiewicz,
Apologies for the delayed response.
Yes, there are 4 custom parameters.
Regards,
Vrishali
Connection Settings > Custom Parameters > refreshCache: Indicates the cache refresh interval
Which cache is refreshed ?
Is it in days/hours ?
Log in or register to comment.