Control Message for the Delete

The sample data delete 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 and default parameters.

On this page

1 Required Parameters
2 Default Parameters

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.

The following is a sample RunTaskRequest (RTR or CM) for the data delete solution.

<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>TST_TSR_ACK_RENAME</messageId>
        <sentBy>http://www.eagleinvsys.com</sentBy>
        <sendTo>http://www.eagleinvsys.com/eagle_ml-2-0_default_cm_control_message</sendTo>
        <creationTimestamp/>
    </header>
    <taskIdentifier>
        <correlationId>delete_191115_3</correlationId>
        <businessTaskId>delete_191115_3</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_delete</value>
        </taskParameter>
        <taskParameter>
            <name>WorkflowData</name>
            <dataType>S</dataType>
            <value>_EAGLEML_DELETE_DATA.zip</value>
        </taskParameter>
    </taskParameters>
</EagleML>

Required Parameters

Parameter names are case-sensitive.

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

Parameter	Example of Value	Comments

Parameter

Example of Value

Comments

ActionType

EXECUTE

Constant value to start the solution.

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 solution.

WorkflowName

eagle_wrf_generic_delete

Constant value for the data delete solution.

The following table lists required parameters to start the data delete solution with the WorkflowData parameter.

Parameter	Example of value	Comments

Parameter

Example of value

Comments

WorkflowData

_EAGLEML_DELETE_DATA.zip

Name of the archive to be deleted.

DeliveryMethod

FILE or FTP

Location of the archive to be deleted, 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 FTP method is used, the archive should be in the FTP directory 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.

The following table lists required parameters to start the data delete solution with Base64 data.

Parameter	Example of value	Comments

Parameter	Example of value	Comments
FileName	_EAGLEML_DELETE_DATA.zip	Name of the archive to be loaded.
Data		Archive data in Base64 format.

Default Parameters

The following table lists default parameters for the data delete.

Parameter	Comments

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