Automating OnRamp
Overview
OnRamp provides a rich set of command-line parameters that make it possible to fully automate user file transfers to the cloud. Automating the use of OnRamp helps ensure an efficient and repeatable process that allows IT administrators to be more productive. In a typical networked company environment, it’s most efficient to deploy OnRamp on a shared server that hosts the application files. This approach is useful as OnRamp then doesn’t have to be installed on each individual system where it will be used; the application can be run directly from the server. Configuration settings and the transfer log files are also stored centrally on this shared server. In a highly distributed environment, it’s of course possible to have multiple shared installations of OnRamp (e.g. one per branch office). Your network configuration will help determine what the best approach is for your environment. OnRamp can also be installed on individual systems, which could be essential for remote employees. In most cases, one script is created for the transfer so that you don’t have to remember all of the command-line parameters every time you perform an operation with OnRamp. These scripts can be simple batch files, PowerShell scripts or anything else that can run an application and pass command-line parameters to the application. These scripts are also useful for integration into OS deployment solutions or desktop management tools from other software publishers.
Automating User File Transfers
Using command-line parameters, OnRamp can be set up to automatically transfer user files to the cloud for the currently logged in user. In a single sign-on environment, no user interaction is needed. The next section details all supported command-line switches followed by batch file examples that will assist you in the development of an automated file transfer process.
Command-Line Parameters
Introduction
This chapter describes the command-line parameters supported by OnRamp. Using these command-line parameters it’s possible to fully automate OnRamp. Do note, however, that an administrator should run OnRamp at least once in order to customize the configuration that should be used by OnRamp.
You need at least one configuration file, but it’s also possible to have multiple configuration files to accommodate different needs for different sets of users, see the CONFIG parameter for information on how to define which configuration file to use for an operation.
When running OnRamp from the command-line, it’s highly recommended that you use start /w to run the application since it ensures Windows will wait for OnRamp to complete the operation before executing the next command.
Command-Line Parameters
The command-line parameters used to automate OnRamp operations include:
- AutoTransfer - perform user file transfer to the cloud
- Config - specify the configuration file to use
- HideStatus – don’t display the progress dialog during the operation
- NoStop – don’t display the stop button in the progress dialog
AUTOTRANSFER
Syntax /AUTOTRANSFER
Use Transfers user files to the cloud automatically. If not in a single sign-on environment, the user will be prompted for their cloud login. Note that the default OnRamp configuration will be used if a configuration file is not specified in the command-line (using the CONFIG command). Administrators should to configure OnRamp with the desired settings.
Must be used with Can be used by itself, but typically at least the CONFIG switch is used as well.
Example START /w OnRamp.exe /autotransfer
CONFIG
Syntax /CONFIG <fully qualified path to configuration file>
Use Specifies the configuration file to use when performing an autotransfer.
If the specified path to the configuration file is invalid OnRamp will terminate and return an exit code.
Must be used with Can be used by itself, but typically used with AUTOTRANSFER
Example START /w OnRamp.exe /autotransfer /config "\\MyServer\OnRamp\configuration.xml"
HIDESTATUS
Syntax /HIDESTATUS
Use Hides the progress dialog during a transfer. See also the related NOSTOP command.
Must be used with AUTOTRANSFER
Example START /w OnRamp.exe /autotransfer /HIDESTATUS
NOSTOP
Syntax /NOSTOP
Use Hides the Stop button in the progress dialog during a transfer. See also the related HIDESTATUS command.
Must be used with AUTOTRANSFER
Example START /w OnRamp.exe /autotransfer /NOCANCEL
Automation Example
With a good understanding of how the command-line parameters are used to automate a file transfer, the next step is to incorporate those command-line switches into an automated script. The following automation use case example is illustrated:
- Transferring Files for Logged On Users
The example includes a fully functional batch file along with a table that describes the commands being used to perform the operation.
| Note |
|---|
To save any of the examples as MS-DOS batch files, open Notepad and copy then paste the text. Select Save, change the Save as type to All files then change untitled to transfer.bat and select Save. |
| Note |
|---|
| The batch file examples in this section do not contain exit codes. The full list of supported exit codes is available under OnRamp Exit Codes. It is recommended that exit codes be included in each batch file that you develop. |
Transferring Files for Logged On Users
Description
Transferring files for a currently logged user is a common use case. In a non single sign-on environment, the user only needs to enter their cloud credentials. In a single sign-on environment the user is already authenticated when logging into Windows so there is no prompt for cloud credentials.
| Note |
|---|
| Unlike other tools, OnRamp does not require the files to be closed before transferring. However, it is advised to save any files before transferring to ensure files transferred are up to date. |
Process Example
Transferring the user files for the currently logged on user is a very straightforward process. Upon launching the process, the user will be prompted to log into their cloud account unless using single sign-on. Once the user begins the transfer process on their machine, they may continue to work. By automating the process, the user does not have to configure anything.
Transfer.bat File Example This Transfer.bat file can be used for each of the processes mentioned above to transfer files for the user. This example assumes that OnRamp was installed on the server “servername” and that the installation directory is shared as “OnRamp”.
@echo offecho Starting file transfer...START /w \\MyServer\OnRamp\OnRamp.exe /autotransfer /config \\MyServer\OnRamp\configuration.xmlIF ERRORLEVEL 1 (echo Transfer failed) ELSE (echo Transfer succeeded)
Transfer.bat File Definition (By Line):
| Line | Definition |
|---|---|
| Line 1 | Turns off the screen messages so the user does not see the commands in the batch file and is optional. |
| Line 2 | Display a progress message so the user knows what’s going on. |
| Line 3 | Starts OnRamp performing a file transfer using the specified configuration file and waits for the transfer to complete. |
| Line 4 | Performs a very simple check to see if the transfer succeeded or not (0 means success, anything greater than 0 means an error occurred) |
OnRamp Exit Codes
Exit codes are used during OnRamp automation to provide the technician performing the automation more information that can assist in resolving issues concerning the installation or operation of OnRamp.
OnRamp Application Exit Codes
| Exit Code | Description |
|---|---|
| 0 | The operation was successful |
| 1 | The user stopped the operation |
| 2 | Invalid command-line option |
| 3 | Configuration file not found |
| 4 | The license used is invalid, has expired, or all seats were used |
| 5 | Invalid cloud login |
| 6 | An error occurred communicating with the cloud server |
| 7 | Insufficient space on cloud server |
| 8 | Unable to access the cloud server |
| 9 | An unknown error occurred |