Documentation for Skedler Reports & Alerts

Simple Reporting and Alerting starts here


Introduction

Welcome to the getting started guide for Skedler Reports. We will go through the key steps required to install, activate and setup Skedler Reports software, and generate automated reports.

System Requirements

Before we begin, please make sure you have sufficient system resources to generate and send reports. While the optimum system requirement varies with application needs, below is a recommendation on minimum resources for running Skedler Reports on a Virtual Machine or dedicated server:

System Resources

  • 2 Core CPU
  • 8 GB RAM

Operating Systems

Linux 7 with x86-64-bit architecture

  • Ubuntu 12.04 and above, Debian 7.x and above, CentOS 7.x, Red Hat Enterprise Linux 7.x

Note: Linux 6 is no longer supported

Windows 64-bit architecture

  • Windows 7, Windows 8, Windows 8.1, Windows 10, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012

Library Dependencies

Font config library

Skedler Reports requires font config library to generate the report. To install the library refer to the following steps:

  • Debian/Ubuntu – sudo apt-get install libfontconfig
  • CentOS/Redhat – sudo yum install fontconfig

libnss3 library

Skedler Reports requires libnss3 library to activate license. To install the library refer the following steps:

  • Debian/Ubuntu – sudo apt-get install libnss3
  • CentOS/RedHat – sudo yum install libnss3.so libnssutil3.so

Elasticsearch, Kibana, Grafana, Open Distro for Elasticsearch and ELK on Security Onion

  • Elasticsearch: 5.x – 7.5.x
  • Kibana: 5.x – 7.5.x
  • Grafana: 5.x – 6.5.x
  • Open Distro for Elasticsearch: 0.8.0 – 1.2.0
  • ELK on Security Onion: 6.8.4

Upgrade

If you are upgrading Skedler from older version to the latest version refer Linux Upgrade Guide link or Windows Upgrade Guide link

Installation

Skedler Reports is available in different editions for different operating systems. The product is also available as a docker container for easy setup and use. Please follow the steps below for installing Skedler Reports in your environment.

Linux Installation

  • Download the latest version of Skedler Reports.
  • Untar the skedler.tar.gz file to the desired folder (e.g., /opt). For convenience, let us call “’/opt/skedler” as $skedler_home.
  • Provide the required permission to install_as_service.sh in $skedler home directory script file using the following command:
  • Run install_as_service.sh as sudo user using the following command:
  • The configuration settings for Skedler Reports are stored in $skedler_home/config/reporting.yml file. These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file, run the command below:

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

Debian Package

The Debian package of Skedler Reports can be used to install Skedler Reports on any Debian-based system such as Debian and Ubuntu.

  • Download Skedler Reports deb file.
  • Install Skedler Reports deb package using the below command:

    Note: After the deb package installation, if you would like to remove Skedler Reports deb package use the below command:

  • The Debian package places config files, script files, and the logs directory in the appropriate locations for a Debian-based system:
  • The configuration settings for Skedler Reports are stored in /etc/skedler-reports/reporting.yml file. These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file, run the command below:

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

RPM Package

The Skedler Reports RPM package can be used to install Skedler Reports on any RPM-based system such as Centos 7 and above & Red Hat 7 and above.

  • Download Skedler Reports rpm file.
  • Install Skedler Reports rpm package using the below command:

    Note: After the rpm package installation, if you would like to remove the Skedler Reports rpm package use the below command:

  • The rpm package places config files, script files, and the logs directory in the appropriate locations for a RPM-based system:
  • The configuration settings for Skedler Reports are stored in /etc/skedler-reports/reporting.yml file. These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file, run the command below:

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

Windows

  • Download the latest version of Skedler Reports.
  • Extract the skedler.zip file to the desired folder (e.g., C:\).
  • Change the current directory (or go) to the folder where skedler.zip was extracted. For convenience, let us call this folder as $skedler_home. (e.g., $skedler_home = C:\skedler)
  • Provide read/write permissions to the following folders.
    • $skedler_home/log
    • $skedler_home/reports
    • $skedler_home/src/preview
  • The configuration settings for Skedler Reports are stored in $skedler_home/config/reporting.yml file. These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file,

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

Docker

Skedler Reports is supported on Docker 1.8 and above. Please make sure an appropriate version of Docker is installed before following the next steps.

Obtaining Skedler Reports for Docker is as simple as issuing a docker pull command.

  • The Docker image for Skedler latest version can be retrieved with the following command
  • Note: For running Skedler Reports with multiple container with Docker Compose file, kindly refer the Skedler Reports Docker Compose Installation Guide.

  • Once the Skedler reports image is retrieved, run Skedler Reports in a Docker Container, using the following command:
  • Note: You can retrieve the older versions of Skedler Reports for Docker using tags from here.

  • To pull a particular version, use the following command:
  • Once the Skedler reports image is retrieved, run Skedler Reports in a Docker Container, using the following command :

Skedler Reports container will be downloaded to your virtual or physical server, and will be ready for configuration and launch.
Note: skedler_home inside the container is /opt/skedler and 0.0.0.0 is the bind address in which Skedler runs, 3001 is the Host IP port which Skedler uses and 3000 is the Docker IP port.

  • The configuration settings for Skedler Reports are stored in /opt/skedler/config/reporting.yml within the docker image. These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file, run the command below:

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

AMI

