Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

You can use a PDF Reader to read the pages of PDF documents.

This document provides information about the PDF Reader using which you can read all the pages in a specified PDF document or read a specific page of a specified PDF document.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-pdf-reader

Prerequisites

  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

You do not require to configure this connector since this connector uses the freely-accessible PDF Reader. For the description of the Connector page and other details, click here.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Read All Pages Reads all the pages of the PDF document whose file name and path you have specified. read_all_pages
Investigation
Read A Page Reads a specific page of the PDF document whose file name and path, and page number, you have specified. read_page
Investigation

operation: Read All Pages

Input parameters

Parameter Description
CyOPs File IRI/Filepath Select whether you want to specify the FortiSOAR™ file IRI or path of the PDF file that you want to read using PDF reader.
  • If you select CyOPs File IRI, then you must specify the IRI of the PDF file in FortiSOAR™ that you want to read using PDF reader.
  • If you select Filepath, then you must specify the complete file path of the PDF file that you want to read using PDF reader.

Output

The output contains the following populated JSON schema:
{
     "Filename": "",
     "Pages": ""
}

operation: Read A Page

Input parameters

Parameter Description
CyOPs File IRI/Filepath Select whether you want to specify the FortiSOAR™ file IRI or path of the PDF file that you want to read using PDF reader.
  • If you select CyOPs File IRI, then you must specify the IRI of the PDF file in FortiSOAR™ that you want to read using PDF reader.
  • If you select Filepath, then you must specify the complete file path of the PDF file that you want to read using PDF reader.
Page Number Page Number of the specified PDF document that you want to read using PDF reader.

Output

The output contains the following populated JSON schema:
{
     "Filename": "",
     "Pages": ""
}

Included playbooks

The Sample - PDF Reader - 1.0.0 playbook collection comes bundled with the PDF Reader connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the PDF Reader connector.

  • Read All Pages
  • Read A Page

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

About the connector

You can use a PDF Reader to read the pages of PDF documents.

This document provides information about the PDF Reader using which you can read all the pages in a specified PDF document or read a specific page of a specified PDF document.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-pdf-reader

Prerequisites

Configuring the connector

You do not require to configure this connector since this connector uses the freely-accessible PDF Reader. For the description of the Connector page and other details, click here.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Read All Pages Reads all the pages of the PDF document whose file name and path you have specified. read_all_pages
Investigation
Read A Page Reads a specific page of the PDF document whose file name and path, and page number, you have specified. read_page
Investigation

operation: Read All Pages

Input parameters

Parameter Description
CyOPs File IRI/Filepath Select whether you want to specify the FortiSOAR™ file IRI or path of the PDF file that you want to read using PDF reader.
  • If you select CyOPs File IRI, then you must specify the IRI of the PDF file in FortiSOAR™ that you want to read using PDF reader.
  • If you select Filepath, then you must specify the complete file path of the PDF file that you want to read using PDF reader.

Output

The output contains the following populated JSON schema:
{
     "Filename": "",
     "Pages": ""
}

operation: Read A Page

Input parameters

Parameter Description
CyOPs File IRI/Filepath Select whether you want to specify the FortiSOAR™ file IRI or path of the PDF file that you want to read using PDF reader.
  • If you select CyOPs File IRI, then you must specify the IRI of the PDF file in FortiSOAR™ that you want to read using PDF reader.
  • If you select Filepath, then you must specify the complete file path of the PDF file that you want to read using PDF reader.
Page Number Page Number of the specified PDF document that you want to read using PDF reader.

Output

The output contains the following populated JSON schema:
{
     "Filename": "",
     "Pages": ""
}

Included playbooks

The Sample - PDF Reader - 1.0.0 playbook collection comes bundled with the PDF Reader connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the PDF Reader connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.