Skip to content

Main Navigation Guide Scripting Reference Tag Reference Developer Guide Operation Guide

Appearance

Sidebar Navigation

Flow Documentation

Welcome

Getting Started

End User License Agreement

Document History

Directories

Program Folder

Application Data Folder

SQL Server Data Folder

Components of Flow

Flow

FlowMonitorService

FlowMonitor

FlowService

FlowAPI

FlowWeb

FlowTransportWeb

Supporting Components

Third Party Components

Installing Flow

Planning the installation

Installation

What is installed?

Installing Microsoft SQL Management Console

Manual Installation

Required Tools

Services Control Panel

IIS Manager

FlowMonitorService

FlowMonitor

FlowService

FlowWeb

FlowTransportWeb

Users and passwords

Starting Flow

Software License

Configuration Databases

Creating a new configuration database

System Connections

Using Windows Authentication

Using SQL Server Authentication

Upgrading a configuration database

Backing up a configuration database

Restoring a configuration database

Shrinking a configuration database

Flow Designer

Modules, Templates, Packages, and Connectors

Administering Flow

Configuring Flow

Action Name

Action Steps List

Action Steps Tab

Active

Custom Script Action

Source Data

Source Type

Active

DB Disconnect Action

Source Data

Source Type

Active

File Router Action

Routing Events

Source Data

Active

Destination Data

Ignore empty source data and continue processing

Map Action

Map

Save to

Source Data

Active

Parameters

Plugin Action

Plugin

Use default property values

Active

Email Address

File Name

Ignore empty source data and continue processing

Output Destination

Output Type

Printer Name

Report Action

Report

Source Data

Subject

Active

SQL Action

SQL Command

Source Data

Source Type

Active

Command Line

Delay

Domain

Password

Shell Execute Action

Use Windows Shell Execute

User Name

Wait for command to finish

Action

Active

Sub Action

Active

Source Data

Transaction Commit Action

Active

Source Data

Transport Action

Active

File Path Pattern

Max Wait

Wait for File Action

Wait for File Flush

Action

Allow DB Connection to change

Allow user to populate parameters

DB Connections

Data List

Data Tab

Definition

Dynamic Search Parameters

File Connection

Preview data before saving

Use a seperate SQL Transaction

Web Connection

Allow action to be paused if error occurs

Allow this action to process in multiple concurrent threads

Cache Action

Daily Settings

Enable re-occurring schedule

Execute after this action

Execute next Action Step even if previous one is cancelled

Execution Tab

File Connection To Monitor

Finish Time

Monthly Settings

Process any existing files when action starts

Re-run the action until an error_cancelled status

Repeat Every

Run Action Via

Run Type

Run once immediately on start up of FlowService

Start Time

The main purpose of this action is to

Transports to Monitor

Use X concurrent threads

Web Service Name

Weekly Settings

Log File Events

Log Info items

Log SQL statements

Notification Email

Notification Tab

Save Log on the following execution statuses

Send notification on the following execution statuses

Use default notification email address

Process the next partner even if an error occurs

Run the action once per linked trading partner

Trading Partner List

Trading Partners Tab

Actions

Common Pitfalls

Examples

Common Dialogs

Files List

Files Tab

Log Viewer

Duration

Finished

Message List

Overview Tab

Started

SQL Statement List

SQL Tab

Transport List

Transports Tab

Code

Description

Parameter Editor

Type

Value

Authorization Type

Domain

Host

Password

Port

Proxy Settings

Use a proxy for this Internet connection

Use default proxy settings from General Setup

Username

Element List

Name

SOAP Element Editor

Value

Authentication Type

Destination Host

Destination Port

Method

Password

Private Key

SSH Port

SSH Server

SSH Settings

Source Port

Use Gateway Ports

Use Port Forwarding

Username

Certificate Depth

Certificate File

Fail if no peer certificate

Key File

Key Password

Method

Root Certificate

SSL Settings

Verify Once

Verify Peer

Edit Pane

Fields List

Results Pane

Script Editor

Source Data

Allow Execute

Allow Full

Allow Read

Allow Write

Deny Execute

Deny Full

Deny Read

Deny Write

Security Editor

User List

Common Pitfalls

Fixed-length field breaks linking

