Every global, A to Z Preview

Every name the engine defines beyond standard JavaScript. There are 128 of them, and this list is generated from the live engine rather than from another product's manual, so a name that is not here does not exist on the Connector.

Rows marked does not work here are present so that ported scripts still parse, but they cannot do what their name suggests. Rows marked needs configuring work once you have filled in the relevant settings. Read the linked page before relying on either.

Name	Kind	What it is
`AlwaysOverwrite`	constant	Transfer policy: replace the destination
`AmqpClient091`	constructor	AMQP 0.9.1 client
`AmqpClient10`	constructor	AMQP 1.0 client
`AppendTextToFile`	function	Append text to a local file
`AzureClient`	constructor	Azure Blob Storage transfer client
`Base64Decode`	function	Decode standard Base64
`Base64Encode`	function	Encode as standard Base64
`Chown`	function	Change a local file's owner. POSIX only, needs root
`clearImmediate`	function	Cancel a setImmediate callback
`clearInterval`	function	Cancel a setInterval callback
`clearTimeout`	function	Cancel a setTimeout callback
`CopyFile`	function	Copy a local file into a directory. Will not overwrite
`CtxRelPath`	function	The path the event is about
`CtxRelTargetPath`	function	The destination path of a rename
`CtxUsername`	function	The user the event is about
`CtxVFSName`	function	The virtual file system the event is about
`DelDir`	function	Delete an empty local directory
`DelFile`	function	Delete a local file
`DelTree`	function	Delete a local directory and everything in it
`DirExists`	function	Does a local directory exist
`EventCtx`	function	The whole event context as one object
`EventHandler`	function	The event id that fired
`ExecutionTimeLeft`	function	Time left before the handler deadline
`ExecutionTimeout`	function	The handler timeout in whole seconds
`Exit`	function	Stop the script. Non zero refuses a before operation
`ExtractExt`	function	The extension of a path, including the dot
`ExtractName`	function	The file name part of a path
`ExtractPath`	function	The directory part of a path
`FileAgeSecs`	function	Seconds since a local file was modified
`FileExists`	function	Does a local file exist
`FileSizeOf`	function	Size of a local file in bytes
`FileType`	function	MIME type of a local file, sniffed from its content
`FormatCSV`	function	Serialize rows to CSV
`FormatDateTime`	function	Format a Date with YYYY MM DD HH mm ss tokens
`FromCurrent`	constant	Seek from the current position
`FromEnd`	constant	Seek from the end of the file
`FromStart`	constant	Seek from the start of the file
`FTP_MODE_A`	constant	FTP ASCII transfer mode
`FTP_MODE_I`	constant	FTP binary transfer mode
`FtpsClient`	constructor	FTP and FTPS transfer client
`GCSClient`	constructor	Google Cloud Storage transfer client
`GeneratePGPKeys`	function	Write a new PGP key pair to disk
`GetCurrentVFS`	function	The live virtual file system of the event
`GetSecret`	function	Read a named credential from the Connector's secret store. Needs configuring: returns an empty string for a name that is not stored
`GetTempFileName`	function	A unique temporary path. Does not create the file
`GunzipFile`	function	Decompress a gzip file
`GzipFile`	function	Compress a single file with gzip
`HandlerPriority`	function	The priority of the handler that ran this script
`HashFile`	function	Hash a local file, streamed
`HashString`	function	Hash a string
`HmacSign`	function	Compute an HMAC
`HmacVerify`	function	Verify an HMAC in constant time
`HttpCli`	constructor	Synchronous HTTP client
`JPEGMetadata`	function	Read a JPEG's dimensions and EXIF
`JPEGResample`	function	Resize a JPEG in place
`LIST_ALL`	constant	Remote listing: files and folders
`LIST_DIRS`	constant	Remote listing: folders only
`LIST_FILES`	constant	Remote listing: files only
`ListDir`	function	List a local directory
`ListDirR`	function	List a local directory recursively
`Log`	function	Write to the Connector log. Also Trace, Debug, Info, Warn, Error
`LongUID`	function	A 54 character time sortable identifier
`MakeDir`	function	Create a local directory
`MoveFile`	function	Move or rename a local file
`NeverOverwrite`	constant	Transfer policy: skip an existing destination
`NotifyViaTelegramBot`	function	Post a message to the configured Telegram chats. Needs configuring: returns false until a bot is saved in Settings
`NumToStrPad`	function	Zero pad a number to a width
`OTFEAlgoAES256GCM`	constant	On the fly encryption with AES-256-GCM
`OTFEAlgoOpenPGP`	constant	On the fly encryption with OpenPGP symmetric
`OverwriteIfDiffSize`	constant	Transfer policy: overwrite when sizes differ
`OverwriteIfNewer`	constant	Transfer policy: overwrite when the source is newer
`ParseCSV`	function	Parse CSV into rows
`ParseXML`	function	Parse XML into a nested object
`PGPDecryptFile`	function	Decrypt a PGP file with a private key
`PGPEncryptFile`	function	Encrypt a file to a public key
`PGPSignFile`	function	Create a detached PGP signature
`PGPVerifyFile`	function	Verify a detached PGP signature
`PNGMetadata`	function	Read a PNG's dimensions
`PNGResample`	function	Resize a PNG in place
`ReadFileAsHex`	function	Read bytes from a local file as hex
`ReadTextFile`	function	Read a whole local text file
`require`	function	Load a CommonJS module from the modules folder
`Run`	function	Run a program and wait
`RunAsync`	function	Start a program without waiting
`RunCapture`	function	Run a program and capture its output
`S3Client`	constructor	Amazon S3 transfer client
`ScriptID`	function	The id of the running script
`ScriptName`	function	The name of the running script
`SecureErase`	function	Overwrite then delete a local file
`SendMail`	function	Send an email through the configured relay. Needs configuring: returns false until SMTP is saved in Settings
`SendSMSViaTwilio`	function	Send an SMS through Twilio
`SendToSlackWebHook`	function	Post to a Slack incoming webhook
`SendToTeamsWebHook`	function	Post to a Microsoft Teams webhook
`Session`	object	The event context in Syncplify Server shape
`setImmediate`	function	Defer a callback. Runs after the script body
`setInterval`	function	Repeat a callback. Runs after the script body
`setTimeout`	function	Defer a callback. Runs after the script body
`SftpClient`	constructor	SFTP transfer client
`ShortUID`	function	A 27 character time sortable identifier
`Sleep`	function	Pause the script, synchronously
`SortAsc`	constant	Sort a listing ascending
`SortByName`	constant	Sort a listing by name
`SortByNameDirsFirst`	constant	Sort a listing by name, folders first
`SortBySize`	constant	Sort a listing by size
`SortByTime`	constant	Sort a listing by modification time
`SortDesc`	constant	Sort a listing descending
`SplitFileByLines`	function	Split a text file into chunks of N lines
`SplitFileBySize`	function	Split a file into chunks of N bytes
`SqlCli`	constructor	SQL database client for eight engines
`StatFileSystemObject`	function	Metadata for one local file or directory
`TcpConnect`	function	Can a TCP connection be opened
`TLS_MODE_EXPLICIT`	constant	FTPS: upgrade with AUTH TLS
`TLS_MODE_IMPLICIT`	constant	FTPS: TLS from the first byte
`TLS_MODE_NONE`	constant	FTP with no encryption
`ToDate`	function	Convert a Date, a listing timestamp or epoch milliseconds into a JavaScript Date
`Unzip`	function	Extract a zip archive
`UUIDv4`	function	A random RFC 4122 version 4 UUID
`VfsTypeAzure`	constant	Virtual file system type: Azure Blob
`VfsTypeDisk`	constant	Virtual file system type: local disk
`VfsTypeGCS`	constant	Virtual file system type: Google Cloud Storage
`VfsTypeR2FS`	constant	Does not work here. Defined, but a VFS of this type cannot be constructed
`VfsTypeS3`	constant	Virtual file system type: S3
`VfsTypeSFTP`	constant	Virtual file system type: remote SFTP
`VirtualFS`	constructor	Build a temporary virtual file system
`VirtualFSByName`	constructor	Does not work here. Always fails; look up by name is not available
`WaitForFile`	function	Block until a local file appears
`WriteTextToFile`	function	Replace a local file's contents with text
`Zip`	function	Create a zip archive, optionally encrypted

Not defined on the Connector

These exist in Syncplify Server or in Syncplify AFT and are not defined here at all. Calling one is a TypeError that stops the script, which on a fail closed before handler refuses the operation.

Name	Where it comes from
`MakeTOTP`, `ValidateTOTP`	Syncplify Server. The Connector has no TOTP secret
`CtxVirtualSite`	Syncplify Server. The Connector has no virtual sites
`Terminate`	Syncplify Server. Sessions are ended by the Head, not the Connector
`HaltSignalReceived`, `ConsoleFeedback`, `JobID`, `Params`	Syncplify AFT. There are no long running jobs here
`FsWatcher`, `RemoteWatcher`	Syncplify AFT
`console`, `fetch`, `process`, `Buffer`, `__dirname`, `window`, `document`	Node.js or a browser. This engine is neither
`_` (Underscore)	Not preinstalled. `require()` it yourself after placing the file

Several Session methods are also absent; the list is on If you know Syncplify Server.

Every global, A to Z Preview ​

Not defined on the Connector ​

Every global, A to Z Preview

Not defined on the Connector