Manage Generic Options

Owned by Natalie Gesin (Deactivated)
Last updated: Nov 24, 2017 by Dmitry Donosiyan (Unlicensed)
2 min read

There are several generic task parameter setups used with any action type. 

Note

Before you can use email distribution lists specified below, you must create an XML outbound email distribution stream, such as eagleml_email_cm_distribution, based on ruleset eagle_ml-2-0_cm\out\xml\task_distributor_email.rsf

The table below lists the generic options and descriptions.

Option

Description

ACKDeliveryMethod

Specifies the delivery method for the acknowledgement ACK and NACK reply messages. Options include FILE, FTP, JMS, and EMAIL.

ACKEmailDistributionList

Specifies the email distribution list to deliver the acknowledgement ACK and NACK reply messages.

ActionType

Action expected: (ACQUIRE, EXTRACT, StarEvent,PaceEvent)

DeliveryMethod

Specifies the delivery method for the incoming file. Options include: FILE, FTP, JMS, and EMAIL.

EnvironmentTag

This is the environment filter. The message will be rejected if the value sent in the message does not match the environment type specified in the w_config.inc. Possible values are DEV, TST, UAT, PRD

ExtractEmailDistributionList

List of email addresses for delivering extract results to.

ReplyDeliveryMethod

Delivery Method for Replies (FILE, FTP, JMS, EMAIL).

CreateConsolidatedTSR

When set to "1", enables consolidated reply messages for your workflow.

ResponseEmailDistributionList

Specifies the email distribution list to deliver response messages.

ExtractEmailDistributionList

Specifies the email distribution list to deliver the extract results messages.

EnvironmentTag

Identifies the environment, such as DEV, TST, UAT, PRD and so forth. The identifier ensures that messages sent with an incorrect identifier are rejected, when the value does not match the not match the environment type specified in the w_config.inc configuration for this environment.

FeedSubType

Specifies the user-defined, detailed description of the data type to be used by the BPM.

ObjectType

Specifies the object data type within the list of EagleML object types, as defined in the <xsd:simpleType name="ObjectTypeEnum"> enumeration of the EagleML XSD schema definition.

StreamName

Specifies the message stream used to initiate the workflow sequence. Options include:

  • eagle_ml-2-0_default_cm_acquire_data
  • eagle_ml-2-0_default_out_star_extracts
  • eagle_ml-2-0_default_out_q
  • eagle_ml-2-0_default_cm_execute_star_event
  • eagle_ml-2-0_default_cm_execute_pace_event
  • eagle_ml-2-0_default_cm_execute_purge_archive

OutputFormat

Specifies the output data format for extracts.

The acceptable values are EagleML, CSV and TagValue.

Please see below for specifics on what each of these values produces:

If OutputFormat=EagleML, the extract file will be in EagleML format and the file extension will be *.xml

If OutputFormat=CSV, the extract file will be in TagValue format and the file extension will be *.csv

If OutputFormat=TagValue, the extract file will be in TagValue format and the file extension will be *.txt

If OutputFormat is set to a value other than EagleML, CSV or TagValue, the extract file will be in TagValue format and the file extension will be *.xml

If OutputFormat is not specified, the extract file will be in EagleML format and the file extension will be *.xml

FeedType

Specifies the feed type for extracts. Refer to Task Parameter Setup for EagleML Tag Value/XML Extract section for the list of options.