Control Message for the Load

The data load IWS solution can be started by sending a Control Message to the eagle_ml-2-0_default_cm_control_message stream. In this Control Message, you can specify various required, optional, and default parameters.

Note

In the Control Message, elements <messageId>, <correlationId>, and <businessTaskId> must be unique. Resending a file with the same values in these elements will result in an error.

Sample RunTaskRequest (RTR or CM) for the data load - click to expand

<EagleML
    xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:type="RunTaskRequest"
    eaglemlVersion="2-0"
    xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd"
    eaglemlType="RunTaskRequest">
    <header>
        <messageId>LOAD</messageId>
        <sentBy>http://www.client.com</sentBy>
        <sendTo>http://www.eagleinvsys.com/eagle_ml-2-0_default_cm_control_message</sendTo>
        <replyTo>{+}http://www.client.com/Eagle+ Control Messages</replyTo>
        <creationTimestamp>2012-08-02T22:13:32.272-05:00</creationTimestamp>
    </header>
    <taskIdentifier>
        <correlationId>kEAGLE_DATA_LOAD_test_001</correlationId>
        <businessTaskId>EAGLE_DATA_LOAD_test_001</businessTaskId>
    </taskIdentifier>
    <taskTypeEnum>LOAD</taskTypeEnum>
    <taskParameters>
        <taskParameter>
            <name>StreamName</name>
            <dataType>S</dataType>
            <value>eagle_ml-2-0_default_cm_execwkfl</value>
        </taskParameter>
        <taskParameter>
            <name>ActionType</name>
            <dataType>S</dataType>
            <value>EXECUTE</value>
        </taskParameter>
        <taskParameter>
            <name>WorkflowName</name>
            <dataType>S</dataType>
            <value>eagle_wrf_generic_load</value>
        </taskParameter>
        <taskParameter>
            <name>DeliveryMethod</name>
            <dataType>S</dataType>
            <value>FILE</value>
        </taskParameter>
        <taskParameter>
            <name>WorkflowData</name>
            <dataType>S</dataType>
            <value>EAGLE_ML_DATA_2.zip</value>
        </taskParameter>
    </taskParameters>
</EagleML>

Required Parameters

Note

Parameter names are case-sensitive.

The following table lists parameters that must be defined in each Control Message file used for the data load.

Parameter

Example of Value

Comments

ActionType

EXECUTE

Constant value to start all workflows.

StreamName

eagle_ml-2-0_default_cm_execwkfl

Constant value for all extracts.

The name of the message stream to which data is sent from the Control Message stream. This stream runs the workflow.

WorkflowName

eagle_wrf_generic_load

Constant value for the load process.

The following table lists required parameters to start the data load workflow with the WorkflowData parameter.

Parameter	Example of Value	Comments
WorkflowData	EAGLE_ML_DATA_2.zip	Name of the archive to be loaded. Note This must be unique
DeliveryMethod	FILE or FTP	Location of the archive to be loaded, if the FILE method is specified. The archive should be in local directory that is specified by the parameter (:w_staging_in_folder:) [Default value: cmw\in]. If the FTP method is used, the archive should be in the FTP directory that is specified by the parameter (:FTP_FILES_LOCATION:) [Default value: CMW/inbound]. These parameters are set in the w_config.inc and w_config_custom.inc configuration files (see Advanced Configuration Options page in EagleML and EJM wiki).
LocalFileFolder	in/RAW/eagle_ml-2-0_default_cm_ndfa/incoming/	Launches a simple EJM process which takes the file specified in WorkflowData parameter and puts it into the target directory specified in LocalFileFolder parameter. The file can be stored b64-encoded. MC/MC2 supported.

The following two parameters are required to start the data load workflow with Base64 data:

Parameter

Example of Value

Comments

WorkflowData

<taskParameter>
    <name>WorkflowData</name>
    <dataType>S</dataType>
    <value>160510_062620_B60F0H44EK7XTBID.zip.base64</value>
</taskParameter>

Name of the archive to be loaded.

MC: WorkflowData+
MC: Data works only with WorkflowData parameter. We have to specify WorkflowData even if we want to use Data parameter only, because WorkflowData contains information about file extension which is in base64 text. WorkflowData is not ignored it is used when process creates file from base64 text.

MC2: WorkflowData
MC2: Data works in the same way as MC

Data

<taskParameter>
    <name>Data</name>
    <dataType>S</dataType>
    <value>UEsDBBQAAAAIACkzqkjeZ42OtkUAABkZBQAuABwANDI4QzRCQTQyRkE5OUMwQ19fR0VORVJJQ1NN
					...
	BgAAAAABAAEAdAAAAB5GAAAAAA==</value>
</taskParameter>

Archive data in Base64 format

Optional Parameters

Note

Parameter names are case-sensitive.

The following table lists optional parameters for the data load workflow.

Parameter	Example of Value	Default Value	Comments
LoadSendNotification	1 or 0	1	The same logic is used for SendNotification, but this option can only be applied to extracts within the workflow.

Default Parameters

Note

Parameter names are case-sensitive.

The following table lists default parameters for the data load workflow.

Parameter	Comments
SendNotification	For more information, see the EJM Job Notifications Overview page in the EagleML wiki.
ReplyDeliveryMethod
ACKDeliveryMethod
CustomReplyLocation
CustomAckLocation