Skedler Reports is available as an Amazon Machine Image(AMI). It simplifies the installation process and shortens the time to get Skedler Reports up and running in AWS

  • Follow the steps given below to Launch the AWS instance.

    1. Login to your AWS account and click “Launch Instance” in the EC2 Dashboard.
    2. Search for Skedler AMI in the AWs Market Place”.
    3. Select Skedler Reports AMI.
    4. Select the instance type. Please check the minimum requirements mentioned below:

      • Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler.
      • In AWS minimum instance type should be t2.large which will meet the above minimum requirements.

    5. Configure the instance details and network configuration as follows,

      • Configure the number of instances for scaling, by default it is 1.
      • In the network select the VPC which you have created. Make sure you select the same VPC network that you have selected for the ES service (if ES service is public access service then select any VPC).
      • Select public subnet (which will be created for the VPC when you create the VPC).
      • Auto-assign public IP :

        • If “Enabled”, AWS will create a public IP for the instance. Note this IP will be terminated once you shut down the system and another IP will be assigned on restart.
        • If you need a permanent IP,  “Use subnet setting (Disable)” you can associate a Public Elastic IP once the instance is Launched.
      • Select the IAM Role to access the instance  – to secure the instance.
      • Configure the shutdown behaviour and termination protection.

    6. Add necessary storage to the instance
    7. Configure the Security Groups as follows,

      • In the Instance creation wizard, Select “Select an existing security group” option – Select the security group that have access to the following ports or Select “Create a new security group” with permissions for the following ports,

        • Port 22 – port used to connect to Skedler instance through SSH and configure Skedler.
        • Port 3000 – port on which Skedler will run by default. You can change the port in Skedler configuration. In that case, you can add permissions to the new port later in the security group.
      • Make sure that security group is added to the AWS Elasticsearch service. (Once created you cannot modify the VPC settings in the AWS ES service).
      • On selecting it will show the inbound rules as in the image.

    8. Add a key pair or use an already existing key pair to login into the system. Follow the instruction in the wizard. Download the pem file and store it securely (you cannot download it later).
    9. After configuring the instance, launch the instance. Once the instance is launched copy the IP address or the public DNS.
  • Using your local computer, SSH into the AWS instance using putty. Login username will be “ubuntu” by default. Goto the /skedler directory. For convenience, let us call “’ /skedler” as $skedler_home.
  • Provide the required permission to install_as_service.sh in $skedler home directory script file using the following command:
  • Run install_as_service.sh as sudo user using the following command:
  • The configuration settings for Skedler Reports are stored in /skedler/config/reporting.yml file (Skedler is installed in the home folder of the instance). These settings include hosts configuration, admin user configuration, SSL settings and Datastore configuration.To edit the configuration file, run the command below:

Proceed to the steps outlined in the Configuration section to configure the reporting.yml settings.

Configuration

Skedler security configuration

To use the security plugin and therefore, the authenticated users of ELK or Grafana for user-based report creation and generation, follow the below configuration,

  • Uncomment the variable skedler_anonymous_access and set the value to false.
  • By default skedler_anonymous_access variable value is set to true. If the value is set to true, Skedler will not use the ELK or Grafana authentication mechanism. For example,
  • If Skedler is configured to work with ELK or Grafana security plugin, the default administrator username/password for Skedler is skedlerAdmin/skedlerAdmin. The administrator login will allow you to configure data source details for Skedler report generation. If you would like to update the admin password, uncomment the variables skedler_password and set the required password and login to Skedler.
    For example,

Datastore configuration

Skedler needs a datastore to store Skedler metadata and history data. By default Skedler uses Internal Database as a Datastore. Alternatively, you can configure either Elasticsearch or an external “mysql” or “sqlite” database as a Datastore.

If you would like to use Elasticsearch as a Datastore (especially if you are upgrading from v3.x), follow the configuration shown below:

Elasticsearch Basic Settings

  • Add Elasticsearch URL with the port (even if the port is 80) in the reporting.yml file in the following format <protocol>://<server>:<port>.
  • If any security plugin is configured for Elasticsearch such as X-pack or Search Guard or Basic Auth or AWS Open Distro, uncomment the variable and configure the variable with the respective value given below:
  • Skedler history index which will be created in elasticsearch. It will create a new index if it doesn’t already exist. Default Skedler_History is .skedler_reporthistory
  • If skedler_history_index_format is set, skedler history index will be created based on the format. For ex :skedler_reporthistory_2019-11-29 for ‘YYYY-MM-DD’

Elasticsearch Advanced Settings

Advanced Configuration are optional, you can uncomment the variables and set the required values. For more information on Advanced Configuration refer to the following article Reporting.yml & ReportEngine Configuration link

  • Skedler supports SSL encryption for both client requests and the requests that the Skedler server sends to Elasticsearch. To encrypt communications between the browser and the Skedler server, you need to configure the following properties in reporting.yml.
  • If you are using X-Pack Security or a proxy that provides an HTTPS endpoint for Elasticsearch, you can configure Skedler to access Elasticsearch via HTTPS so communications between the Skedler server and Elasticsearch are encrypted. To do this, you specify the HTTPS protocol when you configure the Elasticsearch URL in reporting.yml,

Proceed to the steps outlined below in Launch section

Internal Database Location

  • Skedler uses an embedded database to store metadata and history data. The embedded database is located at,

External Database Settings

If you would like to use an external database, which should either be “mysql” or “sqlite”, refer to How to configure an external database link

Proceed to the steps outlined below in Launch section

Launch

Skedler can be run manually (via command line) or as a service. It can also be run in debug mode which generates additional log information. Skedler support team will request you to run Skedler in debug mode while troubleshooting report generation issues.

Linux

Running as a Service

  • To start Skedler Reports as a service, execute the command as shown below:
  • To stop Skedler Reports as a service, execute the command as shown below:

