Fortinet white logo
Fortinet white logo

QR Code Tools

1.0.1

QRCode Tools v1.0.1

About the connector

QR Code Tools helps users read QR and bar codes from an image, PDF, DOCX file, or an attachment.

This document provides information about the QR Code Tools Connector, which facilitates automated interactions, with a QR Code Tools server using FortiSOAR™ playbooks. Add the QR Code Tools Connector as a step in FortiSOAR™ playbooks and perform automated operations with QR Code Tools.

Version information

Connector Version: 1.0.1

FortiSOAR™ Version Tested on: 7.6.0-5012

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.0.1

Following enhancements have been made to the QR Code Tools Connector in version 1.0.1:

  • Added support to specify name or path of the file in /tmp directory to read the QR or Bar code.
  • Added support to read the QR or Bar code from a PDF or a DOCX file.

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-qrcode-tools

Prerequisites to configuring the connector

You must have the libGLU and poppler-utils packages installed. To install run the following commands as a root user:

yum install libGLU
yum install poppler-utils

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

No configurations are required for this connector.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Read QR/Bar Code Read QR/Bar codes from an image, PDF, or DOCX file or attachment. read_qr_code
Investigation

operation: Read QR/Bar Code

Input parameters

Parameter Description
Input Type Specify the input type that to submit for reading the QR code. You can choose from the following options:
  • IRI: Specify the file or attachment IRI of the file containing the QR code to read, in the File IRI/Attachment IRI field.
  • File Path: Specify the name or path of the file containing the QR code to read, in the File Path field.

Output

The output contains the following populated JSON schema:

[
    {
        "text": "",
        "format": "",
        "content": "",
        "position": ""
    }
]

Included playbooks

The Sample - QR Code Tools - 1.0.1 playbook collection comes bundled with the QR Code Tools connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the QR Code Tools connector.

  • Read QR/Bar Code

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.

Previous
Next

QRCode Tools v1.0.1

About the connector

QR Code Tools helps users read QR and bar codes from an image, PDF, DOCX file, or an attachment.

This document provides information about the QR Code Tools Connector, which facilitates automated interactions, with a QR Code Tools server using FortiSOAR™ playbooks. Add the QR Code Tools Connector as a step in FortiSOAR™ playbooks and perform automated operations with QR Code Tools.

Version information

Connector Version: 1.0.1

FortiSOAR™ Version Tested on: 7.6.0-5012

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.0.1

Following enhancements have been made to the QR Code Tools Connector in version 1.0.1:

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-qrcode-tools

Prerequisites to configuring the connector

You must have the libGLU and poppler-utils packages installed. To install run the following commands as a root user:

yum install libGLU
yum install poppler-utils

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

No configurations are required for this connector.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Read QR/Bar Code Read QR/Bar codes from an image, PDF, or DOCX file or attachment. read_qr_code
Investigation

operation: Read QR/Bar Code

Input parameters

Parameter Description
Input Type Specify the input type that to submit for reading the QR code. You can choose from the following options:
  • IRI: Specify the file or attachment IRI of the file containing the QR code to read, in the File IRI/Attachment IRI field.
  • File Path: Specify the name or path of the file containing the QR code to read, in the File Path field.

Output

The output contains the following populated JSON schema:

[
    {
        "text": "",
        "format": "",
        "content": "",
        "position": ""
    }
]

Included playbooks

The Sample - QR Code Tools - 1.0.1 playbook collection comes bundled with the QR Code Tools connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the QR Code Tools 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.

Previous
Next