Advanced Tab

Keep Connection Active

Max Connections

Max Transactions per update of ID fields

Min Connections

Other Parameters

Connection Name

DB Connection

Connection Type

Database Name

General Tab

Password

Server Name

User Name

DB Connections

ADO connection

DB2 connection

Examples

Informix connection

Interbase connection

MS Access connection

MYOB connection

Microsoft SQL Compact connection

Microsoft SQL Server connection

MySQL connection

ODBC connection

Oracle connection

PostgreSQL connection

QuickBooks connection

Data Connections

Common Pitfalls

Using local file paths

Examples

Inbound File

Local File Path

Network File Path (UNC)

Outbound File

File Connection

File Description

Allow this file to be access via Flow HTTP server

Audit Directory

Convert Excel to CSV

Ensure unique file name

Error Directory

File Directory

File Name

File Search Pattern

General Tab

Inbound Queue

Outbound Queue

Select File Channel

Web Link Name

File Connections

Authentication credentials not supplied

Common Pitfalls

Using web service path instead of WSDL path

WSSDL path not accessible

Examples

Local WSDL path

Remote WSDL path

General Tab

Password

Realm (Domain)

User Name

WSDL Path

Web Connection Name

Web Connection

Web Connections

Common Pitfalls

Linking data views from different DB Connections

Linking dataviews on non-unique fields

Not emptying destination DB Definitions

DB Definition

Designer

DB Definition Name

DB Connections

Disable Automatic String Trim

Duplicate Record Handling

General Tab

Include null values in SQL statement

Save Blank String Fields as Nulls

Save Null Fields as Blank string

Transaction Identification

Use In-memory Check

Main Screen

DB Definitions

Examples

Reading DB Definition

Writing DB Definition

Data Definitions

Data Views (Datasets)

Datasets - Records and Fields

Common Pitfalls

Incorrect Root Nodes in XML Files

EDI File

Examples

Flat File

XML File

Designer

File Definition

DB Connection

Disable automatic string trim

EDI File Type

Element Delimiter

Record Delimiter String

Record Delimiter

Segment Terminator

Sub-element Delimiter

Trim Strings

File Connection

File Definition Name

File Type

Add Record Delimiter

Allow quoting of data type

Bottom Lines Excluded

Delimited Fields

Field Delimiter

Flat File Type

Force Unicode Processing

Ignore Extra Fields

Ignore Invalid Lines

Ignore Invalid Numbers

Ignore undefined records

Null String

Print Header Row

Quote Char

Record Delimiter String

Record Delimiter

Top Lines Excluded

Trim Strings

Use Null Conversion

Use Quoted String

Use loose quoted string

General Tab - EDI

General Tab - Excel

General Tab - Flat

General Tab - XML

General Tab

Add namespaces as needed

Allow DTD references in XML

Create C-Sharp object

Include XML Prolog

Include XMLSchema (XSD)

Include XMLSchema-inst (XSI)

Output XML in readable format

Resolve imported schemas

Root Node Index

Schema Location

Show schema annotations

Target NS Prefix

Use xsinil for null fields

Validate XML Document

Write out files using UTF-16

XML File Type

XSD Schema

Main Screen

File Definition Tree

Partner Identification Tab

Selected Field List

When running an Action c

File Definitions

Common Pitfalls

Incorrect Root Nodes

Examples

Reading Web Definition

Writing Web Definition

Designer

DB Connections

Endpoint

General Tab

Operation

Port

SOAP Action

Service

Set Target Namespace as default namespace

Validate Request against WSDL Schema

Validate Response against WSDL Schema

Web Connection

Main Screen

Web Definition Name

Web Definition

Web Definitions

Documentation Note

Documenting

Exporting and Importing

Description

Folder List

Folders

Name

Auto Backup Tab

Perform automatic backup to local disk at

Remove backups older than

Remove logs older than

Email Setting Tab

From Display Name

From Email Address

Notification Email Address

Port

SMTP Server

Use in-built SMTP server

User Name

User Password

Email Body Text

Email Footer Text

Email Text Tab

General Setup

Allow Creation of Fields automatically

Application Priority

Cause error on non-empty destination data

Confirm Delete Actions

Default File Path