Running from the command line

  • To start Skedler manually, make sure that the current user running Skedler has the ownership for skedler home directory. Goto the $skedler_home directory (e.g., /opt/skedler) and execute command as shown below:

Running in debug mode

  • To start Skedler Reports in debug mode, execute the command as shown below from $skedler_home

Test Skedler Reports connectivity

  • Once launched, you can test the Skedler connectivity by accessing the following URL:
  • Skedler Reports server URL will be as shown below:

For Elastic Stack reporting, proceed to the steps outlined in Install Skedler Reports as Kibana Pluign section (or) proceed to the steps outlined below in Skedler Login section

Debian/RPM Package

  • To automatically, start Skedler Reports when the system boots up, execute the command as shown below:

Running as a Service

  • To start Skedler Reports as a service, execute the command as shown below:
  • To stop Skedler Reports as a service, execute the command as shown below:

Test Skedler Reports connectivity

  • Once launched, you can test the Skedler connectivity by accessing the following URL:
  • Skedler Reports server URL will be as shown below:

For Elastic Stack reporting, proceed to the steps outlined in Install Skedler Reports as Kibana Pluign section (or) proceed to the steps outlined below in Skedler Login section

Windows

Running as a Service

  • To start the application as service, execute the command as shown below from $skedler_home
  • To stop the application as service, execute the command as shown below from $skedler_home

Running from the command line

  • To start the application manually, execute the command as shown below from $skedler_home

Running in debug mode

  • To start Skedler Reports in debug mode, execute the command as shown below from $skedler_home

Test Skedler Reports connectivity

  • Once launched, you can test the Skedler connectivity by accessing the following URL:
  • Skedler Reports server URL will be as shown below:

For Elastic Stack reporting, proceed to the steps outlined in Install Skedler Reports as Kibana Pluign section (or) proceed to the steps outlined below in Skedler Login section

Docker

Running as a Service

  • To start Skedler Reports as a service, execute the command as shown below:
  • To stop Skedler Reports as a service, execute the command as shown below:

Running in debug mode

  • To start Skedler Reports as a service in debug mode, execute the command as shown below from $skedler_home

Test Skedler Reports connectivity

  • Once launched, you can test the Skedler connectivity by accessing the following URL:
  • Skedler Reports server URL will be as shown below:

For Elastic Stack reporting, proceed to the steps outlined in Install Skedler Reports as Kibana Pluign section (or) proceed to the steps outlined below in Skedler Login section

AMI

Running as a Service

  • To start Skedler Reports as a service, execute the command as shown below:
  • To stop Skedler Reports as a service, execute the command as shown below:

Running from the command line

  • To start Skedler manually, make sure that the current user running Skedler has the ownership for skedler home directory. Goto the $skedler_home directory (e.g., /skedler) and execute command as shown below:

Running in debug mode

  • To start Skedler Reports in debug mode, execute the command as shown below from $skedler_home

Test Skedler Reports connectivity

  • Once launched, you can test the Skedler connectivity by accessing the following URL:
  • Skedler Reports server URL will be as shown below:

For Elastic Stack reporting, proceed to the steps outlined in Install Skedler Reports as Kibana Pluign section (or) proceed to the steps outlined below in Skedler Login section

Install Skedler Reports as Kibana Plugin

If you are using ELK stack, you can now install Skedler as a Kibana plugin. Skedler Reports plugin is available for Kibana versions from 6.5.x to 7.5.x
NOTE: Skedler plugin is not available for Grafana at this time.

Follow the steps below to Install Skedler Reports as a Kibana Plugin.

Installation

If the server in which you are installing Skedler Reports plugin has an internet connection, use Online Installation. If the server in which you are installing Skedler Reports plugin does not have an internet connection, use Offline Installation.

Online Installation

Copy the URL of the Skedler Reports plugin matching your exact Kibana version from here link.

  • Stop Kibana
  • Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
  • Execute the command as shown below:

For Linux,

For example if the Kibana v7.5.0 and Skedler Reports plugin v4.8.0,

For Windows,

For example if the Kibana v7.5.0 and Skedler Reports plugin v4.8.0,

Offline Installation

Download the Skedler Reports plugin matching your exact Kibana version from here link

  • Stop Kibana
  • Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
  • Execute the command as shown below:

For Linux,

For example if the Kibana v7.5.0 and Skedler Reports plugin v4.8.0,

For Windows,

For example if the Kibana v7.5.0 and Skedler Reports plugin v4.8.0,

Configuration

Once the Skedler Reports plugin is installed, configure the Skedler Reports URL to connect to the Skedler Reports server.

  • Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
  • cd $kibana_home/plugins/skedler/config
  • To edit the configuration file skedler_reports.yml, run the command below:
  • For Linux,

    For Windows,

URL Configuration

Configure the Skedler Reports server URL in the skedler_reports_url variable. By default, the variable is set as shown below,

Basic Auth Configuration

If the Skedler Reports server URL requires basic authentication, for example, Nginx, uncomment and configure the skedler_username and skedler_password with the basic authentication credentials as shown below:

Start Kibana

Start Kibana, it will start optimizing and caching browser bundles. This process may take a few minutes and cannot be skipped. After the plugin is installed and optimized, Kibana will be up running.

Access Skedler Reports Plugin

In the Kibana home page, you will find the Skedler Reports in the left panel as shown below,
plugin-skedler

Click on the “Skedler Reports” to access Skedler Reports UI

plugin-skedler-ui
Proceed to the steps outlined below in Basic Setup section

Access Skedler Reports

If you are using Skedler Reports with Grafana, access Skedler Reports as shown below:

Linux/Debian/RPM Packages/Windows/Docker

Once launched, Skedler Reports can be accessed from the following URL:

Proceed to the steps outlined below in Skedler Login section

AMI

Once launched, Skedler can be accessed from the following URL:

Proceed to the steps outlined below in Skedler Login section

Skedler Login

If the skedler_anonymous_access variable is set to false in reporting.yml, Skedler will display a login screen as shown below on successful installation.

Login

Login Skedler with the default Skedler admin credentials, configured in the Skedler configuration file $skedler_home/reporting.yml in the SKEDLER SECURITY SETTINGS section. On successful login, follow the steps outlined below in Basic Setup

If the skedler_anonymous_access variable is set to true, in reporting.yml, Skedler will not have a login screen on successful installation. Follow the steps outlined below in Basic Setup

Basic Setup

The following pop-up is displayed when Skedler is launched.

skedler-basic

Data Source Configuration

You can configure the Data Source details required for Skedler report generation.

1. Select the Datasource as ELK Stack or Grafana
If you use Elasticsearch and Kibana, choose Datasource as ELK Stack,

data_source_configuration

  • Enter the name of the Datasource in the Name field.
  • Enter the Elasticsearch URL instance in the Elasticsearch URL field. By default the field is set with “http://localhost:9200” value.

elastic_search_url

  • Optionally, If the entered Elasticsearch URL has SSL certificate, enable the Elasticsearch SSL using the toggle button
    • Specify the path to the PEM-format of the certificate and key in the SSL Certificate and SSL Key fields respectively.
    • Specify the path to the PEM file of the certificate authority in the SSL Certificate Authorities field.
    • Select the SSL Verification Mode as None to disregard the validity of SSL certificates, and Full to regard the validity of SSL certificates.
  • Optionally, Elasticsearch Advanced Options allows you to set the following,
    • Search Limit – Search limit is the number of rows to show in the search table. The default value set is 500.
    • Ping Timeout
      • Time in milliseconds to wait for Elasticsearch to respond to pings. This must be > 0.
    • Request Timeout
      • Time in milliseconds to wait for responses from Elasticsearch. This must be > 0.

    SSL

  • Enter the Kibana URL instance for Skedler report generation in the Kibana URL field. By default the field is set with “http://localhost:5601” value.
  • Enter the Kibana index in the Kibana Index field. By default the field is set with .kibana value
  • Optionally, If the entered Kibana URL has SSL certificate, enable the Kibana SSL using the toggle button
    • Specify the path to the PEM-format of the certificate and key in the SSL Certificate and SSL Key fields respectively.
    • Specify the path to the PEM file of the certificate authority in the SSL Certificate Authorities field.
    • Select the SSL Verification Mode as None to disregard the validity of SSL certificates, and Full to regard the validity of SSL certificates.
      ES
  • If Kibana has Security plugin or Basic auth configured, then turn “On” the Authentication using the toggle button and fill the following field values. If Kibana does not have any Security plugin or Basic auth configured turn “Off” the Authentication using the toggle button. By default Authentication is enabled.
    • Select the Authentication Type from the drop-down.
    • To let Kibana users login Skedler enable the Enable Kibana User Authentication for Report Generation.
    • Note: If the Authentication Type is Xpack, you can enable the User Impersonation option which will generate reports on behalf of the login user. To know more about User Impersonation in Skedler refer X-pack User Impersonation in Skedler link
    • Enter the security username and password for Elasticsearch in the Elasticsearch Admin Username and Elasticsearch Admin Password field and for Kibana in the Kibana Admin Username and Kibana Admin Password respectively.

If you use Grafana, choose Datasource as Grafana,

Grafana

  • Enter the name of the Datasource in the Name field.
  • Enter the Grafana URL instance in the Grafana URL field. By default the field is set with “http://localhost:3000” value.

    ssl_certificate
  • Optionally, If the entered Grafana URL has SSL certificate, enable the Grafana SSL using the toggle button
    • Specify the path to the PEM-format of the certificate and key in the SSL Certificate and SSL Key fields respectively.
    • Specify the path to the PEM file of the certificate authority in the SSL Certificate Authorities field.
    • Select the SSL Verification Mode as None to disregard the validity of SSL certificates, and Full to regard the validity of SSL certificates

      authentication_grafana
  • If Grafana has Security users, then turn “On” the Authentication using the toggle button and fill the following field values. If anonymous access is enabled in Grafana turn “Off” the Authentication using the toggle button. By default Authentication is enabled.
    • To let Grafana users login Skedler enable the Enable Grafana User Authentication for Report Generation
    • Enter the security username and password for Grafana in the Grafana Admin Username and Grafana Admin Password field respectively.

2. Click Test and Save to test and save the configuration. On successful configuration click Next button.

Notification Channel Configuration

1. Select the Notification Channel from the drop-down.
For Email Settings, choose Notification Channel as Mail,

