Difference between revisions of "Notify"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "{| style="float:right;border:1px solid black" |+ Details | Executable | <code>Notify.exe</code> |- | Stage | style="text-align:center;" | 255 |- | Percent Complete | style="te...")
 
Line 19: Line 19:
 
=Notifiers=
 
=Notifiers=
 
The channel in which a topic will be sent. E.G. Email, SMS, Teams, etc.  
 
The channel in which a topic will be sent. E.G. Email, SMS, Teams, etc.  
 +
 +
==Email==
 +
 +
==Micosoft Teams==
 +
 +
==Send Grid==
 +
 +
==Slack==
 +
 +
==Twilio==
  
 
=Topics=
 
=Topics=

Revision as of 10:59, 1 April 2021

Details
Executable Notify.exe
Stage 255
Percent Complete 100%
Message Queue notify


The Notify ETL is responsible for broadcasting different topics of information to different communications channels when a load completes. The progress of a load is not dependent on Notify.

Notifiers

The channel in which a topic will be sent. E.G. Email, SMS, Teams, etc.

Email

Micosoft Teams

Send Grid

Slack

Twilio

Topics

The information which is sent thru a notifier.

Plugins

Notify supports a plugin architecture to add additional Notifiers and Topics. See the .NET Core SDK articles to how to add a reference to the SDK. The nuget package thats relevant is Truxton.Notifications.Core - this package contains all the necessary transitive SDK dependencies.

Plugin Scan Directory

Notify will scan C:\ProgramData\Truxton\Plugins when it starts up for plugins (if the plugin folder does not exist go ahead and create one).

The folder structure for a plugin must be as follows:

  • C:\ProgramData\Truxton\Plugins
    • \PLUGIN_ASSEMBLY_NAME
      • \PLUGIN_ASSEMBLY_NAME.dll
      • (any additional dependencies)

Please take note of the the nested directory. This is so every assembly doesn't need to scanned on startup. So as an example, if my plugin was foobar.dll, you would place it here: C:\ProgramData\Truxton\Plugins\foobar\foobar.dll. Any additional dependencies that foobar.dll needs will go into that directory.