Media types

Media types specify the delivery method for reports. They are unique to each company and based on these base types: Email, SCP, S3, and Kafka.

Media types can be managed under Administration > Media types. A list displays all configured media types, and new ones can be created.

Creating media types

To create a new media type, click the blue plus:

mediatypeForm — *Create a media type form*

Name: Name of the media type.
Company: Company in which the media type will be available.
Base type: One of Email, SCP, S3, or Kafka.

After completing the form, click Create. The new media type will appear in the list.

Configuring media types

To configure a media type, click its card.

Email configuration

In case of report delivery via Email, the following information must be provided:

mediatypeEmailConf — *Media type: Email configuration form*

Company: Company for which the media type is created. Cannot be changed.
Mediatype: Base type, fixed to Email. Cannot be changed.
Name: Name for the media type.
Sender email address: Email address used to send messages.
Email server address: FQDN or IP address of the mail server.
Email server port: Typically 25 or 587.
Email server authentication: Toggle if authentication for the mail server is required.
Email server username: Username for authentication against the mail server.
Email server password: Password for authentication against the mail server.
Email subject: Optional static text for the subject line.
Email body: Optional static text for the body.

SCP configuration

mediatypeSCPConf — *Media type: SCP configuration form*

Company: Company for which the media type is created. Cannot be changed.
Mediatype: Base type, fixed to SCP. Cannot be changed.
Name: Name for the media type.
Host: FQDN or IP address of the remote server.
Port: Typically 22 - the default SSH port.
Username: Username for SSH access.
SSH key: Public key of the given user.
Run script after delivery: Option to execute a script after report delivery has been completed.
Script: Script or command to execute if the option Run script after delivery is enabled.

S3 configuration

mediatypeS3Conf — *Media type: S3 configuration form*

Name: Name for the media type.
Object storage URL: URL of the object storage.
Bucket name: Name of the target bucket for deliveries.
Access key: Access key for authentication.
Secret key: Secret key for authentication.
Require TLS: Toggle to enforce connecting over TLS.

Kafka configuration

mediatypeKafkaConf — *Media type: Kafka configuration form*

Company: Company for which the media type is created. Cannot be changed.
Mediatype: Base type, fixed to Kafka. Cannot be changed.
Name: Name for the media type.
Kafka server address: FQDN or IP address of the broker.
Kafka server port: Typically 9092 - the default Kafka port.
Partition: Partition on the broker.
Kafka topic: Target topic on the broker for the reports.
Application name: Optional application name to embed in the message.
Enable authentication: Toggle for client certificate authentication.
Client certificate: PEM-encoded client certificate if authentication is enabled.
Private key: PEM-encoded private key if authentication is enabled - associated with the client certificate.
CA certificate: PEM-encoded CA certificate if authentication is enabled.
Skip certificate validation: Toggle to skip server certificate validation.

Kafka message structure

type Message struct {
    ApplicationName  string `json:"applicationName"` // Application sending the message
    Type             string `json:"type"`            // Type of the message, e.g., 'report'
    ContentType      string `json:"contentType"`     // MIME type of the report
    ContentEncoding  string `json:"contentEncoding"` // Encoding of the report
    Version          string `json:"version"`         // Format version (currently 1.0)
    Hash             string `json:"hash"`            // Hash of the enclosed data
    Data             string `json:"data"`            // Actual report in JSON
}

Deleting media types

Open the context menu of a media type and click Delete.