Era.Common.DataDefinition.Task.Server.GenerateReport_EmailTarget

Description

Configuration for report sent using email

Properties

Name JsonSchemaType Description
bodyContent string Content of email with generated report
mailHeader reference to Era.Common.DataDefinition.Task.Server.MailHeader Email message headers configuration
mailServer reference to Era.Common.DataDefinition.Task.Server.MailServer SMTP server configuration (override for server configuration)
reportFormat reference to Era.Common.DataDefinition.Reports.PrintReportParameters Parameters for report generating
sendIfNoData boolean true = send independently whether data are available or not ; false = send only if data are available

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.Server.GenerateReport

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.Server.GenerateReport_EmailTarget",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.Server.GenerateReport_EmailTarget"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.Server.GenerateReport_EmailTarget": {
            "$ref": "#/definitions/GenerateReport_EmailTarget"
        }
    },
    "definitions": {
        "GenerateReport_EmailTarget": {
            "additionalProperties": false,
            "required": [
                "bodyContent",
                "mailHeader",
                "reportFormat"
            ],
            "type": "object",
            "properties": {
                "bodyContent": {
                    "type": "string"
                },
                "mailHeader": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.MailHeader#/definitions/MailHeader"
                },
                "mailServer": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.MailServer#/definitions/MailServer"
                },
                "reportFormat": {
                    "$ref": "Era.Common.DataDefinition.Reports.PrintReportParameters#/definitions/PrintReportParameters"
                },
                "sendIfNoData": {
                    "type": "boolean"
                }
            }
        }
    }
}