Table of Contents


Introduction

FileCatalyst Server

FileCatalyst Server software is deployed wherever files are centrally managed and handles file and user management, security, transfer acceleration (up to 10Gbps), and other features. Since a FileCatalyst Server is the heart all FileCatalyst applications, FileCatalyst deployment can be expanded in any direction with perfect interoperability.

FileCatalyst Server help documentation is available here.

Web Administration

Although FileCatalyst Server is a desktop application, it can be managed remotely either with a Java-based Remote Administration tool or via this web-based tool.

This guide is intended to explain the FileCatalyst Server's Web Administration tool, walking the administrator through the interface in order to show how to configure and use FileCatalyst Server.

User Interface (UI) Overview and Conventions

The interface uses a common “vocabulary” of interactions. A quick look at the application's conventions should allow most administrators to get right into using the product as a whole.

Main Navigation

Administrative and configuration categories are found in the main navigation. When the viewport (ie. browser window) meets a minimum size requirement, this navigation is always visible as a vertical sidebar beside the main content area.

Sidebar Navigation

When the viewport is below a certain size threshold, the navigation becomes hidden in an off canvas menu, accessible by clicking the "hamburger" menu widget:

Mobile Sidebar Navigation

Main Content

As the user navigates the sidebar, the content in the main area changes, exposing the tools related to the navigation item.

Main Area

Within the main content area are a few additional control types to be aware of:

Sub-navigation

Drill down further into more specific configuration and information options by clicking through the sub-navigation items. In the large view, these appear as tabs: Main Area Tabs

In the small view, these become "accordion" panels. Clicking one will expand it into view: Main Area Accordion

Item Tools

Certain views contain tables of data. These tables typically represent lists of editable items, such as lists of users present on the system. At the end of each row is an icon which opens a pop-up menu enabling actions such as editing or deleting the item. Main Area Tabs

Directly below the main navigation are a few action buttons:

Sidebar Tools

Allows the administrator to sign out of the application and clear their credentials from the browser.

Note: It is possible to set FileCatalyst Server to not request credentials for local administration. In this case, the Sign Out button is replaced by a Refresh Session button, which clears the current session and refreshes the page.

Allows the administrator to visually pause updates to the UI. The application will be functioning as usual in the background, but the current view has its state paused. Activities which refresh data (such as sorting, page navigation, and editing individual items) will cause the latest version of the data to appear.

Opens this help document.

This link opens a new page displaying the FileCatalyst Server logs.

This invokes a pop-up dialog with information about installation environment and version.

About FileCatalyst

In addition to a Close button, the dialog also contains the Diagnostic Report button.

Diagnostic Report should only be pressed if requested by the support team, at which time it will create a package of files to be used during troubleshooting. No additional visual feedback is presented to the user after pressing the button.

This button appears in browsers other than Chrome and Edge (which do not support Java plugins), and only when the HotFolder Web Admin is viewed from within FileCatalyst Central. The button allows the administrator to launch a Java applet version of the Remote Administration tool directly within the browser.

Understanding Users, Groups, and Virtual Files / Folders

In the "Users" panel are 5 tabs which represent a series of interconnected pieces of information related to users. A user may belong to a group (for example), but a group is created independently from a user. Either groups or individuals may have access to configured virtual files and folders. Let's take a moment to examine how pieces of user data relate to one-another, and then we will explore the interface itself in the subsequent chapter.

User Accounts

FileCatalyst Users live at the application layer, and are managed by our internal database. Unlike standard UNIX FTP servers, you do not need to create a user at the OS level in order to utilize FTP access. If the user also exists on the operating system however, FileCatalyst Server can authenticate the user using external directory services such as Active Directory, LDAP or PAM.

FileCatalyst users by default are jailed to their home directories. This security feature ensures that a user cannot see data which does not belong to them (i.e. cannot see C:\Windows).

User Groups

For larger and more complex configurations, user groups are available. These allow administrators to easily map drive access to organizational roles (example: IT staff needs access to backups), and allow users to be assigned to one or more groups.

When assigning Virtual Files or Folders to either Users or Groups, permissions may also be granted. If multiple paths exist to a file or folder (example: John sees folder "project1" both through "IT" and "development" group), permissions are stacked for each access a user has to that file or folder.

Virtual Files / Folders

