Page Comparison

...

Delivery Method

Option

Sub Options Available

Example of Use

FILE

:enumDMFILE:

FILE_IN_LOCATION
FILE_EXTRACT_LOCATION
FILE_REPLY_LOCATION
FILE_ACK_LOCATION

Code Block

language	xml

<COL TAG="FILE_IN_LOCATION" EXPRESSION="'../../../cmw/in/'" USERDESCRIPTION="FILE IN LOCATION"/>
<COL TAG="FILE_EXTRACT_LOCATION" EXPRESSION="'../../../cmw/extracts/'" USERDESCRIPTION="FILE extracts location"/>
<COL TAG="FILE_REPLY_LOCATION" EXPRESSION="'../../../cmw/reply/'" USERDESCRIPTION="FILE reply location"/>
<COL TAG="FILE_ACK_LOCATION" EXPRESSION="'../../../cmw/ack/'" USERDESCRIPTION="FILE ack location"/>

Info

title	Note

The expression for FILE method should contain full local path

FTP

:enumDMFTP:

FTP_URL [we recommend setting this parameter as server ip]
FTP_USER
FTP_PWD [encryption recommended]
FTP_FILES_LOCATION
FTP_EXTRACT_LOCATION
FTP_REPLY_LOCATION
FTP_ACK_LOCATION

Code Block

language	xml

<COL TAG="FTP_URL" EXPRESSION="'00.000.00.00'" USERDESCRIPTION="EA FTP URL"/>
<COL TAG="FTP_USER" EXPRESSION="'USER'" USERDESCRIPTION="EA FTP USER"/>
<COL TAG="FTP_PWD" EXPRESSION="'base64aes~abcdefgij+X8H+6N93cTok1='" USERDESCRIPTION="EA PASSWORD" ENCRYPTED="YES"/>
<COL TAG="FTP_PWD_ISENCRYPTED" EXPRESSION="'YES'" USERDESCRIPTION="It is strongly recommended to encrypt the password above. Otherwise set this value to NO"/>
<COL TAG="FTP_FILES_LOCATION" EXPRESSION="'CMW/inbound/'" USERDESCRIPTION="EA FTP LANDING ZONE LOCATION"/>
<COL TAG="FTP_EXTRACT_LOCATION" EXPRESSION="'CMW/extracts/'" USERDESCRIPTION="EA extracts location"/>
<COL TAG="FTP_REPLY_LOCATION" EXPRESSION="'CMW/outbound/'" USERDESCRIPTION="EA reply location"/>
<COL TAG="FTP_ACK_LOCATION" EXPRESSION="'CMW/ack/'" USERDESCRIPTION="EA ack location"/>

Info

title	Note

Folder path should be entered relative to the root folder to which you have FTP access.

SFTP

:enumDMSFTP:

SFTP_URL [we recommend setting this parameter as server ip]
SFTP_USER
SFTP_PWD [encryption recommended]
SFTP_PWD_ISENCRYPTED
SFTP_FILES_LOCATION
SFTP_EXTRACT_LOCATION
SFTP_REPLY_LOCATION
SFTP_ACK_LOCATION

Code Block

language	xml

<COL TAG="SFTP_URL" EXPRESSION="'00.000.00.00'" USERDESCRIPTION="URL"/>
<COL TAG="SFTP_USER" EXPRESSION="'USER'" USERDESCRIPTION="USER"/>
<COL TAG="SFTP_PWD" EXPRESSION="'PASSWORD'" USERDESCRIPTION="PASSWORD"/>
<COL TAG="SFTP_PWD_ISENCRYPTED" EXPRESSION="'NO'" USERDESCRIPTION="It is strongly recommended to encrypt the password above. Otherwise set this value to NO"/>
<COL TAG="SFTP_FILES_LOCATION" EXPRESSION="'CMW/inbound/'" USERDESCRIPTION="SFTP LANDING ZONE LOCATION"/>
<COL TAG="SFTP_EXTRACT_LOCATION" EXPRESSION="'CMW/extracts/'" USERDESCRIPTION="SFTP extracts location"/>
<COL TAG="SFTP_REPLY_LOCATION" EXPRESSION="'CMW/outbound/'" USERDESCRIPTION="SFTP reply location"/>
<COL TAG="SFTP_ACK_LOCATION" EXPRESSION="'CMW/ack/'" USERDESCRIPTION="SFTP ack location"/>

Info

title	Note

Folder path should be entered relative to the root folder to which you have SFTP access.

JMS

:enumDMJMS:

W_JMS_DEF_ACK_STREAM
W_JMS_DEF_REPLY_STREAM
W_JMS_DEF_EXTRACT_STREAM

Code Block

language	xml

