Output

Output



Output

Delete

Description

Delete is a step in the Output Plugin for Process Studio Workflows. Delete, plugin step is for deleting rows.


Configurations

No.

Field Name

Description


Step Name

Name of the step.  This name has to be unique in a single workflow.

1

Connection

Name of the database connection on which the target table resides. 

2

Target Schema

The name of the Schema for the table to write data to. 

3

Target Table

Name of the target table.

4

Commit Size

The number of rows after which to commit.





The keys to lookup the values:


1

Table field

Field in the table to lookup

2

Comparator

Select from the list of comparators

3

Stream field1

Table field is compared with Stream field1 using comparator

4

Stream field2

Table field is compared with Stream field2 using comparator



Insert / Update

Description

Insert/Update is a step in the Output Plugin for Process Studio Workflows. Insert/Update plugin step can be used for inserting/updating rows in a table. The insert or update operation is based on the result of looking up one or more lookup keys in the target table.  

Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Connection

Name of the database connection on which the target table resides. 

3

Target Schema

The name of the Schema for the table to write data to. 

4

Target Table

Name of the target table.

5

Commit Size

The number of rows after which to commit.

6

Don’t perform any updates 

Select this checkbox to perform only insert.





The keys to lookup the values:


1

Table field

Field in the table to lookup

2

Comparator

Select from the list of comparators

3

Stream field1

Table field is compared with Stream field1 using comparator

4

Stream field2

Table field is compared with Stream field2 using comparator


Update Fields:


1

Table field

The field to be updated in the table

2

Stream field

The field in the stream used to update the table field.

3

Update

Select Y/N to confirm update




JSON Output

Description

JSON Output is a step in the Output Plugin for Process Studio Workflows. Json output step generates json blocks based on input step values and outputs it in a field or file. Output json is vailable as java script array or java script object depending on step settings.

Configurations

General Tab: 

No.

Field Name

Description

1

Operation

Specify type of step operation, output json structure, step output file. This file will be used to dump all generated json.


Settings:


1

Step name

Step name should be unique in context of workflow 

2

Operation

Specify step operation type. Currently available 3 types of operation: 
Output value - only pass output json as a step output field, do not dump to output file

Write to file - only write to fie, do not pass to output field

Output value and write to file - dump to file and pass generated json as a step output file 

3

Json block name 

This value will be used as a name for json block. Can be empty string that will affect output json structure, see detailed description below.

4

Nr. rows in a block

Specify the number of rows in a block. In others words it is the number key - value pairs in a json block. 0 means all the rows in the same unique block. 
NOTE, 1 is a special value, in case of 1 every output will be generated as one object. See description below. 

5

Output value 

This value will be used as a step output field. Will contain generated json output block depending on step settings. 

6

Compatibility mode

This check box handles compatibility configuration with previous Process Studio versions.


Output File:


1

Filename

full path to output file 

2

Append 

If not checked new file will be created every time step is running. If file with specified name already existed - it will be replaced by a new one. If checked - new json output will be appended at the end of existing file. Or if existing file is not exists - it will be created as in previous case. 

3

Create Parent folder 

Usually file name contains some path folder as a parent folder. If parent folder does not exist and this option is checked - parent folder will be created as a new folder. Otherwise - file not be found and step will fail. 

4

Do not open create at start 

If not checked - file (and in some cases parent folder) will be created/opened to write during workflow initialization. If checked - file and parent folder will be created only after step will get any first input data. 

5

Extension 

Output files extension. Default value is 'js' 

6

Encoding 

Output file encoding 

7

Pass output to servlet

Enable this option to return the data via a web service instead writing into a file

8

Include date in filename? 

If checked - output file name will contain File name value + current date. This may help to generate unique output files. 

9

Include time in filename

If checked - output file name will contains file creation time. Same as for 'Include date in filename' option 

10

Show filename(s) button 

Can be useful to test full output file path 

11

Add file to result filenames? 

If checked - created output file path will be accessible form step result 


Fields Tab

No.

Field Name

Description

1

Fieldname

Input step field name. Use 'Get Fields' button to discover available input fields 

2

Element name

Json element name as a key. For example "A":"B" - A is an element name, B is actual input value mapped for this Element name.




Microsoft Excel Output

Description