Virtual files and folders allow an administrator to create multi-pathed home directories, and give flexibility to allow users access to directories outside their locked user account paths. Virtual Files allow an administrator to give access to specific files outside of the users home directory.

Example: Bob requires access to project files stored in Y:/DEV in addition to files in his home directory. We can create a Virtual Folder called "project1" with a path Y:/DEV/. Once this is done, the Virtual Folder can be assigned to the user, where it will appear as a mounted subdirectory inside his home directory. Note that these labels will be case insensitive on a Windows machine. (i.e. "project1" is the same as "PROJect1")

Multiple virtual files and folders may be assigned to a user, each with assigned permissions.

Permissions

Permissions are assigned at a per-user or per-group level. When a user belongs to one or more groups, the higher permission level has precedence, creating a permissions "merge". For example, a user who does not normally have "Modify Files" belongs to a group that has "Modify Files". The user will now have "Modify Files" as long as they belong to that group.

The available permissions are as follows:

  • Download Files: If selected, the user has the ability to download files from the server. Note: Download with Incremental Delta's requires upload permission as part of the RSYNC algorithm (signature files).
  • Upload Files: If selected, the user has the ability to upload files to the server. This does not indicate that they can modify or overwrite files if they already exist. Note: Upload with Incremental Delta's requires download permission as part of the RSYNC algorithm (signature files).
  • Modify/Overwrite Files: If selected, the user is given permission to upload files, as well as modify existing files by overwriting, or performing file operations (chmod, etc).

    • Note: Some features require modify/overwrite permissions.
    • HTTP upload transfers need this enabled, as HTTP blocks are appended to a file and are considered "modified" rather than an original upload.
    • Transfers using auto-resume as an option require modify to be enabled, as resuming a partially transferred file is considered modification of an existing file.
  • Delete Files: If selected, the user is able to delete files from the server.
  • Rename Files: If enabled, the user is able to rename existing files on the server. Note: Upload transfers with temporary filenames require rename permissions to be enabled.
  • List Directories: If enabled, the user is given permission to browse the file system, and get directory and file listings. This is required for all FileCatalyst clients download option to work correctly.
  • Create Directories: If selected, the user will be able to create new directories on the server.
  • Modify Directories: If selected, the user is given permission to create new directories, and modify existing directories (chmod, etc)
  • Delete Directories: If selected, the user is permitted to delete existing directories from the server.
  • Rename Directories: If enabled, the user is able to rename existing directories.

Force File Ownership (Upload Only)

By selecting the "Force File Ownership" checkbox, all files transferred to the user will have their operating system user ownership set to the value specified. If the "Use user login" checkbox is selected, the FileCatalyst user's current username will be used instead of the specified value.

Note 1: On Linux or Mac OSX, an additional field allows configuring group ownership.

Note 2: Force File Ownership is currently only supported with internal file systems. All external file system transfers will not have their file ownership changed to the configured value.

Note 3: If the Maintain UID/GID system property is enabled, the user and group data will be updated to accept user and group identifiers. Please note that this functionality is only on Linux and Mac OSX operating systems.

Test Disk Write I/O Dialog

Test Disk Write I/O Dialog

Click "Start Test" to perform a sequential write operation to the user's home directory. Using a small file size will likely demonstrate only system/hardware cache availability. Select a larger file size to test and show true disk write speeds.

A maximum timeout value (seconds) can be set to ensure that the I/O test stops after a specified time. If the test was not able to complete before reaching the timeout, the last speed before stopping is returned, and all I/O resources are released back to the server.

Note: The test creates a temporary file on the disk. Ensure that enough space is available for the test.

Users Panel

Select "Users" from the main menu to load this panel into the main content area. The users panel has five sub-navigation tabs, exposing controls related to creating the "interconnected" user data described in the previous section:

  • User List
  • Groups
  • Files / Folders
  • User Defaults
  • Login Security

User List

Navigating to the User List tab exposes a table populated with user information:

User List

The table rows show "at a glance" data related to each user, including:

  • Username: A unique identifier for the user. The username is used throughout the system for activities such as logging in and user-specific statistics.
  • Full Name: Arbitrary text; by convention, a first name and last name combination.
  • Home Directory: The path on the server machine where this user's files are stored.
  • Enabled/Disabled: Rows highlighted with yellow and with italic text show disabled user accounts.
  • Blocked: The rows highlighted with red and with italic text show blocked user accounts.

