OpenLM EasyAdmin – Reports Scheduler (v21 and higher)
The OpenLM EasyAdmin web interface incorporates a variety of reports that display information related to license usage. EasyAdmin allows sharing these reports by either:
- Granting report viewing access to non-administrator accounts
- Sharing a custom-generated report URL
- Sharing the report by email to specific users, groups or individual addresses in an accessible format (.png, .csv)
By default, these reports are generated manually whenever the user requests or accesses the given feature. The OpenLM Reports Scheduler extension allows administrators to automate this process by giving them the ability to generate reports according to a predefined schedule.
In order to schedule a report, the OpenLM administrator should:
- Configure a valid SMTP server in EasyAdmin’s “Email/SMS” module.
- If EasyAdmin authentication is turned on, check that you have an admin account in EasyAdmin and configure it with Scheduler.
- Open a specific EasyAdmin report and define filters (e.g. License Usage report).
- Click Share → Schedule, define the frequency, report recipients, then click Save.
Once this is done, the scheduled report will be sent to the designated recipients at the specified time. A scheduled report displays the same data as a regular report, the main difference being that it’s generated automatically. This makes them ideal when used with a date range filter that displays a recent period (i.e. “Last 7 days”).
In order to install OpenLM Reports Scheduler the following prerequisites must be met:
- A single OpenLM Server installation running on a central network server.
- An OpenLM license that includes support for the Reports Scheduler extension (please contact sales if you cannot locate the “Reports_Scheduler” feature in the Administration → OpenLM License window).
- (optional) If you choose not to install the OpenJDK 11 distributive that comes bundled with the Reports Scheduler installer, a compatible version of Java 11 must be present on the target machine.
* This will vary depending on the Reports Scheduler installer package (consult the release notes).
OpenLM Reports Scheduler should be installed on the same machine where OpenLM Server resides.
1. Download the latest installer of OpenLM Reports Scheduler from the Downloads page.
2. Double-click the installer file (Openlm_Reports_Scheduler_XXXX.exe) to start the installation. The installer window appears:
3. Click Next to advance to the License Agreement screen:
4. Check the I accept the terms of the License Agreement box then click Next
5. On the Choose Install Location screen you can provide an alternative installation folder. We recommend leaving the default one as-is. Click Next.
6. The Choose Components screen displays the required components that will be installed. JRE can be optionally unchecked if you prefer using an external installation of Java 11, however we recommend leaving the default settings as-is. Click Install.
7. Click Next then Finish to close the wizard.
8. To verify that the Reports Scheduler is operational, open the Services window and verify that the “OpenLM Report Scheduler” service is up and running.
Since OpenLM Reports Scheduler sends the reports by email, a working email server must be configured in EasyAdmin’s Start → Administration → Email/SMS module.
It is highly recommended to enter at least one value for Recipient Addresses as it will be used to send notifications in case any errors occur.
By default, scheduled reports are attributed to a specific user. In most cases, this user would be the administrator that set up the scheduled reports. This designated user should exist within the OpenLM database and should have a valid email account associated with it.
In order to set a user’s email, open EasyAdmin Start → Users & Groups → Users. Find the user you want to assign an email to, double click on it and edit the user’s details as depicted in the image below:
For more information on how to create users (and other entities) in OpenLM, please refer to this application note: Introducing Entities in OpenLM – Users, Groups, IP and Hosts
The report_scheduler.properties file is where all of Reports Scheduler’s settings are stored. Usually, most settings required for operation are defined during the installation process or preserved from a previous version (if upgrading). Manually editing this file is not required as long as the steps in section 4 (“Configuring EasyAdmin to produce scheduled reports”) have been followed.
However, editing is possible and even required in special cases such as:
- If no SMTP server has been configured in EasyAdmin. By default, the SMTP configuration in EasyAdmin overrides the one in report_scheduler.properties. However, if for some reason SMTP is not configured there, the mail variables can be used to configure SMTP independently. A benefit of doing this is that administrators can be notified by email if any errors occur during the integration of Reports Scheduler with Server.
- If there are any changes to the OpenLM Server hostname (if installed on a different machine than the Server) or default communication ports.
The following variables are most relevant for administrators to configure:
|mail.smtp.host*||User-defined||The SMTP server host or IP.|
|mail.smtp.port*||User-defined||The SMTP server port.|
|mail.smtp.auth*||true or false||Set depending on whether the SMTP server requires login credentials.|
|mail.smtp.ssl*||true or false||Set depending on whether the SMTP server uses SSL for connections.|
|mail.smtp.username*||User-defined||The SMTP server user.|
|mail.smtp.password*||User-defined||The SMTP server password.|
|mail.smtp.sender*||User-defined||The email address that will show up on the “from:” field.|
|mail.recipients*||User-defined||The recipient email(s), separated by a semicolon.|
|openlm.protocol||http (default) or https||The protocol used on OpenLM’s API port.|
|openlm.host||localhost (default) or FQDN||The OpenLM Server hostname that Reports Scheduler will synchronize with.
The localhost is to be changed by the Fully Qualified Domain Name (FQDN) when the SSL connection is required by the OpenLM Server.
|openlm.soap.port||Default: 5015||The OpenLM Server API port.|
|openlm.ea.port||Default: 5015||OpenLM’s EasyAdmin port.|
|openlm.ea.host||Default: localhost (default) or FQDN||OpenLM’s EasyAdmin hostname, the same as OpenLM Server’s hostname
The localhost is to be changed by the FQDN when the SSL connection is required.
|openlm.ea.protocol||http (default) or https||OpenLM’s EasyAdmin communication protocol. Can be set to http or https.|
|openlm.client.id=openlm.reportscheduler.client||Configured automatically from Identity Service web UI when a user connects Identity Service and Reports Scheduler||Report Scheduler’s credentials for a secure connection.|
|scheduler.report.files.directory||User-defined||If you want reports to also be stored locally in a specific directory, set a path here.|
|webdriver.impl.path||Default: chromedriver.exe||Change if using a different path for the ChromeDriver.|
* Note: If not configured, Reports Scheduler will use the SMTP server settings configured in EasyAdmin.
Param.js File Configuration to connect OpenLM Server (EasyAdmin) with Report Scheduler
In case OpenLM Server (Easy Admin) and Report Scheduler are installed on different computers/servers and they are unable to connect, for example, getting the connection error while connecting to default host 127.0.0.1. Perform the following steps to change the required hostname and port number in the param.js file of the OpenLM Server to enable connect it to the required host and port of the Report Scheduler:
To locate the param.js file of the OpenLM Server, navigate to the below-mentioned default path:
“C:\Program Files\OpenLM\OpenLM Server\bin\wwwroot\params.js”
Default Report Scheduler – scheduling task URL is mentioned in the param.js file and is as per shown in the image below:
Change the hostname and/or the port number of the computer/server to that of where the Report Scheduler is installed.
Case 1: Connection via Identity Service
To configure Report Scheduler in a secured environment via the Identity Service, perform the following steps:
Please know it is required to have the OpenLM Server, Identity Service, and Report Scheduler installed on your machine:
- Install OpenLM Server. Refer to the link on How to Install OpenLM Server:
- Install Identity Service. Refer to the link on How to Install Identity Service:
- Install Report Scheduler. Refer to Section 3 of this document for the Report Scheduler installation process.
- Now, configure these above-installed applications to connect through the Identity service. The OpenLM Server and Report Scheduler are connected with Identity Service, as shown in the screen below.
To configure Report Scheduler with Identity Service, go to Identity Service< Settings< Security Configuration and switch on the toggle button and add Report Scheduler URL. (Port: 8888). Click the Save button to save the information.
- Restart the Report Scheduler to apply the changes and restart the OpenLM Server.
To restart the Report Scheduler, go to Services > select OpenLM Reports Scheduler, and click Restart to restart the service.
Similarly, to restart the OpenLM Server, go to Services > select OpenLM Server, and click Restart to restart the service.
Report Scheduler will now be connected in a secured environment with Identity Server, as shown in the screen below:
The report_scheduler.properties file will be updated with client.id and client.secret, as shown in the image below.
Case 2 – Connection through HTTPS
When the OpenLM Server is connected through https, it is also required that the OpenLM Report Scheduler is also connected through HTTPS.
Note: The OpenLM Server will not be able to connect to OpenLM Report Scheduler if they both are not connected through HTTPS.
Required Changes in OpenLM Report Scheduler Properties File
To connect the OpenLM Report Scheduler through HTTPS, perform the following steps:
- Navigate to the OpenLM Report Scheduler Properties file.
- Change the protocol of openlm.protocol and openlm.ea.protocol fields to HTTPS.
- Change the openlm host to Fully Qualified Domain Name.
3. Change the server protocol to HTTPS.
- Save the Report Scheduler Properties file to save the changes.
Required Changes in OpenLM Server Param.js File
- Navigate to the param.js file of OpenLM Server.
- In the var_schedulingTaskURL, change HTTP to HTTPS.
- Save the OpenLM Server Param.js file to save the changes.
Required Changes in OpenLM Identity Service appsettings.json File
- Navigate to the appsettings.json file of OpenLM Identity Service.
- Change the scheduler URL to HTTPS. Save the appsettings.json file.
In the OpenLM Identity Service UI, navigate to the Security Configuration tab, and change the URL for Report Scheduler to HTTPS.
Restart the “OpenLM Reports Scheduler” service.
The OpenLM Server will be now connected to Report Scheduler through HTTPS.
1. To schedule a report, open any of the EasyAdmin reports (e.g. License Usage).
2. Configure the report fields, filters, and other options as you require.
3. Click Share in the bottom-left corner of the report window then click on Schedule.
4. The Schedule Report window appears:
Here you can set up:
- Frequency of the report (e.g. Every Sunday at 01:00 AM),
- Recipient(s): this can be either an existing user(s), group(s), or any number of direct email addresses. Please note that for the user and group recipients, a valid email address must be associated with the user and/or the users in those groups
- Job Description: any text you enter here will be included in the email report
- Receiving User Timezone: if the recipient is in a different timezone than the OpenLM Server, this option can be used to adjust the timing
5. Click OK to save the report, then Close the window.
In order to manage scheduling tasks that you have already created:
1. Click EasyAdmin Start → Scheduling Tasks
2. In the window that appears, select any of the tasks you wish to modify. You can Edit, Delete, Disable/Enable and Show URL of any of the scheduled reports (this feature is identical to the one when clicking Share → Share Link)