Notification

    • Enter the name of the notification channel in the Name field
    • By default Supported Service is set to Others. Choose one of the following email services.
      • If you use a standard SMTP server, choose Others.
        support_Service
      • Enter the outgoing email server in the Outgoing Server field.
      • Enter the Port for the email server.
      • Enable Use SSL toggle button to use SSL to connect to email server.
      • Enter the email id of the sender in the Sender’s Email field (this is the email id from which all the reports are sent) to configure the outgoing mail settings.
      • Enable Password using toggle button if the SMTP server has authentication.
      • Enter the password in the Password field.
      • Enter an email address for the Admin Email field. This is the email to which a warning message will be sent if the reports are empty.
    • If you use Gmail, choose Gmail
      Gmail

      • Enter the email id of the sender in the Sender’s Email ID field (this is the email id from which all the reports are sent) to configure the outgoing mail settings.
      • Enter the password in the Password field.
      • Enter an email address for the Admin Email field. This is the email to which a warning message will be sent if the reports are empty.
    • If you use Amazon SES, choose SES, SES-US-EAST-1, SES-US-WEST-1 or SES-US-WEST-2
      SES

      • Enter the email id of the sender in the Sender’s Email ID field (this is the email id from which all the reports are sent) to configure the outgoing mail settings
      • Enter the username in the Username field.
      • Enter the password in the Password field.
      • Enter an email address for the Admin Email field. This is the email to which a warning message will be sent if the reports are empty.
    • If you use other Amazon SES, choose SES Other Settings
      SES_Others

      • Enter the outgoing email server in the Outgoing Server field.
      • Enter the Port for the email server.
      • Enable Use SSL toggle button to use SSL to connect to email server.
      • Enter the email id of the sender in the Sender’s Email field (this is the email id from which all the reports are sent) to configure the outgoing mail settings.
      • Enter the username in the Username field.
      • Enable Password using toggle button if the SES server has authentication.
      • Enter the password in the Password field.
      • Enter an email address for the Admin Email field. This is the email to which a warning message will be sent if the reports are empty.

For Slack Settings, choose Notification Channel as Slack,
Slack

  • Enter the name of the notification channel in the Name field.
    Token
  • Enter the Legacy token that was generated using your Slack API to the Token field.
  • Enter the user or channel name to the Admin field. A warning message will be sent to the configured user or the channel if the reports are empty.

2. Click Save and Test button to test the configuration. On successful configuration click the Create Report button to create the report definition.

Schedule Reports

Next, we will create and schedule a report with default options. You can further customize the report using template and filters which are described later.

Basic Report

Enter the appropriate values in the fields to generate the report.

Report Details

basic_report

  1. Enter the name of the report in the Report Name field.
  2. Select the Data Source from the drop-down.
  3. Select the type as Dashboard for report with dashboard visualizations. Select the type as Search for report with search results. Select the type as Data Table for report with Data Table Visualization.
    Note: If you have multiple Spaces configured in Kibana, select the spaces from the Select Space drop-down or if Grafana has multiple Organization in Grafana, select the Organization from the Select Organization drop-down. The dashboards or search list will be discovered based on the selected space or organization.
  4. Select the required dashboard or search from the Select Dashboard, Select Search or Select Data Table drop-down to generate reports.
  5. Optionally, select the required filter from the Select Filter drop-down. By default, the “No filter” option is selected.
  6. If the Kibana Dashboard is saved with Store time with dashboard in Kibana then Use dashboard time window option is enabled by default. This schedules the report for the stored time. If Use dashboard time window checkbox is not selected, Time Window is enabled, which allows you to generate the report for a specific time window.
  7. Optionally, enter the Tags which helps you to search the report based on the tags.
  8. In the Advanced option optionally, enter the Report Output Directory. It allows storing the scheduled reports on the Skedler server. You can also customize your report output directory by adding the custom parameters. To display the list of custom parameters created type $ in the Report Output Directory field. By default the Include Basepath is enabled Skedler will take the base path configured in the Advanced settings page and the report will be generated in that location. You can also override by unchecking the Include Basepath checkbox.
  9. Click the Next button to configure Report Design details

Report Design

Report_design

  1. Enter the title of the report for the generated PDF report in the Report Title field.
  2. Select the format of the report from the Select Format drop-down. The following formats are available: PDF, PNG – Inline, PNG – Attachment, Excel and HTML.
    Note: When the Email setting is disabled, the report is downloaded in the PDF or PNG format.
  3. Optionally, you can enable the Include Report type option to generate excel report along with the other report types.
  4. Select the required template from the Select Template drop-down.
    • By default, “Default Template” is selected.
      default_template
      • Click the Download Template button to download and view the selected template.
      • Select the Layout type as Smart Layout or Custom Layout, by default “Smart Layout” is enabled.
        Note: Layout Configuration applicable only for PDF reports.
    • If No Template option is selected,
      No_Template
      • Select the Layout type as Smart Layout or Dashboard Layout, by default “Smart Layout” is enabled.
        Note: Layout Configuration applicable only for PDF reports.
      • Choose page Orientation (portrait or landscape). By default “Portrait” is selected
      • Advanced Option (is applicable for PDF reports) allows you to select the following,
        • Page size: If the report type is PDF, you can configure the paper size of the report as A4, A3, Legal or Letter
        • Optionally, you can set a logo for the report to be generated. By default “No Logo” is selected. The logo options are as follows:
          • Choose Default Logo: If you would like to use the default logo that you configured on the Settings page.
          • Custom Logo: You can use a custom logo for this report by uploading logo in the Logo field.
      • Font Family: You can select the type of font in which the report needs to be generated.

Schedule Details

Schedule

Optionally, you can enable Schedule. If you would like to schedule the reports specify the following details and click the Schedule button.

  1. Set up the schedule for the report by selecting the Frequency Type as “Hourly”, “Daily”, “Weekly”, “Monthly”, or “Yearly”
  2. Enter the scheduled frequency time in the Schedule Frequency Time section to schedule report generation.
  3. Enter/select the start time to generate the report from the Start Time field. Once the report is scheduled you will find the schedule details as shown below,
    report_detail

Report Action

Optionally, you can configure Report Actions details.

Click the + button to add the action(Email/Slack). Click on the respective action to configure the details for the reports.

  • Email
    Email_action
    1. Enter the recipient email address in the Email To field.
    2. To send a copy of the email, enter the email addresses in the Email CC field.
    3. To send a copy of the email privately, enter the recipient email address in the Email BCC field.
    4. To send the generated reports to the recipients corresponding to the filter, select the Include Recipients in Filter checkbox. Refer to Set up Filters section for information on setting up the filter.
    5. Enter the subject of the email in the Subject field.
    6. Enter the message for the email in the Message field.
    7. Select the parameter name from the Merge Parameter Name field. You can merge the Custom parameter names in the Subject and Message fields for the email with the generated report.
      warning_email
    8. Optionally, you can customize the Warning Message Option. If the generated report has no date for the specified Time Window then the email will be sent to recipient entered in the Warning Email field.
      email_report
    9. To send a copy of the report instantly, click the Action button and click Email Report option.
    10. To save the scheduled report, click the Save and Exit button.
    11. If the Email Setting option is set of “off” in the Configuration > Notification Channels , you can generate the reports using the Generate now option.
  • Slack
    You can also schedule the slack for the report if the Slack Setting option is set to “on” in the Slack configuration settings page.
    slack_channel

    1. Click the Slack Channel action button. The Slack action tab is displayed.
    2. Enter the Channel name or the user name or the user id in the Send To field to which the reports have to be sent.
    3. Enter the message for the email in the Message field.
    4. Select the parameter name from the Parameter field and click the Merge button. This enables you to merge the parameter names in the Message fields for the slack with the generated report.
    5. Additional Information lets you send the parameter name to the Slack message. By default, the Additional Information option is enabled with the default parameters.
      slack_report
    6. To send a copy of the report instantly, click the Action button and click Slack Report option.
    7. If the Setting Setting option is set to “off” in the Slack Configuration page, you can generate the reports using the Generate now option.
    8. Once the action tab details are configured click the Save and Exit button.

When the report is scheduled, you can view the scheduled report for the Dashboard

report_dashboard

You can also send or generate multiple reports in a single click. select the reports that you need to send or generate and click “Send / Generate” option from action dropdown as shown,

multiple_generate

Custom Report

Professional looking custom reports are ideal for sending to customers and important stakeholders. Custom reports require report templates. You can design a report template with header, footer, logos and more. Then you can use this template to design a custom layout for the report.

Template Creation

Click on Report Templates in the main menu, to navigate to the template creating page. By default a “Default Template” is available. Click Create New Template button to create custom templates.

Template

Select the appropriate option listed below for creating the templates.

template_option

  1. Click the pencil icon to enter the name of the report template.
    orientation
  2. Choose Orientation (portrait or landscape)
  3. Select the Page Size you can configure the report paper size with the following options – A3, A4, Letter, or Legal.
  4. Select the Font Family you can select the type of font in which the report needs to be generated.
  5. Select the template from the Template drop-down to customize the new report template.
  6. The report template has two list of pages Cover Page and a Report Page. You can set placeholder elements to the pages. The elements with the parameter will be replaced with the corresponding values during report generation.

Cover Page

coverpage

Cover page has three sections: Header, Main, and Footer
Here are some tips for working with the custom tools for Introduction page:

  • Header and Footer – The Header is a section that appears in the top margin, while the Footer is a section that appears in the bottom margin. Headers and footers generally contain additional information such as page numbers, date, report title, and logo.
    elements
  • You can set the information by dragging the report template elements like Text(Dynamic), Image, Data & Time(Dynamic), Time Window(Dynamic), Report Title(Dynamic) and Pagination(Dynamic) to your desired position.

    Note: If Header and Footer sections are enabled it’s common across all the pages (Cover and Report page).
    cover_report_page
  • You can change the background color of the Cover page Header/Footer. To choose a background color for the header/footer section. Click the Color bar and choose the color scheme you want to apply.
    apply_cover
  • Apply layout to all pages – Report template elements present in the header or footer of the Cover page will appear on the Report page.
  • Properties – You can set report template elements to the report with the help of the following properties.
    Note: Elements with dynamic are parameters. The elements will be replaced by the value during report generation.

    1. Text – You can add text to your page with the Text item.
      • Click and drag the Text element to the desired position in header/main/footer section
        drag_option

      • Double-click the element. Type your text in the text area.
      • To format the text,
        • Select the text you want to modify
        • To apply the formatting, click one or more of the formatting buttons on the Mini-Toolbar: Font Size, Underline, Strikethrough, Bulleted list, Alignment or Font Color.
      • Click the save icon.
      • To delete, the object on the object hover click the delete icon.
      • To edit, double click the object perform the necessary changes and then click the save icon.
        save
      • Click the save icon.
      • To increase or decrease the size in one or more directions, You’ll see a box around the object with dots along the edges and in the corners, click, hold down the mouse button and drag a sizing handle inwards to shrink or outward to enlarge.
      • Note: Delete, Edit, Format or Resize options of the report template element(Text) is similar to following subsequent elements.
    2. Image – You can add a background image or logo to the Cover page with the Image element.
      • Click and drag the Image element to the Main section.
        image
      • Double-click the element and choose the image that you want to set as the image.
      • To increase or decrease the size in one or more directions, You’ll see a box around the object with dots along the edges and in the corners, click, hold down the mouse button and drag a sizing handle inwards to shrink or outward to enlarge.
    3. Date & Time(Dynamic) – You can add the current Date and Time to the page with the Date & Time(Dynamic) element.
      • Click and drag the Date & Time(Dynamic) element to the desired position in header/footer section
        date_time
      • To save the object click the save icon
    4. Time Window(Dynamic) – You can add the scheduled Time window to the page with the Time Window(Dynamic) element
      • Click and drag the Time Window(Dynamic) element to the desired position in header/footer section
        Time_window
      • To save the object click the save icon
    5. Report Title(Dynamic) – You can add the report title to the page with the Report Title(Dynamic) element
      • Click and drag the Report Title(Dynamic) element to the desired position in header/main/footer section
        Report_title
      • To save the object click the save icon
    6. Pagination(Dynamic) – You can add the page numbers to the page with the Pagination(Dynamic) element
      • Click and drag the Pagination(Dynamic) element to the desired position in header/footer section
        Pagination
      • To save the object click the save icon

