Configure Delivery Method Options

Currently there are 7 delivery methods you can utilize in your process: 

• FILE – message will be created in defined server folder

• FTP - message will be created in defined FTP folder

• SFTP - message will be created in defined SFTP folder

• JMS - message will be created and sent by Java Message Service

• MQS -  message will be created and sent by Message Queuing Service

• EMAIL - message will be created and sent to defined emails list

• HTTP - message will be sent to defined URL

In this page:

How to Set Delivery Methods

There are two ways to set delivery method for notification messages in an environment:

• Set the same delivery method for all notification message types by defining the W_DEF_DATA_DM variable in the config file or DeliveryMethod as a task parameter in the Control Message (CM).

• Set a separate delivery method for each notification message type by customizing a variable:

  • W_DEF_ACK_DM (in config) / ACKDeliveryMethod (as task parameter) – define custom delivery method for ACK notification message types

  • W_DEF_EXTRACT_DM / ExtractDeliveryMethod – for Extract notification message types

  • W_DEF_ALERT_DM / AlertDeliveryMethod – for Alert notification message types

  • W_DEF_REPLY_DM / ReplyDeliveryMethod – for Reply notification message types

An example of such combination is below:

The task parameters for CM below not only create ACK, Extract, Alert, Reply messages in the defined server folder, but also send a duplicate of the Reply message to defined emails as well:

When no default delivery method is specified in the configuration files, the FILE delivery method option is used by default. 

The FILE delivery method is special and is always used, regardless of whether another delivery method has been set.

For example, if the notification delivery method is set to EMAIL a notification message will be sent via email AND the same notification message will be generated in the defined server folder. If the notification delivery method is set to FILE, only one notification message will be generated in the defined server folder.

You can specify the default delivery method option and associated sub options by file type. The following table lists the delivery method options and sub options available for each file type.

Change Folders for FILE and FTP/SFTP Delivery Methods in the Control Message

Extend the Wait for File Upload Time for FILE and FTP/SFTP Methods

Task reported checks the size of received files,
- for FILE - once in 5 seconds
- for FTP/SFTP - once in 20 seconds

By default, if file size remains the same between two checks, the file is taken into further processing.

You can make the process perform size checks for an extended time to make sure the file was fully delivered. To do that, please specify the following task parameter in your CM:

Default extended value is 300 seconds. To customize it, you can use the global parameter W_WAIT_FOR_FILE_UPLOAD_TIME or the following CM parameter:

FTP/SFTP and JMS Delivery Setup

Configure Control Message Delivery Over FTP

To make Eagle consume control messages from an FTP location, it is necessary to:

• Create a folder on your FTP site CMW/control.

• Create a stream* of FTP/Inbound/XML type based on the eagle_ml-2-0_cm\in\xml\control_messages.rsf ruleset file.

• Do NOT use eagle_ml-2-0* mask for the stream name or it will be deleted when you upgrade.

The control message file should be delivered in to the CMW/control folder.

Configure Control Message Delivery Over JMS

To make Eagle consume control messages from a JMS queue, it is necessary to:

• Create a separate JMS queue for Eagle to read control messages from.

• Create a stream* of JMSPTP/Inbound/XML type based on the eagle_ml-2-0_cm\in\xml\control_messages.rsf ruleset file.

• Do NOT use eagle_ml-2-0* mask for the stream name or it will be deleted when you upgrade.

Configure Data Delivery Over JMS

In order for Eagle to receive data for EJM Requests from a JMS queue, it is necessary to:

• Create a stream* of JMSPTP/Inbound/XML type based on the Eagle_ml-2-0_cm\queue\queueing.rsf ruleset file.

• Specify the data payload.

Configure Control Message Delivery Over FTP

To make Eagle consume control messages from an FTP location, it is necessary to:

• Create a folder on your FTP site CMW/control.

• Create a stream* of FTP/Inbound/XML type based on the eagle_ml-2-0_cm\in\xml\control_messages.rsf ruleset file.

• Do NOT use eagle_ml-2-0* mask for the stream name or it will be deleted when you upgrade.