<COL TAG="W_JMS_DEF_ACK_STREAM" EXPRESSION="'JMS_EJM_EAGLETIP_SEND'" USERDESCRIPTION="Default JMS ACK Delivery Stream"/>
<COL TAG="W_JMS_DEF_REPLY_STREAM" EXPRESSION="'JMS_EJM_EAGLETIP_SEND'" USERDESCRIPTION="Default JMS REPLY Delivery Stream"/>
<COL TAG="W_JMS_DEF_EXTRACT_STREAM" EXPRESSION="'JMS_EJM_EAGLETIP_SEND'" USERDESCRIPTION="Default JMS EXTRACT Delivery Stream"/>

EMAIL

:enumDMEMAIL:

W_SMTPSERVERW_SMTPPORT
W_SENDMAILFROM
W_SENDMAILTO W_EMAIL_DEF_ACK_STREAM
W_EMAIL_DEF_REPLY_STREAM
W_EMAIL_DEF_EXTRACT_STREAM
W_EMAIL_DEF_ALERT_STREAM

Code Block

language	xml

<COL TAG="W_SMTPSERVER" EXPRESSION="'000.000.0.00'"/>
<COL TAG="W_SMTPPORT" EXPRESSION="'25'"/>
<COL TAG="W_SENDMAILFROM" EXPRESSION="'a@b.com'"/>
<COL TAG="W_SENDMAILTO" EXPRESSION="'x@y.com'"/>

Setting email delivery streams (eagle_ml-2-0_default_cm_email_distribution is most commonly used)

Info

title	Note

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.

Code Block

language	xml

<COL TAG="W_EMAIL_DEF_ACK_STREAM" EXPRESSION="'eagle_ml-2-0_default_cm_email_distribution'"/>
<COL TAG="W_EMAIL_DEF_REPLY_STREAM" EXPRESSION="'eagle_ml-2-0_default_cm_email_distribution'"/>
<COL TAG="W_EMAIL_DEF_EXTRACT_STREAM" EXPRESSION="'eagle_ml-2-0_default_cm_email_distribution'"/>
<COL TAG="W_EMAIL_DEF_ALERT_STREAM" EXPRESSION="'eagle_ml-2-0_default_cm_email_distribution'"/>

MQ

:enumDMMQ:

W_MQS_DEF_ACK_STREAM
W_MQS_DEF_REPLY_STREAM
W_MQS_DEF_EXTRACT_STREAM

Code Block

language	xml

<COL TAG="W_MQS_DEF_ACK_STREAM" EXPRESSION="'MQS_EJM_SEND'" USERDESCRIPTION="Default MQ ACK Delivery Stream"/>
<COL TAG="W_MQS_DEF_REPLY_STREAM" EXPRESSION="'MQS_EJM_SEND'" USERDESCRIPTION="Default MQ REPLY Delivery Stream"/>
<COL TAG="W_MQS_DEF_EXTRACT_STREAM" EXPRESSION="'MQS_EJM_SEND'" USERDESCRIPTION="Default MQ EXTRACT Delivery Stream"/>

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

Info

title	Note

Task parameters set in the Control Message override settings applied anywhere else.

Expand

title	Example of Control Message for FILE Method (click to expand):

Code Block

language	xml

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" eaglemlVersion="2-0" eaglemlType="RunTaskRequest" xsi:type="RunTaskRequest">
    <header>
        <messageId>FRT2454018</messageId>
        <sentBy>http://www.client.com</sentBy>
        <sendTo>http://www.eagleinvsys.com/eagleml-2-0_control_messages</sendTo>
        <replyTo>http://www.client.com</replyTo>
        <creationTimestamp>2013-10-31T18:17:11.048-05:00</creationTimestamp>
    </header>
    <taskIdentifier>
        <correlationId>rsCODEEXTRACT029</correlationId>
        <businessTaskId>CODEEXTRACT029</businessTaskId>
        <sequenceNumber>1</sequenceNumber>
        <totalCount>1</totalCount>
    </taskIdentifier>
    <taskTypeEnum>NEW</taskTypeEnum>
    <taskParameters>
       <taskParameter>
              <name>CustomExtractLocation</name>
              <dataType>S</dataType>
              <value>../../../cmw/custom_extracts/</value>
       </taskParameter>
       <taskParameter>
              <name>CustomReplyLocation</name>
              <dataType>S</dataType>
              <value>../../../cmw/custom_reply/</value>
       </taskParameter>
       <taskParameter>
              <name>CustomAckLocation</name>
              <dataType>S</dataType>
              <value>../../../cmw/custom_ack/</value>
       </taskParameter>
       <taskParameter>
              <name>EnvironmentTag</name>
              <dataType>S</dataType>
              <value>DEV</value>  
       </taskParameter>
       <taskParameter>
              <name>ActionType</name>
              <dataType>S</dataType>
              <value>EXTRACT</value>  
       </taskParameter>
       <taskParameter>
              <name>StreamName</name>
              <dataType>S</dataType>
              <value>eagle_ml-2-0_default_out_q</value>  
       </taskParameter>
       <taskParameter>
              <name>FeedType</name>
              <dataType>S</dataType>
              <value>CODEEXTRACT</value>  
       </taskParameter>
       <taskParameter>
              <name>OutputFormat</name>
              <dataType>S</dataType>
              <value>EagleML</value>  
       </taskParameter>
    </taskParameters>