When the Apply layout to all pages option is enabled in the Cover page then the report template items present in the Introduction page Header/Footer section will be available on the subsequent Report pages also.
saveexit
To save the report template click the Save and Exit button.
To reset the report template click the Reset button.
To save as a new report template click the Save as New Template option.

Report Page

If the Apply layout to all pages options is NOT enabled, scroll down, below the Cover page is the Report page, customize the Report page Header/Footer section with the report template elements.

report_page

In the report page, the main section is the Dynamic chart area where you can drag and drop the Kibana chart at the time of report creation. Also, you can drag and drop the needed report template elements.
Note: Image element is not available for the Report page

After customizing the report , you can click the Save and Exit button. To discard the changes and use default template, click the Reset button.

The custom template will now be available in the list under Templates menu

templates_menu

Custom Report Creation

Once the template is created, you can create a custom report using the new template. The steps below describe how to use the template in an existing report and customize it. You can also create a new custom report using the template.

To edit the scheduled report, select “Edit” from the “Action” drop-down in the Skedler home page

custom_report

  1. Navigate to the “Report Design” section in the report definition.
  2. Select a previously created template from the Select Template drop-down to generate a custom report. To view the selected template, click Download Template button.

    download_template
  3. On selecting the template the Layout Type as Custom Layout, you will be navigated to the Custom Layout page. The left panel displays the list of charts present in the Kibana dashboard. The right panel is the Report page of the template where you can drag and drop the charts to the Main section.

    layout_type
  4. To add charts to the Main section, drag and drop the Kibana dashboard charts displayed on the left panel of the Custom Layout page to the desired position.
    kibana_dashboard
  5. To increase or decrease the size in one or more directions, You’ll see a box around the object with dots along the edges and in the corners, click, hold down the mouse button and drag a sizing handle inwards to shrink or outward to enlarge.
  6. To delete the chart from the page click the trash icon.
  7. Click Add Page to add subsequent page. Initially, the Report page count is 1. The page count increases when a new page is added.

    add_page
  8. Once clicked the current page scrolls up and the newly added page is visible where you can drag and drop the required charts in the desired position and the Report page count is increased.
    position
  9. To delete a page, click the delete page icon.
    delete
  10. To update the custom report click Save And Exit option from the “Action” drop-down or to navigate to next section click the Next button.
    You can now view the scheduled report on the Dashboard. The report now uses custom template and layout.

Report Bursting

Report bursting is a method of producing a set of reports containing personalized content that is based on a common report definition. You can use Filters to create reports with personalized data for recipients. For example, you can use report bursting to send the website visitor metrics reports for each country to the respective country marketing managers.

Filter Creation

  1. Click on Burst Filters in the main menu, then click the Create New Filters button to create a filter list.

    create_filter

  2. Enter the name of the filter list in the Filter Name field.
    add_new_filter
  3. Filter list can be added using the following ways – uploading an excel file or creating an empty file.
    • To upload an excel file, click the Upload Filter From Excel button. Please note that only .xlsx file format is supported.
      • Select the Excel file with filters, recipients, folder and customparam. A sample Excel file format is shown below. The recipients can be an individual email address, email mailing list or bank cell. The filter consists of the lucene/kibana query filter. The folder is the name the sub-folder in which the report needs to be generated. You can assign custom parameter name and value for the filter query.
        filter_excel
      • Click the Create button to create the filter list with query filters.
        query_filter
  4. Click the Add Parameter button to add the customer parameters. The Parameter Name is the list of the parameter name created in the Custom Parameter section in the Advanced settings page. Select the Parameter Name from the drop down and assign a specific value.

    custom_parameter

  5. Click the save icon to save to entire row of Report Filter, Report Recipients, Folder Name and Custom Parameter.
    filter_Save

Reports with Filters

Once the filter list is created successfully, you can configure filters either to the existing report or create a new report with filters. The steps below describes how to use a filter with the existing scheduled report.

  1. To edit the scheduled report, select “Edit” from the “Action” drop-down in the Skedler home page.
    custom_report
  2. In the “Report Details” section, select the custom filter from the Select Filters drop-down
    • Select the required filter from the Select Filter drop-down. The drop-down displays all the existing filter list created.
      select_filter
    • Click the Save and Exit option from the “Action” drop-down, to update filter details of the schedule report

      save_report

The filter has been updated for the scheduled report now.

License Activation

Upgrading from 3.x to 4.x

If you have a valid Skedler product license key, then upgrading Skedler from v3.x to v4.0 does not require License activation.

New free trial of Skedler

Once Skedler has launched it operates in Enterprise trial with a validity of 21 days. Once the Enterprise trial expires, the product moves to Community Edition and operate with limited functionality

activat_licence

Upgrading from Community/Trial Edition

Activation is required for purchased product license key. If you purchase Skedler license, you will receive a license key by email.

If the server in which you are installing Skedler has an internet connection, use Online License Activation. If the server in which you are installing Skedler does not have an internet connection, use Offline License Activation.