Default Max Thread Per Action

Delete half-written files when export fails

Enable Business Activity Monitoring

General Tab

Look And Feel

Max Threads

Trace Mode

Use web-based help files

Wait Before Execution

Authorization Type

Domain

Host

Password

Port

Proxy Settings Tab

Use a proxy for Internet connections

User Name

Enter new extension

Register Flow in Explorer Context Menus

Register for the following file extensions

Shell Extensions Tab

Web Address

Web Service Namespace

Web Settings Tab

Global Setup

DB Connection

SQL Result Pane

SQL Statement Pane

SQL Window

Execute Actions within a hidden windows session

Host Port

Host Server

Password

Service Name

Service Type

Service

Windows User

Services

Access

Full Name

Password

Username

Users

View

Auto Search

File Name

Files List

Files Tab

Include files in Audit folder

Include files in Error folder

Include files in Main folder

Logs From

Logs To

Auto Search

For Action

For Partner

Include Cancelled Logs

Include Failed Logs

Include Successful Logs

Logs From

Logs List

Logs Tab

Logs To

SQL Search

Logs

Auto Search

For Partner

For Transport

Include Failed Transports

Include Pending Transports

Include Retrying Transports

Include Successful Transports

Logs From

Logs To

Transports Editor

Transports List

Transports Tab

Common Pitfalls

Examples

Designer

Destination Data

General Tab

Source Data

Main Screen

Map Name

Parameters List

Parameters Tab

Map

Maps

Plugin Manager

Plugin

Common Pitfalls

Linked Data not assigned

Examples

Designer

General Tab

If there is no data print as much as possible

Print individual report for each master record

Source Data

Main Screen

Report Name

Report

Reports

Third Party Tools

XSD Inference

Common Pitfalls

Examples

Trading Community

Address 1

Address 2

City

Contact Details Tab

Country

Email

Fax

First Name

Last Name

Phone

State

Suburb

Custom ID

General Tab

Partner Type

Partner specific database (optional)

Their ID for you as customer

Their ID for you as supplier

Transformation Field

User Name

User Password

Your ID for them as customer

Your ID for them as supplier

Partner Name

Trading Partner Attributes

Trading Partner

File Connection List

Transports Tab

Search

Trading Partner List

Trading Partners Tab

Common Pitfalls

Examples

Description

Dont delete file from server

FTP

File Directory

Host

Indicator File Ext

Method

Move to Directory

Password

Port

Use LIST command instead of NLST

Use Passive FTP

Use temporary file name

User Name

Authorization Type

Description

Dont delete file from server

Fields

HTTP

In Process Auth

Make one request only

Password

Realm (Domain)

URL

Use Get Method

Use Multipart Form

User Name

Buffer Size

Connection Manager

Description

IBM MQ

Queue Name

Inbound Transports

Description

LAN

UNC Path

Description

Host

MSMQ

Message Delivery Type

Queue Name

Queue Visibility Type

Use Transactions

Delete emails even if other attachments exist

Description

Host

POP

Password

Port

User Name

Authorization Type

Description

Fields

In Process Auth

Make one request only

Password

Realm (Domain)

SOAP

Treat result node as XML content

URL

User Name

AS2

Description

Common Pitfalls

Examples

Description

Dont delete file from server

FTP

File Directory

Host

Indicator File Ext

Method

Move to Directory

Password

Port

Use LIST command instead of NLST

Use Passive FTP

Use temporary file name

User Name

Authorization Type

Description

Fields

HTTP

In Process Auth

Password

Realm (Domain)

URL

Use Multipart Form

Use Put Method

User Name

Connection Manager

Description

IBM MQ

Queue Name

Description

LAN

UNC Path

Description

Host

MSMQ

Message Delivery Type

Queue Name

Queue Visibility Type

Use Transactions

Outbound Transports

DB Password

DB User

Database Name

Database Type

Description

Language

License Server

Object Name

SAP Password

SAP User

SAP

Server Host

Update Strategy

Description

Email Address

Request Read Receipt

SMTP

Send attachment as body of email

Subject

Authorization Type

Description

Fields

In Process Auth

Password

Realm (Domain)

Response File

SOAP Namespace

SOAP

URL

User Name

