Configuring the Scheduler [Linux]
This video explains how to configure Exago BI’s Scheduler Service on a Linux server with Apache.
Welcome back to the Exago Technical Training Series! In this video we will demonstrate how to configure the Scheduler Service on Linux. Configuration in two steps: first we’ll configure the Scheduler Service itself then move on to the Web Application’s Admin Console to finish the setup.
Navigate to the Scheduler Service’s installation directory. By default, this is /opt/Exago/Scheduler. In this example environment, we used /opt/Exago/Exago_21.1/Scheduler. Open the Scheduler Service’s configuration file, eWebReportsScheduler.xml in a text editor. There are many available settings in the file. For this video, we will focus on configuring the Scheduler Service to e-mail completed reports and how the Web Application should communicate with the Scheduler Service.
These settings tell the Service how to send e-mail. Provide the host name or IP address of an SMTP server and set smtp_enable_ssl to true if that server requires secure connections. Provide a valid SMTP user ID and password.The smtp_from and smtp_from_name configure the e-mail address and friendly contact name that e-mails from the Scheduler Service will appear to be from.
These settings tell the service how to communicate with the Web Application. The channel type node determines the protocol through which the two communicate: either HTTP or TCP. The port node sets the corresponding port number. All Scheduler Services residing on the same server must have a unique port number. Record these settings, as they’ll be needed when finishing the configuration in the Admin Console. The rest of the settings here can be left as the default values. Though we would like to point out that setting logging to on can capture any helpful information in troubleshooting. Save the file.
Before continuing to the Admin Console configuration, the Scheduler Service must be running. When utilizing a systemd service, the Scheduler Service should start automatically when the system boots and can be managed with the service command. For example, to start the service, we’ll use this command. To check the status of the service, we’ll use this command.
Now we need to go into the Admin Console for the final configuration steps. To open the Admin Console, we’ll use the server IP slash web app virtual path slash Admin.aspx to build our URL. In our case, this looks like this. The Admin Console is used to build Exago’s base configuration file. We will dive into more details in later videos. Use this pane on the left to navigate through the Admin Console’s many settings. To access the Scheduler settings, expand the General node then double-click on Scheduler Settings. Change Enable Report Scheduling to True. Think of this as the “master switch” for all scheduled report functions. We will also set Show Schedule Reports Manager and E-mail Scheduled Reports to True. The Schdule Reports Manager is an interface in the Web Application that shows the status of scheduled reports. E-mail Scheduled Reports tells Exago to use the stored SMTP settings to send scheduled reports via e-mail. Next, set the Schedule Remoting Host in the format channel type colon backslash backslash server colon port. In our case, tcp colon backslash backslash localhost colon 2001 to point the Web Application to the Scheduler Service. If there are multiple Scheduler Services, separate their origins on this line with a semicolon. Click the Test Connection icon to test if the connection is successful. Click Apply to save the configuration changes.
Congratulations! At this point, the Scheduler Service has been installed and configured! We will navigate to the Exago full user interface and show the available scheduling options as as a result of our configuration. To open the full UI, we’ll open a browser tab and build our URL using the serer IP slash web app virtual path slash ExagoHome.aspx. From the Report Tree, on reports permissioned for scheduling, we will now have options to schedule and e-mail. In the Scheduler Manager, we can see existing jobs, both complete and pending.