Page Comparison

In this page:

...

Parameter

Example of Value

Comments

ActionType

EXTRACT

Constant value for all extracts.

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_extract

FeedType

SMF,FINANCIALEVENT

Defines the list of object to be extracted.
Should contain a comma-separated combination of values:

ENTITY – all ENTITY + RULE will be extracted
RULE – all RULE will be extracted
REFERENCE – all REFERENCE [ISSUER + SYSTEM + SECURITY] will be extracted
ISSUER – all ISSUER group only will be extracted
SYSTEM – all SYSTEM group only will be extracted
SECURITY – all SECURITY group only will be extracted
WAREHOUSE – all WAREHOUSE will be extracted
CORPORATEACTIONS – all CORPORATEACTIONS group will be extracted
SMF – all SMF will be extracted
ACCOUNTING – all ACCOUNTING group will be extracted
CORPORATEACTIONS – all CORPORATEACTIONS group will be extracted
FINANCIALEVENT – all FINANCIALEVENT will be extracted
CLIENT – all CLIENT will be extracted

You can also select only specific extract types from a group, such as: ENTITYLISTLISTEXTRACT, WRHSCLOSELOTEXTRACT, WRHSNAVEXTRACT
For a list of all object groups, see Extract Object Groups.

Anchor

	Compress
	Compress

Compress

Y (default)
N
ZIP
GZIP
GZ
TAR (only UNIX)
TARGZ (only UNIX)
B64
TAR+B64 (only UNIX)
TARGZ+B64 (only UNIX)
GZIP+B64
GZ+B64
ZIP+B64

Y – Default method ZIP (.zip extension)
N – this setting disables compression for extracted files. Available only for FILE delivery method.
ZIP – files will be compressed as ZIP archive (.zip extension)
GZIP, GZ – files will be compressed altogether in one TAR archive, only after this it will be compressed as GZIP archive, because GZIP can work only with one file. (.tar.gz extension)
TAR – files will be compressed as TAR archive (.tar extension)
TARGZ – files will be compressed as TAR archive (.tar.gz extension)
B64– files will be compressed as ZIP archive and then encoded to base64 text
TAR+B64– files will be compressed as TAR archive and then encoded to base64 text
TARGZ+B64– files will be compressed as TARGZ archive and then encoded to base64 text
GZIP+B64 – files will be compressed as TARGZ archive and then encoded to base64 text
GZ+B64 – files will be compressed as TARGZ archive and then encoded to base64 text
ZIP+B64– files will be compressed as ZIP archive and then it will be compress to base64 text

Info

Important notes:

If delivery method is JMS, all archive will be automatically base64-encoded
Generic Extract workflow and simple extract have several differences:
1. Generic Extract cannot produce GZIP archives, because GZIP does not allow multiple files, so at first a TAR archive will be created and after this it will be compress as GZIP. Simple extract works fine with GZIP
2. Default value for compress in Generic Extract is ZIP
3. Default value for compress in simple extract is G ZIP
Compress parameter would affect the way you set CustomExtractLocation 69731191 parameter:
1. Compress = Y or specific archivation format: the relative path for CustomExtractLocation is resolved relative to the extracts folder [...]/cmw/extracts/
2. Compress = N: the relative path for CustomExtractLocation is resolved relative to the Packer stream folder [MessageCenter root directory]/estar/tpe/data/msgcenter/out/TAGVALUE/eagle_ml-2-0_default_cm_packer/

...

Parameter

Example of Value

Default Value

Comments

ExtractDeliveryMethod

JMS,FTP,SFTP,FILE

FILE

Chooses the way the extract to be delivered. This setting can affect the set of available parameters you can apply to your extract.

DeliveryStreamName

default value is taken from W_JMS_DEF_EXTRACT_STREAM global parameter in w_config_custom.inc

You use this parameter is case of ExtractDeliveryMethod = JMS to use a custom stream

FromFolder

../../../cmw/extracts/

Folder containing files to be archived.

ToFolder

../../../cmw/extracts/

Folder in which the archives should be created.

Info

title	Note

You must create this destination folder if it does not exist.

Especially useful when you use FTP/SFTP/JMS delivery method, but want to save archive locally in the path different from default

Anchor

	OutputZipFileName
	OutputZipFileName

OutputZipFileName

test_new_name_002

Archive name. Only ZIP format compression is available.
If this parameter is specified, the archive name will be generated as "test_new_name_002" and this name will be hardcoded.

Info

title	Note

If you run the extract twice with the same archive name (OutputZipFileName), files will be added to this archive.
This parameter has higher priority than "OutputZipNamePattern".
If OutputZipFileName and OutputZipNamePattern parameters are not specified, the name will be given as follows: "YYMMDD_HHMMSS"+ :CorrID:
For example: 141209_113034_1KJ1JSQ8SVMMB15F5
This parameter has no sense in case you set Compress 69731191 to N.

