These settings apply to DUAS nodes (except OS400). The SMTP settings define the configuration of Uproc or alert notification.
The default configuration set in the SMTP folder can be overwritten with Area-specific parameters.
Dollar Universe V5 node:
|
Variable / Label |
Description |
|
|---|---|---|
|
Default email configuration S_ENABLE_SMTP |
D |
Yes: The same SMTP server will be used whatever the Area. No: Different SMTP servers can be defined for each Area: Application, Integration, Simulation and Production. |
|
Host S_SMTP_HOST |
D |
Enter the default host name of the SMTP server. |
|
Port S_SMTP_PORT |
D |
The default value is empty for V5 and 25 for V6. This value may have been changed for the server indicated. Contact the email administrator to check the port number to be used. |
|
Sender S_SMTP_SENDER |
D |
Enter the email address to be used as the default message sender. This address does not have to exist on the SMTP server; in this case, no reply will be possible. Backslash character "\" forbidden. |
Dollar Universe V6 node:
|
Variable / Label |
Description |
|
|---|---|---|
|
Extension of the name of a file attached to email notifications U_SMTP_LOGATTACH_EXT |
D |
Enter the file extension of the file attached to the email notification. The default value is txt. |
|
Enable the email notification by default S_ENABLE_SMTP |
|
Disable: No email notification by default, refer to section: Areas Settings. Enable: This is the default setting for all Areas. |
|
Default SMTP server host S_SMTP_HOST |
D |
Enter the default hostname of the SMTP server. |
|
Default SMTP server port S_SMTP_PORT |
D |
The default value is empty for V5 and 25 for V6. This value may have been changed for the server indicated. Contact the email administrator to check the port number to be used. |
|
Default sender email address S_SMTP_SENDER |
D |
Enter the email address to be used as the default message sender. This address does not have to exist on the SMTP server; in this case, no reply will be possible. Backslash character "\" forbidden. |
|
Customize email header S_SMTP_HEADER |
D |
Title of email notification. The following variables can be used to customize the title of the email notification: !INF!: Information !SEV!: Severity !STATUS!: Job status !TSK!: Task name !SES!: Session name !UPR!: Uproc name !MU!: Management Unit name !NLANC!: Launch number !NUPR!: Uproc execution number !NSESS!; Session execution number !ESP!: Area |
For each Area:
|
Variable / Label |
Description |
|
|---|---|---|
|
Activation SMTP_SETTING_AREA_<Area> |
S |
For each Area, three options can be selected in the drop-down list: Use default: The default configuration (above) will be used. Enable for this Area: The new values defined for this Area will be used. Disable for this Area: No email notification will be sent for this Area. If values have been entered, they will not be used, kept for future use. |
|
V5: Host V6: SMTP server host for area … S_SMTP_HOST_<Area> |
D |
Enter the hostname of the SMTP server for the Area. |
|
V5: Port V6: SMTP server port for area … S_SMTP_PORT_<Area> |
D |
The default value is 25. |
|
V5: Sender V6: Sender email address for area … S_SMTP_SENDER_<Area> |
D |
Enter the email address to be used as the message sender. This address does not have to exist on the SMTP server; in this case, no reply will be possible. Backslash character "\" forbidden. |
<Area> can be set:
The following variables can be used to configure MIME types.
|
Variable: S_SMTP_MIME_... |
Description |
|
|---|---|---|
|
VERSION |
D |
Defines the MIME types version, this value should be '1.0'. |
|
SUBJ_CHARSET |
D |
Defines the character set used in the subject of the email, value should be character sets supported by MIME types (http://www.iana.org/assignments/character-sets ). The default 'unicode-1-1-utf-7' supports the majority of languages. |
|
SUBJ_ENCODING |
D |
Defines an encoding for the subject of the email, it must be set to 'B' or 'base64' (base64 encoding) or to 'Q' or 'quoted-printable' (quoted-printable encoding) or to '' (no encoding). |
|
HEADER_TYPE |
D |
Defines the format of the email. In DUAS, the option 'multipart/mixed' is recommended. |
|
BODY_TYPE |
D |
Defines the content of the message body. In DUAS, the 'text/plain' is recommended. |
|
BODY_ENCODING |
D |
Defines an encoding for the body of the email, it must be set to 'B' or 'base64' (base64 encoding) or to 'Q' (quoted-printable encoding) or to '' (no encoding). |
|
BODY_CHARSET |
D |
Defines the character set used in the body of the email, value should be character sets supported by MIME types (http://www.iana.org/assignments/character-sets ). The default 'unicode-1-1-utf-7' supports the majority of languages. |
|
BODY_DISP |
D |
Defines layout of the email body. In DUAS, the 'inline' option is recommended. |
|
ATTACH_TYPE |
D |
Defines attachment type for email attachments. In DUAS, the 'text/plain' option is recommended. |
|
TRANSFER_ENCODING |
D |
Sets the encoding for the mail attachment. It must be set to 'B' or 'base64' (base64 encoding) or to 'Q' or 'quoted-printable' (quoted-printable encoding) or to '' (no encoding). Default value is 'base64'. |
You must comply with value syntax requirements (including breaks). If an option is not defined, the default value is used.
We recommend changing the default values only if you experience problems sending emails. Make sure you understand MIME types before updating options. SMTP servers involved in the sending of emails may have to be configured to handle MIME types.
DUAS does not support all MIME types, especially MIME types relating to multimedia content.
An email notification can be sent if it has been set up in a Uproc ("Email Notification") or in an alerting rule ("Notification"). The content is the same in both cases, it depends on the execution context.
The message Object contains the following information:
DU/<Alert type>/<Criticity>/<Alert Description>/<COMPANY>/<AREA>/<node>.
For example: DU/JOB_STATUS/HIGH/test/UNIV00/X/NB120290
The different alert types are:
The message body contains a first part, identical regardless of the type of alert, and a variable part depending on the type of the alert.
The first part of the message body contains the following information:
Dollar Universe Alert: <Alert Type>
Criticalness: <Criticity>
Label: <Alert Description>
Company: <Company>
Area: <Area>
Node: <Node>
The variable part of the message body, depending on the alert type, contains the following information:
Task: <Task Id>
Task MU: <Task Management Unit>
Session: <Session Name>
Session Version: <Session Version>
Session Number: <Session Number>
Uproc: <Uproc Name>
Uproc Version: <Uproc Version>
MU: <Management Unit>
Launch Number: <Launch Number>
Uproc Number: <Execution Number>
Queue: <Batch Queue>
Priority: <Priority>
Severity: <Severity>
Information: <Information>
Application: <Application>
Domain: <Domain>
Submission Account: <Submission Account>
Processing Date: <Processing Date>
Status: <Uproc Statut>
Alert Type: TOO_LONG_RUN/TOO_LONG_WAIT/TOO_SHORT
Task: <Task Id>
Task MU: <Task Management Unit>
Session: <Session Name>
Session Version: <Session Version>
Session Number: <Session Number>
Uproc: <Uproc Name>
Uproc Version: <Uproc Version>
MU: <Management Unit>
Launch Number: <Launch Number>
Uproc Number: <Execution Number>
Queue: <Batch Queue>
Priority: <Priority>
Severity: <Severity>
Information: <Information>
Application: <Application>
Domain: <Domain>
Submission Account: <Submission Account>
Processing Date: <Processing Date>
Status: <Uproc Statut>
Time Limit: <Limit Duration>
Percentage Limit: <Percentage>
Task: <Task Id>
Session: <Session Name>
Session Version: <Session Version>
MU: <Management Unit>
Session Number: <Session Number>
Processing Date: <Processing Date>
Status: <Status>
Alert Type: TOO_LONG/TOO_SHORT
Task: <Task Id>
Session: <Session Name>
Session Version: <Session Version>
Session Number: <Session Number>
MU: <Management Unit>
Processing Date: <Processing Date>
Status: <Status>
Time Limit: <Limit Duration>
Percentage Limit: <Percentage>
As of version 6.10.41, documentation new updates are posted on the Broadcom Techdocs Portal.
Look for Dollar Universe.