WSDL

Anzen Dir

CPA ID

CPA Name

Description

From URL

Service Name

To URL

ebXML

Transports

Configuring FlowMonitor

Installing FlowMonitor

Using FlowMonitor

Checking which Actions FlowService is executing

Actions

Error Handling

Events

Managing what data has been processed

Concepts

EDI Techniques

Integration Techniques

Configuring FlowService

Handling errors when starting FlowService

Publishing instance of FlowService

Scheduling Actions under FlowService

Starting Stopping FlowService

Accessing FlowWeb

Configuring FlowWeb

Starting FlowWeb

Accessing FlowWebTransport

Configuring FlowTransportWeb

Operating Flow

Developing with Flow

Maintaining your Flow installation

Backing up Flow

Upgrading Flow

Change Logs

Automatic Upgrade

Manual Upgrade

Rolling back an upgrade

Using Beta Versions

Relocating Flow

Tag Reference

Standard Tags

Data Tags

Super Global Tags

Local Global Tags

Parameter Tags

Partner Tags

License Tags

Scripting Reference

Script Editor

Scripts

Comments

Statements

Assignment

Begin...End

Try...Except

If

Case

While loop

For loop

Operators

Arithmetic Operators

Assignment Operator

Boolean Operators

Relational Operators

String Operators

Exceptions

Program Flow

Events

LinkedData

BeforeMap

AfterMap

OnMap

Data Types

Testing for Null etc

Boolean (Boolean)

Datetime (TDateTime)

Float (Double, Extended, Currency)

Guid (TGuid)

Integer (Integer, Cardinal, Int64)

String (String, Widestring)

Variant (Variant)

Blob (Blob, Memo)

Enumerations

TFloMD5HashType

TFloPartnerType

TFloFieldType

TRegConType

TVarType

TFieldType

TQuestionResult

Format Specifiers

Date Format Specifiers

Number Format Specifiers

File Search Specifiers

Variables

LOCAL Variables

GLOBAL Variables

Global Datasets

Super Globals

Local Globals

User Parameters

Global Dataset Aliases

Referencing Fields

Classes

File Connection (FileCon)

FileCon.FileName

FileCon.CurrentFileName

FileCon.FileDir

FileCon.ProcessFileDir

FileCon.AuditDir

FileCon.ProcessAuditDir

FileCon.ErrorDir

FileCon.ProcessErrorDir

FileCon.SendViaTransport

FileCon.DoMoveToAudit

FileCon.MoveFile

FileCon.CopyFile

DB Connection (DBCon)

DBCon.Database

DBCon.Hostname

DBCon.Username

DBCon.Password

DBCon.OtherParams

DBCon.ConnectionType

Data Definition

DBConCount

DBCons

FileCon

StartTransaction

CommitTran

RollbackTran

Data Set

Dataset.BOF

Dataset.EOF

Dataset.FieldByName

Dataset.Fields.Count

Dataset.FieldByNumber

Dataset.Delete

Dataset.Find

Dataset.RecordCount

Dataset.RecordPosition

Dataset.Insert

Dataset.Edit

Dataset.Post

Dataset.CancelPost

Dataset.First

Dataset.Last

Dataset.Next

Dataset.Prior

Dataset.HasDetail

Dataset.IsDetail

Dataset.IsMaster

Dataset.RecordPKValue

TFloClientDataset.Create

Field

Field.Value

Field.AsSQL

Field.AsString

Field.AsInteger

Field.AsFloat

Field.AsDateTime

Field.FieldName

Field.FieldType

License

License.UserId

License.LicenseId

License.LicenseName

License.LicenseExpiry

Action

Action.Actions

Action.Partners

Partner

Partner.Id

Partner.CompanyName

Partner.FlowNetId

Partner.FirstName

Partner.LastName

Partner.PartnerType

Partner.CustomerId

Partner.TPSupplierId

Partner.SupplierId

Partner.TPCustomerId

Partner.Email

Partner.Phone

Partner.Fax

Partner.Address1

Partner.Address2

Partner.Address3

Partner.City

Partner.Country

Partner.Username

Partner.Userpass

Partner.AddrState

TStringList

TStringList.Count

TStringList.Add

Functions

Accounting