Online Activation

  1. Click license information edition on the main-menu, and then click the Activate License button

    activat_licence
  2. The License Activation page is displayed.
    • In the License Activation page, enter the required details.
      • Enter the Name, Email, and Company Name in the corresponding fields.
      • Enter the 25-digit alphanumeric license key or activation code in the License Key field.
        Note: You must have a license key to activate the product.

  3. If the Internet connection requires a proxy server enable the Enable Proxy option.
    Note: By default Enable proxy option is disable. To enable the option navigate to Configuration > Advanced Settings > Proxy Setting. By default “no proxy” option is set. Click the “Edit” icon, specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the Username and Password fields. Click the Save button.
  4. Read and select I agree to the terms and conditions checkbox.
  5. Click Online Activation button to activate the Skedler Product License
    actvate
  6. You can verify the active license by clicking license information edition on the main-menu,
    starter

Offline Activation

  1. Click license information edition on the main-menu, and then click the Activate License button

    activat_licence
  2. The License Activation page is displayed.
    • In the License Activation page, enter the required details.
      • Enter the Name, Email, and Company Name in the corresponding fields.
      • Enter the 25-digit alphanumeric license key or activation code in the License Key field.
        Note: Activating the product offline does not require proxy settings
        Note: You must have a license key to activate the product.

    • Read and select I agree to the terms and conditions checkbox.
    • Click Offline Activation to initiate offline activation of Skedler.
      offlineActivation
  3. This generates the product_activation.txt file. Follow the steps below to generate the license file (license_key.dat).On clicking, it will generate a product_activation.txt file. Follow the steps given below to generate the license file(license_key.dat).
    • Copy the product_activation.txt file from the server to a machine with an internet connection (you need an internet connection to generate the license_key.dat file from the license server)
    • Visit Skedler licensing activation page:
      https://www.skedler.com/license-activation/
    • On the licensing activation page, Follow the instructions to upload product_activation.txt file and generate license_key.dat licensing file.
      activation
    • Copy the downloaded license_key.dat file to the skedler server.

      • Make sure there is no other license_key.dat file in the folder you copy.
      • Do not rename the license_key.dat file
    • Upload the license_key.dat file to Skedler using the below steps.
  4. Click license information edition on the main-menu, and then click the License Information button.
    license_info
  5. The License key details are automatically populated. Click Select File to upload the license_key.dat file from the computer and click Activate to activate the license
    activate_button
  6. To cancel the activation, click the Abort button.
  7. You can verify the active license by clicking license information edition on the main-menu,
    starter

License Deactivation/Reactivation

Online Deactivation

UI deactivation

  1. Click the license information edition on the main-menu.

    UI_deactivation
  2. Click Deactivate button to deactivate the product license.

    deactivate

Command line deactivation

Online deactivation requires an Internet connection.

  1. To deactivate Skedler Reports license key, navigate to the skedler_home directory and run the following commands:

Offline Deactivation

UI deactivation

  1. Click the license information edition on the main-menu.

    UI_deactivation
  2. Click Deactivate button to deactivate the product license.

    deactivate
  3. This generates a text file in the product_deactivation.txt path. Please send this file to Skedler Support team via https://support.skedler.com/support/home link. Support team will deactivate and email you a confirmation.

Command line deactivation

Offline deactivation does not require an Internet connection

  1. To deactivate Skedler Reports license key, navigate to the product_deactivation.txt and run the following commands:
  2. This generates a text file in the product_deactivation.txt path. Please send this file to Skedler Support team via https://support.skedler.com/support/home link. Support team will deactivate and email you a confirmation.

Advanced Setup

The advanced setup options are accessible by clicking on Configuration icon on Skedler main menu, and then selecting Advanced tab.

Timezone

By default timezone is set with the Skedler server time. Time Zone is used for scheduling the report.

TimeZone

Proxy Details

If the Internet connection requires a proxy server set the Proxy Settings details.

    proxy

  1. Click the Edit icon to update Proxy Details settings
  2. Select the Proxy Type. By default, No Proxy is selected.
  3. If the Proxy Type is Automatic Proxy then it takes the system configured proxy.
  4. If the Proxy Type is Manual Proxy, specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the User Name and Password fields.
  5. Click the Save button.

Report Logo (optional)

You can configure a default logo for the scheduled reports. This logo will be used in the header of PDF reports.

Report_logo

  1. Click Edit icon to update Report Logo settings.
  2. Click Select image to upload the logo. Once the image has been loaded, you can change or remove it by clicking Change and Remove buttons.
  3. Click Save to save the uploaded image. Click Close to reset Report Logo settings.

Custom Parameter

You can add custom parameters to your report. Custom parameter allows you to add a dynamic key with a specific value. Where you can define the parameters name and value in report output directory, report title and merge parameters while sending out an email. This parameter name will be replaced by the value in the PDF reports.

no_parameter

  1. Click Add Parameter button
    custom_parameter
    add_parameter
  2. Add the Parameter Name and a default value and click Save to save the custom parameter.

Other Settings

Other_settings

  1. Debug Mode If you face any issue in running Skedler, the support team will request you to run Skedler in debug mode and upload the log files. By default, the value is set as false. You can modify the value as true and click the Save icon.
  2. Zoom Factor You can scale the Kibana map visualization when you generate the Skedler report with the Zoom Factor for the Map visualization. By default, the value is set as 68. You can modify the value as required and click the Save icon.
  3. Base Folder Directory You can configure the location for storing your skedler reports. Make sure the folder has read/write permissions. The default location is $skedle_home/reports in the application directory. You can modify the default location and click Save icon.

    Note: In Skedler v3.5 and below, if the report generation location is configured in the Skedler configuration file for report_dir variable then the base path is taken from the configuration file.
Suggest Edit
scroll_to_top