====== TaskNotificatorEx ======

The TaskNotificatorEx Job-Step makes it possible to send tasks as an e-mails to a partnerspecific e-mail address.

**Note:**
  * By default, a notification is sent to the email address registered with the user. In the case of automated jobs, this is the user defined in the automation.
  * The fields marked with an <sup>m</sup> can contain variables and functions, see [[en:kommunikation:kanal:masken|]].

~~ GENERATED src="eBiss.ClassLib.Resources.JobSteps.TaskNotificatorEx" changed="" ~~
^Properties^^
^Name^Description^
|**Type**|Class name of the jobstep|
|**Name**|Name for the jobstep that will appears in the job designer|
|**Description**|Optional description for the jobstep|
|**Channel name**|Over which channel the notifications should be sent|
|**Collection scope**|Setting to filter the tasks which should sent from the Notificator: \\- Job tasks \\- Not reported job tasks  \\- Not done current job tasks ( not including sub jobs) \\- Not reported current job tasks ( not including sub jobs)|
|**Relevant task levels**|Sends only the selected tasks. If this is empty, then it sends all types of tasks.|
|**Min. number of failed runs**|Notify only if the message exceeds the number of failed runs. To send a task only once after retries.|
|**Notify system partner**|Send Notifications also to SystemPartner's administrative address.|
|**Notify trading partner**|Send Notifications also to TradingPartners's administrative address.|
|**Use message com sender address**|Uses the sender(system-/tradingpartner) as administrative address.|
|**Use message com receiver address**|Uses the receiver(system-/tradingpartner) as administrative address.|
|**Subject**|The mail subject. If not set, the subject will be "[<timestamp>] eBiss Notification for: recipient". Otherwiese you can set a subject here also using all variables from below, e.g.: "We cannot process docnumer $DocumentNumber"|
|**Additional recipient(s)** <sup>m</sup>|Additional eBiss user or Name:e-Mail addresses separated by comma or semicolon.\\(e.g. Muster Frau and Muster Mann: mf@pranke.com, mm@pranke.com). |
|**CC recipient(s)** <sup>m</sup>|CC eBiss user or Name:e-Mail addresses separated by comma or semicolon.\\(e.g. Muster Frau and Muster Mann: mf@pranke.com, mm@pranke.com). |
|**Notification content type**|Content can be created as HTML, TEXT or from Template (See property 'Notification template'). |
|**Notification template**  <sup>m</sup>|If the notification content type has the value template, then the template will be used to format the notification. Example templates are located in eBissPath\StandardTemplates\TaskNotificatorEx\.|
|**URL Reference**|URL which the notificator refers to|
|**Reset task and message status**|Define whether sent tasks should be set to completed and the message error status should be reset. For the options marked with '(PI)', the action will be executed only if a message has been sent to the system or trading partner.|
|**Append Attachment**|Append the message (attachment) to the mail.|

\\ 
{{:images:sign_warning.png?nolink|}}**Note:** The option **[[en:system:benutzer:anlegen|CreateSingleTaskMessage]]** of the eBissUsers should be used unconditionally to allow the creation of individual tasks for each error to send the TaskMessages to the administrator of the relevant TradingPartner.\\ 




===== The following JobSteps are usually connected to the TaskNotificatorEx =====

  * [[en:prozessdefinition:jobs:jobsteps:kommunikation:taskdispatcher]]


===== Notification when using a template =====

To display the TaskNotification content in a different form it is possible to change the default template.
For example, HTML. \\ Whereby the variable contents can be filled with the following variables.

^Name  ^Meaning|
|**$CommunicationReference**|Reference of the communication (// ComRef //). The message ID of the associated message.|
|**$CommunicationReferences**|Returns the list of $CommunicationReference values separated by comma. Useful if several messages are assigned to the task.|
|**$DocumentExcerpt**|Extract from the affected message (max. First 256 characters).|
|**$DocumentNumber**|A document number. If the error affects more than one document, then the first document number is here.|
|**$DocumentType**|The type of document. For multiple documents, the type of the first document.|
|**$DocumentNumbers**|Returns the list of document numbers separated by commas. Useful if the task concerns several documents.|
|**$DocumentTypes**|Returns the list of document types separated by commas. Useful if the task concerns several documents.|
|**$MessageTradingPartner.Name**|Name of the trading partner associated with the message.|
|**$MessageTradingPartner.TNr**|Participant number of the trading partner associated with the message.|
|**$MessageSystemPartner.Name**|Name of the system partner associated with the message.|
|**$MessageSystemPartner.TNr**|Participant number of the system partner associated with the message.|
|**$MessageTradingPartners.Name**|Returns the list of $MessageTradingPartner.Name values separated by comma. Useful if several messages are assigned to the task.|
|**$MessageTradingPartners.TNr**|Returns the list of $MessageTradingPartner.TNr values separated by comma. Useful if several messages are assigned to the task.|
|**$MessageSystemPartners.Name**|Returns the list of $ MessageSystemPartner.Name values separated by comma. Useful if several messages are assigned to the task.|
|**$MessageSystemPartners.TNr**|Returns the list of $ MessageSystemPartner.TNr values separated by comma. Useful if several messages are assigned to the task.|
|**$NotifiedParty**|Salutation of the recipient (corresponds to the name of the contact person in the trading partner).|
|**$Subject**|Subject of the affected message.|
|**$Subjects**|Returns the list of $Subject values separated by comma. Useful if several messages are assigned to the task.|
|**$TaskCreated**|Fault time.|
|**$TaskMessage**|error message.|

If desired, a fallback can be specified that is to be used when the desired information is missing. \\
The syntax for variable placeholders with fallback: $ (<name of variable> | "<alternative text>"). \\ \\
An example of HTML template is stored in. \ EBiss 3 \ StandardTemplates \ TaskNotificatorEx \. \\


{{:images:sign_warning.png?nolink|}}**Note:** {{ :downloads:basic_task_notification_template.zip|Alternative TaskNotificatorEx template}}.