Skip to content

Syncplify Server! V6

Main Navigation www.syncplify.com

Appearance

Sidebar Navigation

Manual & Docs

READ THIS FIRST

General concepts

Logical structure

Log levels

BlockList, SafeList, AllowList

Variables (parametric stuff)

Installation and Setup

Minimum hardware

Download the installer

Install on Windows (GUI)

Install on Linux

Administration (Web UI)

SuperAdmin UI

Logging into the SuperAdmin UI

Managing virtual sites

Admin UI

Logging into the Admin UI

The dashboard

The blocklist

Virtual file systems (VFS)

LDAP (Active Directory)

Managing users

Security

General security settings

Safe/Allow lists

General SSH/SFTP settings

Advanced SSH/SFTP settings

General FTP(E/S) settings

Advanced FTP(E/S) settings

General WebClient! settings

Advanced WebClient! settings

Password constraints

Scripting/event-handling

Scripts

Event handlers

Other settings

Global speed limits

SMTP settings

Logging

Certificates & Keys

SSL/TLS Certificates

SSH Host Keys

Miscellaneous concepts

Dynamic "banners"

Administration (REST API)

OpenAPI definitions

Scripting/Event-Handling

Server!-specific SyncJS

Helper functions

EventHandler()

ScriptID()

ScriptName()

HandlerPriority()

ExecutionTimeout()

SecondsLeft()

The "Session" object

GetID()

GetUser()

GetCurrentVFS()

GetVirtualSite()

GetRemoteAddress()

GetClientVersion()

GetProtocol()

GetStartTime()

GetLastActivity()

BlockOperation()

AddCustomData()

GetCustomData()

GetAllCustomData()

AddQuestion()

AddQuestionPassword()

AddQuestionTOTP()

AuthenticateUserFromScript()

GetAbsPath()

GetAbsTargetPath()

GetRelPath()

GetRelTargetPath()

RemoveFromDirList()

GetLastCommand()

GetLastCommandTime()

GetLastError()

GetLastErrorTime()

The "User" object

GetID()

The "VFS" object

ImportFile()

ExportFile()

The SyncJS language

SyncJS types

Directory list items

Local file-system functions

ListDir (list directory)

ListDirR (recursive ListDir)

CopyFile (copy a file)

MoveFile (move/rename a file)

DelFile (delete a file)

SecureErase (delete file)

MakeDir (create a directory)

DelDir (delete a directory)

DelTree (delete directory-tree)

ReadTextFile (read a text file)

ReadFileAsHex (read file bytes)

Write text to file (2 ways)

Zip (compress files)

FileType (identify MIME-type)

StatFileSystemObject (file/dir)

HashFile (file hashing)

Web (HTTP/HTTPS) functions

Configuration methods

HTTP(S) verbs

HttpRes response object

SQL database functions

Supported database servers

Configuring SqlCli

Connecting to a DB server

Querying a dataset

Insert/Update/Delete

AMQP message queue protocol

AMQP object properties

Connecting to an AMQP queue

Monitoring a queue

Processing messages

Cloud and integration functions

Send to Slack (webhook)

Send SMS via Twilio

Email/communication functions

SendMail (sending emails)

Process management

Run (execute a process)

RunAsync (async execution)

Image processing

JPEGResample (resize a JPG)

PNGResample (resize a PNG)

JPEGMetadata (extract EXIF)

PNGMetadata (PNG info)

Security/encryption functions

Generate a PGP key-pair

PGP encrypt file

PGP decrypt file

Miscellaneous functions

Log (custom log line)

Sleep (pause execution)

Extract file path

Extract file name

Extract file extension

Num-to-string (padded)

Unique IDs (UUID)

ToDate()

More (cool) stuff

Requiring a Node.js module

The "underscore.js" library

WebClient! UI

On this page

The SyncJS language

This section of the manual documents all objects, properties, and methods of the SyncJS language that are shared between Syncplify Server! and AFT!, and are therefore available in both products.

Pager

Previous pageExportFile()

Next pageSyncJS types