FileCatalyst...java –version which will return the version number. On Windows you may use the...
Transcript of FileCatalyst...java –version which will return the version number. On Windows you may use the...
FileCatalyst HotFolder
Quickstart
FileCatalyst HotFolder Quickstart
i
Contents
1 Installation ............................................................................................................................................ 2
1.1 Verify Java Version ........................................................................................................................ 2
1.2 Perform Installation ...................................................................................................................... 3
1.2.1 Windows ............................................................................................................................... 3
1.2.2 Mac OSX ................................................................................................................................ 3
1.2.3 Linux, Solaris, *nix ................................................................................................................. 3
1.3 Enable Service (Optional) .............................................................................................................. 3
2 First Run Wizard .................................................................................................................................... 4
3 Site Manager ......................................................................................................................................... 7
3.1 Add a New Site .............................................................................................................................. 7
3.2 Detect Bandwidth for Site ........................................................................................................... 11
4 Define a HotFolder .............................................................................................................................. 12
5 Bandwidth ........................................................................................................................................... 15
5.1 Bandwidth Scheduler .................................................................................................................. 15
6 Task Scheduler .................................................................................................................................... 17
6.1 Add a New Task ........................................................................................................................... 17
6.2 Transfer files................................................................................................................................ 18
6.3 Monitor Activity .......................................................................................................................... 19
6.4 Edit a Task ................................................................................................................................... 20
6.4.1 Overview of Edit Task Options ............................................................................................ 23
7 Remote Administration ....................................................................................................................... 24
7.1 Enable Features ........................................................................................................................... 25
8 Next Steps ........................................................................................................................................... 26
8.1 Enable Incremental ..................................................................................................................... 26
8.2 Widen transfer interval ............................................................................................................... 26
8.3 Read Documentation .................................................................................................................. 26
8.4 Complete the Demo Scenario ..................................................................................................... 26
9 Support................................................................................................................................................ 27
9.1 Online Support Portal ................................................................................................................. 27
9.2 Email ............................................................................................................................................ 27
FileCatalyst HotFolder Quickstart
ii
9.3 Telephone ................................................................................................................................... 27
FileCatalyst HotFolder Quickstart
1
Introduction
FileCatalyst HotFolder is the most commonly used of the FileCatalyst clients. HotFolder is a highly
configurable and feature-rich desktop application that combines the acceleration and
optimization of the FileCatalyst core technology, along with automation, monitoring and
bandwidth management. File transfers become as easy as saving to a folder that is already part of
an existing workflow.
This guide picks up where the FileCatalyst Server Quickstart leaves off; therefore it is assumed
that a FileCatalyst Server is already installed. By the end of the HotFolder Quickstart, you will be
able to:
1. Install HotFolder on any supported platform
2. Create a connection to the FileCatalyst Server
3. Define a directory to be used as a HotFolder
4. Schedule bandwidth usage
5. Execute an upload task
6. View transfer activity
7. Remotely administer your HotFolder
For the purpose of visualization, this guide invokes a real-world scenario, only one of many
possible ways to use HotFolder:
An example user’s HotFolder is configured to upload data to a server at a scheduled interval,
only sending files that are new or that have changed. Several other HotFolders monitor the
same server and automatically download new content. The example user only needs to place a
file in their defined HotFolder, and it is distributed to the rest automatically.
Let’s set up the sending user’s HotFolder, after which you will understand the fundamentals for
creating the receiving HotFolders.
FileCatalyst HotFolder Quickstart
2
1 Installation
FileCatalyst HotFolder is most commonly run as a desktop GUI application. The following
instructions assume that a windowed environment is being used for each operating system.
For Linux and other Unix-like systems, a basic understanding of using the command line is
assumed.
1.1 Verify Java Version
FileCatalyst will run on any Windows, Linux, OS X, or Solaris/Sparc computer that can run Java 1.8
or higher. Please visit http://java.com to get the latest version of Java for your platform. Oracle
JDK is recommended. OpenJDK and GNUJDK are not supported. MacOSX installers for FileCatalyst
products include an appropriate version of Java; verification is not required.
On every operating system including Windows, you may verify without a GUI by opening a
command prompt and typing the following:
java –version
which will return the version number.
On Windows you may use the operating system UI to find Java version:
In Windows
Control Panel
(Classic View),
locate and double-
click Java icon
Click “About”
on the General
tab.
1
2
FileCatalyst HotFolder Quickstart
3
1.2 Perform Installation
Note: if you have another instance of FileCatalyst HotFolder running, you must exit before
continuing with this guide. Be particularly careful to see if it has been started as a service, and
stop it accordingly.
1.2.1 Windows
1. Download the HotFolder installer (install_fc_hotfolder.exe) to your desktop
2. Double-click installer icon to launch install wizard (some versions of Windows will require
you to trust the application)
3. Step through the wizard to choose installation directory and shortcut options
4. At end of wizard, click “Finish”
5. Locate and launch the application from the Start Menu
1.2.2 Mac OSX
1. Download HotFolder installer for Mac (FileCatalyst HotFolder.pkg) and save it to Desktop
2. Double-click the package to begin installation
3. Step through the installation wizard:
a. When asked how to install, select "Install for all users of this computer"
b. Choose default installation location to place FileCatalyst HotFolder into the
Applications folder
4. At end of wizard, click “Finish”
5. Locate and launch the application from the Applications folder
1.2.3 Linux, Solaris, *nix
1. Create directory at /opt/utechsoft/hotfolder
2. Download tarball (fc_hotfolder.tar.gz) to this directory
3. Use GUI-based archive tool to unpack the tarball, or open a terminal and enter with the
following commands:
> cd /opt/utechsoft/hotfolder
> gunzip fc_hotfolder.tar.gz
> tar –xvf fc_hotfolder.tar
4. With the tarball unpacked, you will now have access to the README file. Open this file
and continue following the instructions in order to complete installation
5. Assuming installation is complete and you are in the HotFolder directory, enter the
command ./fc_hotfolder.sh to start the application.
1.3 Running as a Service
FileCatalyst HotFolder is most effective when run as a service. As a service, the application will
continue with automated tasks after the machine has restarted for any reason. After completing
the "Quickstart" document you are currently reading, you should consider referring to the main
documentation. The chapter "Running at Startup" describes the procedure to run the application
as a service for your given platform.
FileCatalyst HotFolder Quickstart
4
2 First Run Wizard
After installation of the FileCatalyst HotFolder , upon first execution, you will be presented with
the First Run Wizard. This wizard will take you through initial steps to set up your bandwidth
connection, add a site and a HotFolder and configure a task.
A welcome message
advises that a first run
wizard has been
launched. Click the
"Next" button to
continue.
1
If known, select the
expected speed of the
data connection for this
machine. Otherwise,
keep as "unknown".
2
FileCatalyst HotFolder Quickstart
5
A Site is the server your
FileCatalyst HotFolder
connects to. You will be
able to test these
settings after the
Wizard completes
3
If you have entered
valid site information, a
confirmation will
appear and you may
proceed. Otherwise
you must go "Back".
4
FileCatalyst HotFolder Quickstart
6
The HotFolder is the
location where your
data will come from
or synch to. Clicking
Next will create the
directory.
5
When completed you
are presented with
the summary. Click
Finish when satisfied
with the settings.
7
Configure the task for
upload or download,
as well as scheduling
and behaviour
options.
6
FileCatalyst HotFolder Quickstart
7
3 Site Manager
3.1 Add a New Site
Go to Site
Manager panel
1
Press “Add New
Site” button
2
FileCatalyst HotFolder Quickstart
8
The “Add New Site” Wizard will open in another window. Click “Next” on the introduction page to be
brought to the Site Settings page:
Enter a Site ID of your own
choosing.
3
Set the Host IP and Port
for your FileCatalyst Server
4
Uncheck box to
enable
authentication
5 Specify the username
and password for a
test user which already
exists on the Server
6
Click “Next” 7
FileCatalyst HotFolder Quickstart
9
Click “Finish” to add this
server to the list of Defined
Sites.
8
FileCatalyst HotFolder Quickstart
10
Defined Sites appear in this list.
An individual site may be
checked, edited, or deleted by
clicking the appropriate link in its
entry.
FileCatalyst HotFolder Quickstart
11
3.2 Detect Bandwidth for Site
You need not detect bandwidth if you are confident that your settings in Bandwidth Scheduler
(section 4 of this document) will regulate your connection. However, if you are connecting to a
site with unknown bandwidth characteristics, you may want to auto-detect.
Select “Site
Manager”
Click “Edit”
1 2
Choose “Network/
Bandwidth
Characteristics tab
Press “Detect”
button. Detection
may take a while.
4
3
Click “Apply” 5
FileCatalyst HotFolder Quickstart
12
4 Define a HotFolder
A “HotFolder” is simply any directory the user wishes to use as the source or destination for
uploads and/or downloads. At least one HotFolder must be defined before a task can be created.
You may find it helpful to create a directory in advance, or identify an existing folder you wish to
use for testing. You may also create a new directory from within the application itself.
The “New” wizard will launch. Click “Next” on the introduction page to be brought to the settings
page:
Go to HotFolders
panel
1
Press “New”
button
2
FileCatalyst HotFolder Quickstart
13
Enter a HotFolder ID of
your own choosing.
3
Set or “Browse” for a
HotFolder. This can be an
existing directory, or you
can create one from the
browse window by right-
clicking inside
4
Click “Finish” 5
FileCatalyst HotFolder Quickstart
14
Adding a directory to the Defined HotFolders list does not modify it in any way. Saving or
modifying files in the directory continues as usual and existing workflow does not need to change.
By defining a HotFolder, the user is simply showing the application where to find the files for
transfer.
Press “Close” to
exit wizard
7
Defined HotFolders appear in this list.
An individual HotFolder may be
browsed, edited, or deleted by clicking
the appropriate link in its entry.
FileCatalyst HotFolder Quickstart
15
5 Bandwidth
Although FileCatalyst Server is able to impose its own bandwidth limitations on users, the
HotFolder client application should also have its bandwidth usage set. By default, HotFolder uses
1 gigabit (1000000b).
5.1 Bandwidth Scheduler
The example user has far higher available bandwidth, and would also like to schedule lower usage
during the workday. Let’s start by changing the bandwidth for all time slots:
Once this step is completed, HotFolder will be set to always attempt to send at the selected rate
(in the example, user will select Fast Ethernet or 100,000 Kbps).
Click to go to
“Bandwidth” panel
1
Click and drag from
top-left cell to
bottom-right cell to
highlight every hour
of the week.
2
Right-click any cell
and choose new
bandwidth from
menu.
(click “Select Rate” for
same menu)
3
FileCatalyst HotFolder Quickstart
16
However, there may be times of the day during which lesser or greater bandwidth usage is
desirable. Our user only wishes to devote 50,000 Kbps to HotFolder during standard business
hours:
Now HotFolder will attempt to use 50,000 Kbps from 8:00 to 17:00; outside of these hours it will
attempt to use 100,000 Kbps.
Highlight only the hours
to be modified.
4
Enter new rate (eg.
50000) then click “OK”
6
Right-click any cell
and choose “Custom”
to reveal the Custom
Rate dialog
5
FileCatalyst HotFolder Quickstart
17
6 Task Scheduler
From the Scheduler pane, you may Add new tasks, Edit or Delete existing tasks, Execute or Cancel
tasks on-demand (overriding the scheduled intervals), and monitor a task’s Activity.
6.1 Add a New Task
Click to go to the
Scheduler panel
1
Click “New”
to launch Add
Task Wizard
2
FileCatalyst HotFolder Quickstart
18
With the settings seen above, the task will attempt to upload files from the HotFolder to the
Server, once every minute, during the days you define.
Note: Because the task is set to run every second, there will be near-continuous transfer activity.
This may be desirable in some cases, but more often the user will enable “Incremental” transfer
options (described in the user guide) which prevent the sending of files that have not changed.
6.2 Transfer files
Transfers are now enabled and will begin automatically. If you have selected or created an empty
directory to be your HotFolder, now is the time to drag, save, or copy some test files to this folder.
If you have chosen a directory which already contains files, no further action is required. Within
one second, you will see transfer activity in the Status column of the Scheduler pane.
Set a Task Name of
your own choosing
Select a Site
Select a HotFolder
Choose “Upload Files
to the Server”
3
5
4
6
Click “Finish” 9
By default, Schedule
will be None. Switch
to Always On for
continuous activity.
Select Scheduled
Execution to edit
the days the task
will run.
7
8
FileCatalyst HotFolder Quickstart
19
6.3 Monitor Activity
Individual tasks may be monitored:
Highlight task to
be monitored
Click “Activity”.
1
3
If a task is not
already running,
Click “Execute” to
force a transfer.
2
FileCatalyst HotFolder Quickstart
20
6.4 Edit a Task
Most of HotFolder’s advanced features are accessed by editing a scheduled task:
Metrics such as
transfer rates and
time elapsed /
remaining
Realtime graph
showing
bandwidth usage
over time
Text log of activity,
including information
such as filenames and
status of file integrity
checks
FileCatalyst HotFolder Quickstart
21
Click “Edit”
button.
Highlight task to
be monitored
1
2
FileCatalyst HotFolder Quickstart
22
“Task Settings” and “Schedule” tabs
reflect the basic options. The other
tabs provide additional control over the
transfer task.
Please read the FileCatalyst HotFolder
documentation for full descriptions.
FileCatalyst HotFolder Quickstart
23
6.4.1 Overview of Edit Task Options
Connection—set functions such as Protocol, Start Rate, Auto Resume and Progressive Transfer
Transfer—set File Verification, Priority and auto-start Transfer Activity monitor
Data Minimization—Enable Incremental transfers, Enable and adjust the level of Compression
and file exclusions for compression.
Fileset—set a remote folder for this transfer, File Filter to exclude or include file types and
Transfer Cache settings
Post Task—Choose what to do with the files after transfer, Execute a PostURL action, Enable
and configure E-mail alerts
FC Web—Configure the FC Web integration settings
FileCatalyst HotFolder Quickstart
24
7 Remote Administration
FileCatalyst HotFolder may be administered remotely, using either a thin client or a web applet.
Before you can take advantage of HotFolder Admin tool, your HotFolder must be properly
licensed. One exception: you may use HotFolder Admin to connect to HotFolder running as a
service on the same machine.
If your instance is eligible, your representative will have sent a HotFolder license key along with
the FileCatalyst Server license. Select “License Key” from the “Actions” menu and enter your key
into the appropriate field.
FileCatalyst HotFolder Quickstart
25
7.1 Enable Features
Remote administration options are availalable from the “Administration” area:
Enable web access and
specify an IP or domain and
port the remote user will
browse to.
Enable login and create
username/password for
the remote connection.
Enable the ability and
specify a port to use for
the connection.
1
2
3 “Apply,” which also
makes the web
access link clickable.
4
FileCatalyst HotFolder Quickstart
26
8 Next Steps
By the end of this guide, you should have completed the following:
Add a FileCatalyst Server as a new site
Define a directory to be used as a HotFolder
Tuned or scheduled your bandwidth appropriately for your environment
Created a basic upload task, which sends files from your HotFolder to an account on the
Server
Enabled Remote Administration
The best way to learn how to use HotFolder is to go ahead and configure some tasks and put
HotFolder into use to become familiar with it. Here are some starting points:
8.1 Enable Incremental
The Incremental feature is not enabled by default, meaning our test task will attempt to send ALL
files every second—which may be undesirable. To manage this constant stream:
1. “Edit” the appropriate scheduled task
2. Go to “Data Minimization” tab
3. Enable Incremental with the checkbox
4. Choose Incremental option:
a. Transfer Entire File (if file has changed, send it again in its entirety)
b. Transfer File Deltas (send only the parts of a file that have changed)
5. Click “Apply”
8.2 Widen transfer interval
1. Edit the appropriate scheduled task
2. Go to “Schedule” tab
3. If one-minute intervals are unreasonable for your environment, select “Scheduled
Execution” and modify it to transfer every hour, every day, or weekly.
8.3 Read Documentation
1. Under “Help” menu, select “Help Contents”
2. Read about each feature offered in FileCatalyst Direct
3. Modify or create new tasks in order to test options that interest you
8.4 Complete the Demo Scenario
Our example describes one user uploading files to the Server, with potentially hundreds of users
then downloading those files automatically. We have walked through the upload half of the
scenario; configuring the download half is nearly identical:
1. Install another HotFolder elsewhere if you can; otherwise use your existing one.
2. Add a new task in the same way already described; except, choose “Download Files From
the Server” for the transfer direction
FileCatalyst HotFolder Quickstart
27
3. Enable incremental and any other options you found useful or interesting during your
exploration.
9 Support
9.1 Online Support Portal
Support is available online at: http://support.filecatalyst.com
Available services include:
Submitting a trouble ticket
Searching the Knowledgebase for solutions to common questions
Live Chat
9.2 Email
FileCatalyst and Unlimi-Tech Software, Inc. may be reached at:
9.3 Telephone
Reach us by phone at:
main: +1.613.667.2439
toll-free: +1.877.327.9387
fax: +1.613.667.5950
Copyright © 2013 Unlimi-Tech Software, Inc.