Microsoft Excel Output is a step in the Output Plugin for Process Studio Workflows. Microsoft Excel Output step can write data to sheets in one or more Excel files. This step can write to a Microsoft Excel 2003 spreadsheet file (xls). If you want to write to an xlsx file (Excel 2007 and above), you may use the Microsoft Excel Writer step. The Split option allows you to write to multiple files. The following sections describe the features available for configuring the Excel output step.  


Configurations

File Tab: 

No.

Field Name

Description

1

Step name

The name of this step in the workflow workspace.

2

Filename

The name of the spreadsheet file you are reading from.

3

Create Parent folder

If checked, the parent folder will be created 

4

Do not create file at start

If checked, does not create the file until the end of the step. This avoids creating empty files when no rows are in the data stream. 

5

Extension

The three-letter file extension to append to the file name.

6

Include stepnr in filename

If you run the step in multiple copies (launching several copies of a step), the copy number is included in the file name, before the extension. (_0).

7

Include date in file name

Includes the system date in the filename (_20101231).

8

Include time in file name

Includes the system time (24-hour format) in the filename (_235959).

9

Specify Date time format

If checked, the filename will include a date and time stamp that follows the selection you choose from the drop-down box. Selecting this option disables the previous two options.

10

Date time format

Provide a specific date time format for the filename. 

11

Show file name(s)

Displays a list of the files that will be generated. This is a simulation and depends on the number of rows that will go into each file.

12

Add filenames to result

Adds the filenames to the internal filename result set. This internal result set can be used later on, e.g. to process all created files.


Content Tab

No.

Field Name

Description

1

Append

When checked, appends lines to the end of the specified file. If the file does not exist, a new one will be created.

2

Header

Enable this option if you want a header to appear before the spreadsheet grid data.

3

Footer

Enable this option if you want a footer to appear after the spreadsheet grid data.

4

Encoding

Specifies the text file encoding to use. Leave blank to use the default encoding on your system. To use Unicode, specify UTF-8 or UTF-16. On first use, Process Studio searches your system for available encodings and populates this list accordingly.

5

Split every ... rows

After this many rows, start a new spreadsheet file to continue data output.

6

Sheet name

Specifies the name of the worksheet within the spreadsheet file.

7

Protect sheet?

If checked, enables password protection on the worksheet. You must also specify a password in the Password field.

8

Auto size columns

If checked, automatically sizes the worksheet columns to the largest value.

9

Retain NULL values

If checked, NULL values are preserved in the output. If un-checked, NULLs are replaced with empty strings.

10

Use temporary file 

Sets whether a temporary file is used during the generation of the workbook. If not set, the workbook will take place entirely in memory. Setting this flag involves an assessment of the trade-offs between memory usage and performance.

11

Temporary files directory 

Define the temporary files directory. 

12

Use Template

If checked, PROCESS STUDIO will use the specified Excel template to create the output file. The template must be specified in the Excel template field.

13

Excel Template

Define the Excel template to use. 

14

Append to Excel Template

Appends output to the specified Excel template.


Custom Tab

No.

Field Name

Description

1

Header Font

Defines the Header Font details

2

Row Font

Defines the Row Font details


Fields Tab

No.

Field Name

Description

1

Name

The name of the field.

2

Type

The field's data type; String, Date or Number.

3

Format

The format mask (number type).



Microsoft Excel Writer

Description

Microsoft Excel Writer is a step in the Output Plugin for Process Studio Workflows. Microsoft Excel Writer step writes into an MS Excel file and supports both the xls and xlsx file formats. 


Configurations

File & Sheet Tab: 

No.

Field Name

Description


File:


1

Filename

The name of the spreadsheet file you are reading from.

2

Extension

Extension is the three-letter file extension to append to the file name. Choose xls or xlsx from the dropdown list. 


Note: The proprietary (binary) xls format is not as well understood and deciphered, so moving/replicating nontrivial xls content in non-MS software environments is usually problematic.

3

Stream XLSX data

