Commands and APIs

Commands and APIs are provided to allow external applications to run file transfers and workflows (Projects) in GoAnywhere Director. These commands and APIs are available at no additional charge and can be installed onto Windows, UNIX, LINUX, IBM i (iSeries), HP-UX and Solaris platforms. The GoAnywhere commands can be run from system command lines, scripts, programming languages (e.g. JAVA and .NET) and 3rd party schedulers.
 
Since the commands and APIs make requests to GoAnywhere Director using the standard HTTP(S) protocol, these commands can connect from other systems on the IP network. This allows a single install of GoAnywhere Director to execute and manage all the file transfer needs within an environment.
 
GoAnywhere Director Run Project Diagram
 
The commands have several parameters which can be specified by the user or application including:
  • Name of the Project to execute
  • User and password for authentication
  • Host name (or IP address) and port number of the GoAnywhere server
  • Variables names and values to override in the Project, such as file names, folder names, IP addresses, etc.
  • Job Queue priority

Commands for Windows

GoAnywhere commands can be run from a Windows command line, from Windows shortcuts, custom applications, languages and Windows schedulers.

Command example:
gacmd.exe -server http://server.example.com:8000/goanywhere/
-user projectManager -password ********
-command runProject -Project /Payroll/SendDirectDeposit
-variables fileName "deposit.csv" folderPath "/inbound/deposit"

Commands for Unix/Linux/HP-UX/Solaris

For Unix and Linux operating systems, GoAnywhere commands can be entered on a command line, run from shell scripts, custom applications, cron and 3rd party schedulers.

Command example:
sh gacmd -server http://server.example.com:8000/goanywhere/
-user projectManager -password ********

-command runProject
-Project /Orders/SendPurchaseOrders
-variables VendorNumber "423231" Status "Open"

Commands for IBM i (iSeries)

The provided GoAnywhere command for IBM i can be entered on an command line, run from CL/RPG/COBOL programs, placed on user menus and run from other job schedulers.

Command example:
GOANYWHERE/RUNPROJECT PROJECT('/FinanceProjects/ACH_Transfer') USER(MSMITH) PASSWORD(********) VARIABLE((STATECODE "NE")) MODE(*INTER)

Commands for Java

Java applications can execute GoAnywhere commands using the same set of options that are available from the command line interfaces. Parameters can be passed through the API to override variables in the executed Projects. The Java API comes with several working examples along with documentation to get you started.

Commands for .NET

GoAnywhere commands can be executed from .NET applications using the GoAnywhere open source C# API. Included in the API is a sample Windows Form application for demonstration purposes and to provide working code examples. Your .NET application can reference the packaged DLL file or include the C# source code for further customization.


GoAnywhere Director can be installed onto Windows, VMware, Linux, IBM i, AIX (pSeries), UNIX, HP-UX, Mac OS and Solaris platforms.  IBM i is also referred to as System i, iSeries, as400, as/400 and i5.