Fortinet black logo

Report Engine Connector

Report Engine Connector v1.3.2

Copy Link
Copy Doc ID 71bb811a-3812-11ed-9d74-fa163e15d75b:410

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the Report Engine or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

The Report Engine connector is used to generate FortiSOAR™ reports and save this report as a text pdf on the Reports > History page.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

Report Engine

The Report Engine connector is used to generate FortiSOAR™ reports and save this report as a text pdf on the Reports > History page.

NOTE: This connector is ready to use, and you do not need to configure this connector.

IMPORTANT: The Report Engine connector does not support execution on an FSR agent.

Version Information

Connector Version: 1.3.2

FortiSOAR™ Version Tested on: 7.2.2-1098

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.3.2

Following enhancements have been made to the Report Engine connector in version 1.3.2:

  • Added compatibility for Python 3.9 to this version of the connector.

NOTE: For more information on previous releases of the Report Engine connector, see the Report Engine Connector v1.3.0 document.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
Generate Report from Schedule Generates the PDF of the report using the ID of the schedule you have specified.
NOTE: The report engine internally downloads reports to the /opt/cyops-integrations/integrations/workspace/ directory to ensure that system users running the integrations runtime require only minimal permissions on the file system.
Generate Report from Report ID Generates the PDF of the report using the ID of the report and optionally the report input parameters you have specified.
NOTE: The report engine internally downloads reports to the /opt/cyops-integrations/integrations/workspace/ directory to ensure that system users running the integrations runtime require only minimal permissions on the file system.
Export Data as CSV Exports data in the CSV format using the filters and other parameters you have specified.

operation: Generate Report from Schedule

Input parameters

Parameter Description
Scheduler Specify the ID of the schedule using which you want to generate the report.

operation: Generate Report from Report ID

Input parameters

Parameter Description
Report ID Specify the ID of the report using which you want to generate the report.
Report Params (Optional) Specify the input parameters for the Report PDF report you want to generate. For example: {"qparam":{"incidentID:"351"}}

operation: Export Data as a CSV

Input parameters

Parameter Description
Query Specify the filters using which you want to export data in the CSV format.
Sample Query:
{
"filters": [
{
"OPERATOR_KEY": "$",
"display": "",
"field": "status",
"operator": "in",
"type": "array",
"value": [
"/api/3/picklists/a53d5465-75a6-4b7a-8144-4eccc23cea4a"
]
}
],
"limit": 30,
"logic": "AND",
"sort": [
{
"_fieldName": "priorityWeight",
"direction": "DESC",
"field": "priorityWeight"
}
]
}
Module Name Select the name of the module to be used to fetch the data.
NOTE: You must also specify either the Module Name such as 'Alerts', or Module Type such as 'alerts'. If you specify both, then preference is given to the value set for 'Module Type'.
Module Type Specify the module type to fetch the data.
User ID Specify the ID of the user whose context is used to fetch data, for example, /api/3/people/34511111-aaaaa-bbbbb-ccccc.
Export Filename Specify the name for the exported CSV file.
Maximum Records to Export Specify the maximum number of records to be exported in a single operation. By default, this is set at '2000'.
Batch Size Specify the number of records that should be pulled in a batch from the database. By default, this is set at '250'; set this to a value lower than the default, if the records are large in size and the queries are getting timed out.
Previous
Next

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the Report Engine or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

The Report Engine connector is used to generate FortiSOAR™ reports and save this report as a text pdf on the Reports > History page.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

Report Engine

The Report Engine connector is used to generate FortiSOAR™ reports and save this report as a text pdf on the Reports > History page.

NOTE: This connector is ready to use, and you do not need to configure this connector.

IMPORTANT: The Report Engine connector does not support execution on an FSR agent.

Version Information

Connector Version: 1.3.2

FortiSOAR™ Version Tested on: 7.2.2-1098

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.3.2

Following enhancements have been made to the Report Engine connector in version 1.3.2:

NOTE: For more information on previous releases of the Report Engine connector, see the Report Engine Connector v1.3.0 document.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
Generate Report from Schedule Generates the PDF of the report using the ID of the schedule you have specified.
NOTE: The report engine internally downloads reports to the /opt/cyops-integrations/integrations/workspace/ directory to ensure that system users running the integrations runtime require only minimal permissions on the file system.
Generate Report from Report ID Generates the PDF of the report using the ID of the report and optionally the report input parameters you have specified.
NOTE: The report engine internally downloads reports to the /opt/cyops-integrations/integrations/workspace/ directory to ensure that system users running the integrations runtime require only minimal permissions on the file system.
Export Data as CSV Exports data in the CSV format using the filters and other parameters you have specified.

operation: Generate Report from Schedule

Input parameters

Parameter Description
Scheduler Specify the ID of the schedule using which you want to generate the report.

operation: Generate Report from Report ID

Input parameters

Parameter Description
Report ID Specify the ID of the report using which you want to generate the report.
Report Params (Optional) Specify the input parameters for the Report PDF report you want to generate. For example: {"qparam":{"incidentID:"351"}}

operation: Export Data as a CSV

Input parameters

Parameter Description
Query Specify the filters using which you want to export data in the CSV format.
Sample Query:
{
"filters": [
{
"OPERATOR_KEY": "$",
"display": "",
"field": "status",
"operator": "in",
"type": "array",
"value": [
"/api/3/picklists/a53d5465-75a6-4b7a-8144-4eccc23cea4a"
]
}
],
"limit": 30,
"logic": "AND",
"sort": [
{
"_fieldName": "priorityWeight",
"direction": "DESC",
"field": "priorityWeight"
}
]
}
Module Name Select the name of the module to be used to fetch the data.
NOTE: You must also specify either the Module Name such as 'Alerts', or Module Type such as 'alerts'. If you specify both, then preference is given to the value set for 'Module Type'.
Module Type Specify the module type to fetch the data.
User ID Specify the ID of the user whose context is used to fetch data, for example, /api/3/people/34511111-aaaaa-bbbbb-ccccc.
Export Filename Specify the name for the exported CSV file.
Maximum Records to Export Specify the maximum number of records to be exported in a single operation. By default, this is set at '2000'.
Batch Size Specify the number of records that should be pulled in a batch from the database. By default, this is set at '250'; set this to a value lower than the default, if the records are large in size and the queries are getting timed out.
Previous
Next