Check this option when writing large XLSX files. It uses internally a streaming API and is able to write large files without any memory restrictions (of course not exceeding Excel's limit of 1,048,575 rows and 16,384 columns). Note: This option is available since version 4.4.0.

4

If output file exists 

Check this option when writing large XLSX files. It uses internally a streaming API and is able to write large files without any memory restrictions (of course not exceeding Excel's limit of 1,048,575 rows and 16,384 columns). Note: This option is available since version 4.4.0. 

5

Wait for first row before creating file 

Checking this option makes the step create the file only after it has seen a row. If this is disabled the output file is always created, regardless of whether rows are actually written to the file. 

6

Add filename(s) to result 

Check to have the filename added to the result filenames 


Sheet:


1

Sheet Name 

The sheet name the step will write rows to. 

2

Make this the active sheet 

If checked the Excel file will by default open on the above sheet when opened in MS Excel. 

3

If sheet exists in output file

The output file already has this sheet (for example when using a template, or writing to existing files), you can choose to write to the existing sheet, or replace it. 

4

Protect Sheet 

The XLS file format allows toprotect an entire sheet from changes. If checked you need to provide a password. Excel will indicate that the sheet was protected by the user you provide here.


Template:

When creating new files (when existing files are replaced, or completely fresh files are created) you may choose to create a copy of an existing template file instead. Please make sure that the template file is of the same type as the output file (bot must be xls or xlsx respectively). Although the xlsx format is usually a good choice when working with template files, as it is more likely to preserve charts and other misc objects in the output.


When creating new sheets, the step may copy a sheet from the current document (the template or an otherwise existing file the step is writing to). A new sheet is created if the target sheet is not present, or the existing one shall be replaced as per configuration above.


Content Tab

No.

Field Name

Description


Content:



Start writing at cell 

This is the cell to start writing to in Excel notation (letter column, number row) 


When writing rows 

The step may overwrite existing cells (fast), or shift existing cells down (append new rows at the top of sheet) 


Write Header 

If checked the first line written will contain the field names 


Write Footer 

If checked the last line written will contains the field names 


Auto Size Columns 

If checked the step tries to automatically size the columns to fit their content. Since this is not a feature the xls(x) file formats support directly, results may vary


Force formula recalculation  

If checked, the step tries to make sure all formula fields in the output file are updated. 
The xls file format supports a "dirty" flag that the step sets. The formulas are recalculated as soon as the file is opened in MS Excel.

For the xlsx file format, the step must try to recalculate the formula fields itself. Since the underlying POI library does not support the full set of Excel formulas yet, this may give errors. The step will throw errors if it cannot recalculate the formulas.


Leave styles of existing cells unchanged 

If checked, the step will not try to set the style of existing cells it is writing to. This is useful when writing to pre-styled template sheets. 


Sheet:



Start writing at end of sheet

The step will try to find the last line of the sheet, and start writing from there. 


Offset by ... rows 

Any non-0 number will cause the step to move this amount of rows down (positive numbers) or up (negative numbers) before writing rows. Negative numbers may be useful if you need to append to a sheet, but still preserve a pre-styled footer. 


Begin by writing ... empty lines 

The step will try to find the last line of the sheet, and start writing from there. 


Omit Header

Any non-0 number will cause the step to move this amount of rows down (positive numbers) or up (negative numbers) before writing rows. Negative numbers may be useful if you need to append to a sheet, but still preserve a pre-styled footer. 


Fields:



Name

The field to write 


Type

The type of data 


Format

The Excel format to use in the sheet. Please consult the Excel manual for valid formats. 


Style from cell 

A cell (i.e. A1, B3 etc.) to copy the styling from for this column (usually some pre-styled cell in a template) 


Field Title 

If set, this is used for the Header/Footer instead of the Process Studio field name 


Header/Footer style from cell 

A cell to copy the styling from for headers/footers (usually some pre-styled cell in a template) 


Field Contains Formula 

Set to Yes, if the field contains an Excel formula (no leading '=') 


Hyperlink 

A field, that contains the target to link to. The supported targets are Link to other cells, http, ftp, email, and local documents 


Cell Comment / Cell Author 

The xlsx format allows putting comments on cells. If you'd like to generate comments, you may specify fields holding the comment and author for a given column. 



Properties Output

Description

Properties Output is a step in the Output Plugin for Process Studio Workflows. Properties Output step outputs a set of rows of data to a Java properties files.  The data needs to be structured in a key/value format to be usable for a properties file. 


Configurations

General Tab: set the input fields that will contain the key van location of the files from which you want to read.

No.

Field Name

Description


Step Name

Name of the step.  This name has to be unique in a single workflow.


Fields 

Key field : The input field name that will contain the key part to be written to the properties file

Value field : The input field name that will contain the value part to be written to the properties file


Comment

A short comment that is going to be copied into the properties file (at the top). 

Note: Only the first line is commented out.  The next ones need to be commented by the user. 


Content Tab

No.

Field Name

Description


File

  1. Filename: the filename without the file extension
  2. Append: check this option to update an existing property file.  Properties in the file that are not processed by the step will remain unchanged.
  3. Create parent folder: check this option if you want to automatically create the parent folder
  4. Accept file name from field:  check this option if the file name is specified in an input stream field.
  5. File name field:  specifies the field that contains the name of the file to write to.
  6. Extension: specify the file extension.  Usually this is "properties".
  7. Include stepnr in filename: includes the step number (when running in multiple copies) in the output filename
  8. Include date in filename: includes the date in the output filename with format yyyyMMdd (20081231)
  9. Include time in filename: includes the date in the output filename with format HHmmss (235959)
  10. Show filenames: hit this button to see the complete filename after assembly of the various parts (filename, extension, stepnr, date and time)


Result filename

Add files to result filename: Adds the generated filenames read to the result of this workflow.  A unique list is being kept in memory that can be used in the next process entry in a process, for example in another workflow.


Salesforce Delete

Description

SalesForce Delete is a step in the Output Plugin for Process Studio Workflows. The SalesForce Delete step deletes data directly from SalesForce using the SalesForce Web Service. 

Configurations

General Tab:

No.

Field Name

Description


Connection:


1

SalesForce 

Webservice URL 

This is the URL to the SalesForce Webservice. 
Note: This URL is dependent on the API version you are using. 

2

Username 

Username for authenticating to Salesforce (i.e. myname@ automationedge.com) 

3

Password

Password for authenticating to Salesforce.  Enter your password followed by your security token.  If you password is 'PASSWORD' and your secuirty token is 'TOKEN', enter 'PASSWORDTOKEN' in this field. 


Settings:


1

Time out

Configure the timeout interval in milliseconds before the step times out. 

2

Use compression

Enable checkbox to use compression.

3

Rollback all changes on 

Enable this checkbox to ensure complete success or to rollback all changes.

4

Batch size

This is the number of rows to commit as a batch.

5

Module

Select the module you wish to delete data from.  

Note: This list will be populated upon successfully authenticating to Salesforce using the Test Connection button. 

6

Fieldname id

This is the ID of the fieldname to delete.





Salesforce Insert

Description

SalesForce Insert is a step in the Output Plugin for Process Studio Workflows. The SalesForce Insert step inserts data directly into SalesForce using the SalesForce Web Service. 

Configurations

General Tab:

No.

Field Name

Description


Connection:


1

SalesForce 

Webservice URL 

This is the URL to the SalesForce Webservice. 
Note: This URL is dependent on the API version you are using. 

2

Username 

Username for authenticating to Salesforce (i.e. myname@ automationedge.com) 

3

Password

Password for authenticating to Salesforce.  Enter your password followed by your security token.  If you password is 'PASSWORD' and your secuirty token is 'TOKEN', enter 'PASSWORDTOKEN' in this field. 


Settings:


1

Time out

Configure the timeout interval in milliseconds before the step times out. 

2

Use compression

Enable checkbox to use compression.

3

Rollback all changes on 

Enable this checkbox to ensure complete success or to rollback all changes.

4

Batch size

This is the number of rows to commit as a batch.

5

Module

Select the module you wish to delete data from.  

Note: This list will be populated upon successfully authenticating to Salesforce using the Test Connection button. 


Output Fields:


1

Salesforce id fieldname 

This is the ID of the fieldname inserted.


Fields:


1

Dynamic Fields as JSON format

Enable checkbox to accept field names as JSON input. In the JSON text you can have dynamic fields to insert rather than static fields as provided in the table provided 

2

JSON

About JSON text:

If ‘Accept Fields as JSON’ checkbox is enabled this field is activated. Choose a field containing the JSON text. JSON text should contain key-value pairs enclosed by double quotes (“) enclosure. Provide all the required or mandatory fields as well as other fields to be inserted as keys in the JSON. 

Note: The JSON could be from any input step such as Generate rows, Text File input, Excel Input Et al. JSON text can only be accepted from input fields from previous steps and not as files directly. JSON text can also be specified by a parameter already defined.


Sample JSON key value pairs:


[

 {

   "displayName": "Service",

   "value": "HR Service Desk"

 },

 {

   "displayName": "Title",

   "value": "Test_KA10"

 }

]


Table:

Tabular selection of fields to be inserted

1

Module field

Module field in Salesforce

2

Stream field

Field from stream

3

Use External id?

(Y/N)




Salesforce Update

Description

SalesForce Update is a step in the Output Plugin for Process Studio Workflows. The SalesForce Update step updates data directly into SalesForce using the SalesForce Web Service. 

Configurations

General Tab:

No.

Field Name

Description


Connection:


1

SalesForce 

Webservice URL 

This is the URL to the SalesForce Webservice. 
Note: This URL is dependent on the API version you are using. 

2

Username 

Username for authenticating to Salesforce (i.e. myname@ automationedge.com) 

3

Password

Password for authenticating to Salesforce.  Enter your password followed by your security token.  If you password is 'PASSWORD' and your secuirty token is 'TOKEN', enter 'PASSWORDTOKEN' in this field. 


Settings:


1

Time out

Configure the timeout interval in milliseconds before the step times out. 

2

Use compression

Enable checkbox to use compression.

3

Rollback all changes on 

Enable this checkbox to ensure complete success or to rollback all changes.

4

Batch size

This is the number of rows to commit as a batch.

5

Module

Select the module for which you wish to update data.  

Note: This list will be populated upon successfully authenticating to Salesforce using the Test Connection button. 


Output Fields:


1

Salesforce id fieldname 

This is the ID of the fieldname to update.


Fields:


1

Dynamic Fields as JSON format

Enable checkbox to accept field names as JSON input. In the JSON text you can have dynamic fields to update rather than static fields as provided in the table provided 

2

JSON

About JSON text:

If ‘Accept Fields as JSON’ checkbox is enabled this field is activated. Choose a field containing the JSON text. JSON text should contain key-value pairs enclosed by double quotes (“) enclosure. Provide all the required or mandatory fields as well as other fields to be updated as keys in the JSON. 

Note: The JSON could be from any input step such as Generate rows, Text File input, Excel Input Et al. JSON text can only be accepted from input fields from previous steps and not as files directly. JSON text can also be specified by a parameter already defined.


Sample JSON key value pairs:


[

 {

   "displayName": "Service",

   "value": "HR Service Desk"

 },

 {

   "displayName": "Title",

   "value": "Test_KA10"

 }

]


Table:

Tabular selection of fields to be updated.

1

Module field

Select a Module.

2

Stream field

Select a field from stream

3

Use External id?

(Y/N)



Salesforce Upsert

Description

SalesForce Upsert is a step in the Output Plugin for Process Studio Workflows. The SalesForce Upsert step inserts/updates data directly into SalesForce using the SalesForce Web Service. 


Configurations

General Tab:

No.

Field Name

Description


Connection:


1

SalesForce 

Webservice URL 

This is the URL to the SalesForce Webservice. 
Note: This URL is dependent on the API version you are using. 

2

Username 

Username for authenticating to Salesforce (i.e. myname@ automationedge.com) 

3

Password

Password for authenticating to Salesforce.  Enter your password followed by your security token.  If you password is 'PASSWORD' and your secuirty token is 'TOKEN', enter 'PASSWORDTOKEN' in this field. 


Settings:


1

Time out

Configure the timeout interval in milliseconds before the step times out. 

2

Use compression

Enable checkbox to use compression.

3

Rollback all changes on 

Enable this checkbox to ensure complete success or to rollback all changes.

4

Batch size

This is the number of rows to commit as a batch.

5

Module

Select the module you wish to delete data from.  

Note: This list will be populated upon successfully authenticating to Salesforce using the Test Connection button. 

6

Upsert Comparison field

The field used to compare the module field and stream field.


Output Fields:


1

Salesforce id fieldname 

This is the ID of the fieldname inserted.


Fields:


1

Dynamic Fields as JSON format

Enable checkbox to accept field names as JSON input. In the JSON text you can have dynamic fields to upsert rather than static fields as provided in the table provided 

2

JSON

About JSON text:

If ‘Accept Fields as JSON’ checkbox is enabled this field is activated. Choose a field containing the JSON text. JSON text should contain key-value pairs enclosed by double quotes (“) enclosure. Provide all the required or mandatory fields as well as other fields to be upserted as keys in the JSON. 

Note: The JSON could be from any input step such as Generate rows, Text File input, Excel Input Et al. JSON text can only be accepted from input fields from previous steps and not as files directly. JSON text can also be specified by a parameter already defined.


Sample JSON key value pairs:


[

 {

   "displayName": "Service",

   "value": "HR Service Desk"

 },

 {

   "displayName": "Title",

   "value": "Test_KA10"

 }

]


Table:

Tabular selection of fields to be inserted

1

Module field

Module field in Salesforce

2

Stream field

Field from stream

3

Use External id?

(Y/N)


Synchronize after merge

Description

Synchronize after merge is a step in the Output Plugin for Process Studio Workflows

This step can be used in conjunction with the Merge Rows (diff) workflow step.  The Merge Rows (diff) workflow step appends a Flag column to each row, with a value of "identical", "changed", "new" or "deleted". This flag column is then used by the Synchronize after merge workflow step to carry out updates/inserts/deletes on a connection table.

Note that the input data streams must be sorted before being passed into the Merge Rows (diff) workflow step. Make sure the sort column(s) are of same or equal data type. Both input tables must have the same number of columns. 

Configurations

General Tab: 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Connection

The database connection to which data is written

3

Target schema

The name of the Schema for the table to which data is written. This is important for data sources that allow for table names with periods in them.

4

Target table

Name of the table in which you want to do the insert/update/delete.

5

Commit size

The number of rows to change before running a commit.

6

Use batch update


7

Tablename is defined in a field


8

Key Lookup table

Allows you to specify a list of field values and comparators. You can use the following comparators: =, <>, <, <=, >, >=, LIKE, BETWEEN, IS NULL, IS NOT NULL 

Note: Click Get fields to retrieve a list of fields from the input stream(s).

9

Update Fields

Allows you to specify all fields in the table you want to insert/update including the keys. Avoid updates on certain fields (e.g. primary keys or non-null constrained fields) by specifying N in the update column. 

Note: Click Get Update fields to retrieve a list of update fields from the input stream(s).

10

SQL button

Click SQL to generate the SQL to create the table and indexes for correct operation.




Advanced Tab: 

No.

Field Name

Description


Operation fieldname

This is a required field. This field is used by the step to obtain an operation flag for the current row. Default from the Merge Rows (diff) step: "flagfield"


Insert when value equal

Specify the value of the Operation fieldname which signifies that an Insert should be carried out. Default from the Merge Rows (diff) step: "new"


Update when value equal

Specify the value of the Operation fieldname which signifies that an Update should be carried out. Default from the Merge Rows (diff) step: 

"changed"


Delete when value equal

Specify the value of the Operation fieldname which signifies that a Delete should be carried out. Default from the Merge Rows (diff) step"deleted"


Perform lookup

Performs a lookup when deleting or updating. If the lookup field is not found, then an exception is thrown. This option can be used as an extra check if you wish to check updates/deletes prior to their execution. Default from the Merge Rows (diff) stepNot applicable



Text file Output

Description

Text file output is a step in the Output Plugin for Process Studio Workflows. The Text file output step outputs data in text file format. This step is commonly used to generate fixed width files by setting lengths on the fields in the fields tab or to write Comma Separated Values (CSV files) that can be read by spreadsheet applications or 

Configurations

No.

Field Name

Description

1

Step name

Name of the step. Note: This name has to be unique in a single workflow.


File Tab

No.

Field Name

Description

1

Filename

This field specifies the filename and location of the output text file. 
Note: Don't add the extension in this field, when the date and time should optionally be appended and afterwards the extension option (see Extension option field below). When the Extension option is left blank, add it to this field. 

2

Run this as a command instead?

Enable to "pipe" the results into the command or script you specify. It can also be used for some database bulk loaders that can process the input from stdin. In this case set the filename to the script or binary to execute. 

3

Pass output to servlet

Enable this option to return the data via a web service instead writing into a file 

4

Create parent folder 

Enable to create the parent folder 

5

Do not create file at start 

Enable to avoid empty files when no rows are getting processed. 

6

Accept file name from field? 

Enable to specify the file name(s) in a field in the input stream

7

File name field 

When the previous option is enabled, you can specify the field that will contain the filename(s) at runtime. 

8

Extension

Adds a point and the extension to the end of the filename. (.txt)

9

Include stepnr in filename

If you run the step in multiple copies (Launching several copies of a step), the copy number is included in the filename, before the extension. (_0).

10

Include partition nr in filename?

Includes the data partition number in the filename.

11

Include date in filename

Includes the system date in the filename. (Default _20041231).

12

Include time in filename

Includes the system time in the filename. (Default _235959).

13

Specify Date time format 

Enable to specify the date time format 

14

Date time format

Chose the date time format to append to the filename 

15

Add file name to rest

This adds all processed filenames to the internal result filename set to allow for further processing. 

16

Show filename(s)

This option shows a list of the files that will be generated. 
Note: This is a simulation and among others depends on the number of rows that will go into each file. 


Content Tab: The content tab contains the following options for describing the content being read:

No.

Field Name

Description

1

Append

Check this to append lines to the end of the specified file.

2

Separator

Specify the character that separates the fields in a single line of text. Typically this is ; or a tab.

3

Enclosure

A pair of strings can enclose some fields. This allows separator or enclosure characters in fields. The enclosure string is optional.

4

Force the enclosure around fields?

This option forces all fields of an incoming string type (independent of the eventually changed field type within the Text File Output field definition) to be enclosed with the character specified in the Enclosure property above. 

5

Disable the enclosure fix?

This is for backward compatibility reasons related to enclosures and separators. The logic is: When a string field contains an enclosure it gets enclosed and the enclose itself gets escaped. When a string field contains a separator, it gets enclosed. Check this option, if this logic is not wanted. It has also an extra performance burden since the strings are scanned for enclosures and separators. So when you are sure there is no such logic needed since your strings don't have these characters in there and you want to improve performance, un-check this option. 

6

Header

Enable this option if you want the text file to have a header row. (First line in the file).

7

Footer

Enable this option if you want the text file to have a footer row. (Last line in the file). Note: Be careful to enable this option when in Append mode since it is not possible to strip footers from the file contents before appending new rows. There are use cases where this option is wanted, e.g. to have a footer after each run of a workflow to separate sections within the file. 

8

Format

This can be either DOS or UNIX. UNIX files have lines are separated by linefeeds. DOS files have lines separated by carriage returns and line feeds. 
The options are: CR+LF terminated (Windows, DOS) / LF terminated (Unix) / CR terminated / No new-line terminator

9

Encoding

Specify the text file encoding to use. Leave blank to use the default encoding on your system. To use Unicode specify UTF-8 or UTF-16. On first use, Process Studio will search your system for available encodings.

10

Compression

Allows you to specify the type of compression, .zip or .gzip to use when compressing the output. Note: Only one file is placed in a single archive.

11

Right pad fields

Add spaces to the end of the fields (or remove characters at the end) until they have the specified length.

12

Fast data dump (no formatting)

Improves the performance when dumping large amounts of data to a text file by not including any formatting information.

13

Split every ... rows

If this number N is larger than zero, split the resulting text-file into multiple parts of N rows.

14

Add Ending line of file

Allows you to specify an alternate ending row to the output file.


Fields Tab: 

The fields tab is where you define properties for the fields being exported. The table below describes each of the options for configuring the field properties: 

No.

Field Name

Description

1

Name

The name of the field.

2

Type

Type of the field can be either String, Date or Number.

3

Format

The format mask to convert with. See Number Formats for a complete description of format symbols.

4

Length

The length option depends on the field type follows:

Number - Total number of significant figures in a number

String - total length of string

Date - length of printed output of the string (e.g. 4 only gives back year)

5

Precision

The precision option depends on the field type as follows:

Number - Number of floating point digits

String - unused

Date - unused

6

Currency

Symbol used to represent currencies like $10,000.00 or E5.000,00

7

Decimal

A decimal point can be a "." (10,000.00) or "," (5.000,00)

8

Group

A grouping can be a "," (10,000.00) or "." (5.000,00)

9

Trim type

The trimming method to apply on the string. Note: Trimming only works when there is no field length given.

10

Null

If the value of the field is null, insert this string into the textfile

11

Get

Click to retrieve the list of fields from the input fields stream(s)

12

Minimal width

Alter the options in the fields tab in such a way that the resulting width of lines in the text file is minimal. So instead of save 0000001, we write 1, etc. String fields will no longer be padded to their specified length.


Update

Description

Update is a step in the Output Plugin for Process Studio Workflows. This step is used for updating field in tables.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Connection

Name of the database connection on which the target table resides. 

3

Target Schema

The name of the Schema for the table to write data to. 

4

Target Table

Name of the target table.

5

Commit Size

The number of rows after which to commit.

6

Use batch updates 

Select this checkbox to decide if updates are in batch mode.

7

Skip Lookup

Select this checkbox to skip lookup.

8

Ignore lookup failure

Select this checkbox to ignore lookup failure.





The keys to lookup the values:


1

Table field

Field in the table to lookup

2

Comparator

Select from the list of comparators

3

Stream field1

Table field is compared with Stream field1 using comparator

4

Stream field2

Table field is compared with Stream field2 using comparator





Update Fields:


1

Table field

The field to be updated in the table

2

Stream field

The field in the stream used to update the table field.

3

Update

Select Y/N to confirm update




XML Output

Description

XML Output is a step in the Output Plugin for Process Studio Workflows. The XML Output step writes data rows from the source to one or more XML files. 


Configurations

File Tab: 

The file tab is where you set general properties for the XML output file format:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Filename

Specifies the file name and location of the output text file 
Note: Don't add the extension in this field, when the date and time should optionally be appended and afterwards the extension option (see Extension option field below). When the Extension option is left blank, add it to this field.

3

Do not create file at start 

Enable to avoid empty files when no rows are getting processed. 

4

Pass output to servlet 

Enable this option to return the data via a web service instead writing into a file 

5

Extension

Adds a period and the extension to the end of the file name (.xml)

6

Include stepnr in filename

If you run the step in multiple copies (see also Launching Several Copies of a step), the copy number is included in the file name, before the extension (_0)

7

Include date in filename

Includes the system date in the file name (_20041231)

8

Include time in filename

Includes the system date in the file name (_235959)


Content Tab: 

No.

Field Name

Description

1

Zipped

Check this if you want the XML file to be stored in a ZIP archive.

2

Encoding

The encoding to use. This encoding is specified in the header of the XML file.

3

Parent XML element

The name of the root element in the XML document.

4

Row XML element

The name of the row element to use in the XML document.

5

Split every ... rows.

The maximum number of rows of data to put in a single XML file before another is created



Fields Tab: 

No.

Field Name

Description

1

Fieldname

The name of the field.

2

Elementname

Specify the name of the element in the XML file to use. 

Type: Type of the field can be either String, Date, or Number.

3

Type

Type of the field can be either String, Date, or Number. Format mask from which to convert; see Number formats for a complete description of format specifiers.

4

Length

The length option depends on the field type follows:

  1. Number - Total number of significant figures in a number
  2. String - total length of string
  3. Date - length of printed output of the string (e.g. 4 only gives back year)

Note: the output string is padded to this length if it is specified.

5

Precision

The precision option depends on the field type as follows:

  1. Number - Number of floating point digits
  2. String - unused
  3. Date - unused

6

Currency

Symbol used to represent currencies such as $10,000.00 or E5.000,00

7

Decimal

A decimal point can be a "." (10,000.00) or "," (5.000,00)

8

Group

A grouping can be a "," (10,000.00) or "." (5.000,00)

9

Null

If the value of the field is null, insert this string into the textfile

10

Get fields

Click to retrieve the list of fields from the input stream(s).

11

Minimal width

Alter the options in the fields tab in such a way that the resulting width of lines in the text file is minimal; for example instead of save 0000001, "1" is written, and so on. String fields are not padded to their specified length.








      Links to better reach 

            Bot Store

             EPD