Skip to content

Main Navigation Installation Designer Scripting Tutorials

Appearance

Sidebar Navigation

Statelake

Style Guide

Getting Started

Installation Guide

Planning The Installation

Directories

Installing Statelake

Manager - Setup Statelake

Creating Configurations With Manager

New Configurations

Configuration Files - The Power of AppData.cfg

Converting Existing 32-bit FLOW Configurations To 64-bit STATELAKE

Tutorials

"Hello World" Introduction

Tutorials: Before you start

Tutorial Resources

Tutorial Exercises

Tutorial 1: Exporting Creditor Accounts Into A Flat File Supplier List

Tutorial 2: Import Debtors Into A Custom Database

Tutorial 3: Import XML Purchase Orders Into A Database

Tutorial 4: Extracting XML Invoices Out Of A Database

Tutorial 6: Import CSV Purchase Orders Into A Database

Administering Statelake

Designer - Build and Manage Integrations

Modules and Templates

Common Dialogs

Global Setup

General Setup

General Tab - General Setup

Email Settings Tab - General Setup

Email Text Tab - General Setup

Proxy Settings Tab - General Setup

Folders

Parameters

Tags (Parameter)

Add Parameter

Include Files

Parameters - Include Files

Scripting - Include Files

Compiler - Include Files

SQL Window

Data Connections

DB (Database) Connections

General Tab - DB (Database) Connections

Advanced Tab - DB (Database) Connections

File Connections

HTTP Connections

General Tab - HTTP Connections

Auth Tab - HTTP Connections

Headers Tab - HTTP Connections

Parameters Tab - HTTP Connections

SOAP (Web) Connections

Data Definitions

Introduction to Magic SQL

DB (Database) Definitions

Design - DB (Database) Definitions

File Definitions

Flat File Definitions

XML File Definitions

EDI File

Excel File Definitions

SOAP (Web) Definitions

JSON Definitions

Design - JSON Definitions

Map

General Tab (Map)

Parameters Tab (Map)

New Parameter - Parameters Tab (Map)

Edit Parameter - Parameters Tab (Map)

Design (Map)

Source - Design (Map)

Destination - Design (Map)

Events - Design (Map)

Scripting - Design (Map)

Compiler - Design (Map)

Actions

Add Data - Data Tab

New DB Definition Item

New File Definition Item

New SOAP Definition Item

New JSON Definition Item

Add Action - Action Steps Tab

New Map Action Item

New Report Action Item

New Shell Command Action Item

New Outbound Transport Action Item

New Inbound Transport Action Item

New SQL Action Item

New Transaction Commit Action Item

New DB Disconnect Action Item

New File Router Action Item

New Sub Action Item

New Wait For File Action Item

New Custom Script Action Item

Execution Tab

Run Action Via

Notification Tab

Trading Partners Tab

Trading Community

New Trading Partner

Edit Trading Partner

Delete Trading Partner

Search Trading Partner

Import or Export Trading Partner

Use Of Trading Partner In An Action

Trading Partner Attributes

Transports

SSH Settings

Proxy Settings

Inbound Transports

FTP or FTP/s or SFTP (inbound)

HTTP or HTTP/S (inbound)

LAN (Inbound)

POP (inbound)

Outbound Transports

FTP or FTP/S or SFTP (outbound)

HTTP or HTTP/S (outbound)

LAN (outbound)

SMTP (outbound)

Exporting And Importing Configurations

Exporting

Exporting All Items Within A Module

Exporting An Individual Item Within A Module

Exporting Multiple Modules

Export An Individual Trading Partner

Exporting Logs

Importing

Configuration Labels

Importing A Template File

Importing A Trading Partner

Importing Individually Saved Export Files

Importing Logs

Logs

Logs Tab

Log Detail Viewer

Operating Statelake

Monitor - Running Actions & Schedules

Error Notifications

Email Notifications

Maintaining your Statelake installation

Regular Maintenance Tasks

Migrating Flow to Statelake

Migrate Flow Database

Migrate Flow Scripting Files

Migrate Flow CFG File

Move Statelake To A Different Environment

Preparing The Target Environment Space

The Source Environment Space

The Target Environment Space

Tag Reference

Standard Tags

Data Tags

Super Global Tags

Local Global Tags

Parameter Tags

Partner Tags

License Tags

Scripting Reference

Comments Within Your Script

Statements

Assignment

Begin....End

Try....Except

If (If....Then/If....Else)

Case

For Loop

While

Operators

Program Flow

Events

Dataview Events (Dataset)

Record-level Events

LinkedData Event

BeforeMap Event (Record-level)