Anchor

	OutputZipFileNamePattern
	OutputZipFileNamePattern

OutputZipFileNamePattern

test_new_name_001

If this parameter is specified, the archive name will be generated as: OutputZipNamePattern:+ :CorrID: so each archive name will be unique.
For example:

test_new_name_001_1M6EX27SPOQZKMUN
test_new_name_001_8Y3ET42SPWEHMLG

Info

title	Note

This parameter has a lower priority than "OutputZipFileName".
If OutputZipFileName and OutputZipNamePattern parameters are not specified, the name will be given according to the following pattern: "YYMMDD_HHMMSS"+ :CorrID:
For example: 141209_113034_1KM1MSQ8SVMMB15F5
This parameter has no sense in case you set Compress 69731191 to N.

Anchor

	OutputZipFileNamePatternEx
	OutputZipFileNamePatternEx

OutputZipFileNamePatternEx

tst_DateTimeStamp_my2_@feedtype.zip

Custom name pattern for the output file. List of valid expressions:

@CorrelationID
@DateTimeStamp – date-time stamp in format YYYYMMDDHHMISS
@DateTimeStampISO – date-time stamp in format YYYYMMDDTHHMISS (with 'T' separator between date and time values)
@DateStamp – date stamp in format YYYYMMDD
@RecordCount – count of extracted records
@EntityList – passed entity list filter
@EntityID – passed entity id filter
@FeedType – passed feed type
@entityselectiontype – passed value of "entityselectiontype" task parameter
@entityselectiontype2 – passed value of "entityselectiontype2" task parameter
@entityselectionvalue – passed value of "entityselectionvalue" task parameter
@entityselectionvalue2 – passed value of "entityselectionvalue2" task parameter
Info
title Note
This parameter has no sense in case you set Compress 69731191 to N.

FilesAddToZip

*.XML

ProcessCorrId.*

Template files that will be added to the archive.

SendDataToFTP

Y or N

N

Info
Before you use FTP/SFTP delivery, please make sure it is properly configured for your environment. See Configure Delivery Method Options page of EagleML and EJM wiki space.

If this parameter is set to Y, archive data will be loaded to FTP into the CMW\extracts folder. This is an equivalent of ExtractDeliveryMethod = FTP and means that result file will be sent to FTP, even if you choose another ExtractDeliveryMethod option.
You can also assign the default value in w_config_custom.inc:

Code Block
<COL TAG="W_EAGLE_EXTRACTOR_ZIP_TO_FTP" EXPRESSION="'Y'" USERDESCRIPTION="Move resulting ZIP file to FTP Y or N"/>

or its obsolete variation (described to support backward compatibility):

Expand

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

ToFTPFolder is also supported, but this is an obsolete parameter, we highly recommend using CustomExtractLocation.

Anchor

	CustomExtractLocation
	CustomExtractLocation

CustomExtractLocation

../../../cmw/custom_extract/

cmw/extracts/

Defines a custom folder on FTP/SFTP or on server into which the archive is loaded.
Custom extract location for Generic Extract can be specified in the following way:
:STREAMDIR: + CustomExtractLocation value].

Consequently, you cannot set an absolute path to a folder – and this behavior is different from the case of CustomExtractLocation for common extracts (you can set absolute folder paths there).

Resulting path for defferent delivery methods is made up like this:

For Delivery Method = FILE:
ResultPath = :STREAMDIR: + CustomExtractLocation

For Delivery Method = FTP:
ResultPath = CustomExtractLocation

For Delivery Method = SFTP:
ResultPath = CustomExtractLocation

Info

title	Note

To use this option for FTP, the ExtractDeliveryMethod parameter must be set to FTP or SendDataToFTP=Y.

:STREAMDIR: = /envPath/estar/tpe/data/msgcenter/out/TAGVALUE/eagle_ml-2-0_default_cm_packer/
:STREAMDIR: = /envPath/estar/tpe/data/msgcenter/DIRECTION/TYPE/NAME (DIRECTION, TYPE, NAME can be different for different processes, but it is always 3 levels of storage.

CustomFTPFolder

CMW/custom_extract/

CMW/extracts/

Defines a custom FTP folder into which the archive is loaded.

Info

title	Note

To use this option, the ExtractDeliveryMethod parameter must be set to FTP or SendDataToFTP=Y.

ExtractSendNotification

1 or 0

1

The same logic is used for SendNotification, but this option can only be applied to extracts within the workflow.

...

Versions Compared

Old Version 14

New Version 15

Key