Adding a User

Click the "New User" button above the table to invoke the "Add a new user" modal dialog:

Add a new user

Username, New Password and Confirm Password are required fields. However, if blank passwords are allowed, only the Username field is required.

After completing the form, click "Create User" to finalize adding a new user. To cancel creating a new user, click the "X" (close) icon in the upper right corner of the dialog.

Unblocking a User

When a user is blocked, that user's tool menu will show an "Unblock" action. Clicking on this action will unblock that user.

Deleting a User

Open an individual user's pop-up menu by clicking the icon in the right of the user's table row. Then select "delete". Upon successful deletion, the table will refresh with the user no longer present.

Connecting a User

Open an individual tab or window on the browser and load TransferAgent Express, connecting the selected user account to FileCatalyst TransferAgent.

TransferAgent Express is an application that uses FileCatalyst TransferAgent to execute transfers between a local machine and a FileCatalyst Server.

More information about TransferAgent Express can be found in the FileCatalyst TransferAgent documentation.

Note: Your browser may block these kinds of “popups”; if pressing the button does not show a new tab, please check your browser settings and pop-up blocker add-ons.

Editing a User

Open the user's pop-up menu by clicking the icon in the right of the user row. Then select "edit". This will invoke a modal dialog overlay containing tabbed sub-sections: General, Security, Groups & Folders, and Bandwidth / Quota. After making changes to any settings, click "Apply" to save the changes to the FileCatalyst Server.

The General tab contains most of the options available when adding a new user:

User General Config
  • Account Enabled: Toggle this checkbox to enable or disable an account.
  • Full Name: Strictly speaking, this field contains arbitrary text. By convention, administrators typically use it to store a user's real first name and last name.
  • Email: The email address is optional, but is used for activities involving notifications as well as for FileCatalyst WebLink functionality. Email address must be properly formatted.
  • Home Directory: The home directory of the user is the root directory to which they will have access. For example, if the user's home directory is specified as C:\Users\MyUsername\, they can access the MyUsername folder, and anything below it (e.g. C:\Users\MyUsername\MyNewDirectory).
  • Account Expiry: Accounts may be set to expire, at which time they become "disabled". Click the button to the right of the input field in order to invoke a date picker. The date picker itself has an additional "time" icon which may be clicked for fine-tuning to the minute. To modify an account to never expire, simply click into the input field and delete its contents.
  • Test Disk Write I/O: Opens a new dialog to request a sequential write operation to the user's home directory as described in the Test Disk Write I/O Dialog section.
  • Force File Ownership: Enable/disable force file ownership on files download by the user as described in the Force File Ownership section.

The Security tab relates mainly to permissions, but also contains the ability to update the user's password:

User Security Config
  • Update Password: Normally, the bottom radio button will be checked. To update the password, fill in the New and Confirm password fields, and then click Apply in the bottom right of the dialog to commit the new password. If blank passwords are allowed, the administrator will have to choose whether or not they want to set a blank password for the user before filling in a password, if needed. This is accomplished via the radio buttons.
  • Permissions: Toggle checkboxes or click on the shortcut buttons described below to give/rescind permissions for this user, at both file and folder levels, clicking "Apply" after all changes are made. Permissions details are described elsewhere in this document.

    • Select All : Shortcut that selects all permission for the user for both files and folders.
    • Read Only: Shortcut that selects only File Download and Folder List permissions.
    • Write Only: Shortcut that selects permissions normally required for a user which only needs to upload files to the server.
    • Clear: Removes all permissions to the user.

The Groups & Files / Folders tab allows the user to be assigned to one or more user groups, and one or more virtual files/folders. Instructions in the dialog itself show how to move groups and folders between "Available" and "Currently Assigned". Any items appearing in "Currently Assigned" are available to the user being edited.

It is also possible to reassign user permissions for individual virtual folders. (Note: For virtual files, read-only permission is always assigned.) Virtual folder permissions can be set to one of Read-only, Read-write or Advanced. If advanced is selected a secondary dialog will pop up allowing additional options. Permissions details are described elsewhere in this document.

Click "Apply" after making any changes.

User Folders and Groups

The Bandwidth / Quota tab allows administrators to restrict bandwidth usage at the account level:

User Bandwidth / Quota Config
  • Priority: This setting determines how much bandwidth will be allocated to a connected user in proportion to other connected users. The possible settings are High, Medium, and Low. The weight of each priority is 10, 5, and 1 respectively. The combined weights of all connected users are added together, and divided into the total available bandwidth of the server. The result is then multiplied by the weight of the user to determine the actual allocated bandwidth. For instance, if there is a high priority user and a low priority user connected, and the server is licensed for 100 Mbps, then the total priority is 11. Divided into 100000, this gives 9090.09 kbps. This means the low priority user will get 9.09 Mbps, and the high priority user will get 90.91 Mbps.

    If only one user is connected, they will be allocated all available bandwidth.
  • Impose Bandwidth Limit: Toggle whether or not the defined bandwidth limit is being used
  • Bandwidth Limit: This setting determines the maximum bandwidth for a particular user, regardless of what is allocated to them via the priority settings. This is useful if the available bandwidth of the end user is known to be a particular value. This ensures that all UDP transfers will never exceed that value. Although the end user also has the option to specify the maximum bandwidth on the client side, this might be easier.

    If the calculated bandwidth based on priority is higher than the maximum value specified in this setting, the difference will be re-allocated to all other connected users.

    This setting helps maintain fairness and still make optimal use of available bandwidth.

    Note on slower bandwidth settings (most noticeable below 100kbps) it may be necessary to lower the packet size of the udp transfers to get a tighter control over the limit due to the granularity effect packet size has on bandwidth throttling.
  • Impose Bandwidth Quota: Toggle whether or not the defined bandwidth quota is being used
  • Daily Bandwidth Quota (Upload only): This setting ensures that a user cannot upload more than the specified value in KB on a given day. A day is determined by the date settings on the server machine. Note that this is not a disk usage quota, but a fair usage quota. A user who has exceeded their quota is not necessarily blocked from transferring; however priority is always given to users with daily quota remaining.

Groups

Navigating to the Groups tab exposes a table populated with group information:

Groups

The table rows show "at a glance" data related to each group, including:

  • Group Name: A unique name given to the group. Administrators will ideally create meaningful names, as this name is sometimes used without an accompanying description.
  • Description: Long-form text description of the purpose of the group.
  • User List: A list of users who belong to the group.
  • Files/Folders: A list of virtual files and folders that are available to this group's users.
  • Assigned/Unassigned: A group's row that is highlighted with a grey background and italicized text indicates that the group is not assigned to any user.
  • Enabled/Disabled: Rows highlighted in yellow, with italic text show disabled groups.

Adding a Group

Creating a new group only requires a name and a description. Click the "New Group" button above the table and complete the form in the modal dialog that appears. After completing the form, click "Create Group" to complete group creation. To cancel, click the "X" (close) icon in the upper right corner of the dialog.

Groups

Deleting a Group

Open an individual group's pop-up menu by clicking the icon in the right of the group's table row. Then select "delete". Upon successful deletion, the table will refresh with the group no longer present.

Editing a Group

Open an individual group's pop-up menu by clicking the icon in the right of the group's table row. Then select "edit", which will invoke the Edit Group modal dialog. In addition to updating the Name and Description of a group, administrators are also able to toggle whether or not the group is Enabled.

Groups

Virtual Files / Folders

Navigating to the Virtual Files / Folders tab exposes a table populated with information on virtual folders and files:

Virtual Files and Folders

The table rows show "at a glance" data related to each virtual file/folder, including:

  • Label: A unique name given to the virtual file or folder.
  • Description: Long-form text description of the purpose or additional information about the file or folder.
  • Assigned Users: A list of users who have access to the file or folder.
  • Assigned Groups: A list of groups with shared access to the file or folder.
  • Assigned/Unassigned: A virtual folder that is not assigned to any user or group will be highlighted in grey with italicized text.

Adding a Virtual File or Folder

Upon clicking the "Add new virtual file or folder" button, a modal dialog containing a short form appears:

Groups

Label

This represents the sub-directory or file name a user will see in their home directory when logging into the system.

Description

Description of the file or folder. Useful for administrators to recognize the purpose of the virtual file or folder.

Path