DiscountAmount

Discounted

TaxAmount

TaxExclusive

TaxInclusive

Barcode

EAN13toEAN128

Blob & Memo

CreateBlobValue

ReadBlobValue

COM

CreateOleObject

GetActiveOleObject

BinToHex

BinToInt

Conversion

CurrStrToFloat

FloatToStr

HexToInt

Int64ToStr

IntToBin

IntToHex

IntToStr

StrToFloat

StrToInt

StrToInt64

StrToIntDef

Database

ExecSQLStatementAndCommit

ExecSQLStatementDest

ExecSQLStatementSource

GetCustomDataSet

GetDataSetFromDest

GetDataSetFromSource

GetSQLValueFromDest

GetSQLValueFromSource

CompareDate

CompareDateTime

Date

Datetime

DayOf

DaysBetween

DaysInMonth

DaysInYear

DecodeDateTime

EncodeDateTime

EndOfTheMonth

Get20thOfNextMonth

IncDay

IncMonth

IncYear

IsPM

IsValidDate

IsValidDateTime

IsValidTime

LocalToUTC

MonthOf

MonthsBetween

Now

RecodeMonth

RecodeYear

StartOfTheMonth

StringToDateTime

Time

TryEncodeDateTime

UTCToLocal

YearOf

YearsBetween

Email

IsEmailValid

SendEmail

SendEmailEx

SendEmailExBCC

SendEmailTo

Base64Decode

Base64Encode

Encryption

MD5Convert

MD5Hash

MD5HashHex

RC4Decrypt

RC4DecryptKey

RC4Encrypt

RC4EncryptKey

ExceptionParam

ExceptionPos

ExceptionProc

ExceptionToString

ExceptionType

Exceptions

RaiseException

ChangeFileExt

ExcludeTrailingPathDelimiter

ExtractFileDrive

ExtractFileExt

ExtractFileName

ExtractFilePath

File

FileLocked

IncludeTrailingPathDelimiter

IsPathDelimiter

LoadFileToString

MakeUniqueFilename

MatchPattern

SaveToFile

TempFileName

Windows File Functions

Zip

ApplicationName

ApplicationPath

Flow

FormatDateTime

FormatFloat

Formatting

EmptyGuid

EmptyGuidString

Guid

NewGuid

NewGuidString

Host Specific

ExonetCleanStockcode

MYOB Exo

LogError

LogErrorAndContinue

LogInfo

LogWarning

Logging

MessageError

MessageInfo

MessageWarning

QuestionYN

Abs

Cos

Mathematical

Pi

Sin

Sqrt

Dec

ExtractNumber

Frac

Inc

Int

IsCurrencyNumber

IsDigit

IsNumber

Numeric

Round

Round2

Round2BR

Round2Up

Trunc

Parameters

CancelExecution

Exit

ProcessMasterRecord

Program Control

Sleep

StopExecution

AddQuotes

CompareText

Copy

DecodeLineFeeds

Delete

EncodeLineFeeds

Insert

LeftPad

Length

Lowercase

MatchesMask

Pos

RemoveLeadingZero

ReverseString

RightPad

SplitString

String

StringContainsOnly

StringOfString

StringReplaceAll

StringReplaceFirst

StringToToken

StripQuotes

Trim

URLEncode

Uppercase

ActivatePartner

ActivatePartnerByWhere

Partner

VarIsClear

VarIsEmpty

VarIsNull

VarToStr

VarToStrDef

VarToWideStr

VarToWideStrDef

VarType

Variant

Getting Support

Register for account on Flow website

Online Documentation

Knowledge Base

Professional Support

Purchasing Support Vouchers

What support is provided free?

Glossary

Other topics

Glossary

Changing Host Systems or Network Environment

Assigning Trading Partners to Actions

Managing Trading Community

Managing Trading Partners

Managing Security

Managing Users and Security

Managing Users

Staff Roles

On this page

Flow documentation · legacy product

Register Flow in Explorer Context Menus

Select to enable the registration of Flow against the given file extensions.

Pager

PreviousEnter new extension

NextRegister for the following file extensions

© Flow SoftwareCopyright, terms and conditions Privacy policy

Copyright, terms and conditions · Privacy policy

© Flow Software