Skip to main content

Email Task Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Patchable (Instance Only)

attachLocalFile

Attach Local File

Specification for whether or not a local file is attached.

Specification for whether or not a local file is attached.

N

Y

bccRecipients

Bcc

Email address of the party being sent a blind (hidden) copy of the email, if any.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Y

body

Body

Text of the email message.

Variables and functions are supported. If both the email template and the email task contain text in the body, the text is appended.

N

Y

ccRecipients

Cc

Email address of the party being sent a copy of the email, if any.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Y

connection

Email Connection

Name of an Email Connection.

An Email Connection specifies information about an email server. If you specify both an Email template and an Email connection, the Email connection overrides the Email Connection specified by the Email template.

Y
(unless an Email
template is specified)

Y

listReportFormat

List Report Format

Report format

info

If the attached report is not a List type report, this option will be ignored.

Default is PDF (1).

Valid Values:

  • As String = PDF, As Value = 1
  • As String = XML, As Value = 2
  • As String = JSON, As Value = 3
  • As String = CSV, As Value = 4
  • As String = TSV, As Value = 5

N

Y

localAttachmentsPath

Local Attachments Path

Location of Local Attachments for the connected Node.

N

Y

localAttachment

Local Attachment

Name of the file(s) to attach.

N

Y

replyTo

Reply-To

Email address of the sender.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Y

report

Report

Report to attach to this email; if reportVar is specified, report is ignored.

If reportVar is specified, report is ignored.

Reports do not have to be unique by Title. However, reports with the same Title must be unique per Visibility: per User, per one or more Groups, and per Everyone.

Therefore, when specifying a report reference, both the Title and Visibility must be specified.

To define a report reference for a report with Title XYZ that is visible to user john.doe, you would specify:

XML
<report>
  <title>XYZ</title>
  <userName>john.doe</userName>
  <groupName />
</report>
JSON
"report": {
  "title": "XYZ",
  "userName": "john.doe",
  "groupName": null
}
info

To specify a single visibility group, you can utilize either groupName or groupNames with only one groupName in the list.

To define a report reference for a report with Title XYZ that is visible to group Operators, you could specify:

XML
<report>
  <title>XYZ</title>
  <userName />
  <groupName>Operators</groupName>
</report>
JSON
"report": {
  "title": "XYZ",
  "userName": null,
  "groupName": "Operators",
}

or

XML
<report>
  <title>XYZ</title>
  <userName />
  <groupName/>
  <groupNames>
    <groupName>Operators</groupName>
  </groupNames>
</report>
JSON
"report": { 
  "title": "XYZ",
  "userName": null,
  "groupNames": {
    "groupName": "Operators",
  }
}
info

Duplicate group visibility is prohibited and thus there should be only a single report (of the same title) visible to a particular group. Therefore, to look up a report visible to multiple groups, you can specify one or more of the visibility groups, as long as the report is visible to all of the specified groups.

To define a report reference for a report with Title XYZ that is visible to groups Operators, Finance, and Development;

You could specify any one of the visibility groups:

XML
<report>
  <title>XYZ</title>
  <userName />
  <groupName>Operators</groupName>
</report>
JSON
"report": {
  "title": "XYZ",
  "userName": null,
  "groupName": "Operators",
}

Or you could specify multiple visibility groups:

XML
<report>
  <title>XYZ</title>
  <userName />
  <groupName/>
  <groupNames>
    <groupName>Operators</groupName>
    <groupName>Development</groupName>
  </groupNames>
</report>
JSON
"report": {
  "title": "XYZ",
  "userName": null,
  "groupNames": {
    "groupName": "Operators",
    "groupName": "Development",
  } 
}

To define a report reference for a report with title XYZ that is visible to Everyone, you would specify:

XML
<report>
  <title>XYZ</title>
  <groupName />
  <userName />
</report>
JSON
"report": {
  "title": "XYZ",
  "userName": null,
  "groupName": null
}

N

reportVar

Y

reportVar

Report Variable

Name of a variable that will be resolved at run time to the name of the Report to use.

N

report

Y

subject

Subject

Subject line of the email.

Variables and functions are supported.

N

Y

template

Email Template

Name of an Email Template

An Email Template allows you to specify standard recipients and text for outgoing emails. Every Email Template specifies an Email connection. If you do not specify an Email template, you must specify an Email connection. If you specify both an Email template and an Email connection, the Email server specified by the Email connection overrides the Email server specified in the Email template. (Any information specified in an Email task overrides what is specified in an Email Template.)

N

Y

templateVar

Email Template Variable

Name of a variable that will be resolved at run time to the name of an Email Template to use.

Format: ${variable name}.

N

Y

toRecipients

To

Email address of the recipient.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Y