Page Comparison

The following Activity shapes are included in the IWS Toolbox:

Table of Contents

maxLevel	2

Activity shapes

Task Translator

This activity shape is associated with transforming data.

On this page

Table of Contents

maxLevel	3

Info

icon	false

This activity shape uses custom Message Center commands and should not be used for xml2xml transformation. For xml2xml transformation, Eagle recommends using the XSLT Translator shape.

The following table describes the shape's properties.

Property	Description
Name	Default is task_translator.
Description	Text displayed below the shape in the workflow diagram
Source	Location of the .ejmtsk file containing the definition of the translator. The field is read-only.
Stream	Instead of creating the translator from scratch in the IWS, it is possible to assign existing Message Center stream to the shape. This should be done after dropping the shape onto canvas, while it is sill just a shell.
OutParams	List of output parameters, to be used by further shapes/steps. It is not enough to simply populate the variables inside of the translator. Special coding is required to make them visible outside of the translator.
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count	Limit to the number of additional files to be processed. (Only applicable if begin shape has "allow extra files per load" option turned on.)
Condition to Execute	Condition which will define when to execute the step and when not to. The default value is 1 (Yes)
TSR Name	This is a dropdown field. Options are: Reflect incoming file name, Define custom file pattern, or Define custom exact file name.
Result File Pattern	Pattern for the result file.
TSR Name	Options for Task Status Response (TSR) file name. Possible values are Reflect Incoming File Name Define Custom File Pattern Define Custom Exact File Name
TSRNamePattern	Pattern for Task Status Response file.
Single Incoming File Only	Indicator to only process one file even if multiple data files match the provided file mask.
Custom Parameters	List of the parameters to be visible inside the translator. They can be expressions based on TSR values or variables returned by prior steps.
TSR Transform Stream	(advanced) This field allows you to use custom stream, which transforms the content and format of Task Status Response (TSR) message before sending it out.
TSR Name Prefix	String literal which will be added to the beginning of the TSR file.
ACK Name Prefix	String literal which will be added to the beginning of the ACK file.
Custom TSR Location	Folder where TSR messages for current workflow should be delivered
Custom ACK Location	Folder where ACK messages for current workflow should be delivered
Comment	Text displayed above the shape in the workflow diagram
MEMO	Arbitrary custom text. It can be used for any descriptive purposes. It is not displayed anywhere on the diagram.

Task Loader

This activity shape is associated with loading data.
The following table describes the shapes' properties.

Property	Description
Name	Default is task_loader.
Description
Source
Stream
OutParams
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
TSR Name	This is a dropdown field. Options are: Reflect incoming file name, Define custom file pattern, or Define custom exact file name.
TSRNamePattern
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

Task Extractor

This activity shape is associated with extracting data.
The following table describes the shape's properties.

Property	Description
Name	Default is task_extractor.
Description
Source
Stream
OutParams
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
TSR Name	This is a dropdown field. Options are: Reflect incoming file name, Define custom file pattern, or Define custom exact file name.
TSRNamePattern
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

Task Unpacker

This activity shape unzips the incoming archive file into a folder so that the unzipped files can be used. Supported archive formats include ZIP, TARGZIP, TAR, GZIP.

Refer to the Use the Task Unpacker Object page for more information.
The following table describes the shape's properties.

Property	Description
Name	Default is task_unpacker.
Description
OutParams
ArchiveFormat	This is a dropdown field. Options are: ZIP, TARGZIP, TAR, or GZIP. Defaults is ZIP.
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
TSR Transform Stream
TSR Name	This is a dropdown field. Options are: Reflect incoming file name, Define custom file pattern, or Define custom exact file name.
TSRNamePattern
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
File/Execution Count
Condition to Execute
Comment
MEMO

XSLT Translator

This shape represents the data translator that uses XSLT functions approved by w3c.org.

Info

title	Note

Eagle recommends this shape as the best choice for xml2xml transformation.

The following table describes the shape's properties.

Property	Description
Name	Default is xslt_translator.
Description
Source
OutParams
ManualIncludedTags
CustomXSLTPath
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
Comment
MEMO

Adapter

Note

icon	false

This activity shape is under construction, feature not implemented yet.

The following table describes the shape's properties.

Property	Description
Name	Default is adapter.
Description
Source
OutParams
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
TSR Name	This is a dropdown field. Options are: Reflect incoming file name, Define custom file pattern, or Define custom exact file name.
TSRNamePattern
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

Eagle Accounting

This activity shape allows you to call an Eagle Accounting event in the workflow.
The following table describes the shape's properties.