</EagleML>

Expand

title	Example of Control Message for FTP Method (click to expand):

Code Block

language	xml

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" eaglemlVersion="2-0" eaglemlType="RunTaskRequest" xsi:type="RunTaskRequest">
    <header>
        <messageId>FRT2454018</messageId>
        <sentBy>http://www.client.com</sentBy>
        <sendTo>http://www.eagleinvsys.com/eagleml-2-0_control_messages</sendTo>
        <replyTo>http://www.client.com</replyTo>
        <creationTimestamp>2013-10-31T18:17:11.048-05:00</creationTimestamp>
    </header>
    <taskIdentifier>
    <correlationId>rsCODEEXTRACT030</correlationId>
    <businessTaskId>CODEEXTRACT030</businessTaskId>
    <sequenceNumber>1</sequenceNumber>
    <totalCount>1</totalCount>
    </taskIdentifier>
    <taskTypeEnum>NEW</taskTypeEnum>
    <taskParameters>
           <taskParameter>
                  <name>DeliveryMethod</name>
                  <dataType>S</dataType>
                  <value>FTP</value>
           </taskParameter>
           <taskParameter>
                  <name>CustomExtractLocation</name>
                  <dataType>S</dataType>
                  <value>CUSTOM_CMW/extracts/</value>
           </taskParameter>
           <taskParameter>
                  <name>CustomReplyLocation</name>
                  <dataType>S</dataType>
                  <value>CUSTOM_CMW/reply/</value>
           </taskParameter>
           <taskParameter>
                  <name>CustomAckLocation</name>
                  <dataType>S</dataType>
                  <value>CUSTOM_CMW/ack/</value>
           </taskParameter>
           <taskParameter>
                    <name>EnvironmentTag</name>
                  <dataType>S</dataType>
                  <value>DEV</value>  
           </taskParameter>
           <taskParameter>
                  <name>ActionType</name>
                  <dataType>S</dataType>
                  <value>EXTRACT</value>  
           </taskParameter>
           <taskParameter>
                  <name>StreamName</name>
                  <dataType>S</dataType>
                  <value>eagle_ml-2-0_default_out_q</value>  
           </taskParameter>
           <taskParameter>
                  <name>FeedType</name>
                  <dataType>S</dataType>
                  <value>CODEEXTRACT</value>  
           </taskParameter>
           <taskParameter>
                  <name>OutputFormat</name>
                  <dataType>S</dataType>
                  <value>EagleML</value>  
           </taskParameter>
    </taskParameters>
</EagleML>

FTP and JMS Delivery Setup

Info

title	Note

Eagle does not provide these streams out of the box because the stream definitions contain specific connection parameters which must be configured by the client.

Configure Control Message Delivery Over FTP

...

Anchor
WaitForFileUpload
WaitForFileUpload
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:

Code Block

language	xml

<taskParameter>
	<name>WaitForFileUpload</name>
	<dataType>S</dataType>
	<value>Y</value>
</taskParameter>

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:

Code Block

language	xml

<taskParameter>
	<name>WaitForFileUploadTime</name>
	<dataType>S</dataType>
	<value>300</value>
</taskParameter>

FTP/SFTP and JMS Delivery Setup

Info

title	Note

Eagle does not provide these streams out of the box because the stream definitions contain specific connection parameters which must be configured by the client.

Configure Control Message Delivery Over FTP

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

...

Info

title	Important Note

If one of the following task parameters: ACKEmailDistributionList , ExtractEmailDistributionList, AlertEmailDistributionList, ResponseEmailDistributionList, - is set in CM then notification message will be sent in any case, regardless of defined delivery type.

Config File Option

Control Message Task Parameter Option

Names

W_SENDMAILTO (apply to all messages types if set delivery method to EMAIL)

ACKEmailDistributionList (ACK messages)

ExtractEmailDistributionList (Extract messages)

AlertEmailDistributionList (Alert messages)

ResponseEmailDistributionList (Response messages)

Values

Email addresses

Example

Code Block

language	xml

<COL TAG="W_SENDMAILTO" EXPRESSION="’tst@mail.ru, tst2@mail.com,tst3@mail.com’"/>

Code Block

language	xml

<taskParameter>
    <name>ACKEmailDistributionList</name>
    <dataType>S</dataType>
    <value>tst@mail.ru, tst2@mail.com</value>
</taskParameter>
<taskParameter>
    <name>ExtractEmailDistributionList</name>
    <dataType>S</dataType>
    <value>tst3@mail.com</value>
</taskParameter>
<taskParameter>
    <name>AlertEmailDistributionList</name>
    <dataType>S</dataType>
    <value></value>
</taskParameter>
<taskParameter>
    <name>ResponseEmailDistributionList</name>
    <dataType>S</dataType>
    <value>tst@mail.ru, tst2@mail.com,tst3@mail.com</value>
</taskParameter>

...

Versions Compared

Old Version 19

New Version 20

Key

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

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

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

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

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

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