AfterMap Event (Record-level)

AfterDetailMap Event

Field-level Events

OnMap Event

BeforeMap Event (Field-level)

AfterMap Event (Field-level)

Data Types

Boolean

DateTime (TDateTime)

Fixed-point (Currency)

Floating-point (Single, Double, Extended)

Integer (Integer, Cardinal, Int64, LongInt)

String (String, Widestring)

Variant

Word (Double Byte)

Testing For Null (empty or blank) Values

Enumerations

TFieldType

TFloFieldType

TFloMD5HashType

TFloPartnerType

TRegConType

TVarType

FileAttribute

Variables

Global Datasets

Global Dataset Aliases

Global Variables

Local Globals

Local Variables

Super Globals

User Parameters

Referencing Fields

Classes

Data Definition Class (TFloDataSource)

TFloDataSource.DBCons

TFloDataSource.DBConCount

TFloDataSource.FileCon

TFloDataSource.StartTransaction

TFloDataSource.CommitTran

TFloDataSource.RollbackTran

Dataset Class (TDataset)

TDataset[.Query].Fields.FieldByName

TDataset.BOF

TDataset.EOF

TDataset[Query.].Fields.Count

TDataset.Delete

TDataset.Find

Client Dataset Class (TFloClientDataset)

TFloClientDataset.BOF

TFloClientDataset.EOF

TFloClientDataset.Fields.FieldByName

DB Connection Class (TFloDBCon)

DBCon.Database

DBCon.Hostname

DBCon.Username

DBCon.OtherParams

DBCon.ConnectionType

DBCon.Password

File Connection Class (TFloFileCon)

FileCon.FileName

FileCon.CurrentFileName

FileCon.FileDir

FileCon.ProcessAuditDir

FileCon.ProcessFileDir

FileCon.AuditDir

FileCon.DoMoveToAudit

FileCon.ErrorDir

FileCon.ProcessErrorDir

FileCon.SendViaTransport

FileCon.MoveFile

FileCon.CopyFile

License Class

License.UserId

License.LicenseId

License.LicenseExpiry

License.LicenseName

TFloFileSearch Class

Functions And Procedures

Parameters Or Arguments?

Function Parameters

Procedure Parameters

What Is A Function

Defining Or Declaring A Function

User-defined Functions

Calling Functions

Functions And Include Files

What Is A Procedure

Defining Or Declaring A Procedure

User-defined Procedures

Calling Procedures

Procedures And Include Files

Accounting Functions

TaxAmount

TaxInclusive

TaxExclusive

Discounted

DiscountAmount

COM Functions

CreateOleObject

GetActiveOleObject

Conversion Functions

BinToHex

BinToInt

BooltoFloString

BoolToStr

FloatToStr

FloStringToBool

FormatDateTime

HexToInt

Int64ToStr

IntToBin

IntToBin2

IntToHex

IntToStr

FloCurrStrToFloat

StringToDateTime

StrToFloat

StrToInt

StrToInt64

StrToIntDef

VarToStr (Variant)

Database Functions

GetCustomDataSet

Insert & Retrieve Data (Column Names Only)

List Default Column Types (When Defined With Names Only)

Specify Column Names, Types, Sizes, & Whether Required

GetDataSetFromSource

GetDataSetFromDest

GetSQLValueFromSource

GetSQLValueFromDest

ExecSQLStatementSource

ExecSQLStatementDest

ExecSQLStatementAndCommit

DateTime Functions

Date

DateOf

DateTimeToJulianDate

DateTimeToModifiedJulianDate

DateTimeToUnix

DayOf (DayOfTheMonth)

DayOfTheWeek

DayOfTheYear

DayOfWeek

DaysBetween

DaysInAMonth

DaysInMonth

DaysInAYear

DaysInYear

DaySpan

DecodeDateDay

DecodeDateMonthWeek

DecodeDateTime

DecodeDateWeek

DecodeDayOfWeekInMonth

EncodeDateDay

EncodeDateMonthWeek

EncodeDateTime

EncodeDateWeek

EncodeDayOfWeekInMonth

EndOfAMonth

EndOfADay

EndOfAWeek

EndOfAYear

EndOfTheDay

EndOfTheMonth

EndOfTheWeek

EndOfTheYear

FormatDateTime (DateTime)

Get20thOfNextMonth

HourOf (HourOfTheDay)

HourOfTheMonth

HourOfTheWeek

HourOfTheYear

HoursBetween

IncDay

IncHour

IncMilliSecond

IncMinute

IncMonth

IncSecond

IncWeek

IncYear

IsInLeapYear

IsPM

IsSameDay

