ServiceSupport.Emails.pyt.xml

<?xml version="1.0"?>
<metadata xml:lang="en"><Esri><CreaDate>20180116</CreaDate><CreaTime>12411700</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20180215</ModDate><ModTime>9520100</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange></Esri><tool name="Emails" displayname="Send Emails" toolboxalias="" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="layer" displayname="Layer" type="Required" direction="Input" datatype="Table or Feature Layer or Table View" expression="layer"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Point, line, or polygon feature layer that will trigger emails to be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Point, line, or polygon feature layer that will trigger emails to be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="delete" displayname="Delete all existing email configurations for this layer" type="Optional" direction="Input" datatype="Boolean" expression="{delete}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Delete all email configurations for this layer.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Delete all email configurations for this layer.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="email_settings" displayname="Email Settings" type="Required" direction="Input" datatype="Value Table" expression="Email Template {SQL Query} {Recipient Email Address} {Email Subject} {Field to Update} {Sent Value};Email Template {SQL Query} {Recipient Email Address} {Email Subject} {Field to Update} {Sent Value}..."><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Emails will be sent in the order listed. For each email setting, provide the following information:&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Email Template: HMTL template that defines the structure and content of the email. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;SQL Query: SQL Query that defines which features will trigger this email to be sent. At a minimum, it is recommended that this query exclude features that have the indicated Sent Values. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Recipient Email Address: Either a static address to which the email should be sent, or the name of a field that contains the email address.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Email Subject: The subject line of the email.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Field to Update: This field will be updated with the provided Sent Value once this email has been attempted to be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Sent Value: The value used to indicate when an attempt has been made to deliver this email. This value will be calculated even is an error occurs when sending the email, such as an invalid email address.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Emails will be sent in the order listed. For each email setting, provide the following information:&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Email Template: HMTL template that defines the structure and content of the email. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;SQL Query: SQL Query that defines which features will trigger this email to be sent. At a minimum, it is recommended that this query exclude features that have the indicated Sent Valus. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Recipient Email Address: Either a static address to which the email should be sent, or the name of a field that contains the email address.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Email Subject: The subject line of the email.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Field to Update: This field will be updated with the provided Sent Value once this email has been attempted to be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;Sent Value: The value used to indicate when an attempt has been made to deliver this email. This value will be calculated even is an error occurs when sendign the email, such as an invalid email address.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="smtp_server" displayname="SMTP Server" type="Required" direction="Input" datatype="String" expression="smtp_server"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;URL of the SMTP server used for sending emails.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;URL of the SMTP server used for sending emails. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="smtp_username" displayname="SMTP Username" type="Optional" direction="Input" datatype="String" expression="{smtp_username}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The username required to authenticate to the SMTP server. This is not required if authenticating through a port.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The username required to authenticate to the SMTP server. This is not required if authenticating through a port.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="smtp_password" displayname="SMTP Password" type="Optional" direction="Input" datatype="String" expression="{smtp_password}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The password required to authenticate to the SMTP server. This is not required if authenticating through a port.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The password required to authenticate to the SMTP server. This is not required if authenticating through a port.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="from_address" displayname="From Address" type="Optional" direction="Input" datatype="String" expression="{from_address}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The address from which the emails should be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The address from which the emails should be sent.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="reply_address" displayname="Reply Address" type="Optional" direction="Input" datatype="String" expression="{reply_address}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The address that should be used for any replies to the email message.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The address that should be used for any replies sto the email message.&lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="use_tls" displayname="Use TLS" type="Optional" direction="Input" datatype="Boolean" expression="{use_tls}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Enable or disable TLS.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Enable or disable TLS.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param><param name="substitutions" displayname="Email Substitutions" type="Optional" direction="Input" datatype="Value Table" expression="{Find {Replace};Find {Replace}...}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;To add attributes from the feature prompting the email to the body or subject of the message, specify text strings that appear in the body or subject and the field or text that should replace them. For example, to add the ID of a feature from the REQUESTID field to the email subject, include a piece of text such as {ID} in the configured Email Subject, and specify here that {ID} should be replaced with the value of the REQUESTID field. All specified substitutions are applied to both the email subject and the email body, for all emails configured for all layers.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference><pythonReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;To add attributes from the feature prompting the email to the body or subject of the message, specify text strings that appear in the body or subject and the field or text that should replace them. For example, to add the ID of a feature from the REQUESTID field to the email subject, include a piece of text such as {ID} in the configured Email Subject, and specify here that {ID} should be replaced with the value of the REQUESTID field. All specified substitutions are applied to both the email subject and the email body, for all emails configured for all layers.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN /&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</pythonReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Send emails based on the attributes of features and table records in ArcGIS Online or Portal-managed layers. These emails can be triggered based on user-provided attributes, or attributes calculated by other tools, such as the Enrich Reports and Moderate Reports tools and can be internal to your organization, or used as a way to acknoledge receipt of a report.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary><usage>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Trigger emails to be sent to either a static email address or one included as an attribute. Emails can be send based on specific attributes by specifying an SQL query that selects only the features for which an email should be sent. &lt;/SPAN&gt;&lt;/P&gt;&lt;P&gt;&lt;SPAN&gt;The contents of the email body can be built in an HTML template, and both the email body and the email subject support including attribute values from the feature or record that is generating the email.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</usage></tool><dataIdInfo><idCitation><resTitle>Send Emails</resTitle></idCitation><idCredit>Esri., Inc.</idCredit><searchKeys><keyword>email; notification</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20180215</mdDateSt></metadata>