Physical disk location on the server where this virtual file or folder is pointing. When the option "Local Files" is selected, this can be a local file or a full UNC path (i.e. "\\10.1.1.1\dir\"). When a external file system is selected, the path must contain the address to access the file or folder.

After completing the form, click "Create Virtual File or Folder" to complete creating the file or folder. To cancel, click the "X" (close) icon in the upper right corner of the dialog

Deleting a Virtual File or Folder

Open an individual item's pop-up menu by clicking the icon in the right of its table row. Then select "delete". Upon successful deletion, the table will refresh with the virtual file or folder no longer present.

Editing a Virtual File or Folder

The options are identical to "Adding a Virtual File or Folder" shown above, with the exception that the "Apply" button takes the place of the "Create Virtual File or Folder" button.

User Defaults

User Defaults allows the administrator to pre-define what configuration values a new user should have by default when created. These are a subset of the options presented when editing a user account, divided into the following sections:

  • Account Settings: Enable/disable new accounts by default, determine a root path (new accounts will use a folder within that path), and set a default expiry for new accounts.
  • Force File Ownership: Enable/disable new accounts to force file ownership on downloaded files as described in the Force File Ownership section.
  • Permissions: A set of default permissions, as described in the Permissions section.
  • Bandwidth / Quota: Default quotas and limits, as described in the Edit User section.

Login Security

Login Security

FileCatalyst Server can be configured to block user accounts and/or IP addresses which have been identified as having multiple consecutive failed login attempts. When the limit is reached, login failures are recorded in the application log files. If FileCatalyst Central is configured, alarms are also sent out notifying that a User account or IP address has had multiple consecutive login failures.

User Accounts

Failures are considered to be at the account level (based on incorrect credentials) and result in blocked accounts. Once user accounts have been blocked, they are highlighted and italicized in the User List. To re-enable, edit the user and toggle the "account enabled" checkbox.

  • Allow blank passwords: with this option enabled, users may be created with no password, and users logging in with such accounts may leave the password field blank.
  • Enable login blocking: with login blocking enabled, FileCatalyst Server can prevent brute-force attacks. Once enabled, the "Consecutive login failure limit" and "Time to block login" fields become available. With login blocking disabled, those fields are ignored.
  • Consecutive login failure limit: this field determines how many consecutive authorization failures must occur before an account is disabled.
  • Time to block login (seconds): once the consecutive failure limit is reached, the account may be disabled temporarily by setting a value in seconds, or permanently by setting a value of zero (0).

IP addresses

Failures are considered to be at the IP level (though still based on incorrect credentials) and result in blacklisted IPs, with the account itself remaining enabled.

  • Consecutive IP Failure Limit: this field determines how many consecutive failures from a single IP must occur before attempts from that IP are blocked.
  • Block IP: with this option enabled, once the failure limit is reached, the IP becomes blocked.
  • Time to block IP (seconds): once the consecutive IP failure limit is reached, the IP may be blocked temporarily by setting a value in seconds, or permanently by setting a value of zero (0).

Advanced Panel

This panel contains settings that go beyond daily usage. Currently there are three sub-section tabs available: Network, License and System Properties

Network Information

Network Information
  • Server Hostname/IP: FileCatalyst Server can bind server port to specific IP addresses hosted by the machine. By default, the server will try to bind to port 21 at 127.0.0.1.

    Note: In some situations the server will try and bind to an IP address that has not yet been initialized by the server. If you are experiencing this problem, you can add a bind timeout to allow more time to establish a bind. To add this value, you must add the following new line to system properties:

    Property Name:FCServer.server.config.bind.timeout, Property Value= TIME

    Replace "TIME" with the number of millisecond you wish to wait to establish a bind. The default is 30000.
  • Server Port:The port on which the server is listening for incoming connections. Clients connecting into this port should be aware that the data (including user/password) are non-encrypted, and can be intercepted on the network. This is maintained mostly for backwards compatibility with standard FTP. Default 21.
  • Secure Server Port: FTPS port, where connection data is encrypted using SSL. Default port 990. By default, a self-signed SSL certificate will be created at run-time by the application.
  • SFTP Port: SFTP port, where connection data is encrypted using ssh. Default port 22. Be aware this feature does not have any bandwidth throttling capability like the Secure Server Port or the Server Port, however transfer statistics are displayed normally. Also note that ssh shell commands are disabled for this feature but scp commands are not.

    Be aware that scp downloads are limited to one file at a time due to security limitations. Attempts to download complete folders will fail using scp command line.

    When using SFTP there will be additional logging, if you do not desire this additional logging you can turn it off in the FCConfig.conf, setting FCServer.server.config.sftp.logging.enabled = false
  • Data Port Range: The port range which the server can use for data connections.
  • Idle Timeout: The amount of time (in seconds) to remain idle before automatically disconnecting a client. This value defaults to 300 seconds or 5 minutes. Note that in some cases the client may be executing long running processes such as an MD5 or delta calculation on very large files and thus it may be necessary to increase this value.
  • IP Masquerade Address: When FileCatalyst server is running on a private IP address, behind a NAT device, you must specify the public IP of the NAT device in order for FileCatalyst to allow connections from outside the NAT.
  • Bypass IP Masquerade for local: By default, the IP masquerade applies to all connections. However, it may be desirable to bypass the masquerade address for local connections. A local connection is considered one whose IP address is within the 192.168.*.*, 172.16-31.*.*, or 10.*.*.* ranges.

License

License
  • Product Version: Current product version.
  • Request String: This string is provided by the product itself. The account representative will need this string in order to generate a working license key for your FileCatalyst Server instance.
  • License Key: Once you have been issued a license key, copy and paste it (ensuring you are not pasting any space characters at the beginning or end of the string) and press the "Apply" button.
  • Expires: The date when you license expires.
  • Bandwidth: Maximum transfer speed allowed by FileCatalyst Server. This is determined by your license.
  • Max # Connections: Maximum simultaneous connections allowed by FileCatalyst Server. This is determined by your license.
  • License Type: The type of license (eg., "FileCatalyst Enterprise License" or "FileCatalyst Demo License").
  • Product Features: Once a license has been successfully applied, a list of available features will appear in this area.

System Properties

System Properties

This tab allows the administrator to arbitrarily add "system properties" to the FileCatalyst Server configuration. System properties are generally considered to be power user fields and are only added under the guidance of FileCatalyst support staff, official knowledge base articles, or documented "tuning" processes.

To add a new system property, click the "New System Property" button. A pair of fields will appear, representing the key (or "name") and the "value" of the new system property. Click the check-mark button to finish adding the new system property.

Press the discard icon next to existing property value fields in order to remove it.

Email Panel

This panel contains settings to configure FileCatalyst Server to send email notifications

Email Settings

SMTP Settings

  • Admin Email: The email address which will be considered the "administrator" email address for the purposes of email notifications.
  • SMTP Server: The hostname of your outgoing mail (SMTP) server.
  • Port: The port which the SMTP server is running on. Typically port 25 for standard or 465 for secure servers.
  • Enable Authentication: If your SMTP server requires authentication, check this box and complete the username and password fields.
  • Username: If your server requires authentication to send mail, then enter the username provided by your system administrator.
  • Password: If your server requires authentication to send mail, then enter the password provided by your system administrator.
  • Use SSL: If your server requires SSL to send mail, then check this box.

With all fields configured, you may press the "Test Settings" button in order to check if FileCatalyst Server is able to successfully request an email to be sent from the SMTP Server. The test does not check for delivery; only for successful authorization and send attempt.

Email Alerts

  • Enable Email Alerts: If this is enabled and the user specifies from the client application to send alerts, an email will be sent to the address provided. Note that some SMTP servers have rules in place that may limit the recipient email address to a certain domain name. If you encounter issues configuring these settings please contact the administrator of your SMTP server.
  • Email Subject: Enter the subject that you would like all email alerts to have. The default subject for alert emails is "FileCatalyst Transfer Notification"
  • Send emails 'From' Admin email: This option determines who will receive email alerts once a transfer has finished. If this option is unchecked, all email alerts will sent to the email address specified within the Admin email text area. If the option is checked, all email alerts will be sent from the specified admin email to the client's email address

Overview

In an attempt to allow FileCatalyst clients a simple and easy method to send files to others, FileCatalyst provides clients with the ability create an email "link" that is sent out to a recipient list specified when the link is created. Upon receiving the link, the recipient will be able to open the email and activate the link by clicking on the URL specified within the email's content. Once a link is activated, a temporary user with no assigned home directory will be created on the server, and the recipient of the weblink will use this temporary user to access the files that are contained within the link. Temporary users created this way will automatically delete after the period of inactivity set by you in link settings.

Note: If IP Masquerade is enabled, all Links that are sent out by FileCatalyst Server will have their access IP replaced with the current masquerade address. If both the IP Masquerade and Use Host Name For Links options are enabled, the hostname will be used over the IP Masquerade address

Additional documentation can be found at the following locations:

  • Link User Guide contains basic overview on how to use the software to create and download a link.

Link Management

Link Management Screenshot

The link management tab allows you see all of the links that are currently stored within the server application. In addition, the table provided will allow you to view important information such as the link ID, which user created the link, how many times the link has been accessed by a client, the creation date of the link and the date the link expires on.

Note: When using FileCatalyst TransferAgent to download a Link, the "Link State" will be set to "COMPLETED" upon both full and partial downloads of the Link. When using HTTP Download, the state will only be set to "COMPLETED" when all files have been downloaded.

By clicking the icon in the right of the link table, the options to edit, delete or resend a Link are presented. When the option “edit” is selected, a pop-up dialog is invoked, containing the field reponsible for changing the expiration date of the selected Link.

Link Creation Settings

Link Settings Screenshot

Allow Clients To Set Link Expiration Options

Enable this option to give client applications the ability to set an expiration time on links. When a client specifies an expiry, the time must be smaller than the value found within the "Number of days that links will be stored" configuration option.

Delete Links After First Successful Download

Enable this option to cause the Server to delete Links after they are successfully downloaded.

Note 1: This setting applies to all current Links for as long this option is enabled

Note 2: A Link is considered to be downloaded when all files in the Link have been downloaded. If one or more of the files in a Link aren't downloaded, and the "Delete Links After First Successful Download" option is selected, the Link will delete/expire as normal.

Note 3: This setting takes precedence over "Allow Clients To Set Link Expiration Options". If both settings are enabled, a client application may only create single-use Links, but is still allowed to set a custom expiry date as per the description for "Allow Clients To Set Link Expiration Options" above.

Number Of Days That Links Will Be Stored

The number of days that a created link will stored. By default the amount of days that links are stored within the server is 7. However you may change this value to any value that is between 1 day and 31 days.

Number Of Days For Failed Emails Will Be Stored

The number of days a failed email will be stored for retry. The default failed email retention value is 2 days; however, you may change this value to any value between 1 and 5 days.

Number Of Minutes That Pass Before Inactive Temporary Users Are Removed

The number of minutes an inactive temporary user will be stored within the server. The default value is 20 minutes; however, you may change this value to any value between 1 and 60 minutes.

Use Host Name For Links

Hostname may be used instead of IP to give links a friendlier appearance, as well as to allow both internal and external users to access the application. If you wish to use a hostname instead of IP, check this box and specify a hostname in the provided field (ie. somemachine.yourdomain.com instead of default IP value).

Note: To function properly, the hostname must be able to be resolved by the recipients of the links. This is typically done through appropriate DNS entries, but may also be accomplished by the user editing their system (ie. a "hosts" file).

Enable Service Image

Enable this option and provide a valid image file (JPG, PNG, or GIF) in order to show the image in Link emails, as well as on the Link Creation and Link Download pages. In Link emails, the image is shown at the top of the email content; on the Link pages it appears at the top-left corner of the page.

Note: Updating these settings will not affect emails that have already been sent.

Note 2: On the Link Creation and Link Download pages the logo is vertically limited by the height of the navigation bar and horizontally by 125px.

Central Management Panel

This panel provides configuration options which allow the FileCatalyst Server to connect to FileCatalyst Central (formerly known as MonitoringAgent or MonitoringConsole) for remote inspection and control.

Central Management

Check the "Enable remote monitoring" option at the top of the panel, then complete the configuration in the following two panels:

Central

The details of the instance of Central are provided here, which ultimately allow the Server to establish the connection.

  • Address: Hostname or IP of the remote Central instance
  • Port: Connection port used by Central
  • User: A username used by Central to permit incoming connections.
  • Password: Paired with the username, a credential which Central uses to permit incoming connections.

Server

The details of this instance of Server are supplied here. Since Servers can respond to connections on various IPs, be sure to select the one that will allow an external application (Central) to have a line of communication to the Server. In other words, it should be an external IP resolving to this Server.

  • IP: From the list of available IPs, the one which Central will be able to use to establish a connection.
  • Hostname: A read-only view of which IP is being broadcast by FileCatalyst Server (usually via the IP Masquerade option).
  • Alias: A unique name which will make this Server easy to recognize within FileCatalyst Central.

Log Viewer

Sessions Table

The log viewer is a screen that holds log information. It contains 6 elements:

  • Log Container: main area containing the log text.
  • Refresh logs: a button to request the logs immediately (otherwise, logs are updated automatically every 5 seconds)
  • Change Order: change the chronological order of log entries (oldest or newest lines first). Hovering over the button indicates the current order.
  • Retrieve All Available: Will request up to 10,000 lines of logs at once.
  • Lines: Allows the user to specify the number of lines to retrieve with each request.
  • Pause/Resume UI: a button to pause/resume the logs updates on the UI. Note: logging will continue within the FileCatalyst Server itself, but the web UI will not receive updates while paused.

Monitor Panel

This panel contains tools for viewing transactions and usage on the FileCatalyst Server. Currently there are two sub-section tabs available: Sessions Table and Bandwidth Usage Graph

Sessions Table

This table shows an overview of any sessions that are currently active on the FileCatalyst Server:

Sessions Table

Visible columns are as follows:

  • Username: The unique name of the user associated with the session.
  • IP: The IP of the transfer client (eg. FileCatalyst HotFolder)
  • File: The actual name of the file currently being transferred. (In some cases, temp names are used; this column will show temp names rather than the original file name).
  • Status: The status of the current session (Idle, cancelling, etc) or in the case of in-progress transfers, the percentage, direction, and mode as a single string (eg. "87% - Receiving (UDP)")

Session Activity View

Select a session on the session table and select “Activity” from the row's tool menu. This will open the "Activity" view in a new tab or window.

Note: Your browser may block these kinds of “popups”; if pressing the button does not show a new tab, please check you browser settings and pop-up blocker add-ons.

Session Activity View

Session Clients Table

This table contains current information about each client of the selected session. It will show the session identification on the title. If the transfer is not in progress the table will be in an idle state. During transfer, it shows:

  • Client ID (sessions can have multiple clients or a “Master” client)
  • Elapsed Time
  • Filename
  • Status (either a progress in terms of percent, or a description of current activity such as "Calculating MD5")
  • Current RTT (latency)
  • Bytes Transferred
  • File ETA (estimated time of arrival)
  • Packet Loss (current)
  • Transfer Rate (current)

Note: If you are seeing a session with multiple clients the Show Overall Graphs and Logs will appear. When it is clicked the overall information for the session is displayed.

Graph, Visualization and Logs Menu

Select an appropriate tab in order to change the information displayed below. “Visualization” is only available for single transfer threads. In other words, it is considered always-on for single-client transfers; for multi-client, an individual client must be selected from the “Clients” table above.

Graph, Visualization and Logs Container

This container shows information relevant to the currently-selected tab.

“Graph” contains a line graph of effective and current transfer rate (in kbps):

Activity View Graph

“Visualization” is bundle of information representing resource usage for Source and Destination:

Activity View Visualization

“Logs” shows the current logs for the task. Logs can be filtered by using the search form at the top of this container:

Activity View Logs

Bandwidth Usage Graph

This graph provides a virtually real-time view of incoming and outgoing data to and from the FileCatalyst Server.

A legend describes the X and Y axes, as well as the direction of the data flow.

Sessions Table

Performance Tuning

The FileCatalyst Performance Tuning documentation can be found here

Support

Support System

Visit our support website at https://support.filecatalyst.com to view the knowledge base and to submit a ticket (Available 24/7).

If you have already submitted a Ticket and would like to send us your case files please go to https://support2u.filecatalyst.com to upload them. A valid Ticket ID will be required.

Chat, Email and Phone Support

Live Chat: Visit our website at httsp://support.filecatalyst.com - Available on Monday to Friday from 7 AM - 7 PM Eastern Time Except for Statutory Holidays

Email: support@filecatalyst.com - Typical response time is one business day

Phone: +1(613) 667-2439 or +1 (877) 327-9387 - Available on Monday to Friday from 7 AM - 7 PM Eastern Time Except for Statutory Holidays