IsToday

IsValidDate

IsValidDateDay

IsValidDateTime

IsValidDateWeek

IsValidTime

JulianDateToDateTime

LocalToUTC

MilliSecondOf (MilliSecondOfTheSecond)

MilliSecondOfTheDay

MilliSecondOfTheHour

MilliSecondOfTheMinute

MilliSecondOfTheMonth

MilliSecondOfTheWeek

MilliSecondOfTheYear

MilliSecondsBetween

MinuteOf (MinuteOfTheHour)

MinuteOfTheDay

MinuteOfTheMonth

MinuteOfTheWeek

MinuteOfTheYear

MinutesBetween

ModifiedJulianDateToDateTime

MonthOf (MonthOfTheYear)

MonthsBetween

MonthSpan

Now

NthDayOfWeek

RecodeDate

RecodeDateTime

RecodeDay

RecodeHour

RecodeMilliSecond

RecodeMinute

RecodeMonth

RecodeSecond

RecodeTime

RecodeYear

SameDate

SameDateTime

SameTime

SecondOf (SecondOfTheMinute)

SecondOfTheDay

SecondOfTheHour

SecondOfTheMonth

SecondOfTheWeek

SecondOfTheYear

SecondsBetween

StartOfADay

StartOfAMonth

StartOfAWeek

StartOfAYear

StartOfTheDay

StartOfTheMonth

StartOfTheWeek

StartOfTheYear

StringToDateTime (DateTime)

Time

TimeOf

Today

Tomorrow

TryEncodeDateDay

TryEncodeDateMonthWeek

TryEncodeDateTime

TryEncodeDateWeek

TryJulianDateToDateTime

TryModifiedJulianDateToDateTime

TryRecodeDateTime

TryEncodeDayOfWeekInMonth

UnixToDateTime

UTCToLocal

WeekOf (WeekOfTheYear)

WeekOfTheMonth

WeeksBetween

WeekSpan

WeeksInAYear

WeeksInYear

WithinPastDays

WithinPastHours

WithinPastMilliSeconds

WithinPastMinutes

WithinPastMonths

WithinPastSeconds

WithinPastWeeks

WithinPastYears

YearOf

YearsBetween

YearSpan

Yesterday

Encryption & Encoding Functions

Base64Decode

Base64Encode

MD5Convert

MD5Hash

MD5HashHex

Exception Functions

ExceptionParam

ExceptionPos

ExceptionProc

ExceptionToString

ExceptionType

RaiseException

File Functions

ChangeFileExt

ExcludeTrailingPathDelimiter

ExtractFileDrive

ExtractFileExt

ExtractFileName

ExtractFilePath

FileIsReadOnly

FileLocked

FloFileSize

IncludeTrailingPathDelimiter

IsApplicationRunning

IsPathDelimiter

LoadFileToString

LoadFileToWideString

MakeUniqueFilename

MatchPattern

NewFileSearch

PurgeFiles

RemoveReadOnly

SaveToFile

SaveWideStringToFile

SaveWideStringToFileWithBOM

SaveWideStringToFileWithBOMBE

TempFileName

Windows File Functions

Zip

Formatting Functions

FormatFloat

FormatDateTime (Formatting)

Format Specifiers

Date And Time Format Specifiers

Number Format Specifiers

Logging Functions

LogError

LogErrorAndContinue

LogInfo

LogWarning

MessageError

MessageInfo

MessageWarning

Mathematical Functions

Abs

Cos

Pi

Sin

Sqrt

Numeric Functions

CompareValue

Dec

ExtractNumber

Frac

IfThen (String)

Inc

Int

IsCurrencyNumber

IsNumber

MaxIntValue

MinIntValue

NthRoot

Power

Round

Round2

Round2Up

Round2BR

SortInt

SortIntEx

Trunc

Program Control Functions

CancelExecution

Exit

ProcessMasterRecord

RunAction

Sleep

StopExecution

StopExecutionAsSuccess

Statelake Specific System Functions

ApplicationName

ApplicationPath

String Functions

AddQuotes

CompareText

ContainsStr

ContainsText

Copy

Delete

DecodeLineFeeds

DupeString

EncodeLineFeeds

EndsStr

EndsText

ExtractNumber (Numeric)

IfBlank

IfThen

IndexStr

IndexText

Insert

IsEmailValid

LeftPad

LeftStr

Length

LowerCase

MatchesMask

MatchStr

MatchText

MidStr

Pos

PosEx

ProperCase

RandomFrom

Regular Expressions (RegEx)

RegExMatch

RegExReplace

RegExExtract

RegExSplit

RemoveLeadingZero

