| | | | 220511131855833 DOCU2540 Workflow email using the Notification Server.pdf Workflow email using the Notification Server.pdf 1865_20220511131854_Workflow email using the Notification Server.pdf 1865_20220511131854_Workflow email using the Notification Server.pdf Workflow email using the Notification Server Page 1 of 4 Workflow email using the Notification Server From 2022 R2 The Notification Server can now be used as an email client for Workflow rules The Sage X3 Notification Server (Administration > Servers > Notification Servers) is an email client for Sage X3 that includes capability for authentication and additional security features such as TLS, and that may also use Notification Themes (Administration > Servers > Notification Themes – Generally available soon) to produce emails. It is based on Nodemailer (Node.js). From 2022 R2, The Notification Server can be used as the main email client in Sage X3 for emails generated by Sage X3 workflow rules. It is optional and can be activated on a need-to basis. Administrators can select whether they would like to use the Notification Server, or the legacy basic email service (meladx) included with the Sage X3 Runtime. Switching to the more advanced Notification Server Please follow these steps to switch to using the Notification Server as an email client for Sage X3 Workflow: General Parameters Parameter Values SYRMAIL and SYRMAILSRV Set up the following parameters (Setup > General Parameters > Parameter Values) in Chapter SUP and group WRK (Workflow) to start using the Notification Server for workflow email. Those parameters are defined at the folder level: • SYRMAIL - (Yes/No – Default = No): Instructs Sage X3 to use the Notification Server for email. Yes: Use the Notification Server for this folder (Endpoint). No: Do not use the Notification Server. The legacy mailer (meladx) will be used as it was in previous releases (no change). No is the default value for this parameter. • SYRMAILSRV: This contains the name of the Notification Server that was set up in Syracuse (See below). Workflow email using the Notification Server Page 2 of 4 Setting up the Notification Server You can set up one or more Notification Servers in Administration > Servers > Notification Servers. Basic information The Name and user-friendly Description identify your Notification Server setup. Type: This identifies the transport type for this setup. The only transport type currently available is SMTP. Additional transport types will be added in subsequent releases of Sage X3. Mail server / Port: This identifies the hostname or IP address to connect to as a mail server (e.g. MS Exchange, hmail server…) and the port to use for sending email (Typically 25 for unsecured SMTP, 465 for secure SMTP). Authentication You can use this to provide authentication credentials for the email server you will connect to. The default value is No authentication. The authentication method available currently is User/Password, but additional authentication methods will be implemented in subsequent releases. Security Enable Secure Connection to encrypt email transfers. This typically uses port 465 with SMTP servers. Enable Check server identity for TLS to perform the usual server integrity checks when secure email is used. Upload the email server CA certificates when using TLS. Refer to this documentation for technical details on CA certificates. Connection Client server name (Unused): This is an optional hostname for current email client (i.e., the Sage X3 application). It is not used for now and the client hostname will default to the local Sage X3 web server hostname. Idle time: This defines a maximum idle time in milliseconds for any connection to the email server. Whenever a connection is opened with the email server, it will stay open after it goes idle, for that timespan. This allows Sage X3 to save time on establishing new connections to the email server each time an email is sent. The longer this idle time is, the less the connection establishment cost is, but the more memory is consumed by the Sage X3 web server (Syracuse). More options This section allows you to enter more advanced options used by Nodemailer for SMTP transport. Please refer to this documentation for more detail. Message configuration Sender email: This is the email that defaults for the sender, if no sender has been defined in the email itself. Default theme: This is the name of the default Notification theme to be used by this Notification server setup. Please see below for more details on setting up a Notification theme (Administration > Notification > Notification themes). Workflow email using the Notification Server Page 3 of 4 Using the Notification server with Workflow rules Prerequisite: General parameter values You need to set the two general parameter values to the correct values (SYRMAIL = Yes and SYRMAILSRV = Notification server name) to instruct Sage X3 to use the Notification Server for workflow-triggered emails. Workflow rule settings Once the parameter values have been set, all workflow rules for that folder will use the Notification server to sent emails, instead of the legacy mailer. An additional setting on the General tab allows you to specify whether Notification themes should be used: Use a theme: When enabled, the Notification server will use its default theme when sending an email. The email contents defined in the workflow rule will be encapsulated within the HTML theme defined in Notification themes, which acts as a container template for your email. See below for more detail on how to set up Notification themes. We are currently working on enhancing Notification themes and making the design easier and more accessible. This will be available very shortly in subsequent releases of Sage X3. Until then, our recommendation with Sage X3 2022 R2 is to keep using Workflow emails with no themes. Using a Theme Notification themes define an HTML envelope, or a generic stylesheet, for emails sent by the Notification server. This acts as a container for email contents, and defines how the title, subtitle and signatures will be displayed in the final email. You can assign a different default theme to each individual Notification server you set up. Defining your template Notification themes work by defining the email content as HTML using the Mustache format. You can use the following variables to define the template for your corporate emails: • content The body content of the mail. • Signature The name of the signer. • Title The title (object) of the email. • subtitle A subtitle for the email. This is not available in Workflow rules. • link.label The displayed text when including a link. • link.href The link reference (URL) when including a link. NOTE: The current workflow rules allow raw-text emails only, even if the text is encapsulated in an HTML theme (template). Full rich-text email content will be enabled in subsequent releases of Sage X3, where it will be possible to set up rich-text content in the Workflow rules. Workflow email using the Notification Server Page 4 of 4 • date.label The current date as a localized string. • date.value The current date as a value. • time.label The current time as a localized string. • time.value The current time as a value. Variables can be embedded in your HTML code using the {{variable}} or {{{variable}}}. The syntax {{#variable}} will display the text only if the variable is not empty. NOTE: We are currently working on enhancing Notification themes and making the design easier and more accessible. This will be available very shortly in subsequent releases of Sage X3. Until then, our recommendation with Sage X3 2022 R2 is to keep using Workflow emails with no themes. We will add more details to this section with the release of the new Notification themes function. |
|