The control message file should be delivered in to the CMW/control folder.

Configure Control Message Delivery Over JMS

To make Eagle consume control messages from a JMS queue, it is necessary to:

• Create a separate JMS queue for Eagle to read control messages from.

• Create a stream* of JMSPTP/Inbound/XML type based on the eagle_ml-2-0_cm\in\xml\control_messages.rsf ruleset file.

• Do NOT use eagle_ml-2-0* mask for the stream name or it will be deleted when you upgrade.

Configure Data Delivery Over JMS

In order for Eagle to receive data for EJM Requests from a JMS queue, it is necessary to:

• Create a stream* of JMSPTP/Inbound/XML type based on the Eagle_ml-2-0_cm\queue\queueing.rsf ruleset file.

• Specify the data payload.

Configure Email Distribution List

You can set email distribution list to define email addresses, on which notification messages will be sent IF delivery method is ":enumDMEMAIL:" / "EMAIL".

To customize the email distribution list in config file, use the W_SENDMAILTO variable. This setting will make notification messages sent to emails defined in this variable if the delivery method is ":enumDMEMAIL:" / "EMAIL"
Example: tst@mail.ru, tst2@mail.com .

You can also specify an email distribution list for each of notification message types using task parameters in CM:

• ACKEmailDistributionList – to define emails for ACK notification message type

• ExtractEmailDistributionList – to define emails for Extract notification message type

• AlertEmailDistributionList – to define emails for Alert notification message type

• ResponseEmailDistributionList – to define emails for Response notification message type

Email Notification Setup

Follow the step-by-step instruction for email notification setup:

You will need to  get SMTP server and port settings. If you already know them, skip to setting notification parameter. 

Otherwise, do the following:

• Open Engine Manager application.

• Go to "All Web Servers">[Server Name in bold]>[THICK server]>EagleSTAR Config Files>Configuration Files->msgcenter->open msgservice.ini file

Open

• Search on the left side parameters SMTP Server,  SMTP Port and From email (if last is set):

Open

• Note these values

• Next, you will need to set Send notification parameter

• Open Message Center Editor.

• Open /eagle_ml-2-0_custom_cm/w_config_custom.inc file:

• Find "W_SMTPSERVER", "W_SMTPPORT" ("W_SENDMAILFROM") parameters and set saved values to them using Message Center Editor:

Make sure you are setting the EXPRESSION attribute values in quotes, for example:

"W_SENDMAILFROM" parameter defines the email, which will be set in "From" field in notification letter.

• For August 2016 EagleML release or older you should set default email delivery streams in w_config_custom.inc:
  In September 2016 EagleML release (and newer) we are going to move these parameters into w_config.inc , so that you will be getting the default values already set. You will not have to add them to w_config_custom.inc unless you want to use custom streams.

  
  
  

• For example:Set value to "W_SENDMAILTO" parameter. This parameter define email, on which notification letter will be send. For example:

  
  
  

• If you want to get notification only on EJM task fails then add to bottom of this config file next line:

  
  
  

• Click Save button:

• Select Tools->re-initialize Message Center Cache menu item:

• Your email setup is now complete.

• You can run some EJM task to verify For example, drop a Control message to eagle_ml-2-0_default_cm_control_message stream to run a non-existent workflow.

HTTP Distribution Setup

In order to enable HTTP Distribution, next steps should be done:

1. Add varHTTPDistribution parameter to w_config_custom.inc

2. In eagle_wrf_generic_extract workflow on eagle_ml-2-0_default_cm_file_distribution step, open Custom Parameters and add RemoteFileName parameter with value like this:

   This string defines cmReplyTo parameter, which contains url to reply with or without options.

3. cmReplyTo can have options defined like this:

   String should start with dynamic:
   parameter_name;parameter_value! separated by ; and each pair should end with !
   List of possible cmReplyTo options:

To trigger HTTP Distribution, RTR should contain ExtractDeliveryMethod parameter with HTTP value:

Example of RTR for HTTP Distribution: