Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 131 Next »

Note

  • Global parameters should be specified in the /eagle_ml-2-0_custom_cm/w_config_custom.inc file individually for each environment, otherwise you will lose your changes after the next EagleML installation event
  • All string values should be put within single quotation marks and the expression is then put within double quotation marks. Like this: EXPRESSION="'string'"
  • The task parameters you specify in your control message (RTR) have a higher priority than their global alternatives listed in the table below
  • After editing a global parameter you should restart MC to apply changes to the configuration

You can double-click an example to highlight all its text

The table below gives a more detailed description of configuration file parameters for such specific processes as:

Configuration ParameterValid ValuesExample of UseComment

Extracts 

w_eagleml_streamingY, N
<CODE>
  :w_eagleml_streaming: := 'Y';
</CODE>

Toggles using streaming extracts in an environment. Please note, that this parameter was introduced in June 2016 EagleML Release. Its alternative obsolete version is w_eagleml_streaming_t which is strongly not recommended for newer environments.

w_eagleml_streaming_t_feedsformatted list of feedtypes
<CODE>
  :w_eagleml_streaming_t_feeds: := '||ENTITYEXTRACT|GENCORPACTIONSEXTRACT|
WRHSPENDINGTRADESEXTRACT|ENTITYSHARECLASSEXTRACT|
ACCRUEDINCOMEEXTRACT|WRHSCSTDBALANCEEXTRACT|';
</CODE>

Sets the list of feedtypes that will utilize streaming extracts, if such exist. Default value: all feedtypes (the list may vary for different EagleML versions). Please note, that this parameter was introduced in June 2016 EagleML Release. Its alternative obsolete version is w_eagleml_streaming_t which is strongly not recommended for newer environments

W_KEEP_ORIGINAL_FN_STREAMINGN, Y (default)
<CODE>
  CreateVariable('W_KEEP_ORIGINAL_FN_STREAMING','Y');
</CODE>

If you create a custom streaming transformation step using IWS, the generated code will contain a link to core EJM file (/eagle_ml-2-0_cm/streaming_task_getinfo.inc). After publish if you drop any file into this process, the code inside core include file will overwrite the original incoming file name by simple CorrId value and cause errors.
This parameter by default has Y (or empty) value – in this case original file name will be kept in the TSR. If set to N – then only CorrID value will be in the processed file name in TSR.

W_FORCE_EMPTY_EXTRACTFILEY, N
<CODE>
  CreateVariable('W_FORCE_EMPTY_EXTRACTFILE','Y');
</CODE>

Generates an empty extraction file in case you get NO_DATA. Its task parameter version for RTR is ForceExtractFileCreation

DEFAULT_EAGLEML_EXTRACT_COMPRESSY, N
<COL TAG="DEFAULT_EAGLEML_EXTRACT_COMPRESS" EXPRESSION="'N'" USERDESCRIPTION="Compress extract file to zip/gz archive"/>

Toggle extract file compression (zip/gz archive). 

COMPRESS_WITH_CORR_IDY, N
<COL TAG="COMPRESS_WITH_CORR_ID" EXPRESSION="'N'"/>

Extraction with 'compress' parameter. 

W_AUTOADDBASISY, N
<COL TAG="W_AUTOADDBASIS" EXPRESSION="'N'"/>

Entity Accounting Periods extract option. If W_AUTOADDBASIS = Y the extract will contain <autoAddBasis>Y</autoAddBasis> node. If such extracted file is sent for load afterwards, the inbound rule will load a new Accounting Basis (a row in RULESDBO.ENTITY_ACCT_BASIS) if it cannot find the Account Basis set in the inbound rule for the Portfolio Acct (Entity Id) in DB.
This option is especially useful for ETL processes in which the extract is sent for load at once. 

EXCLUDE_SECURITY_ALIASY or empty (default)
Exclude Security Alias from all extracts.
W_INCLUDE_SECALIAS_FORWHSY or empty (default)
Enable adding Security Alias for Warehouse extracts. Has a higher priority than EXCLUDE_SECURITY_ALIAS for Warehouse objects.
W_INCLUDE_ENTITY_INFON (default), Y, ALL
<COL TAG="W_INCLUDE_ENTITY_INFO" EXPRESSION="'Y'"/>

A setting for extracts with Entity fields (such as Entity Id, Name, Xref etc).
N: The following fileds are extracted: Entity Id, Entity Name, Entity Type, Xref Account Id, Xref Account Id Type, Xref Class Code
Y: These fields are extracted along with ones above: Long Entity Name, Legal Entity Name, Total Count Share Class, Partition Number
ALL: Physical Partition fields are extracted along with all fields above: PPTRADES, PPHOLDING, PPCASH, PPPERFORM, PPLEDGER
See a more detailed description of these fields. 

W_INCLUDE_ALL_ENT_XREFY (default), N
This parameter works for all EagleML objects with Entity fields except for Warehouse. 
If set to Y, all Entity Xref identifiers existing in DB for the Entity Id are extracted.
If set to N, only one set of Entity Xref identifiers is extracted.
W_USE_NUMERATION_FOR_XREFSN (default), Y
<COL TAG="W_USE_NUMERATION_FOR_XREFS="'Y'"/>

When set to Y, numeration is added for entity and security xref elements:

<entityXrefs>
	<entityXref1>
		<xrefAccountId>BT3903IU_TYPE2</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref1>
	<entityXref2>
		<xrefAccountId>BT3903IU_TYPE3</xrefAccountId>
		<xrefAccountIdType>TST</xrefAccountIdType>
	</entityXref2>
</entityXrefs>

This can also be applied to a single extract by using task parameter UseNumerationForXrefs.

W_INCLUDE_REPORT_DETAILSN (default), Y
If set to Y, the following fields are added to the extract inside the <navReportDetails> complex node.
  • Prior NAV (NAV for the previous Valuation Date), 
  • Mkt Value Cash (elements from the Position Detail table in case Base Currency = Local Currency or sum of elements in case Base Currency != Local Currency), 
  • Share Class Level (elements of ARCH_CTRLCTR.NAV_DETAILS table linked with main table via Valuation Date, Entity Id, Share Class), 
  • Total Fund Level (elements of  ARCH_CTRLCTR.NAV_DETAILS сtable linked with main table via Valuation Date, Entity Id for Share Class = 'TF')
  • Distribution Log Level

Works only with WRHSNAVMONTHENDEXTRACT feedtype

Alternative for a single extract event is the RTR parameter includeReportDetails

W_INCLUDE_CUSTOM_REPORT_DETAILSN (default), Y
If set to Y, the following fields are added to the extract inside the <navReportDetails> complex node.
  • Prior NAV (NAV for the previous Valuation Date), 
  • Mkt Value Cash (elements from the Position Detail table in case Base Currency = Local Currency or sum of elements in case Base Currency != Local Currency), 
  • Share Class Level (elements of ARCH_CTRLCTR.NAV_DETAILS table linked with main table via Valuation Date, Entity Id, Share Class), 
  • Total Fund Level (elements of  ARCH_CTRLCTR.NAV_DETAILS сtable linked with main table via Valuation Date, Entity Id for Share Class = 'TF')
  • Distribution Log Level

Works only with WRHSNAVMULTIEXTRACT feedtype

Alternative for a single extract event is the RTR parameter includeCustomReportDetails

W_INCLUDE_ASSET_PROPERTIESN (default), Y
<COL TAG="W_INCLUDE_ASSET_PROPERTIES" EXPRESSION="'Y'"/>

If set to Y, the Asset Properties model is added to the extract. 

W_FORWARD_SINGLE_LEG_MODEN (default), Y
<COL TAG="W_FORWARD_SINGLE_LEG_MODE" EXPRESSION="'Y'"/>
Setting to Y adds singleLegLoadFlag = Y element to all SMFEXTRACT. RTR parameter version is SetSingleLegLoadFlagValue
w_[FeedType]_profileQueryProfileName
<COL TAG="W_INCLUDE_ASSET_PROPERTIES" EXPRESSION="'Y'"/>

Applies an element reduction profile to all extracts of the feedtype.

W_EXTRACTS_EXCLUDE_0N (default), Y
<COL TAG="W_EXTRACTS_EXCLUDE_0" EXPRESSION="'Y'"/>

Toggles removing numeric fields with zero values from the extract to decrease its volume. Valid only for Warehouse objects. Supported with regular extracts as well as with the Generic Extract workflow. Please note, that this parameter was introduced in June 2016 EagleML Release. Its alternative obsolete version is EXTRACTS_EXCLUDE_0 which is strongly not recommended for newer environments

wa_DateRuleparameters declared in specific format
<COL TAG="wa_DateRule" EXPRESSION="'url;http://localhost:9001!user;username!password;
EXPR#:wa_DateRulePass:!soapaction;!'"/>

Enables date rules for extracts. One of the parameters is the username you use in the environment. 

wa_DateRulePasspassword

Example before encryption:

<COL TAG="wa_DateRulePass" EXPRESSION="'eaglepassword'"/>

Example after encryption:

<COL TAG="wa_DateRulePass" EXPRESSION="'base64aes~esC4Vn7jf6jjf0/SXstfjdw46mufgl0k/t'" ENCRYPTED="YES"/>

The password for the user name in the environment you specified in wa_DateRule parameter. Encryption is mandatory. 

W_REMOVE_ENTITY_DUPLICATESN (default), Y
<COL TAG="W_REMOVE_ENTITY_DUPLICATES" EXPRESSION="'Y'"/>

Enables/disables extraction of duplicate entities for entityselectiontype = ENTITYID filter. You do not get duplicate entities if set to 'Y'.

W_ENTITY_UPDATE_DEEPN (default), Y
<COL TAG="W_ENTITY_UPDATE_DEEP" EXPRESSION="'Y'"/>

Switch to Y, if you want to use XREF and LEI tables to filter records by update_date. E.g., you have an entity with update date 1/1/2012 with a linked XREF of 1/1/2014. Using update date filter by 1/1/2013 with W_ENTITY_UPDATE_DEEP option will return. 

W_INCREASE_LAST_RUN_DATE_TIME 
 
ALWAYS (default), NEVER, ONLY_DATA_EXTRACTED
<COL TAG="W_INCREASE_LAST_RUN_DATE_TIME" EXPRESSION="'ONLY_DATA_EXTRACTED'"/>

This parameter works only with delta-based extracts. 
 
ALWAYS - always rewrite the last run date value after delta-based extraction
NEVER - switches off rewriting last run date
ONLY_DATA_EXTRACTED - change last run date only if some data has been extracted

W_LINKED_ASSET_ONLY_DELTAN (default), Y
<COL TAG="W_LINKED_ASSET_ONLY_DELTA" EXPRESSION="'Y'"/>

This parameter works only with ReportDictionary extracts. If this parameter is set to Y, then whenever we do a delta based dictionary extract, we should only look at SECURITY_DICTIONARY_LINK.SECURITY_DATE to determine the linked assets (and their corresponding dict detail) records to extract. There is no need to check dict detail update_date for delta based dictionary extracts in the selection criteria if that flag is set to Y. Available as an RTR task parameter.

W_TAKE_BASE_CURRENCY_FROM_WRHS_POS_DETN (default), Y
<COL TAG="W_TAKE_BASE_CURRENCY_FROM_WRHS_POS_DET" EXPRESSION="'Y'"/>

A parameter exclusively for Warehouse Position extracts. Forces taking the value for baseCurrency from HOLDINGDBO.POSITION_DETAIL.BASE_CURRENCY instead of HOLDINGDBO.POSITION.BASE_CURRENCY field. Also available as a task parameter in the RTR TakeBaseCurrencyFromWRHSPosDet

W_ADD_BUSINESSTASKID_EXTRACTSY(default), N
<COL TAG="W_ADD_BUSINESSTASKID_EXTRACTS" EXPRESSION="'Y'"/>

By default, businessTaskId element (inside taskIdentifier root node, next to the correlationId node) is extracted. Setting W_ADD_BUSINESSTASKID_EXTRACTS to N removes businessTaskId from the extract. This parameter is available since July 2017 EagleML release

W_INCLUDE_COMMON_TRANSACTIONS_INFOformatted list of feedtypes
 
<CODE>
:W_INCLUDE_COMMON_TRANSACTIONS_INFO: := 'CODEVALEXTRACT,ENTITYEXTRACT';
</CODE>

Adds a commonTransactionsInformation model with values of dates you have used in your Date filter (please note, that not all date filters are supported by your specific feedtype, refer to the table for date filters). Available as an RTR task parameter - IncludeCommonTransactionsInfo

W_INCLUDE_EXTRACT_STATSN (default), Y
<COL TAG="W_INCLUDE_EXTRACT_STATS" EXPRESSION="'Y'"/>
Setting to Y adds extractStats model to TSRs for all extracts on the region. Currently supported for the following interfaces: Schedule, GenericSMF, WarehouseCashActivity, WarehouseCashFlowProjection, WarehouseCloseLot, CustodyRestrictionActivity, CustodyRestrictionBalance, WarehouseDisclosureStatus, WarehouseGLBalances, WarehouseNAVMonthEnd, WarehouseNAVMulti, WarehouseNAV, WarehouseOpenLot, WarehousePendingTrade, WarehousePerformance, WarehousePosition, WarehouseTrade, WarehouseWashSaleTrade
W_RECORD_COUNT_PER_NUGGETnumber
<COL TAG="W_RECORD_COUNT_PER_NUGGET" EXPRESSION="'5'"/>

Sets the amount of records per batch.

Task parameter version is MicroBatchKeyRecordCount

W_SAVE_SQL_QUERYY(default), N
:W_SAVE_SQL_QUERY: := 'N';
When set to N removes query file *_Q.txt during extract process.
W_DELETE_EXTRACT_DAT_FILEN (default), Y
:W_DELETE_EXTRACT_DAT_FILE: := 'Y';
When set to Y deletes tag value *.dat file during extract process.
W_ENABLE_S2P_REMAPPING_FLAG

Works only with WRHSTRADEEXTRACT

Setting to Y enables S2P remaping for the following fields:
'secFee' is mapped into 'otherFee'
'secFeesBase' is mapped into 'otherFeeBase'
'exchangeFee' is mapped into 'secFee'
'exchangeFeeBase' is mapped into 'secFeeBase'
'otherFee' is mapped into 'exchangeFee'
'otherFeeBase' is mapped into 'exchangeFeeBase'.

RTR parameter is EnableS2PReMappingFlag

W_WRHS_EXECUTE_ROLLBACK_SWITCHY(default), N
<COL TAG="W_WRHS_EXECUTE_ROLLBACK_SWITCH" EXPRESSION="'N'"/>

Setting to N disables the rollback in xmldbapi format.

Works with WRHSOPENLOTEXTRACT and WRHSPOSITIONEXTRACT.

EAGLEML_WRHS_EXTRACT_BATCH_MODEY(default), N
:EAGLEML_WRHS_EXTRACT_BATCH_MODE: := 'N';

Setting to N removes the Batch key added to Warehouse extracts in delta mode. 

RTR analog is BatchMode = N

W_PRICINGREPORTEXTRACT_ACTIVE_FLAGY(default), N
<CODE>
:W_PRICINGREPORTEXTRACT_ACTIVE_FLAG: = 'N';
</CODE>
 Setting to Y allows bringing back pricing records only when the price validation rule has an Active status. The alternative for a single extract is pricingactiveflag RTR parameter.

Delivery Methods

FILE_IN_LOCATION



FILE_EXTRACT_LOCATION



FILE_REPLY_LOCATION



FILE_ACK_LOCATION











Please refer to Configure Delivery Method Options page for a complete guide.

FTP_URL
FTP_USER
FTP_PWD
FTP_FILES_LOCATION
FTP_EXTRACT_LOCATION
FTP_REPLY_LOCATION
FTP_ACK_LOCATION
SFTP_URL
SFTP_USER
SFTP_PWD
SFTP_PWD_ISENCRYPTED
​SFTP_FILES_LOCATION
SFTP_EXTRACT_LOCATION
SFTP_REPLY_LOCATION
SFTP_ACK_LOCATION
W_JMS_DEF_ACK_STREAM



W_JMS_DEF_REPLY_STREAM



W_JMS_DEF_EXTRACT_STREAM
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
W_MQS_DEF_ACK_STREAM



W_MQS_DEF_REPLY_STREAM



W_MQS_DEF_EXTRACT_STREAM

Purge and Archive

W_PA_SETTINGSformatted value (more details here)
<COL TAG="W_PA_SETTINGS" EXPRESSION="'FTP;FOLDER;CMW/inbound;*;ARCHIVE;data/msgcenter/ftp_archive;Y;72;N|
FTP;FOLDER;CMW/outbound;*;PURGE;;;48;N|
FTP;FOLDER;CMW/ack;*;PURGE;;;48;N|
FTP;FOLDER;CMW/control;*;PURGE;;;48;N|
FTP;FOLDER;CMW/extracts;*;PURGE;;;48;N|
FTP;FOLDER;CMW/archive;*;PURGE;;;48;N|
FTP;FOLDER;CMW/reply;*;PURGE;;;48;N|
FILE;ALLMCSTREAMFOLDERS;processing;*;PURGE;;;48;N|
FILE;ALLMCSTREAMFOLDERS;incoming;*;PURGE;;;48;N|'"/>

A number of objects to be purged or archived and the parameters of the process in the appropriate format. 

W_PA_SETTINGS_LOGGING_ENABLEDY (default), N
<COL TAG="W_PA_SETTINGS_LOGGING_ENABLED" EXPRESSION="'N'"/>

Toggle Purge and Archive logging. Available as an RTR task parameter - loggingEnabled.

W_PA_SETTINGS_LOG_FILE_PATHfile path
<COL TAG="W_PA_SETTINGS_LOG_FILE_PATH" EXPRESSION="GetDirRoot()+ 'logs/msgcenter/purgeandarchive/pa_log.log'"/>

File path for purge and archive log file.

W_PA_MODELISTONLY or STANDARD
<COL TAG="W_PA_MODE" EXPRESSION="'LISTONLY'"/>

Set purge and archive mode. See more details on this page. 

W_CONFIG_FTP_CLEANUP_LOCATION_LISTlist of folders and time intervals
<COL TAG="W_CONFIG_FTP_CLEANUP_LOCATION_LIST" EXPRESSION="'/CMW/outbound/,21\n/CMW/inbound/,21\n/CMW/control/processed/,21\n'" USERDESCRIPTION="List of ftp folder for cleanup and purge intervals for them"/>

List of ftp folders to be cleaned up and purge intervals for them.

W_CONFIG_FTP_CLEANUP_MODEMOVE, DELETE
<COL TAG="W_CONFIG_APP_CLEANUP_MODE" EXPRESSION="'MOVE'" USERDESCRIPTION="Valid values: MOVE or DELETE; if MOVE the variable W_CONFIG_FTP_CLEANUP_MOVE_FOLDER must be specified"/>

Cleanup mode: either MOVE or DELETE. If set to MOVE the Advanced Configuration Options#W_CONFIG_FTP_CLEANUP_MOVE_FOLDER variable must be specified.

W_CONFIG_FTP_CLEANUP_MOVE_FOLDERfolder path
<COL TAG="W_CONFIG_FTP_CLEANUP_MOVE_FOLDER" EXPRESSION="'/CMW/archive/'" USERDESCRIPTION="Destination folder for MOVE"/>

The folder used in the ftp cleanup process.

W_CONFIG_APP_CLEANUP_LOCATION_LISTfolders and time intervals
<COL TAG="W_CONFIG_APP_CLEANUP_LOCATION_LIST" EXPRESSION="'CMW/reply'" USERDESCRIPTION="List of ftp folder for cleanup and purge intervals for them"/>

List of app folders for cleanup and purge intervals for them. 

W_CONFIG_APP_CLEANUP_MODEMOVE, DELETE
<COL TAG="W_CONFIG_APP_CLEANUP_MODE" EXPRESSION="'MOVE'" USERDESCRIPTION="Valid values: MOVE or DELETE; if MOVE the variable W_CONFIG_APP_CLEANUP_MOVE_FOLDER must be specified"/>

Cleanup mode: either MOVE or DELETE. If set to MOVE the W_CONFIG_APP_CLEANUP_MOVE_FOLDER variable must be specified.

W_CONFIG_APP_CLEANUP_MOVE_FOLDERfolder path
<COL TAG="W_CONFIG_APP_CLEANUP_MOVE_FOLDER" EXPRESSION="'CMW/archive/'" USERDESCRIPTION="Destination folder for MOVE"/>

The folder used in the app cleanup process.

W_REPLYCM_MODEN/OFF (default), Y/ON, ONonlyForIWS, ONuseExactFileName
<COL TAG="W_REPLYCM_MODE" EXPRESSION="Y"/>

Works with IWS workflows

  • N or OFF - TSR/ASK messages are named by default.
  • Y or ON - TSR/ASK messages are named as defined in the IWS solution.
  • ONonlyForIWS - If the solution was created via IWS, the TSR/ASK messages are named as defined in the solution. If not defined - default names are assigned.
  • ONuseExactFileName - excludes correlationID prefix from the file name when you use ACKStrictPattern or TSRStrictPattern parameters. Read more in EJM Job Notification Overview
    Please note, that this option should be handled with care, because in case different processes get the same file patterns, files will be rewritten by the latter process.

You will find more details in the Setting Custom TSR/ACK Names tutorial on IWS wiki.

W_REPLY_CUSTOM_LOCATIONS_MODEN/OFF (default), Y/ON, ONonlyForIWS
<COL TAG="W_REPLY_CUSTOM_LOCATIONS_MODE" EXPRESSION="Y"/>

Works with IWS workflows

  • Y or ON – TSR messages will be saved in ../cmw/reply/workflowname and ACK messages in ../cmw/ack/workflowname. 
  • N or OFF – TSR and ACK use default folders as their location.
  • ONonlyForIWS – Only IWS created solutions will use custom folders as their location.

CustomReplyLocation and CustomAckLocation parameters override this parameter.

Read more in the Setting Custom TSR/ACK Locations tutorial on IWS wiki.

Generic Load and Generic Extract 

EAGLE_EXTRACTOR_ZIP_TO_FTP0, 1
<COL TAG="EAGLE_EXTRACTOR_ZIP_TO_FTP" EXPRESSION="'1'" USERDESCRIPTION="Move result ZIP file to FTP yes(1) or no(0)"/>

Toggle moving result ZIP file to FTP. 

GENERIC_LOAD_DP_LOG_INSERT0, 1
<COL TAG="GENERIC_LOAD_DP_LOG_INSERT" EXPRESSION="'0'" USERDESCRIPTION="Use dp_log insert yes(1) or no(0)"/>

Toggle using an additional subprocess (dp_log insert) within Generic Load.

W_GEN_EXTRACT_OUTPUT_FORMATXMLDBAPI (default),
EagleML
<COL TAG="W_GEN_EXTRACT_OUTPUT_FORMAT" EXPRESSION="'EagleML'"/>

Defines the format of Warehouse Position and Warehouse Open Lot extracts.

W_ENABLE_VALIDATE_CACHE

W_CACHE_VALIDATION_WORKFLOW

W_CACHE_RELOAD_PERIOD

N (default), Y

workflow name

time in seconds

<CODE>
   CreateVariable( 'W_ENABLE_VALIDATE_CACHE','Y' );
   CreateVariable( 'W_CACHE_VALIDATION_WORKFLOW','any_workflow_name' );
   CreateVariable( 'W_CACHE_RELOAD_PERIOD','3000' );
</CODE>

These three parameters allow to enable and control CacheValidation sub-process prior to the extract step. 

  • EnableValidateCache (RTR) and global parameter W_ENABLE_VALIDATE_CACHE to enable the step prior to extract

  • CacheValidationWorkflow (RTR) and global parameter W_CACHE_VALIDATION_WORKFLOW which specifies the Name of the workflow which will be triggered via the sub-process

  • CacheReloadPeriod (RTR) and global parameter W_CACHE_RELOAD_PERIOD which controls how often cache validation will run. The established setup time is in seconds.

Security Resolution