Property	Description
Name	Default is eagle_accounting.
Description	OutParams
STAREventName
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
EventExecTimeout
AlertTimeout
Condition to Execute
Comment
MEMO

Eagle Warehouse

This activity shape allows you to call an Eagle Warehouse Engine event in your workflow.
The following table describes the shape's properties.

Property	Description
Name	Default is eagle_warehouse.
Description
OutParams
PACEEventName
PACEEventType
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
EventExecTimeout
AlertTimeout
Condition to Execute
Comment
MEMO

Subprocess

Use this activity shape when you want to create an embedded workflow in the main workflow. This embedded workflow is executed by a Control Message (CM) that is automatically generated by the shape. Double click the shape to assign a name and configure its structure.
The following table describes the shape's properties.

Property	Description
Name	Default is subprocess.
Description:
Source
OutParams
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

Generic Extract

This activity shape allows you to generate a Generic EagleML extract from the database.
The following table describes the shape's properties.

Property	Description
Name	Default is generic_extract.
Description
OutParams	ExtractFileName
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
TSR Name
TSR Name Pattern
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

This dialog box opens when you right click this shape and select Properties:

Select Parameters screen

Generic Extract and Transform

This activity shape allows you to generate a Generic EagleML extract from the database followed by transformation of the extracted data.
The following table describes the shape's properties.

Property	Description
Name	Default is generic_extract_and_transform.
Description
OutParams	ExtractFileName
Send notifications	This is a dropdown field. Options are: always, never, or on failure.
DataTaskEmailDistribution	This is a checkbox field.
ResponseNotificationEmail	This is a checkbox field.
ASKNotificationEmail	This is a checkbox field.
File/Execution Count
Condition to Execute
TSR Name
TSR Name Pattern
CustomCMParams	This is a dropdown where you can enter custom parameters.
TSR Transform Stream
TSR Name Prefix
ACK Name Prefix
Custom TSR Location
Custom ACK Location
Comment
MEMO

This dialog box opens when you right click this shape and select Properties:

Select Parameters screen

ExecuteCM

This activity shape allows you to execute the Control Message as an EJM Task.
The following table describes the shape's properties.

Property	Description
Name	Default is executecm.
Description
CM StreamName
WaitForCompletion	This is a checkbox field.
CM DeliveryStream
CustomCMParams	This is a dropdown where you can select custom parameters.
IsNewProcess	This is a checkbox field.
CM CorrId
Condition To Exectute
Comment
MEMO

UnDup

This object generates a Message Center stream that removes duplicate records from an incoming file based on a key field. In addition the user can set filter and order by expressions. UnDup task is a separate workflow step that can be used in the same way as a Task Translator:

UnDup workflow

Format Settings

Use double mouse click on object to create a task. Entered name will be used for Solution Explorer tree item and generated Message Center stream:

Add Task Undup
Task Format popup will be opened once task was created. Set sample data and format settings:

Task Format dialog
Header lines (except the column header) and footer lines are excluded from output message by default. Use 'Include header lines in output' and 'Include footer lines in output' options to add them.

Info

icon	false

All required columns must be specified in the sample.

Grouping Settings

UnDup settings form will be generated for task:

UnDup Settings form
Use Source object to update task format and Key, Filter, and Order By objects to set grouping and filtering settings:

Key Expression

The following table describes the shape's properties:

Property	Description
Name	Default is undup.
Description	Your custom description.
Source
Condition to Execute
Comment
MEMO

Expand

title	See an UnDup object use case (click to expand):

Let's create and publish a sample bundle-based workflow:

Create and Publish workflow diagram

The sample file for it looks like this:

Panel
001\|d\|002\|003\|001\|a\|002\|003\|001\|b\|002\|003\|001\|b\|002\|003\|001\|c\|002\|003\|001\|d\|002\|003\|001\|d\|002\|003\|001\|e\|002\|004\|

The second column is considered to contain the key expression.
Sample file with corresponding file mask is sent to the eagle_ml-2-0_default_cm_ndfa stream.

Workflow has been successfully executed:

Workflow Successfully executed
UnDup task result was successfully sent to the next step. Outgoing file doesn't contain duplicate values of the key column:

Message Details

Versions Compared

Old Version 41

New Version 42

Key

Task Translator

Task Loader

Task Extractor

Task Unpacker

XSLT Translator

Adapter

Eagle Accounting

Eagle Warehouse

Subprocess

Generic Extract

Generic Extract and Transform

ExecuteCM

UnDup

Format Settings

Grouping Settings