ReplaceStr

ReplaceText

ResemblesText

ReverseString

RightPad

RightStr

Soundex Functions

Soundex

SoundexCompare

SoundexInt

DecodeSoundexInt

SoundexProc

SoundexSimilar

SoundexWord

DecodeSoundexWord

SplitString

StartsStr

StartsText

StringContainsOnly

StringOfString

StringReplaceAll

StringReplaceFirst

StringToToken

StripNumbers

StripQuotes

StuffString

TitleCase

Trim

UpperCase

URLEncode

Trading Partner Functions

Variant Functions

IfEmpty

IfNull

VarIsEmpty

VarIsNull

VarToStr

VarToStrDef

VarToWideStr

VarToWideStrDef

VarType

JSON For Scripts

JSON Object Classes & Variable Types

Creating JSON Objects

Accessing Child Elements Of JSON Objects And Arrays

Modifying Child Elements Of JSON Objects And Arrays

Convert A JSON Value To A String (serialization)

Objects References And Deep Copying

Iterating Through TJSONObject Keys And Values

Methods Summary

Transitional JSON Interface for Scripting

HTTP Scripting

HTTP Requests

Scripting Parameters and Methods - HTTP Requests

HTTP Request Examples

HTTP Responses

Scripting Parameters and Methods - HTTP Responses

HTTP Response Examples

Anatomy Of An HTTP Request

Anatomy Of An HTTP Response

HTTP Status Codes

Reserved Words

Glossary

On this page

File Functions

The following File functions are available.

They assist with working with folder paths and file names.

In this section

ChangeFileExt
The ChangeFileExt function changes the extension on the given file path to that specified.
ExcludeTrailingPathDelimiter
The function ExcludeTrailingPathDelimiter returns the file path without a path delimiter on the end.
ExtractFileDrive
This function returns the drive portion of a file path which includes a filename.
ExtractFileExt
ExtractFileExt returns the file name extension of a file path.
ExtractFileName
Returns the file name portion of a file path, including the file extension.
ExtractFilePath
The ExtractFilePath function returns the drive and file path portion of a file path which includes a filename.
FileIsReadOnly
The function FileIsReadOnly asks a question - whether the file named by the parameter FileName is a property of ReadOnly or not.
FileLocked
FileLocked returns True if the file specified by aFilePath is locked.
FloFileSize
The FloFileSize function returns the size in bytes of the specified on-disk file FileName.
IncludeTrailingPathDelimiter
The IncludeTrailingPathDelimiter function returns the file path with a path delimiter on the end.
IsApplicationRunning
The IsApplicationRunning function performs a background check on whether or not a specified program aAppName is currently running.
IsPathDelimiter
IsPathDelimiter checks within the parameter S for the character at the position given in Index, to determine if it is a path delimiter.
LoadFileToString
LoadFileToString loads the contents of the file specified by aFileName into a string variable.
LoadFileToWideString
LoadFileToWideString loads the contents of the file specified by aFileName into a string variable.
MakeUniqueFilename
MakeUniqueFileName checks to ensure the provided file name aFilename is unique.
MatchPattern
The MatchPattern function returns the boolean value True if the string Source matches with the pattern specified by the parameter Pattern.
NewFileSearch
The function NewFileSearch has been introduced to facilitate searching for files in the file system.
PurgeFiles
The PurgeFiles function deletes files from the file directory specified by AFileMask, where a file date stamp is older the current date by AOlderThanDays number of days.
RemoveReadOnly
The function RemoveReadOnly checks the file named by the parameter FileName, and if it is set with a property of ReadOnly, the ReadOnly status will be removed.
SaveToFile
SaveToFile saves the string given by aContents as a file on disk named as specified by aFileName.
SaveWideStringToFile
SaveWideStringToFile saves the string given by aContents as a file on disk named as specified by aFileName.
SaveWideStringToFileWithBOM
SaveWideStringToFileWithBOM saves the string given by aContents as a file on disk named as specified by aFileName.
SaveWideStringToFileWithBOMBE
SaveWideStringToFileWithBOMBE saves the string given by aContents as a file on disk named as specified by aFileName.
TempFileName
TempFileName returns a temporary file name including the path, to the windows temp folder.
Windows File Functions
Statelake provides functions for working with files, both as File Functions and also as properties and methods for the File Connection object class, found at File Connection Cla...
Zip
The Statelake function Zip produces a zipped output file from one or more source files.

Pager

PreviousRaiseException

NextChangeFileExt

© Flow SoftwareCopyright, terms and conditions Privacy policy

Copyright, terms and conditions · Privacy policy

© Flow Software