CONFIG_BATTING_ORDERbatting order
<CODE>
    CreateVariable( 'CONFIG_BATTING_ORDER','cusip,isin,sedol,reuters,
bloombergId,sicovmId,valorenId,cedel,internalId,cinsId,ticker');
</CODE>

Specify a batting order for all workflows that differs from the default

CONFIG_XREF_MAPxref map
<CODE>
    CreateVariable( 'CONFIG_XREF_MAP','');
</CODE>

Specify xref transformations that should occur for all files

CONFIG_SEC_RES_OPTIONsecurity resolution option
<CODE>
    CreateVariable( 'CONFIG_SEC_RES_OPTION','XREF_EXCHANGE,MATURITY_DATE,ASSET_CURRENCY');
</CODE>

Specify security resolution options that are different from default for an entire box (meaning, for all workflows, streams and other processes)

Read more about security resolution..

CONFIG_BATTING_ORDER_EXTRACTbatting order
<CODE>
    CreateVariable( 'CONFIG_BATTING_ORDER_EXTRACT',
'cusip,isin,sedol,reuters,bloombergId,sicovmId,valorenId,cedel,internalId,cinsId,ticker');
</CODE>

Set a custom batting order for all extracts in the environment.

CONFIG_XREF_MAP_EXTRACTxref map
<CODE>
    CreateVariable( 'CONFIG_XREF_MAP_EXTRACT','');
</CODE>

Set a custom xref map for all extracts in the environment.

CONFIG_SEC_RES_OPTION_EXTRACTsecurity resolution option
<CODE>
    CreateVariable( 'CONFIG_SEC_RES_OPTION_EXTRACT','NULL');
</CODE>

Set a custom security resolution option for all extracts in the environment.

CONFIG_USE_DUMMY_PRIMARY_ASSET_ID_TYPE_EXTRACTcustom type
<CODE>
    CreateVariable( 'CONFIG_USE_DUMMY_PRIMARY_ASSET_ID_TYPE_EXTRACT','DUMMYTYPE');
</CODE>

Available for Warehouse Position and Warehouse Open Lot. Provides an option to force custom primaryAssetIdType in the extract.

W_ALWAYS_USE_XREFY (default), N
<COL TAG="W_ALWAYS_USE_XREF" EXPRESSION="'N'"/>

Toggles using specific SWAP security resolution logic.

W_NOOVERRIDE_SEC_RES_OPTIONALLOW_DUPL_XREF
<COL TAG="W_NOOVERRIDE_SEC_RES_OPTION" EXPRESSION="'ALLOW_DUPL_XREF'"/>

Setting this parameter to ALLOW_DUPL_XREF turns off the logic excluding xref duplicates.

Can be used for a single message by adding the following element to it: 

<assetResolutionOption>ALLOW_DUPL_XREF</assetResolutionOption>
W_GENERICCA_IGNORE_EDITCHECK302Y (default), N
<COL TAG="W_GENERICCA_IGNORE_EDITCHECK302" EXPRESSION="'N'"/>

For Accounting CA only.

By default the message is not failed if tag 302 is not resolved and throws only a WARNING.

If tag 302 is not resolved, you can choose to fail such messages by setting either:

  • global variable W_GENERICCA_IGNORE_EDITCHECK302 with the value ‘N’ or
  • element referenceTransaction/header/processingOptions with the value ‘USE_TOASSET_CHECK’ 
W_PRICE_RESOLVE_SW_BY_XREFN(default), Y
<COL TAG="W_PRICE_RESOLVE_SW_BY_XREF" EXPRESSION="'Y'"/>

For IssuePrice, ExchangePrice and IssuePcPrice.

By default SWAP resolution for prices has specific logic based on Processing Security Type and only one leg could be priced.

The flag allows to switch on SWAP resolution based on xreferences, ignoring PST.

This mode can be enabled for a single message by setting element referenceTransaction/header/processingOptions with the value 'PRICE_RESOLVE_SW_BY_XREF'


Entity Load Options

W_PERFORM_FULL_ENTITY_RESN(default), Y
<COL TAG="W_PERFORM_FULL_ENTITY_RES" EXPRESSION="'Y'"/>

Setting to Y makes the interface use not only the first entity cross reference in the incoming data, but all xrefs instead to resolve the entity.

Can be especially useful for Warehouse and Accounting interfaces which have full entity resolution switched off for compatibility reasons.

W_ENT_BATTING_ORDERbatting order
<COL TAG="W_ENT_BATTING_ORDER" EXPRESSION="'EML_HUB1,EML_HUB2,EML_HUB3,EML_HUB4'"/>

Entity Batting Order determines which entity xreference identifiers are used in the security resolution and their order for matching.

W_ENT_RES_OPTION

entity resolution option:

RESOLVE_ENTITY_BY_XREFS,
SKIP_INCOMING_ENTITY_ID 

<COL TAG="W_ENT_RES_OPTION" EXPRESSION="'RESOLVE_ENTITY_BY_XREFS'"/>

RESOLVE_ENTITY_BY_XREFS switches on entity xref resolution even if the entity id is defined. This mode can be enabled for a single message by setting <entityResolutionOption>RESOLVE_ENTITY_BY_XREFS</entityResolutionOption> in the incoming message.

SKIP_INCOMING_ENTITY_ID allows to skip incoming entity id value and to generate entity id if it was not resolved. This mode can be enabled for a single message by setting <entityResolutionOption>SKIP_INCOMING_ENTITY_ID </entityResolutionOption> in the incoming message.

W_ENT_XREF_MAPxref map
<COL TAG="W_ENT_XREF_MAP" EXPRESSION="'XREF4,XREF4_@SentBy,XREF2,XREF2_NEW'"/>

Sets a custom entity xref map for all loads in the environment.

W_ENT_LOAD_XREF_OPTIONSentity load xref options
Sets entity xref options for load.
W_ENTITY_PARTITION_MAPPINGpartition mapping
<COL TAG="W_ENTITY_PARTITION_MAPPING" EXPRESSION="'HUBID|TESTENV_1|PARTITION|1|\n
HUBID|TESTENV_2|PARTITION|2|OVERWRITE|Y|\n
FROMSOURCENAME|TESTSOURCE_1|PARTITION|1|OVERWRITE|N|\n
FROMSOURCENAME|TESTSOURCE_3|PARTITION|2|OVERWRITE|Y|\n
'"/>
Sets partition mapping for Generic Entity.

Xref Load Options

W_USEDYNAMIC_FOR_XREF   Y (default), N
By default any number of identifiers can be loaded in the <xrefIdentifiers> complex node. Switch to N to return to old logic, limiting this number by 10.
W_LOAD_XREF_OPTIONSstring value
<CODE>
   CreateVariable(‘W_LOAD_XREF_OPTIONS’,‘W_IGNORE_EMPTY_SECXREF,CUSIP’);
</CODE>

Set to Y to ignore identifiers with empty id values specified in the <xrefIdentifiers> section. Read more on this page.

W_IGNORE_EMPTY_SECXREF


W_DUP_XREF_CHECK

Y, N (default)
<CODE>
   :W_DUP_XREF_CHECK::='Y';
</CODE>
Set to Y to check and skip duplicate identifiers in current message. Available only with W_USEDYNAMIC_FOR_XREF flag enabled

Task Reporter

W_COLLECT_DISTRIBUTION_ERRORSJMS,MQ,EMAIL
<CODE>
   :W_COLLECT_DISTRIBUTION_ERRORS::='JMS';
</CODE>
Specify the delivery method for which task reporter should be enabled. RTR analog is CollectDistributionErrors.
W_CONFIG_JMS_TSR_RE_TRY_CNTnumber
<CODE>
   :W_CONFIG_JMS_TSR_RE_TRY_CNT::='10';
</CODE>
Sets the number of retries for JMS delivery. Default value is 10.
TSR_RE_TRY_WAITtime in seconds
<CODE>
   :TSR_RE_TRY_WAIT::='1';
</CODE>
Sets the wait time between retry attempts. Default value is 1 second.
W_CONFIG_CHECK_STATUS_RE_TRY_CNTnumber
<CODE>
   :W_CONFIG_CHECK_STATUS_RE_TRY_CNT::='10';
</CODE>
Sets the number of retries when the file is sent.
W_WAIT_FOR_FILE_UPLOAD_TIMEtime in seconds
<CODE>
   :W_WAIT_FOR_FILE_UPLOAD_TIME::='300';
</CODE>

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. Default value is 300 seconds. Read more

W_FTP_CURL_TIMEOUT_30MINN (default), Y
<CODE>  :W_FTP_CURL_TIMEOUT_30MIN::='Y';
</CODE>
Y value sets the timeout for curl command execution to 30 minutes (1800s).

ServiceNow Alerts

w_profile_dirfolder path
<COL TAG="w_profile_dir" EXPRESSION="GetDirRoot() +
'dynamic/msgcenter/eagle_ml-2-0_cm_profiles/'” />

The folder where workflow profiles will be stored (default value is ../estar/tpe/dynamic/msgcenter/eagle_ml-2-0_cm_profiles).

W_EAS_CLIENT_IDclientId, default value is EAGLE
<COL TAG="W_EAS_CLIENT_ID" EXPRESSION="'EAGLE (QA test box, 2017R2, Oracle, 32Gb RAM'"/>

Client information added to alerts. Can be used to identify the environment sending alerts and to provide more details about it.

W_EAS_MAIL_LIST:W_EAS_MAIL_LIST:+ list of emails
<COL TAG="W_EAS_MAIL_LIST" EXPRESSION=":W_EAS_MAIL_LIST:+',user@mail.com'"/>

Add emails to the default list (:W_EAS_MAIL_LIST: in w_config.inc) to receive EAS alerts.

W_EAS_PATERNSPatterns separated by ! sign
<COL TAG="W_EAS_PATERNS" EXPRESSION="'Job Execution Warning!Missing Files Error!RTR-TSR Matching Error!FTP CM not read!'"/>

A filter for EAS alerts. Alerts matching a pattern will be delivered, others will be ignored.

W_EAS_SENDMAILFROMemail
The sender email in the message. Set by default in w_config.
W_ENV_NAMEname of environment
<COL TAG="W_ENV_NAME" EXPRESSION="'ENVNAME'"/>

This parameter is usually resolved automatically in the get_enviroment_name.inc include. But you can set it manually.

W_MONITOR_ENABLEDY or N
<CODE>
:W_MONITOR_ENABLED::='Y';
</CODE>
Enables/disables monitoring stream
monHealthTraceLevelnumber
<COL TAG="monHealthTraceLevel" EXPRESSION="'1'"/>
Adjust the output of debug messages in the status. Default value is 1, increase it to reduce the amount of debug messages.
monHealthTimeouttime in milliseconds
<COL TAG="monHealthTimeout" EXPRESSION="'600'"/>
Sets a timeout at the end of the health check cycle to let the workflow return to normal status and avoid false errors. Recommended value is 600, but should be adjusted for a particular environment.
monHealthTestListformatted value
<COL TAG="monHealthTestList" EXPRESSION="'FILE:EXTRACT,WORKFLOW!FTP:LOAD!FTP_CURL:EXTRACT'"/>

This parameter contains delivery methods, separated by “!”. For each delivery method you can (optionally) specify methods for Control Messages. The attempt to send Control Message(s) will take place after trying to write and read a file using the specified method.

Delivery method is separated from optional parameters by “:”. Optional parameters are separated by “,”. At least one method for Control Messages should be specified for each Delivery method.

The example gives the following instructions: read/write through FILE method, then try to send EXTRACT and WORKFLOW Control Messages, then check read/write for FTP and FTP_CURL. If there is an instruction to send Control Messages, the results will be checked after a timeout. In case the Control Message returns an error or does not return any results, alert will be generated and sent according to the configuration. 

Available delivery methods:
•       FILE
•       FTP 
•       FTP_CURL
•       SFTP_CURL

Available commands for them:
•       EXTRACT
•       WORKFLOW
•       PACE_EVENT
•       STAR_EVENT
•       LOAD 

RTR_JOBS_PARAMSformatted value
<COL TAG="RTR_JOBS_PARAMS" EXPRESSION="'PACEEventType!test!PACEEventName!test!EventExecTimeout!6000!\n
PACEEventType!test!PACEEventName!test!EventExecTimeout!6000!'"/>

Settings for an RTR job.

Sequencer

w_seq_timeouttime in seconds
<COL TAG="w_seq_timeout" EXPRESSION="180"/>

Defines the timeout between steps since the last message processed (or queued if W_LAST_SEQUENCE is empty).

w_exec_folder:w_mcdata_dir: + folder name
<CODE>
   :w_seq_folder: := :w_mcdata_dir: + 'out/TAGVALUE/eagle_ml-2-0_default_cm_sequencer/incoming/';
</CODE>

Sets the processing folder for Sequencer. Default is out/TAGVALUE/eagle_ml-2-0_default_cm_sequencer/incoming/ 

Nuggetizer

W_NGTZR_MASK_CNTnumber
<CODE>
    CreateVariable( 'W_NGTZR_MASK1','STAR_ndfa_1_mask1_' );
    CreateVariable( 'W_NGTZR_MASK1_OUT','STAR_ndfa_1_NUGGET_1_' );
    CreateVariable( 'W_NGTZR_MASK1_SIZE','10' );
    CreateVariable( 'W_NGTZR_MASK1_WAIT','10' );
    CreateVariable( 'W_NGTZR_MASK1_FORMAT','EagleML' );
    CreateVariable( 'W_NGTZR_MASK1_WKFL','some_workflow' );
    CreateVariable( 'W_NGTZR_MASK1_LOADFROMDIR',:W_NGTZR_DIST_FOLDER: );
</CODE>
<CODE>
    CreateVariable( 'W_NGTZR_MASK2','STAR_ndfa_1_mask2_' );
    CreateVariable( 'W_NGTZR_MASK2_OUT','STAR_ndfa_1_NUGGET_2_' );
    CreateVariable( 'W_NGTZR_MASK2_SIZE','2' );
    CreateVariable( 'W_NGTZR_MASK2_WAIT','1000' );
    CreateVariable( 'W_NGTZR_MASK2_FORMAT','EagleML' );
    CreateVariable( 'W_NGTZR_MASK2_WKFL','some_workflow' );
    CreateVariable( 'W_NGTZR_MASK2_LOADFROMDIR',:W_NGTZR_DIST_FOLDER: );
</CODE>
Number of file masks fed to the nuggetizer. 
W_NGTZR_DIST_FOLDERfolder patheagle_ml-2-0_default_cm_disribute_to_nuggetizer (if involved into the workflow) puts files into this folder and eagle_ml-2-0_default_cm_nuggetizer can then use these files.
W_NGTZR_MASK1file maskExpected file mask.
W_NGTZR_MASK1_OUTfile maskThe file mask for outgoing nuggets.
W_NGTZR_MASK1_SIZEnumberThe number of files matching W_NGTZR_MASK1, 'glued' into one nugget.
W_NGTZR_MASK1_WAITtime in secondsThe timout for nugget creation (the nugget is not considered complete till this time runs out). 
W_NGTZR_MASK1_FORMATEagleMLFile formatting. (Currently only EagleML available).
W_NGTZR_MASK1_WKFLworkflow nameThe workflow to which created nuggets are sent for further processing. 
W_NGTZR_MASK1_LOADFROMDIRfolder pathThe folder in which nuggetizer looks for files matching W_NGTZR_MASK1.
Other masks are configured in a similar way (see the example).

Generic Load Enrichment Process

CONFIG_GENERICLOAD_SKIPLOAD0, 1
<CODE>
    CreateVariable( 'CONFIG_GENERICLOAD_SKIPLOAD','1' );
</CODE>

Toggle skipping the load step (generic_load) within generic_load_enrichment workflow.

CONFIG_GENERICLOAD_SKIPRDC0, 1
<CODE>
    CreateVariable( 'CONFIG_GENERICLOAD_SKIPRDC','1' );
</CODE>

Toggle skipping RDC call (PACE job) within generic_load_enrichment workflow. 

Monitoring Stream

W_MONITOR_ENABLEDY, N
<CODE>
   :W_MONITOR_ENABLED: :='Y';
</CODE>

Toggle monitoring stream usage.

W_MONITOR_SCH_ENABLEDY, N
<CODE>
   :W_MONITOR_SCH_ENABLED: :='Y';
</CODE>

Toggle monitoring sch stream usage - monitoring_sch stream is used to launch monitoring for a separate process.

w_monitoring_streamstream name
<CODE>
    :w_monitoring_stream: := 'eagle_ml-2-0_default_cm_monitoring';
</CODE>

Name of the monitoring stream.

W_MONITOR_PROCESS_IDprocess id
<CODE>
    :W_MONITOR_PROCESS_ID::='2841284';
</CODE>

Process id for your monitoring stream. 

W_MONITOR_APP_IDapplication id
<CODE>
    :W_MONITOR_APP_ID::='2259035154';
</CODE>

New application id for your monitoring stream.

W_MONITOR_CUR_APP_IDapplication id
<CODE>
    :W_MONITOR_CUR_APP_ID::='26704';
</CODE>

Old application id for your monitoring stream. W_MONITOR_CUR_APP_ID will be replaced with W_MONITOR_APP_ID in the system.

W_MON_STREAMSformatted list
<CODE>
   :W_MON_STREAMS::=’:STREAM:your_stream_name1:FOLDER:your_stream_folder1:\n’+
‘:STREAM:your_stream_name2:FOLDER:your_stream_folder2:\n’;
</CODE>

List of streams and folders to be monitored.

W_CM_EA_FTP_READER_ENABLEDY, N
<CODE>
   :W_CM_EA_FTP_READER_ENABLED: :='Y';
</CODE>

CM_EA_FTP_READER is an alternative for the FTP stream, its main feature is that it takes the list of files from DB sitesee instead of calling FTP
It is commonly used to avoid the FTP plugin issue - too frequent FTP pulling.

W_EXECUTION_MONITORING_TIMEOUTtime in seconds
<COL TAG="W_EXECUTION_MONITORING_TIMEOUT" EXPRESSION="'55'"/>
Maximum status check timeout. Can be set as a task parameter ExecutionMonitoringTimeout for a single process.
W_EXECUTION_MONITORING_PERIODtime in seconds
<COL TAG="W_EXECUTION_MONITORING_PERIOD" EXPRESSION="'300'"/>
Time interval between status checks. Can be set as a task parameter ExecutionMonitoringPeriod for a single process.

SiteSee 

SITESEE_DB_TNSTNS
TNS (server alias) for SiteSee.
SITESEE_DB_USERuser name
Setting user name for SiteSee.
SITESEE_DB_PWDpassword
Enter the password for SiteSee (encrypted). When you set a new password restart MC to apply changes.
SITESEE_FTP_SUBFOLDERfolder path
Specifies the folder for SiteSee FTP Reader. Standard setting is CMW/control
SITESEE_FTP_CHECK_TIMEtime in seconds
Sets the timeout for SiteSee FTP Reader.

Custom XSD Validation File and Schema Location

w_xsd_validation_filefile path
<COL TAG="w_xsd_validation_file" EXPRESSION="'dynamic/eagleml/extension/eagleml-ext-2-0.xsd'"/>

Set custom XSD validation file location. 

w_schema_namefile path
<COL TAG="w_schema_name" EXPRESSION="'http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-ext-2-0.xsd'"/>

Set custom schema location. 

Instance to Instance (I2I)

W_I2I_IS_SPOKEYES or empty
<COL TAG="W_I2I_IS_SPOKE" EXPRESSION="'YES'"/>

Defines if an environment is set as Spoke in an I2I process.

W_I2I_IS_HUBYES or empty
<COL TAG="W_I2I_IS_HUB" EXPRESSION="'YES'"/>

Defines if an environment is set as Hub in an I2I process.

I2I_LOAD_IN_HISTORYY or empty
<COL TAG="I2I_LOAD_IN_HISTORY" EXPRESSION="'Y'"/>

Toggle loading SMF into the history table (equal to forcing <historyOnlyFlag>=Y) within an I2I process, when the data is extracted from the composite table of Hub and then loaded into the history table of Spoke. 

W_I2I_FORCE_WRHS_TRADE_INSY, N
<COL TAG="W_I2I_FORCE_WRHS_TRADE_INS" EXPRESSION="'Y'"/>

If set to Y, this parameter forces all Warehouse Trade extracts on the box to have the updatetype of I. 

This option is also available as a Task Parameter in the control message (especially useful, when you do not want to apply this updatetype to all Warehouse Trade extracts on the box). Task parameter version for RTR is ForceWRHSTradeIns

W_I2I_RELOAD_FINAL_FLAGN (default), Y
<COL TAG="W_I2I_RELOAD_FINAL_FLAG" EXPRESSION="'Y'"/>

This parameter affects Warehouse Performance - Delta Mode only. Allows to load Warehouse Performance even in case STATUS_FLAG is already set as F(FINAL). 

W_USE_ORCH_FOR_DELTAY(default), N
<COL TAG="W_USE_ORCH_FOR_DELTA" EXPRESSION="'N'"/>

When set to N, extracts in delta mode do not use orchestration. 

Configure the FTP for I2I

Some parameters are noted as Required - this is only in case you want to use FTP delivery method
w_i2i_ftp_urlftp url
FTP URL. Required
w_i2i_ftp_passpassword
FTP Password (It can be either encrypted or not - we recommend that you encrypt your password). Required
w_i2i_ftp_encryptedYES or NO (default)
YES – password is encrypted. NO or NULL if not encrypted. Optional.
w_i2i_ftp_useruser name
FTP User Name. Required
w_i2i_ftp_data_locationfolder path
Folder for archive on FTP. Default value is 'CMW/inbound/'. Optional
w_i2i_ftp_reply_locationfolder path
Required when the workflow is launched remotely (Extract or Load). If you want TSR to be loaded on FTP.
w_i2i_ftp_control_locationfolder path
Required when the workflow is launched locally (Extract or Load). If you want RTR to be loaded on FTP.

Configure the Web Service for I2I

Some parameters are noted as Required - this is only in case you want to use Web Service delivery method

w_i2i_web_service_urlWS url
WS URL. Required
w_i2i_web_service_passpassword
WS password. Required
w_i2i_web_service_useruser name
WS user name. Required
w_i2i_web_service_retry_countnumber (integer)
WS number of retries. Optional

I2I Filters

w_i2i_spoke_enitity_list


w_i2i_spoke_xref_id_type_list


w_i2i_spoke_data_sources


w_i2i_spoke_xref_id_type_output


I2I workflow parameters

w_i2i_from_folder


w_i2i_to_folder


w_i2i_delivery_stream

This is the MAIN parameter in configuration, which defines the way TSRs/RTRs are sent to the other side of the I2I process.
w_i2i_mixed_deliveryYES or NO (default)
If this parameter set to YES, extracted data will be base64-encoded and wrapped into RTR/TSR

PACE and STAR Jobs

W_CONFIG_SKIP_SUCCESS_STEPSY (default), N
<COL TAG="W_CONFIG_SKIP_SUCCESS_STEPS" EXPRESSION="'N'"/>

Available since May 2016 EagleML Release. Toggles displaying details for successful substeps. Switched off ("Y") by default. Read more... 

W_CONFIG_INCLUDE_ENTITIES_DETAILSN (default), Y
<COL TAG="W_CONFIG_INCLUDE_ENTITIES_DETAILS" EXPRESSION="'Y'"/>

Setting to Y enables Event Entity Details for STAR events and for DataMart Model Manager steps in the final TSR for PACE jobs - these are available since May 2016 EagleML Release for PACE and since September 2016 EagleML Release for STAR. In addition, includes execution details for STAR (available since October 2016 EagleML Release). Read more... 

W_CREATE_PACE_JOB_DEFN (default), Y
Enable support for Pace Jobs with incoming parameters.
W_CONFIG_INCLUDE_SECURITY_DETAILSN (default), Y
<COL TAG="W_CONFIG_INCLUDE_SECURITY_DETAILS" EXPRESSION="'Y'"/>

Enable security-level details for failed TSR for RDC Composites. 

TBA workflow

W_TBA_LoadStreamstream name
<COL TAG="W_TBA_LoadStream" EXPRESSION="'custom_load_stream_for_tba'"/>

Data delivery stream for TBA workflow. 

W_TBA_STP_FlagN (default), Y
<COL TAG="W_TBA_STP_Flag" EXPRESSION="'N'"/>

If value is set to Y the last step of each relevant workflow will start the next one automatically. 

FTP/SFTP

FTP_RE_TRY_MAX_CNTnumber, default is 5
<COL TAG="FTP_RE_TRY_MAX_CNT" EXPRESSION="'5'"/>

Defines the number of retry attempts. 

FTP_RE_TRY_ATT_INTERVALtime in seconds, default is 1
<COL TAG="FTP_RE_TRY_ATT_INTERVAL" EXPRESSION="'1'"/>

Defines the timeout between attempts. Read more.. 

SFTP_RE_TRY_MAX_CNTnumber, default is 5
<COL TAG="SFTP_RE_TRY_MAX_CNT" EXPRESSION="'5'"/>

Defines the number of retry attempts. 

SFTP_RE_TRY_ATT_INTERVALtime in seconds, default is 1
<COL TAG="SFTP_RE_TRY_ATT_INTERVAL" EXPRESSION="'1'"/>

Defines the timeout between attempts. Read more.. 

NG Logic 

W_NG_CUST_SWITCHNG, CUSTOM, CORE
For some Warehouse objects, such as Warehouse Month End, this parameter allows:
•    NG – to use common NG XSLT – 1 for all NG SP
•    CUSTOM – for warehouse objects this allows to use custom xslt for each data type object like: wrh_pos_cust.xsl
•    CORE- to use CORE XSLT and SP.
This value can also be set within the Warehouse message itself - in the procedureSwitch node
w_ng_enabledlist of feedtypes
Defines the list of feedtypes for which NG logic is enabled
W_'+Upper(:varObjectType:)+'_NG_SCHEMA_NAMEschema name
<COL TAG="W_GENERICSMF_NG_SCHEMA_NAME" EXPRESSION="'PACE_MASTERDBO'"/>

Custom NG schema name. Default value is core schema name

W_'+Upper(:varObjectType:)+'_NG_PACKAGE_NAMEpackage name
<COL TAG="W_GENERICSMF_NG_PACKAGE_NAME" EXPRESSION="'ESTAR_SEC_NG'"/>

Custom NG package name. Default value is core package name + _NG

W_'+Upper(:varObjectType:)+'_NG_SP_NAMESP name
<COL TAG="W_GENERICSMF_NG_SP_NAME" EXPRESSION="'INSERT_UPDATE_SMF_MI_NG'"/>

Custom NG SP name. Default value is core SP name + _NG

EJM Notification Filename Settings

W_TSR_STRICT_PATTERNcustom TSR strict pattern
Please refer to this page to learn more about configuring EJM Notification Filenames.
W_ACK_STRICT_PATTERNcustom ACK strict pattern
W_TSR_NAME_PATTERNcustom TSR name pattern

GPG Encryption

GPG_USERIDuser ID
<COL TAG="GPG_USERID" EXPRESSION="'MYNAME'" USERDESCRIPTION="UserId for the encryption process" />
UserId for the encryption process of GPG. 
ENCRYPTION_MODEGPG,PGP,NONE
<COL TAG="ENCRYPTION_MODE" EXPRESSION="'GPG'" USERDESCRIPTION="Encrypt logic used by the workflow. Choose GPG,PGP,NONE"/>
Set encryption mode.

GPG Decryption




W_AUTO_DETECT_ENCRYPTIONY (default), N
<COL TAG="W_AUTO_DETECT_ENCRYPTION" EXPRESSION="'Y'"/>
By default automatic detection of encrypted files for both unpacker and ndfa streams is enabled. This flag has a higher priority than W_NDFA_INCOMING_ENCRYPTED
W_NDFA_INCOMING_ENCRYPTEDEXTENSION BASED (default), ALL
<COL TAG="W_NDFA_INCOMING_ENCRYPTED" EXPRESSION="'ALL'"/>
By default, the ndfa automatically detects encrypted files by their extension. ALL value enables 
GPG_PASSPHRASEpass phrase
<COL TAG="GPG_PASSPHRASE" EXPRESSION="'sdp10923'" USERDESCRIPTION="Pass phrase for the encryption/decryption process"/>
Pass phrase for the decryption process.
DECRYPTION_MODEGPG,PGP
<COL TAG="DECRYPTION_MODE" EXPRESSION="'GPG'" USERDESCRIPTION="Decrypt logic used by the workflow. Choose GPG or PGP"/>
Set decryption mode.

Workflow Waiting and Error Queues

W_WAITEVENTS_DATABASE_MODEY (default), N
<COL TAG="W_WAITEVENTS_DATABASE_MODE" EXPRESSION="'Y'"/>
Setting to Y makes the process store wait event info in orch_request_params table.
W_GLOBAL_ERROR_QUEUE_CLEANUP_PERIODtime in days
<COL TAG="W_GLOBAL_ERROR_QUEUE_CLEANUP_PERIOD" EXPRESSION="'45'"/>
Sets the cleanup period for global error queue in days.
W_WORKFLOW_SPECIFIC_ERROR_QUEUE_CLEANUP_PERIODtime in days
<COL TAG="W_WORKFLOW_SPECIFIC_ERROR_QUEUE_CLEANUP_PERIOD" EXPRESSION="'10'"/>
Sets the cleanup period for workflow specific error queue in days.
W_WORKFLOW_SPECIFIC_WAITING_QUEUE_CLEANUP_PERIODtime in days
<COL TAG="W_WORKFLOW_SPECIFIC_WAITING_QUEUE_CLEANUP_PERIOD" EXPRESSION="'10'"/>
Sets the cleanup period for workflow specific waiting queue in days.
W_GLOBAL_ERROR_QUEUE_ORCH_INSTANCEinstance number
<COL TAG="W_GLOBAL_ERROR_QUEUE_ORCH_INSTANCE" EXPRESSION="'-418'"/>
Sets the value of ORCH_INSTANCE for global error queue.
W_WORKFLOW_SPECIFIC_WAIT_QUEUE_ORCH_INSTANCEinstance number
<COL TAG="W_WORKFLOW_SPECIFIC_WAIT_QUEUE_ORCH_INSTANCE" EXPRESSION="'-200'"/>
Sets the value of ORCH_INSTANCE for workflow specific waiting queue.
W_WORKFLOW_SPECIFIC_ERROR_QUEUE_ORCH_INSTANCEinstance number
<COL TAG="W_WORKFLOW_SPECIFIC_ERROR_QUEUE_ORCH_INSTANCE" EXPRESSION="'-200'"/>
Sets the value of ORCH_INSTANCE for workflow specific error queue.

Other Parameters

w_mc2_http_retry_counttime in seconds
<CODE>:w_mc2_http_retry_count: := '5';</CODE>

w_disable_task_statistics_update

N (default), Y
<CODE>:w_disable_task_statistics_update: := 'Y';</CODE>

Setting to Y disables the execution of update_tasks_statistics.inc logic globally. Alternative to apply it to a single process is DisableTaskStatisticsUpdate RTR parameter.

 Note (click to expand):

Disabling update task statistics will lead to the following consequences:

1. There may be problems in the Monitoring Tool. Not all information may be displayed.

2. There may be problems with AC. Not all information may be displayed.


3. You can see incorrect status if there are errors in events that are not displayed due to the use of this option




W_REF_BATCH_MODEY (default), N
Disable single commit scope mode when loading Schedule, Variable Rate and Earnings in batch mode (when loading via the _mi stream). 
W_LOAD_XREFID_IN_UPPER_CASEN (default), Y
Disable single commit scope mode when loading Schedule, Variable Rate and Earnings in batch mode (when loading via the _mi stream). 
W_WRHS_IGNORE_POS_FLAGN (default), Y
<COL TAG="W_WRHS_IGNORE_POS_FLAG" EXPRESSION="'Y'"/>

Ignore POS_FLAG field in POSITION flag during load. Available since February 2017 EagleML release.

W_VALIDATE_MSG_SAFETYY (default), N
<CODE>
:W_VALIDATE_MSG_SAFETY: := 'N'
</CODE>
Setting to N disables validation for SQL injection.
W_NO_LOAD_VALIDATION_FLAGN (default), Y
<COL TAG="W_NO_LOAD_VALIDATION_FLAG" EXPRESSION="'Y'"/>

Global analog of noLoadValidationFlag element for Reference objects.

W_UNDERLYING_VALIDATION_SKIPN (default), Y
<COL TAG="W_UNDERLYING_VALIDATION_SKIP" EXPRESSION="'Y'"/>
Setting to Y turns off validation of fields during the load of Underlying SMF shell records created for Underlying from the SMF .

Effect is close to noLoadValidationFlag, but works only for Underlying.

W_UNDERLYINGSMF_DELETE_REINSERT_SWITCHN (default), Y
<CODE>
   :W_UNDERLYINGSMF_DELETE_REINSERT_SWITCH::='Y';
</CODE>
Setting to Y allows to delete the underlying record by key and reinsert a new incoming one. RTR analog is underlyingDeleteReinsertSwitch.
W_UNDERLYINGSMF_COMPABILITY_MODEN (default), Y
<CODE>
   :W_UNDERLYINGSMF_COMPABILITY_MODE::='Y';
</CODE>
Setting to Y allows to avoid new implemented logic for underlying upload that tracks underlying periods and adjust them. Basically it is a backup option in the case that someone would require old behavior and wanted to avoid updated underlying period by period loading process.
W_ExecuteSRM 0,1
Toggle SRM process usage when the generic load workflow launches the composite pace_event.

W_USE_STREAM_FAILURE_TOLERANCE

Y, N(default)
<COL TAG="W_USE_STREAM_FAILURE_TOLERANCE" EXPRESSION="'Y'" USERDESCRIPTION="Use the preset stream Failure Tolerance value for TSR status. Y(yes) or N(no)"/>

Toggle stream Failure Tolerance value usage in TSR status resolution. 

W_FAILURE_TOLERANCE_TYPEBATCH (default), RECORD
<COL TAG="W_FAILURE_TOLERANCE_TYPE" EXPRESSION="'BATCH'"/>
Switches failure tolerance type between batches and separate records. Works only with Warehouse Preproc stream (as only this stream can handle batches with multiple records inside). Default value is BATCH.
W_VENDOR_PARAMSformatted value
<COL TAG="W_VENDOR_PARAMS" EXPRESSION="'120:
:FTP_URL:199.181.252.17
:FTP_USER:EAGLEACCFTPH3
:FTP_PASSWORD:'+IIF (:g_EagleML20_Version: >= '13','base64aes~3ixVtDShlFVvUggGTym0xtgyXc5KbnS/','base64vig~Sn1cdCkrKUU=')+'
:FTP_DIRECTORY:/IN/FRFILEHOLD/
:FTP_FILE:CUSTID.MMKT
:VENDOR_NAME:IDC
:FEED_NAME:Fundrun:\n
120:
:FTP_URL:10.70.132.27
:FTP_USER:DISDEVFTP2
:FTP_PASSWORD:base64aes~9LwuJR5vWo6gtnndb9sUxn3r3ivvhiDe
:FTP_DIRECTORY:/ABVDEV/REQUEST/
:FTP_FILE:unvmnt.ftp
:VENDOR_NAME:IDC
:FEED_NAME:Solvency
:FTP_RESPONSE_DIRECTORY:/ABVDEV/RESPONSE/'" />

VENDOR FTP credentials.

UNPACK_WITH_CORR_IDY, N
<CODE>
  CreateVariable( 'UNPACK_WITH_CORR_ID','N');
</CODE>

Unpackaging with correlation Id in file names. 

w_preproc_pathfolder path
<CODE>
  :w_preproc_path: :=GetDirRoot() + 'servers/msgservice/preprocessors';
</CODE>

Setting correct preprocessors folder location in case IWS resolves them in a wrong way. 

W_REQ_CNT_LOOP_MAXtime in seconds
<COL TAG="W_REQ_CNT_LOOP_MAX" EXPRESSION="'18000'"/>

Sets the timeout during which the parallel_exec stream checks if the file has been loaded. Default value is 18000 (5h).

EAGLEML_WAREHOUSE_BATCH_ERROR_MODEN (default), Y
<CODE>   :EAGLEML_WAREHOUSE_BATCH_ERROR_MODE::='Y';
</CODE>

Toggles Batch Error mode for Warehouse objects. See more details on this page. 

W_BATCH_COLLECT_ERRORS_FLAGN (default), Y
<COL TAG="W_BATCH_COLLECT_ERRORS_FLAG" EXPRESSION="'Y'"/>
Toggles Report all errors at once feature. Read more
W_SMF_GENERICSMF_DEBUGN (default), Y
<COL TAG="W_SMF_GENERICSMF_DEBUG" EXPRESSION="'Y'"/>
If this flag set to "Y" the additional  XSLT is used in genericSMF rule logic and all tags are mapped into TAGVALUE format and after that all tags are split and created by CreateVariable construction. With this approach tags will be displayed in the Outgoing tab in Message Center Console, thus making SMF debug more comfortable.
Currently unavailable due to MC bug. This warning will be removed as soon as it is fixed. 
w_default_send_notifications
ALWAYS (default) , 
NEVER, 
ONFAILURE
<COL TAG="w_default_send_notifications" EXPRESSION="'ALWAYS'"/>

Manages EJM jobs notifications.
  ‘ALWAYS’ or ‘1’ to enable   
  ‘NEVER’ or ‘0’ to disable
  ‘ONFAILURE’ to send notification on failure case only (TSR has ‘FAILED’ final status).

W_INTERNAL_TSR_GENERATIONY (default), N
<COL TAG="W_INTERNAL_TSR_GENERATION" EXPRESSION="'N'"/>
Setting to N suppresses intermediate TSR generation. RTR analog is InternalTSRGeneration.

W_INCLUDE_ALL_DETAILS

N (default), Y
<COL TAG="W_INCLUDE_ALL_DETAILS" EXPRESSION="'Y'"/>

This flag allows to show details for SUCCESS messages in consolidated TSR like:

<transactionId>B90DBM55FL6PIXJB</transactionId>
<eagleDetailId>4839327</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>1</identifierValue>
</identifier><identifier><identifierName>account</identifierName><identifierValue>261</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>-3862</identifierValue>
</identifier><identifier><identifierName>identifier2</identifierName><identifierValue>19900101</identifierValue>
</identifier><identifier><identifierName>identifier3</identifierName><identifierValue>99</identifierValue>
</identifier>

This flag works in conjunction with CreateConsolidatedTSR and IncludeRecordErrorDetails. So to use this option within one single process you need to set IncludeAllDetails = Y, CreateConsolidatedTSR = Y and IncludeAllDetails = Y in the RTR.

W_INCLUDE_RECORD_ERROR_DETAILS

Y (default), N
<COL TAG="W_INCLUDE_RECORD_ERROR_DETAILS" EXPRESSION="'N'"/>

Setting to N excludes errors from TSR. RTR analog is IncludeRecordErrorDetails.

See more details on this page.

W_DISABLE_EXT_ERR_DESC_PACE_UPLOADER

N (default), Y
<COL TAG="W_DISABLE_EXT_ERR_DESC_PACE_UPLOADER" EXPRESSION="'Y'"/>
Setting to Y excludes errors from Pace Uploader in TSR generation. There is no RTR analog.
W_SYNCCALL_OPTIMIZE_FLAG


w_enable_ndfa_multifiles


W_ROLLUP_FLAGY (default), N
<COL TAG="W_ROLLUP_FLAG" EXPRESSION="'N'"/>

Setting to N disables the roll-up for Warehouse Position and Open Lot. Alternative setting:

<rollupFlag>N</rollupFlag>

element in the incoming message.

W_USE_RDC_PRICINGN (default), Y
<COL TAG="W_USE_RDC_PRICING" EXPRESSION="'Y'"/>
Global analog of useRdcPricing element for IssuePcPrice object. Toggles RDC load mode for IssuePcPrice.  When set to Y, loads using RDC processes.

W_USE_RDC_FX

N (default), Y


<COL TAG="W_USE_RDC_FX" EXPRESSION="'Y'"/>
Global analog of useRdcFx element for IssueFxPcRate object. Toggles RDC load mode for IssueFxPcRate.  When set to Y, loads using RDC processes.
w_disableACKForStreamspipe-delimited list of streams'
<CODE>
    :w_disableACKForStreams: := '|eagle_ml-2-0_default_out_q|eagle_ml-2-0_default_in_xml_reference|';
</CODE>
Disable ACK messages for specified streams. For example, when you load via eagle_ml-2-0_default_cm_control_message or when you do not want extra ACK produced for acync extract.
W_WRITE_WORKFLOW_LOGY, N (default)
<COL TAG="W_WRITE_WORKFLOW_LOG" EXPRESSION="'N'"/>
Toggles writing of logs generated by exec_wkfl stream. These logs are required to autostart subprocesses, for other cases can be switched off.
W_SCHD_EJM_WORKFLOW_CANCELY, N (default)
<CODE>
:W_SCHD_EJM_WORKFLOW_CANCEL: := 'Y';
</CODE>

Toggles the timeout for workflow_restart rule. RTR version of this parameter is EnableTimeoutCancel.

Timeout value is set with W_SCHD_EJM_RUN_TIMEOUT parameter. 

W_SCHD_EJM_RUN_TIMEOUTtime in seconds or 
time in hh:mm format 
<CODE>
:W_SCHD_EJM_RUN_TIMEOUT: := 60;
</CODE>
<CODE>
:W_SCHD_EJM_RUN_TIMEOUT: := 17:30;
</CODE>

Sets the timeout value for workflow_restart rule. RTR version of this parameter is EJMRunTimeout.

Timeout can be enabled with W_SCHD_EJM_WORKFLOW_CANCEL=Y parameter. 

W_SCHD_EJM_RUN_CANCEL_TIME

time in hh:mm format 
<CODE>
:W_SCHD_EJM_RUN_CANCE_TIME: := 17:30;
</CODE>

Sets the cancel time value for workflow_restart rule. RTR version of this parameter is EJMRunCancelTime.

This parameter allows to setup a specific time to end all orphaned scheduled workflow executions and stop specific scheduled events at the specified time.

g_eaglepy_version


USE_TRADE_EXT1, N (default)
<COL TAG="USE_TRADE_EXT" EXPRESSION="'1'"/>
When enabled, Warehouse Trade load calls EGL_TRD_INTERFACE_EXT stored procedure instead of default TRD_EGL_GEN_INTERFACE.
W_ENABLE_EXTENDED_FILE_STATISTICSN (default), Y
<COL TAG="W_ENABLE_EXTENDED_FILE_STATISTICS" EXPRESSION="'Y'"/>

Setting to Y expands file statistics with translation statistic and stores it in the PACE_MASTERDBO.ORCH_QUEUE.ORCH_STATE_CLOB DB table to support data load validation. ORCH_STATE_CLOBE table contains:

  • statistics for the source file: partition count; count of filtered records before the translation; total batches for main destination; count of input records; count of records passed to translation.

  • statistics for translated files: total translated records; number of batches and filtered records for destination; translated records for partition; outgoing filename; count of records in key file for roll-up process.

W_ENABLE_SIGNAGE_LOGICN (default), Y
<COL TAG="W_ENABLE_SIGNAGE_LOGIC" EXPRESSION="'Y'"/>

Y enables signage logic.

Please note, that the if local parameter EnableSignageLogic is present in Control Message (RTR), it will have priority over the global parameter.

W_ISSUEROLE_UPDATE_CLOSED_ALLOWEDN (default), Y
<CODE>
   :W_ISSUEROLE_UPDATE_CLOSED_ALLOWED: = 'Y';
</CODE>

Setting to Y allows to update closed issue roles (records woth close date not null).

Alternative way to use this logic is to set referenceTransaction/issuerRole/allowUpdateClosedSwitch to Y.


W_WRHS_USE_GENERATED_BIND


W_DISPLAY_ENVNAME_IN_SENTBY

N (default), Y
<COL TAG="W_DISPLAY_ENVNAME_IN_SENTBY" EXPRESSION="'Y'"/>

By default the sentBy value is the URL. Setting to Y allows to set meaningful information about the region. The information will be taken from EnvironmentName variable from eagle_ml-2-0_custom_cm/w_config_version.inc.

RTR analog is DisplayEnvNameInSentBy.

Default value:

<sentBy>http://www.eagleinvsys.com/</sentBy>
Parameter is set to Y:
<sentBy>http://www.eagleinvsys.com/O171Q001</sentBy>

W_HTTP_CALL_TIMEOUT

time in seconds
<COL TAG="W_HTTP_CALL_TIMEOUT" EXPRESSION="'1000'"/>

Sets the timeout value for http_calls.inc include file. 

Alternative way to use this logic is to set the local parameter httpCallTimeout before including http_calls.inc.

W_UNPACKER_TIMEOUT

time in seconds
<COL TAG="W_UNPACKER_TIMEOUT" EXPRESSION="'500'"/>

Sets the timeout value for all runpreprocessors (unzip, file listing, ...) in unpacker. 

Alternative way to use this logic is to set the parameter UnpackerTimeout in Properties of Task Unpacker in IWS when you edit a workflow.

W_SEC_SHELL_RECORD_ONLYN (default), Y
<COL TAG="W_SEC_SHELL_RECORD_ONLY" EXPRESSION= "'Y'"/>

By default, during initial load the tag 1257 (HISTORY ONLY) is not sent to the Stored Procedure even when it is populated in incoming file. As a result the data is loaded into the master table fully.

The flag allows load initial security in History mode, as a result only specific list of tags will be inserted into master table.

This mode can be enabled for a single message by setting element referenceTransaction/header/processingOptions with the value 'SEC_SHELL_RECORD_ONLY'

W_UNPACKER_UNZIP_SKIP_TIMESTAMP_RESTORATION

N (default), Y
<COL TAG="W_UNPACKER_UNZIP_SKIP_TIMESTAMP_RESTORATION" EXPRESSION="'Y'"/>

By default, during unpacker processing zip files are unzip utility always use timestamp restoration and unpacked files always have original timestamp when they were created. 

This option allows to skip timestamp restoration and set actual timestamp for unpacked files.

Alternative way to use this logic is to set the parameter  UnpackerUnzipSkipTimestampRestoration in Properties of Task Unpacker in IWS when you edit a workflow or as parameter in RTR.

W_WAIT_LAST_TASK_REPORTER_SECONDS

time in seconds
<COL TAG="W_WAIT_LAST_TASK_REPORTER_SECONDS" EXPRESSION="'3'"/>

Allows to freeze execwkfl step and wait last task_reporter step if it is still in processing.

Should be used together with W_WAIT_LAST_TASK_REPORTER_RETRY_COUNTS parameter.

Alternative way to use this logic is to set the parameter WaitLastTaskReporterSeconds in RTR.

W_WAIT_LAST_TASK_REPORTER_RETRY_COUNTS

number, default is 3
<COL TAG="W_WAIT_LAST_TASK_REPORTER_RETRY_COUNTS " EXPRESSION="'5'"/>

Can be used only with W_WAIT_LAST_TASK_REPORTER_RETRY_COUNTS parameter.

Allows to set how many times we will try to wait last task_reporter step.

Alternative way to use this logic is to set the parameter WaitLastTaskReporterRetryCounts in RTR.

W_SKIP_SINK_SCHEDULE_MANAGER_VERSION_CHECK

Y, default is empty

<COL TAG="W_SKIP_SINK_SCHEDULE_MANAGER_VERSION_CHECK " EXPRESSION="'Y'"/>

Can be used for eagle_ml-2-0_default_in_xml_sink_schd_manager stream to skip version check if you have SECURITYDBO.SINK_SCHEDULE_KEYS table.

W_MC2_LOADY, default is empty<COL TAG="W_MC2_LOAD" EXPRESSION="'Y'" />

Can be used by eagle_ml-2-0_default_cm_acquire_data stream to load data using MC2 service.

Alternative way to use logic is to set the parameter MC2Load in RTR.

  • No labels