Overview

FileCatalyst Central has two types of User Accounts, these accounts are an Admin level and User level. Both accounts store their username and password in the FileCatalyst Central configuration file. Passwords for both accounts are not visible in clear text and are converted to a hash value, however, the account names are visible in clear text. The configuration file is not accessible to anyone who does not have access to the filesystem where FileCatalyst Central is installed. The Admin User Account gives full control over the Web User Interface and Configurations page.  This article will outline how to identify the Admin Username, change the Admin Username if desired and how to reset the Admin User password temporarily. All changes that are made to the Admin Account and the configuration file should be performed from the machine that hosts FileCatalyst Central.

Environment

FileCatalyst Central v3.5 and later.

Resolution

1. Identify or Change Admin Username
   
   There are two ways to identify and change the Admin User Name. If you have access to the Web Interface you will know what the Admin Username is since you will be able to login. If you do not know what the Admin Username is you can retrieve it from the FileCatalyst Central configuration file (maconfig.conf) and it can be changed directly from this file. Use the following instructions to confirm or modify the Admin Username:
   
   
   1. Shutdown the FileCatalyst Central Service. You can verify this by trying to access the FileCatalyst Central instance from a web browser.
   2. Create a copy of the configuration file (maconfig.conf) for recovery purposes.This file can be found in the installation directory of FileCatalyst Central.
   3. Using a text editor, open the maconfig.conf  configuration file. 
   4. Locate the for a parameter called FCMonitoringAgent.config.wac.admin.user.username. The value that this parameter is set to will indicate what your username is. By default it is admin and the parameter will look like:
      
      FCMonitoringAgent.config.wac.admin.user.username=admin
      
      If you would like to change the Admin Username enter the account name after the equal sign. For example, if you want your new Admin Username to be newadmin, the parameter would look like:
      
      FCMonitoringAgent.config.wac.admin.user.username=newadmin
      
   5. Save your changes and close the editor.
   6. Start the FileCatalyst Central Service.
   7. Access FileCatalyst Central from a web browser, if you are on the machine hosting it you can use http://127.0.0.1:8080/login.jsp.
      
      
2. Change Admin Password
   
   The Admin Password can be changed from the Web UI and the configuration file (maconfig.conf), however, unlike the Admin Username, you will not be able to view it in plain text from the configuration file. This can only be made to the configuration file directly and it is recommended to perform this change from the machine that is hosting FileCatalyst Central. If you have misplaced your password or need to reset it follow these steps:
   
   
   1. Shutdown the FileCatalyst Central Service. You can verify this by trying to access the FileCatalyst Central instance from a web browser.
   2. Create a copy of the configuration file (maconfig.conf) for recovery purposes.This file can be found in the installation directory of FileCatalyst Central.
   3. Using a text editor, open maconfig.conf file.
   4. Locate a parameter called FCMonitoringAgent.config.wac.admin.user.password. It will probably have a has value assigned to it and look similar to:
      
      FCMonitoringAgent.config.wac.admin.user.password=AES_3368667a38326631e73b11ac9c6c0061f7dfbe4af95085be
      
      Change this parameter back to the default entry of admin. This will be temporary. The new command should look like:
      
      FCMonitoringAgent.config.wac.admin.user.password=admin
      
      
   5. Save your changes and close the editor.
   6. Start the FileCatalyst Central Service.
   7. Access FileCatalyst Central from a web browser, if you are on the machine hosting it, you can use http://127.0.0.1:8080/login.jsp
   8. Login using the username admin and the password admin.
   9. Hover over the gear icon on the top right-hand corner of the page and select Configuration.
   10. Under the Web Administration Configuration section you can change your Admin Username and Admin New Password. Please note the field Admin Password is checking for your current password, enter the password from Step d there.
   11. Hit the Apply changes button.
   12. If you re-open maconfig.conf in a text editor, you will notice that FCMonitoringAgent.config.wac.admin.user.password parameter will now have a hash value assigned to it.

Overview

The FileCatalyst Direct Suite has the ability to specify a version of the Java Runtime Environment to use when launching the application as a service. Some common issues that are reported to the Support Team are:

• Application stalls.
• Abnormal service termination.
• The application does not launch or exits abruptly.
• Windows Service Manager Error 1067: "The process terminated unexpectedly".

The FileCatalyst Server, HotFolder and Central deployments can be installed as a Windows Service. If the current version of Java is updated while the application service is still active the corresponding application will experience a crash and the service will not cycle properly.

All FileCatalyst Direct Suite applications can be run in standalone mode and can experience the symptoms described above. However, the applications that run in standalone mode will pull the Java Path from the Windows Environment.

This article will provide a walkthrough on how to modify the current path to the Java command in your deployment for applications running as a service. The following instructions only apply to Windows systems and may require elevated user privileges. The resolution section is sorted by product. 

Environment

FileCatalyst Direct Suite v3.4 and later.

Resolution

For the following solutions to be deployed correctly, all FileCatalyst applications and services must be shutdown as the configuration files will be modified. Before we proceed to modify the configuration files verify the Windows Environment has a valid installation of Java RE or Java DK. 

1. Java Installation and Verification
   
   
   1. Open the Command Prompt and run the following:
      
      java -version
      
      The expected output from the command should look like:
      
      C:\WINDOWS\system32>java -version
      java version "1.8.0_91"
      Java(TM) SE Runtime Environment (build 1.8.0_91-b14)
      Java HotSpot(TM) 64-Bit Server VM (build 25.91-b14, mixed mode)
      
      Note the version of Java may vary between installations and when the Java RE or Java DK package has been installed.
      
      
   2. If you did not receive and output similar to step 1a, download a Java RE or Java DK package from: http://www.oracle.com/technetwork/java/javase/downloads/index.html.
      We recommend using a Java with x64 architecture. After the installation is complete retest step 1a.
      
      
2. Java Path Configuration for FileCatalyst Applications
   
   
   1. FileCatalyst Server
      
      
      1. Shutdown the FileCatalyst Server service and any FileCatalyst Server Remote Admin applications.
      2. Navigate to the FileCatalyst Server installation directory. By default, it is installed in C:\Program Files\FileCatalyst Server\.
      3. Open the configuration file fcconf.conf in a text editor.
      4. Locate the Java Command. It will be located under the Wrapper Properties section and will look like:
         
         wrapper.java.command=C:/Program Files/Java/jre1.8.0_91/bin/java
         
         If you would like to use a specific Java version specify the path after wrapper.java.command=. Since the Java installation was verified in step 1, we recommend using the path that the Windows Environment recognizes to the Java Application. The property should look like:
         
         wrapper.java.command=java
         
         
      5. After your changes are made to the wrapper.java.command, save the file and close the text editor. On the next launch of the FileCatalyst Server (service or standalone) the new Java path will be pulled.
         
         
   2. FileCatalyst HotFolder
      
      
      1. Shutdown the FileCatalyst HotFolder service and any FileCatalyst HotFolder Remote Admin applications.
      2. Navigate to the FileCatalyst HotFolder installation directory. By default, it is installed in C:\Program Files\FileCatalyst HotFolder\.
      3. Open the configuration file fchf.conf in a text editor.
      4. Locate the Java Command. It will be located under the Wrapper Properties section and will look like:
         
         wrapper.java.command=C:/Program Files/Java/jre1.8.0_91/bin/java
         
         If you would like to use a specific Java version specify the path after wrapper.java.command=. Since the Java installation was verified in step 1, we recommend using the path that the Windows Environment recognizes to the Java Application. The property should look like:
         
         wrapper.java.command=java
         
         
      5. After your changes are made to the wrapper.java.command, save the file and close the text editor. On the next launch of the FileCatalyst HotFolder (service or standalone) the new Java path will be pulled.
         
         
   3. FileCatalyst Central
      
      
      1. Shutdown the FileCatalyst Central service.
      2. Navigate to the FileCatalyst Central installation directory. By default, it is installed in C:\Program Files\FileCatalyst Central\.
      3. Open the configuration file mawrapper.conf in a text editor.
      4. Locate the Java Command. It will be located under the Wrapper Properties section and will look like:
         
         wrapper.java.command=C:/Program Files/Java/jre1.8.0_77/bin/java
         
         If you would like to use a specific Java version specify the path after wrapper.java.command=. Since the Java installation was verified in step 1, we recommend using the path that the Windows Environment recognizes to the Java Application. The property should look like:
         
         wrapper.java.command=java
         
         
      5. After your changes are made to the wrapper.java.command, save the file and close the text editor. On the next launch of the FileCatalyst Central Service, the new Java path will be pulled from the system.

Overview

Setting the JAVA_HOME path in the environmental variables on the Windows local machine.

Environment

Windows Environment.

Java v7.0 JDK or JRE.

Resolution

1. Open the System Properties. Right click on My Computer and click Properties.
2. Click Advanced System Settings on the left side.
3. Hit Advanced Tab on the top menu and click on the Environment Variables button.
4. Go to System Variables section, find the PATH variable, highlight it and click Edit.
5. Add the location of the Java install to this list.  Ensure that there is a ; between the path values.
6. Click New, give the new variable with the name JAVA_HOME and a variable value as C:\ top level directory of your Java installation. A sample path would be C:\Program Files\Java\jdk1.8.0_73\bin.

Note

Some of the steps above will differ from one version of Windows to the next. The core steps are the same some sections may be labeled differently.

Overview

This is a known issue with our Development Team and has been fixed in FileCatalyst Hotfolder v3.5 and FileCatalyst Central v3.5. 

Original Issue:

When connecting a FileCatalyst HotFolder v3.4 or v3.4.2 to  FileCatalyst Central, the following message appears:

HotFolder is Connected to Central but is not Licensed for Alarms

In addition, the FileCatalyst HotFolder raises two alarms in FileCatalyst Central for each connected HotFolder:

- LicenseExpired (critical)
- LicenseExpiring (minor)

Despite the alarms and the error message, the HotFolder will function as expected in Central.

Both FileCatalyst Hotfolder Remote Admin Application and alarms will function properly in Central even if the license key is not present on the HotFolder.

Environment

FileCatalyst Hotfolder v3.4 and v3.4.2.

FileCatalyst Central v3.4.2.

Resolution

To remove this error and the alarms, a proper license key must be applied on the client side for each HotFolder that is connecting to Central. 

Overview

If you run into issues while using a FileCatalyst Web Application (such as Workflow, Central, and TransferAgent) or certain Unlimi-Tech transfer applets, there are two important reasons for knowing how to view and understand the JavaScript console:

1. The support team may ask for additional information, such as the errors being reported.
2. To spot any errors you may have introduced in a configuration file.

Environment

FileCatalyst Workflow v4.9.4 and later.

FileCatalyst TransferAgent Deployment Package v3.5 and later.

FileCatalyst Central v3.5 and later.

Resolution

Opening the console:

1. Google Chrome
   1. Click the Menu icon.
   2. Cursor down to the More Tools fly-out menu.
   3. Open Developer Tools.
   4. On the top menu bar in the Developer Tools Window, click on Console.
      
      
2. Firefox
   1. Click the Menu icon.
   2. Select Developer.
   3. Open the Web Console.
      
      
3. Safari
   1. The Open the Tools from Safari, they must first be enabled:
      1. Open Safari Preferences.
      2. Switch to the Advanced Pane.
      3. Check the Show Develop Menu in Menu Bar check box.
         
         
   2. After the step above, the Web Inspector will be available. You can add it to the menu bar with Customize Menu Bar, which will create a quick-access icon. Or you can fire it up the longer way:
      1. Select Develop from the main menu.
      2. Click on Show Error Console.
         
         
4. Internet Explorer 9 and later:
   1. Open the Tools menu, in compact view, this looks like a gear cog.
   2. Select F12 Developer Tools.
   3. Switch from the DOM Inspector to the JavaScript console by clicking the Console.

Catching errors:

• If there are errors in the JavaScript, they should be prominently visible in the JavaScript console. Once it is opened, you may clear it to start with a fresh view, and then refresh the page and step through your failure scenario. At the point of failure, if it is a JavaScript issue, you will see an error reported, generally with red text to emphasize the fact that it is an error.
• Errors come with text that is meant to be as meaningful as possible, and an additional link is supplied which will take you to the source of the error. For example:
  
  Uncaught ReferenceError:   someFunction is not defined    main.js line 1566
  
  
• The application is trying to use a piece of code called someFunction but it doesn't exist. At the right, you can generally click the main.js line 1566 and the view will change you to a view of the JavaScript with the questionable function highlighted for you.

Configuration errors:

• Configuration errors will appear the same way. JavaScript doesn't know that it was a typo in configuration; it just knows that some JavaScript failed. However, when the error refers to problems within a configuration file, the error occurs in configuration.js line 23, it is worth considering that the problem may have been introduced during the configuration phase.
  
  
• When a Configuration is handled by the JavaScript, it must still follow JavaScript conventions and rules. Here are some common culprits:
  
  
  • Missing Commas:
    The items in a list of configurable parameters might be done with a bunch of key-value pairs. These are identified by the key:value pattern (a colon separating them) and the entire pair is separated from the next with a comma. Here is an example that contains an error:
    
    var config = {
      name: "Server 1",
      hostname: "myserver.site.com"
      port: 21
    }
    
    The missing comma after the hostname means that the rest of that Configuration variable will be dropped. The application probably expects a port value, and when none is found, it will send an error to the JavaScript console.
    
    
  • Missing Semicolons:
    In some cases, configurable parameters are each individual variables. They follow a parameter=value; pattern, often preceded by var. JavaScript interpreters are a liberal with semicolons, but sometimes a missing semicolon can introduce errors. Here is an example that might break in some browsers:
    
    var name = "Server 1";
    var hostname = "myserver.site.com"
    var port = 21;
    
    
  • Incorrect Type of Information:
    The Configuration document will describe the type of value expected. Typically, JavaScript comments (//) also reinforce the type. Types used in FileCatalyst Configuration files tend to be:
    
    
    1. String: is text surrounded by quotation marks.
    2. Boolean: is true or false, not surrounded by quotation marks.
    3. Integer: is a number, not surrounded by quotation marks.

When the wrong type is provided, JavaScript can break. Here is an example in which every line is correct:

var config = {
  hostname: "myserver.site.com", // string 
  port: 21, // integer
  autoconnect: true //boolean
}

and here is the same example with every line incorrect:

var config = {
  hostname: myserver.site.com, // supposed to be a string, but quotation marks are missing 
  port: "21", // supposed to be an integer, but the quotation marks indicate it's a string 
  autoconnect: "true" // again, the quotation marks change this from a boolean to a string
}

Overview

Behaviour:

Trying to open the FileCatalyst Central Administration page results in Central encountering a 500 error in the web browser. This occurs after installation of Java Version 8 Update 91 or higher on Linux or Windows Environments. MAC OSX users are unaffected by this update of Java 8.

Exception:

org.apache.jasper.JasperException: Unable to compile class for JSP: 

An error occurred at line: 1 in the generated java file
The type java.io.ObjectInputStream cannot be resolved. It is indirectly referenced from required .class files

Stacktrace:
        org.apache.jasper.compiler.DefaultErrorHandler.javacError(DefaultErrorHandler.java:97)
        org.apache.jasper.compiler.ErrorDispatcher.javacError(ErrorDispatcher.java:330)
        org.apache.jasper.compiler.JDTCompiler.generateClass(JDTCompiler.java:457)
        org.apache.jasper.compiler.Compiler.compile(Compiler.java:374)
        org.apache.jasper.compiler.Compiler.compile(Compiler.java:352)
        org.apache.jasper.compiler.Compiler.compile(Compiler.java:339)
        org.apache.jasper.JspCompilationContext.compile(JspCompilationContext.java:601)
        org.apache.jasper.servlet.JspServletWrapper.service(JspServletWrapper.java:344)
        org.apache.jasper.servlet.JspServlet.serviceJspFile(JspServlet.java:389)
        org.apache.jasper.servlet.JspServlet.service(JspServlet.java:333)
        javax.servlet.http.HttpServlet.service(HttpServlet.java:722)

Environment

Windows and Linux OS.

FileCatalyst Central all versions.

Java Version 8 Update 91 or higher. (JRE or JDK) 

Resolution

1. Turn off the FileCatalyst Central Service.
2. Install an older version of Java, older than version mentioned in the Environment.
3. Point the FileCatalyst Central folder Java Path in the mawrapper.conf to the correct Java path. 
4. Search for wrapper.java.command=
5. Replace this path after the = to point to the older <path to Java Install>\Java\bin\ version. For example:

   # Java Application
   wrapper.java.command=C:\Program Files\Java\jdk1.8.0_73\jre\bin\java

6. Start the FileCatalyst Central service.

Note: 

Most machines will probably be using the JRE.  Confirm your environment and choose the appropriate version.

See http://www.oracle.com/technetwork/java/archive-139210.html for older versions of Java.

Overview

This article describes how to update the .jar files in FileCatalyst Central to remedy the Java Application Blocked message that Administrators receive when trying to launch the Remote Admin Applet in Central.

The Java message or pop-up is generated from a failed check for a security certificate. Our web based Java Applets and Applications are signed for 2 years from the date of the build. For the purposes of this article, any FileCatalyst Application connecting to FileCatalyst Central is referred to as a node.

Environment

FileCatalyst Central v3.6 and older.

Resolution

1. Determine what version of the .jar files you need for the nodes that are connecting to the FileCatalyst Central deployment. In Windows, look in the \FileCatalyst Central\www\Web Console\<client application> for all connected applications. Each folder in this directory will reference the version of FileCatalyst Application that Central has communicated with.  Or look in the nodes section in FileCatalyst Central.
2. Shut down the FileCatalyst Central service.
3. Rename the old applets to something different. Change the extension of the current .jar file to .jar.old. For example, the file FileCatalystHotFolderAdminApplet.jar would be renamed to FileCatalystHotFolderAdminApplet.jar.old. See the addendum at the bottom of the page.
4. Download the appropriate version of the applets that you need from http://ca1.filecatalyst.com/download/archive/resignedApplets_2016/. You will need to obtain the user-name and password to this location by logging into your account at http://support.filecatalyst.com/.
5. Transfer the files to the appropriate directory for the version of the application you require from #2 above.
6. Rename the new files and remove the build version portion of the name, for example, v3.5_build9_AppletLoader.jar to AppletLoader.jar.
7. Replace the current AppletLoader.jar file from the \FileCatalyst Central\www\Web Console\lib with the AppletLoader.jar file from the previous step.
8. Clear the Java cache from the system that is accessing the respective Remote Admins. This step has to be performed on all computers that use FileCatalyst Central. Go to https://www.java.com/en/download/help/plugin_cache.xml for a detailed guide.
9. Reopen the browser and clear your browser cache Ctrl-Shift-Delete (Windows) or Command-Shift-Delete (Mac)
10. Restart the FileCatalyst Central service, this may take a few seconds.
11. Log into Central as normal and test the Remote Admin Applets from the Nodes page.

Note: 

Default location and names of the Applets.

• FileCatalyst Central
  Be aware this is different than the AppletLoader.jar files contained in the application location.
  
  
  • Location: \FileCatalyst Central\www\Web Console\lib\
  • Filename: AppletLoader.jar
    
    
• FileCatalyst Server
  
  
  • Location: \FileCatalyst Central\www\Web Console\FCServer\Default\ 
    Each build within this location is contained in a seperate folder.
    
    
  • Filenames: AppletLoader.jar and FileCatalystServerAdminApplet
    
    
• FileCatalyst Hotfolder
  
  
  • Location: \FileCatalyst Central\www\Web Console\HotFolder\
    Each build within this location is contained in a separate folder.
    
    
  • Filenames: FileAppletLoader.jar and FileCatalystHotFolderAdminApplet.jar

Overview

This article will outline how to force FileCatalyst Central to redirect all traffic to use an HTTPS connection.

Environment

FileCatalyst Central v3.6 and later.

Resolution

To force a redirect of all traffic to HTTPS automatically, we need to edit the web.xml file. 

1. Shutdown the FileCatalyst Central Service.
2. Open the web.xml file in a text editor. It is located in /<path to FileCatalyst Central>/FileCatalyst Central/www/Web Console/WEB-INF/. 
   A sample path in the Windows Environment is, C:\FileCatalyst Central\www\Web Console\WEB-INF\.
   
   
3. Edit the web.xml and add the following lines above the last </web-app> (closing element):
   
     <!-- Require HTTPS for everything except /img (favicon) and /css. -->
     <security-constraint>
         <web-resource-collection>
             <web-resource-name>HTTPSOnly</web-resource-name>
             <url-pattern>/*</url-pattern>
         </web-resource-collection>
         <user-data-constraint>
             <transport-guarantee>CONFIDENTIAL</transport-guarantee>
         </user-data-constraint>
     </security-constraint>
     <security-constraint>
         <web-resource-collection>
             <web-resource-name>HTTPSOrHTTP</web-resource-name>
             <url-pattern>*.ico</url-pattern>
             <url-pattern>/img/*</url-pattern>
             <url-pattern>/css/*</url-pattern>
         </web-resource-collection>
         <user-data-constraint>
             <transport-guarantee>NONE</transport-guarantee>
         </user-data-constraint>
     </security-constraint>
   
   
4. Save and close the web.xml file and restart the FileCatalyst Central Service.

Overview

With the release of File Catalyst Direct 3.0.1, Central will provide the ability to enable external access to its database of transfer information.

First, a little basic information: Central uses a Derby database to store its data. This means that whatever tool you are planning on using to access the database will need to be able to interact with Derby. In order to do this, the tool must be able to use the Apache Derby Client driver (http://db.apache.org/derby). Our preferred client is a free Java based tool called SQuirreL SQL Client (http://www.squirrelsql.org/), which includes the Apache drivers by default. This is the tool that will be used in this guide. However, you can use any tool that supports the driver. You will just need to adjust your set up as appropriate for your chosen tool.

WARNING: The FileCatalyst Central Database is a critical component of the deployment and by connecting to it you are directly modifying it. We strongly recommend making a backup of the deployment before making any modifications. We will not be able to revert any changes that are being made in error.  

Environment

FileCatalyst Central v3.5 and later.

SQuirreL SQL Client.

Windows Environment.

Resolution

1. Connecting SQuirreL to FileCatalyst Central DB.
   
   The first step is to configure Central to provide access. Currently, the configuration UI of Central does not allow for configuration of the database access, so we need to make the changes directly to the MAConfig.conf file which can be found in the install directory of FileCatalyst Central. Follow these steps to make the changes to this file:
   1. Shutdown the Central Service using the Service Manager (Services.msc).
   2. Once Central is shut down, open MAConfig.conf in a text editor and scroll down to the bottom. You are looking for the parameters:
      
      
      • FCMonitoringAgent.config.allow.external.database.access: This parameter determines whether or not the database will be accessible or not. Set it to equal true.
        
        
      • FCMonitoringAgent.config.derby.drda.host: This value is the address that remote hosts must use to connect to the database. It defaults to localhost, if no value is set, then it will prevent any non-local access to the database. This value can be any address that points to the FileCatalyst Central. If you wish to allow anyone access, as long as their address points to the correct machine, the value must be set to 0.0.0.0. In this case, the network server will listen on all interfaces.
        
        
      • FCMonitoringAgent.config.derby.drda.portNumber: This value is the port which clients use to connect to the server. The default value is 1527. This is the standard port for Derby databases. You can use any port number here that is available on the machine.
        
        
      • FCMonitoringAgent.config.external.database.username: This value is the username used for remote access. The default value is username. Because this value is loaded in from the configuration file and is not encoded in any way, it is limited with the characters that it can accept. It is recommended that you use a simple string of alphanumeric values. When this information can be modified from the UI, it will be encoded and thus able to be a more complex string.
        
        
      • FCMonitoringAgent.config.external.database.password: This sets the password for the remote access and defaults to password. It has all the same limitations as the username.
        
        Note: As with any FileCatalyst Central configuration value, if the values are not present in maconfig.conf, they will be set to the defaults.
        
        
   3. Once you have your values set, you can restart FileCatalyst Central service.
      
      
2. Configuring a connecting client.
   
   
   1. For this article, we will be using SQuirreL as the client, but the basics should be similar for any client that supports the Derby driver.
      
      
      • In SQuirreL, we want to Add an Alias. This is what the new alias dialog looks like: 
        
        
        
        
      • As you can see in the illustration above, most of the values are pretty straight forward. The URL, however, is a little complicated because it contains most of the information that is used to connect to the database:
        
        jdbc:derby://<server>:<port>/<databaseName>;<URL attribute>=<value>
        
        
      • Here is an example of an alias tha thas been filled out:
        
        
        
        
      •  Click Test to verify your connection and that it is connecting successfully. Hit OK when the test is complete. At this point you should see the Name you entered in the aliases list:
        
        
        
        
      • Double click on the Alias and SQuirrL will open and Auto Logon to the database. This opens a tab that shows the contents of the database.
        
        
        
        
      • The only branch on the tree that we need to concern ourselves with is the MONITOR_DB branch. As mentioned above, this is the name of our database and this branch contains all of the tables with our data under TABLE. However, before we are able to access our data, we have one more step.
        
        In Derby, the database assumes that you want to connect to a schema within the database that is the same as the username you have used to connect. In this case, it assumes that we want to connect to a schema within the database named USERNAME as that’s the username we used in the MAConfig.conf. Not only is this not the schema we want, it doesn’t even exist. While we can open the schema with the above viewer and examine the contents, we do not have the ability to make queries which is likely the reason you wanted to connect to the database in the first place.
   2. In order to access the correct schema we need to switch to the SQL tab and enter the command:
      
      SET SCHEMA MONITOR_DB
      
      
   3. After we have entered this command we can now retrieve data from the database. The external user is read only and only selects may be done.
      
      
3. Here is our current Schema: 

Overview

This article will give a quick walkthrough on the generation of a Certificate Signing Request (CSR) and Private Key file which will be used in FileCatalyst Server, Central, and HotFolder.

Environment

OpenSSL 
Windows OS

Resolution

Install OpenSSL:

1. Download the OpenSSL installer from one of the mirrors located at https://wiki.openssl.org/index.php/Binaries. The example install directory referenced in this article is C:\OpenSSL\.
   
   
2. Follow the installation wizard to complete the rest of the installation.
   
   
3. Make sure that C:\OpenSSL\bin\ has been added to your Windows Environment PATH Variable. This will make the OpenSSL command accessible from the Command Prompt.

Create Certificate Signing Request (CSR) and Generate the RSA Key:

1. Open a command prompt and navigate to the final destination of where you want the Private Key and CSR to be stored.
   
   
2. Run the following command:
   
   openssl req -out  filecatalyst.csr -new -newkey rsa:2048 -nodes -keyout filecatalyst-private.key
   
   You will be prompted to enter some information about your company and on the final step, you will be asked to provide a challenge password. Please keep this between 6-8 characters as this will be the password you need to open your PEM container. If you are repurchasing your SSL Certificate we recommend using your old password.
   
   Your output should look like:
   
   
   
   The two files filecatalyst.csr and filecatalyst-private.key are now created:
   
   
   
   
3. The Certificate Authority will request the CSR to process your SSL certificate purchase.
   

Overview

This article will provide a quick walkthrough of the installation of an SSL Certificate in FileCatalyst Central.

With our most recent release of FileCatalyst Central v3.7.2, we have replaced the embedded Tomcat Web Server which is used to serve up the Central deployment with the Grizzly Web Server. With this new implementation, we will be using this internal web server in all our product lines. Depending on your starting point you can jump down in the article to different guides which will help you install and deploy an SSL Certificate on your Central deployment:

• Install OpenSSL
• Legacy Guide: Installation of SSL Certificates on Older FileCatalyst Central Deployments
• Generate a CSR and Private Key for SSL Certificates Using OpenSSL
• SSL Certificate Installation on the FileCatalyst Central Using a PFX File
• SSL Certificate Installation on FileCatalyst Central using PKCS#7 Certificate
• Using Self Signed Certificates on the FileCatalyst Central
• Install SSL Certificates on FileCatalyst Central

Environment

FileCatalyst Central v3.7.2 and later.

Resolution

Please make sure that OpenSSL is installed on your machine before you proceed with further in this guide.

Install OpenSSL:

1. Download the OpenSSL installer from one of the mirrors located at https://wiki.openssl.org/index.php/Binaries. The example install directory referenced in this article is C:\OpenSSL\.
   
   
2. Follow the installation wizard to complete the rest of the installation.
   
   
3. Make sure that C:\OpenSSL\bin\ has been added to your Windows Environment PATH Variable. This will make the OpenSSL command accessible from the Command Prompt.

Install SSL Certificates on FileCatalyst Central

Once you have your Certificate (.pem file), Private Key (.pvk) and PEM Container Password you can modify the Central configuration file directly. This method is not recommended while the FileCatalyst Central service is running. Please shut down the FileCatalyst Central service before you proceed.

Locate your maconfig.conf file which is inside the installation path of your FileCatalyst Central.

1. Open a command prompt and navigate to the final destination of where you want the Private Key and PEM Container to be stored.
   
   
2. Run the following command:
   
   openssl req -newkey rsa:2048 -nodes -keyout privatekey.pvk -x509 -days 365 -out certificate.pem
   
   You will be prompted to enter some information about your company. 
   
   Your output should look like:
   
   
   
   Now that you have the Certificate (.pem file) and Private Key (.pvk) generated, you can proceed to the Install SSL Certificates on FileCatalyst Central section.

Overview

Every instance that is deployed on Amazon EC2 must have Firewall and specific ports configured. By default, most of the ports that are needed are not open for TCP or UDP connections. The FileCatalyst Server, FileCatalyst Workflow, and FileCatalyst Webmail deployments all need to have their respective ports opened for connectivity and data transfer.

This article will walk you through a typical security group setup for an Amazon EC2 instance.

The default ports for FileCatalyst Direct are:

• Port 21 for TCP.
  This is used as the communication channel. Port 21 is a default specified in the FileCatalyst Server and is not secure. You can change this as long as both FileCatalyst Server and Client Applications are using the same port.
  
  
• Port 22 for TCP.
  This port is used for SSH connections.
  
  
• Port 990 for TCP.
  This Port is secured over SSL and is also used as the communication channel. The default value of 990 can also be changed in the FileCatalyst Server Remote Admin Application.
  
  
• Port range 8000-8999 for TCP and UDP.
  Some firewalls and NAT devices require setting up 2 separate rules and others allow you to specify TCP and UDP. These ports are used to transfer the Data to and from the FileCatalyst Server and is commonly referred to as the Data Channel. 

• Port 12400 for TCP.
  This is the Remote Admin Port. This port is exclusive to the FileCatalyst Server Remote Admin Application.
  
  
• Port 12480 for TCP.
  The internal Web Server uses this port to broadcast all communications. The Admin Applet, Link, and Servlet are hosted from this Web Server.

The default ports for FileCatalyst Workflow/Webmail are:

• Port 80 for TCP.
  HTTP inbound connections are accepted by the Tomcat Web Server on this port. 

• Port 443 for TCP.
  HTTPS connections and secured communication to the Tomcat Web Server use this port. 

Environment

FileCatalyst Direct Suite v3.5 and later.

FileCatalyst Workflow v4.9.5 and later.

FileCatalyst Webmail v4.9.4 and later.

Linux and Windows Environments.

Resolution

1. Log into your AWS Console. Click on Security Groups on the left-hand side.
   
   
   
   
2. Click on the Create Security Group button, see the attached illustration below.
   
   
   
   
3. Specify the Security Group Name and Description.
   
   
   
   
4. Hit Add Rule to add your first port. Here is an example of adding a single port 21 on TCP for a connection originating from anywhere.
   
   
   
   
5. This is an example of how to add a range of ports. We have added the FileCatalyst Data Port range for both TCP and UDP.
   
   
   
   
   
6. Once all your Firewall Rules have been added, hit the Create button.
   
   
7. Using the Security Group Name, you can add this of Firewall Rules to your EC2 Instance.

Overview

Every FileCatalyst application that runs, whether it is a service or in stand-alone mode has a Process ID (PID) associated with it when it launches.

A Heap Dump is a snapshot of the memory of a Java Process. The snapshot contains information about the Java objects and classes in the heap at the moment the snapshot is triggered. Our developers can use this information to analyze the root cause of failures.

This article will explore a command line method which can be used on Linux, Windows, and MAC OSX Environments. There are two PDF documents attached which will explore alternative methods with a GUI. If the primary method using the jmap command do not produce results please use the method listed in the respective PDF.

The JMAP application which is shipped with the Java Development Kit (JDK) is no available through standard Java RE installations and a Java JDK is required to collect a Heap Dump. The Java Development Kit installer is available through Java's Download Portal: http://www.oracle.com/technetwork/java/javase/downloads/index.html

Environment

FileCatalyst Direct Suite.

Java Development Kit v7.0 and v8.0.

Resolution

1. Verify Java Version
   
   
   1. Open a Command Prompt or Terminal Window.
   2. Run the following command:
      
      java -version
      
      The output should return:
      
      java version "1.8.0_91"
      Java(TM) SE Runtime Environment (build 1.8.0_91-b14)
      Java HotSpot(TM) 64-Bit Server VM (build 25.91-b14, mixed mode)
      
   3. If the Java version information is not displayed properly, you will need to re-install the Java JDK.
      
      
2. Process ID of the FileCatalyst Application
   
   
   1. Windows:
      1. Open the Task Manager application.
      2. Under the Details tab locate the java.exe process and look for the PID.
         
         
   2. MacOSX (using UI):
      1. Open the Activity Monitor application.
      2. Under the Process Name column locate your FileCatalyst Application. In the corresponding row, the Process ID (PID) will be shown.
         
         
   3. Linux and MacOSX (command line method):
      1. Open the command prompt.
      2. Run the following command:
         
         ps -ax | grep FileCatalyst
         
         This command will output a list of applications running with their PID. Here is an example of MAC OSX output:
         
         0      71        1         0 Mon10am       89:16.73 /Applications/FileCatalystServer.app/Contents/MacOS/FileCatalystServer -service
         0      101      1         0 Mon10am       46:11.65 /Applications/FileCatalystHotFolder.app/Contents/MacOS/FileCatalystHotFolder -service
         503  14625   1         0 1:53pm         0:42.27 /Applications/FileCatalystHotFolderAdmin.app/Contents/MacOS/FileCatalystHotFolderAdmin
         503  14636   1         0 1:53pm         0:54.89 /Applications/FileCatalystServerAdmin.app/Contents/MacOS/FileCatalystServerAdmin
         
         In this list, the second column references the PID and the FileCatalyst Server Service has a PID of 71.
         
         
3. Capturing a Heap Dump
   
   For this section we will use the Process ID of the FileCatalyst Server Service in step 2c), which was observed as 71.
   
   

   1. From the command line run the following command to process the Heap Dump:

      Windows and Linux Command:
      jmap -dump:format=b,file=<storage_path>/filecatalyst-application.hprof <PID>
      
      Mac OSX Command:
      jmap -J-d64 -dump:format=b,file=<storage_path>/filecatalyst-application.hprof <PID>

      Using the Process ID from the example above, the command would look like:

      jmap -dump:format=b,file=/heapdump-storage/filecatalyst-server-heapdump.hprof 71

   2. The parameter file=/heapdump-storage/filecatalyst-server-heapdump.hprof, will indicate where the Heap Dump will be stored.

Note

• At the bottom of this article, there are two PDF's that are available for the Heap Dump Process in a Windows and Linux Environment.

Overview
There are few folders which reside within FileCatalyst applications such as logs and diagnostic that should be cleaned up periodically. This will prevent the local disk from being filled up and causing service interruptions. In Linux environments, you have the ability to set up cronjobs to delete files and folders that are not needed and taking up some disk space. This article will give you sample crontab entries to clean up log folders.

Environment
FileCatalyst Direct v3.4 and later.
Linux Environment.

Resolution 

1. Using PuTTY or another application SSH to the Linux system and edit your crontab file by running: sudo crontab -e 
   
   
2. The following example is set to run every day at 4 am local system time and deletes all the log files on the FileCatalyst Server which are older than 8 days.
   
   * 4 * * * find /opt/utechsoft/server/log/* -mtime +7 -type f -delete
   
   
   
   
3. Running sudo crontab -l command will display and verify the cronjobs are configured properly.
   
   
   
   

Note: 

If you have the FileCatalyst Central or FileCatalyst Hotfolder  In Linux environments, The following lines are needed for log folder cleanup:
HotFolder Log Location: * 4 * * * find /opt/utechsoft/hotfolder/log/* -mtime +7 -type f -delete
Central Log Location: * 4 * * * find /opt/utechsoft/central/log/* -mtime +7 -type f -delete

Alternatively, you can specify a full path after the find command above to clean up that folders contents.

Overview

Clients who upgrade FileCatalyst Central to v3.7.3 build 22 may experience nodes not coming online after the upgrade. Central uses a field called Listener IP which is set on various nodes (FileCatalyst Server, TransferAgent and HotFolder). This address is used to connect the node to your Central deployment. 

In the latest release of Central, we have corrected a known issue which impacts the Listener IP field and could pose as a product defect. For example, you have multiple IPs on the Central machine 192.* and 172.* and the 192.* address is specified on Central as the Listener IP.  Your nodes can only have one IP (e.g. 172.*) specified on the (Server/HotFolder/TransferAgent) node machine. When the node comes online and tries to connect to the Central deployment, this will fail as you have 172.* specified on the node and Central is accepting communication on the 192.* NIC.



Environment

FileCatalyst Central v3.7.3 build 22 (only)

Resolution

1. Connect to the Central deployment.
2. Log in using your Admin account.
3. Access the drop-down list on the top right and select the Configuration cog.
4. In the Remote Connections Configuration section locate the Listener IP drop down and select the IP you would like to use and specify it on the node (Server/HotFolder/TransferAgent).

Overview
The following article describes how to perform an upgrade of FileCatalyst Central on Windows, Mac OSX and Linux platforms.

Please note this document does not apply to any versions of FileCatalyst Central below 3.4.

Click on the links below to view the individual guide based on your Operating Systems:

• How To Upgrade FileCatalyst Central in a Windows Environment
• How To Upgrade FileCatalyst Central in a Linux Environment

Environment
FileCatalyst Central v3.4 and later.

Resolution

How To Upgrade FileCatalyst Central in a Windows Environment

1. Shut down the application.
   FileCatalyst Central needs to be shut down prior to any upgrade. Do not skip this step as it could lead to a serious database issue. 
   
   
   • To stop a Central instance running as a service, close the FileCatalyst Central Web Portal.
   • Right-click on your Start button to open the WinX Menu. Select Run. This opens the Run box.
   • Type services.msc in it and hit enter to open the Services Manager.
   • Scroll down and find FileCatalyst Central service and select it. Right-click on it and hit Stop.
     
     
2. Backup the old configuration files.
   The following list of files will be required for the rest of the upgrade. Move them into a folder outside of the install location. These files and folders will be located in the root directory of the FileCatalyst Central Installation:
   
   
   • .fcdb folder: This folder is hidden on some operating systems and contains the database information.
   • backup folder: Archived copies of the configuration files and database are stored in this folder.
   • Custom maps and backgrounds: This folder contains custom map background images and icons uploaded by the user. It is located in www\Web Console\images\MapBackground
   • maconfig.conf: This file contains most of the settings that belong to the FileCatalyst Central and your license.
   • mawrapper.conf: This file contains Java related settings and service wrapper configurations.
     
     Note: If you are upgrading a FileCatalyst Central that is version 3.6 or below, and are also performing the upgrade into a different location than the original install, please make sure to copy all the images from www\Web Console\images into a folder outside of the install location. 
     
     
3. Download and run the Central installer. If you intend to use the same configuration and data, the installation path should match the current one being used.
   
   
4. Edit the mawrapper.conf and modify the wrapper.java.command=java. This will force the system to push the location of your Java 8 installation. Save the file and close it.
   
   
5. Once the installation completes the FileCatalyst Central automatically starts as a Windows service.
   
   
6. Launch the FileCatalyst Central Web Portal and verify if the upgrade was successful and the configuration was successfully migrated.

How To Upgrade FileCatalyst Central in a Linux Environment

1. Shut down the application:
   FileCatalyst Central needs to be shut down prior to any upgrade. Do not skip this step as it could lead to a serious database issue.
   
   
   • Stand Alone Execution of Central
     
     To stop a stand-alone instance use the following steps:
     
     
     • Change your working directory to /opt/utechsoft/central/
     • Execute the following command from a Terminal:
       
       ./fc_central_stop.sh
       
       
     • Verify the service is down by running the command:
       
       ps -ef | grep "java"
       
       
   • Central Running as a Service
     
     
     • Execute the following command from a Terminal
       
       service fc_central stop
       
       
     • Verify the service is down by running the command: 
       
       ps -ef | grep "java"
       
       
2. Backup the old configuration files.
   
   The following list of files will be required for the rest of the upgrade. Move them into a folder outside of the install location.
   These files and folders will be located in the root directory of the FileCatalyst Central installation:
   
   cd /opt/utechsoft/central/
   mkdir ./upgrade
   cp maconfig.conf ./upgrade
   cp -Rp .fcdb ./upgrade 
   cp -Rp ./www/Web\ Console/images/MapBackground ./upgrade
   cp ./conf/wrapper.conf ./upgrade
   
   If you are upgrading a FileCatalyst Central that is version 3.6 or below, and are performing the upgrade into a different location than the original install, also run the following backup commands:
   
   mkdir -p ./upgrade/images
   find ./www/Web\ Console/images -maxdepth 1 -type f -exec cp {} ./upgrade/images \;
   
   
3. Download the new installer package into /opt/utechsoft/central/ from the FileCatalyst Download Portal.
   
   
4. Unpack the software with the following commands:
   
   cd /opt/utechsoft/central/
   gunzip fc_central.tar.gz
   tar –xvf fc_central.tar
   chmod a+x *.sh
   
   
5. Restore Configuration files that were overwritten by tar bundle.
   
   cd /opt/utechsoft/central/
   cp ./upgrade/maconfig.conf ./
   cp -Rp ./upgrade/images ./www/Web\ Console
   cp -Rp ./upgrade/MapBackground ./www/Web\ Console/images
   cp ./upgrade/wrapper.conf ./conf/
   
   Note: the .fcdb directory should not be overwritten by tar bundle.
   
   
6. Edit the /opt/utechsoft/central/conf/wrapper.conf and modify the wrapper.java.command=java. This will force the system to push the location of your Java 8 installation. Save the file and close it.
   
   
7. Restart the FileCatalyst Central application (either as a service or standalone) based on your installation.
   
   
8. Launch the FileCatalyst Central Web Portal and verify if the upgrade was successful and the configuration was successfully migrated.

Overview

First, what is a diagnostic report?
Using tools within Java we capture the current state of the Java Virtual Machine at a very low level.
This allows our developers to examine what is occurring within the memory, which internal (Java) components are open and how long they have been, among many other things.
These are all captured among our logs into a zip file.

Most of our FileCatalyst products that have a User Interface have a "Diagnostic Report" button on the "About FileCatalyst" popup page.

Note:

While the Diagnostic report is being generated it will be named:

CREATING_DIAGNOSTICS

When the process is complete the filename will contain the current date/time in the file name

FileCatalyst<Application>_<YYYY-MM-DD-HH-MM-SS>_diagnostics.zip 


Environment

FileCatalyst Server v3.7.3
FileCatalyst HotFolder v3.7.3 
FileCatalyst TransferAgent v3.7.3
FileCatalyst Central v3.7.3

Resolution

FileCatalyst Server

Access to the "About FileCatalyst" page on Windows and Linux is the same, located under the "Help" drop-down in the FileCatalyst Server Admin GUI. On a Mac system the "About FileCatalyst" is located under "FileCatalystServerAdmin" when the remote admin is open and in focus.



Location of the diagnostic report zip file:

• Windows and Linux:  this is in the installation location in a diagnostics folder i.e \FileCatalyst Server\diagnostics\ or /opt/utechsoft/server/diagnostics/
  
• MacOSX this is determined by how the application is run
  i) Run as a service
  /Library/Application Support/FileCatalyst/Server/
  
  ii) Run stand-alone
  /Users/system username/Library/Application Support/FileCatalyst/Server/
  
  

FileCatalyst HotFolder

Access the "About FileCatalyst" page on Windows and Linux is the same, located under the "Help" drop-down in the FileCatalyst HotFolder Admin GUI. On a Mac system the "About FileCatalyst" is located under "FileCatalystHotFolderAdmin" when the remote admin is open and in focus.

Location of the diagnostic report zip file:

• Windows and Linux:  this is in the installation location in a diagnostics folder i.e \FileCatalyst HotFolder\diagnostics\ or /opt/utechsoft/hotfolder/diagnostics/
  
• MacOSX this is determined by how the application is run
  i) Run as a service
  /Library/Application Support/FileCatalyst/HotFolder/
  
  ii) Run stand-alone
  /Users/system username/Library/Application Support/FileCatalyst/HotFolder/

FileCatalyst TransferAgent

Access to the "About FileCatalyst" page is served through the configuration page.
This can be accessed through the toolbar icon when the application is run stand-alone. 
When the application is run as a service you will open a browser and enter the following address "https://localhost.filecatalyst.net:12680/config.html"

Location of the diagnostic report zip file:

• Windows and Linux:  this is in the installation location in a diagnostics folder i.e \FileCatalyst TransferAgent\diagnostics\ or /opt/utechsoft/transferagent/diagnostics/ or C:\Users\<username>\AppData\Local\FileCatalyst\FileCatalyst TransferAgent
  
  
• MacOSX this is determined by how the application is run
  i) Run as a service
  /Library/Application Support/FileCatalyst/TransferAgent/
  
  ii) Run stand-alone
  /Users/system username/Library/Application Support/FileCatalyst/TransferAgent/

FileCatalyst Central

Access to the "About FileCatalyst Central" page can be found in the drop-down under the "Logged in as: admin" in the top right corner of the browser.

Location of the diagnostic report zip file:

• Windows and Linux:  this is in the installation location in a diagnostics folder i.e \FileCatalyst Central\diagnostics\ or /opt/utechsoft/central/diagnostics/ 
  

Overview

The following instructions are provided as a guide to installing Java onto a system for use with FileCatalyst the Java API, SDK and CLI which do not have an embedded Java Runtime Environment and require one to run.

On Windows, Linux and OSX, many FileCatalyst v3.8 products (HotFolder, Server, TransferAgent and Central) do not need Java installed separately as a JRE (Amazon Corretto Java 8) is already pre-packaged in these applications.

Implementation notes: 

• Windows
• MacOSX
• Linux

Environment

FileCatalyst Direct Suite v3.8

FileCatalyst Server

FileCatalyst HotFolder

FileCatalyst Central

FileCatalyst API/SDK

FileCatalyst Command Line (CLI)

Operating Systems:

Windows, MacOSX and Linux

Resolution

To access our Download Portal, please log in to your Support Portal Account and select the Get Download Credentials widget. If you do not have access to the Get Download Credentials widget, submit a ticket to Support to enable this feature.

Windows:

1. Download Windows x64 Java 8u242
2. Unzip Java bundle, place the tar bundle under C:\Program Files\Java\ (administrative privileges will be required)
3. Open a command prompt and navigate to C:\Program Files\Java\bin\
4. Test the Java version:
   
   C:\Program Files\Java\bin>.\java -version
   openjdk version "1.8.0_242"
   OpenJDK Runtime Environment Corretto-8.242.08.1 (build 1.8.0_242-b08)
   OpenJDK 64-Bit Server VM Corretto-8.242.08.1 (build 25.242-b08, mixed mode)
   
   
5. Additional configuration may be required to:
   1. Modify the application script to use this specific Java version.
   2. Have the system path pointing to this location for the system to pick it up.

Linux:

1. Download Linux x64 Java 8u242 JRE
2. Execute the following commands from a terminal window:
   
   [email protected]:~$ sudo mkdir /opt/java
   [email protected]:~$ sudo cp ./amazon-corretto-8.242.08.1-linux-x64.tar.gz /opt/java/
   [email protected]:~$ cd /opt/java/
   [email protected]:/opt/java$ sudo tar -xvf amazon-corretto-8.242.08.1-linux-x64.tar.gz
   [email protected]:/opt/java$ sudo chown -R root:root /opt/java/amazon-corretto-8.242.08.1-linux-x64
   
   
   
3. Test to ensure Java is installed:
   
   [email protected]:/opt/java$ /opt/java/amazon-corretto-8.242.08.1-linux-x64/bin/java -version
   openjdk version "1.8.0_242"
   OpenJDK Runtime Environment Corretto-8.242.08.1 (build 1.8.0_242-b08)
   OpenJDK 64-Bit Server VM Corretto-8.242.08.1 (build 25.242-b08, mixed mode)
   
   
4. Additional configuration may be required to:

1. Modify the application script to use this specific Java version.
2. Have the system path pointing to this location for the system to pick it up.

MacOSX:

1. Download OSX x64 Java 8u242
2. Execute the following commands from a terminal window (from the directory where the package has been placed):
   
   sudo tar -xvf ./amazon-corretto-8.242.08.1-1-macosx-x64.tar.gz
   sudo chown -R root:wheel amazon-corretto-8.242.08.1-1-macosx-x64/
   sudo mv ./amazon-corretto-8.242.08.1-1-macosx-x64 /Library/Java/JavaVirtualMachines/
   cd /Library/Java/JavaVirtualMachines/
   
   
3. Test the Java version:
   
   /Library/Java/JavaVirtualMachines/amazon-corretto-8.242.08.1-1-macosx-x64/Contents/Home/bin/java -version
   openjdk version "1.8.0_242"
   OpenJDK Runtime Environment Corretto-8.242.08.1 (build 1.8.0_242-b08)
   OpenJDK 64-Bit Server VM Corretto-8.242.08.1 (build 25.242-b08, mixed mode)
   
   
4. Additional configuration may be required to:
   1. Modify the application script to use this specific Java version.
   2. Have the system path pointing to this location for the system to pick it up.

Overview

The FileCatalyst Suite of products can leverage cloud resources supplied by Amazon AWS. Using EC2 Instances, users are able to create and deploy our software on many different versions of Windows and Linux Operating Systems. You will need to consult Amazon AWS for their Cloud Services Pricing.

The products in the FileCatalyst Direct Suite can be downloaded directly from our Download Page. To access the page, you will need credentials which can be obtained from your FileCatalyst Sales Representative or the FileCatalyst Support Team. The FileCatalyst Direct Download Page can be accessed through this link: http://filecatalyst.software/fc-direct-download.html

The following guide will walk you through the basic setup of an AWS EC2 Instance, the configuration of security and network groups and the deployment of FileCatalyst Direct.

Environment

FileCatalyst Direct Suite v3.6 and later.

Amazon AWS EC2 Instances.

Resolution

Use the following steps to ensure that you have full connectivity in and out of your EC2 Instance. The following steps may redirect you to other guides, please complete them in the order they appear in this section.  

Some of the links below will require credentials to access the respective material. If you do not have these credentials please contact your FileCatalyst Sales Representative or the FileCatalyst Support Team.

1. Choosing the right EC2 Instance and Operating System 
   
   Based on the System Requirements (http://filecatalyst.com/resources/system-requirements/), you can choose the EC2 Instance that fits the needs of your deployment.  When prompted to select the architecture type please select "64-bit (x86)". Using the "64-bit (Arm)" option will not launch the Server properly.
   
2. Security Groups and Network Configuration
   

   You can use the following guide on FileCatalyst Amazon EC2 Port Configuration and Security Groups Guide: http://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/263/0/firewall-and-port-configuration-for-amazon-ec2-instances-using-security-groups
   
   It is very important that the network is properly configured so that you do not encounter any issues that are firewall related when transferring data in or out of Amazon. 

3. Installation Instructions 
   
   Once you have downloaded the respective application you would like to deploy to your EC2 Instance, you can use one of the following Quickstart Guides to install your FileCatalyst Application:
   
   
   • FileCatalyst Server Quickstart Guide: http://filecatalyst.software/download/filesFCDirect/current/documentation/server/FileCatalyst_Server_Quickstart.pdf
   • FileCatalyst HotFolder Quickstart Guide: http://filecatalyst.software/download/filesFCDirect/current/documentation/hotfolder/FileCatalyst_HotFolder_Quickstart.pdf
   • FileCatalyst Central Quickstart Guide: http://filecatalyst.software/download/filesFCDirect/current/documentation/central/Web%20Console/docs/help.html#installation

Notes:

There are other common articles that will be useful in customizing your deployment. You can access them using the links below:

• Connecting to a Headless Installation of FileCatalyst Server:  http://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/326/0/connecting-to-a-headless-installation-of-filecatalyst-server
• Installing Hotfolder on Linux as a Service in Headless Mode:  http://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/141/0/installing-hotfolder-on-linux-as-a-service-in-headless-mode
• Adding External File Systems to a FileCatalyst Server

In the External File Systems document, there is a list of limitations when using Cloud Storage (S3 buckets) which are imposed by Amazon. You can view them here: http://filecatalyst.software/download/filesFCDirect/current/documentation/server/efs.html#implementationNotes

Overview

Logs are one of the critical pieces of information requested by FileCatalyst Support. Below is a list of those viewed as most useful from a support perspective and their default locations. If support has requested logs for a given event please remember that they are rotated every 24 hours at the time set in the configuration file and archived with the dates shown in the name.

The default location is dictated by the O/S version and is established during the initial install. If the FileCatalyst Server has been installed somewhere other than the default path adjust these directions accordingly.

Environment

FileCatalyst Direct Suite v3.4 and later.

Windows, Linux, and Mac OSX Environments.

Resolution

Note:  All FileCatalyst Direct Suite logs get zipped and rotated every 24 hours.

'FileCatalyst Server:

1. Location of the Log:
   
   
   • Windows Location: <path to>\FileCatalyst Server\log\
   • Linux Location: /opt/utechsoft/server/log/
   • Mac OSX Locations:
     
     
     • Running Stand Alone: /Users/<username>/Library/Application Support/FileCatalyst/Server/log/
     • Running as a Service: /Library/Application Support/FileCatalyst/Server/log/
     • Wrapper log for the Service: /Library/Logs/FileCatalyst/Server/log
       
       
2. Log Types:
   
   
   • wrapper.log:
     • This log uses the naming convention wrapper.log.<#>, and by default, the rotation spans from 1 to 5.
     • It contains information about the FileCatalyst Server service, user account changes, status messages of connected storage devices, Java Exceptions and Client Side Application connections.
       
       
   • FileCatalyst<Date>Usr.single.log:
     • The naming convention this log follows is FileCatalyst<dd:mm:yy>Usr.log.
     • User logs contain specifics about transfers, Remote Admin connections to the FileCatalyst Server and data encryption messages.
       
       
   • Administrative<Date>Usr.single.log:
     • Administrative Users connecting to the FileCatlayst Server using the Remote Admin Application will have their actions and connection history logged in this file.
       
       
   • FCServer-Connect<UTCTime>-<Date>.Usr.single.log:
     • These logs are generated when single session transfers are launched when the "Connect" option is selected from User List.
     • All connection information and specific transfer information will be found in this file.

FileCatalyst HotFolder:

1. Location of the Log:
   
   
   • Windows Location: <path to>\FileCatalyst HotFolder\log\
   • Linux Location: /opt/utechsoft/hotfolder/log/
   • Mac OSX Locations:
     
     
     • Running Stand Alone: /Users/<username>/Library/Application Support/FileCatalyst/HotFolder/log/
     • Running as a Service: /Library/Application Support/FileCatalyst/HotFolder/log/
     • Wrapper log for the Service: /Library/Logs/FileCatalyst/HotFolder/log
       
       
     
     
     
2. Log Types:
   
   
   • wrapper.log:
     • This log uses the naming convention wrapper.log.<#>, and by default, the rotation spans from 1 to 5.
     • It contains information about the FileCatalyst HotFolder Service, status messages of background processes, Java Exceptions, and connections to the FileCatalyst Server.
       
       
   • FCHotFolder<Date>Usr.single.log:
     • The naming convention this log follows is FileCatalyst<dd:mm:yy>Usr.single.log.
     • User logs contain specifics about transfers and data encryption messages.
     
     
   • FCHotFolder-<Task Name>-<Task ID>-<UTCTime>-<Date>Usr.single.log:
     
     • Transfer related information and Java Exceptions get logged in this file.
     • OS information and software build information can be found in these logs.
       
       
   • FCHotFolder-Connect<UTCTime>-<Date>.Usr.single.log:
     • These logs are generated when single session transfers are launched when the "Connect" option is selected from Site list.
     • All connection information and specific transfer information will be found in this file.

FileCatalyst Express:

1. Location of the Log:
   
   
   • Windows Location: C:\Users\<username>\.unlimitedftp\
   • Linux Location: /root/.unlimitedftp/
   • Mac OSX Location: /Users/Admin/Desktop/.unlimtedftp
     
     
2. Log Types:
   
   
   • FCAPI<dd:mm:yy>.log:
     • Each transfer generates its own log. If more than one site is used then a numerical value is appended to the filename (FCAPI080616Usr.single.log.1).
       
     • This log contains all transfer details and error messages.

FileCatalyst Central:

1. Location of the Log:
   
   
   • Windows Location: <path to>\FileCatalyst Central\log\
   • Linux Location: /opt/utechsoft/central/log/
   • Mac OSX Location: /Users/<username>/Library/Application Support/FileCatalyst/Central/log
     
     
2. Log Types:
   
   
   • wrapper.log:
     • This log uses the naming convention wrapper.log.<#>, and by default, the rotation spans from 1 to 5.
     • It contains information about the FileCatalyst Central service, database messages, alarm details, Java Exceptions and details on connected nodes.
       
   • Central-<Date>-Usr.0.log:
     • Detailed alarm history, background process details, and Java Exceptions can be tracked in this file.

FileCatalyst TransferAgent:

1. Location of the Log:
   
   
   • Windows Location:
     • <path to>\FileCatalyst TransferAgent\log\ 
     • C:\Users\<username>\AppData\Local\FileCatalyst\FileCatalyst TransferAgent\logs\ (non-admin account)
   • Linux Location: /opt/utechsoft/transferagent/log/
   • Mac OSX Locations:
     
     
     • Running Stand Alone: /Users/<username>/Library/Application Support/FileCatalyst/TransferAgent/log/
     • Running as a Service: /Library/Application Support/FileCatalyst/TransferAgent/log/
     • Wrapper log for the Service: /Library/Logs/FileCatalyst/TransferAgent/log
2. Log Types:
   
   
   • FCTransferAgent-<Date>-Usr.0.log:
     • Transfer related information gets logged.

Overview

All of our FileCatalyst Products are installed with default memory limits, including both initial reserve and maximum memory. However, these can be configured to fit your specific needs and environment.  This article will go through the configuration process for each FileCatalyst Product for Windows, Linux, and Mac OSX

NOTE:  

• For all environments:
  If you are using a 32-bit Operating System or Java 32-bit, the maximum memory you can define for Java is limited to 1.5GB of memory.  64-bit Operating Systems running 64-bit Java can allocate a maximum of 4 GB.
• It is also recommended (but not required) to set the minimum and the maximum memory to the same value, as this allows JAVA to allocate a single continuous block of the memory from the OS on startup.

Environment

FileCatalyst Direct Suite v3.4 and later.

Resolution

FileCatalyst Direct Server:

1. Windows

   1. Stand-alone:  When running FileCatalyst Server stand-alone (directly launching the executable), the FileCatalyst Server will run using a maximum of 1024 MB of memory.  This cannot be modified since the values are embedded inside the FCServer.exe binary.
      
      
   2. Service:  When running FileCatalyst Server as a Windows Service, you can configure the application to use either a smaller or larger memory footprint based on your needs:
      1. Stop FileCatalyst Server Service.
      2. Open the fcconf.conf found in the application installation directory (by default C:\Program Files\FileCatalyst Server\fcconf.conf) in a text editor.
      3. Locate the following entries in the file:
         
         # Initial Java Heap Size (in MB)
         wrapper.java.initmemory=1024
         # Maximum Java Heap Size (in MB)
         wrapper.java.maxmemory=4096
         
         
      4. Enter the desired variable Initial and Maximum Memory.
         
         
   3. Save the file.
   4. Start the FileCatalyst Server Service.
      
      
2. Linux
   
   
   1. Stand-alone:  Linux installations include basic startup scripts (fc_server.sh, fc_server_console.sh) which can be modified to use more memory.  
      1. Here is a sample from a launch script with 1GB minimum and 4GB maximum memory (non-continuous block):
         
         java -Xms1024 -Xmx4096M -jar FileCatalystServer.jar -systray
         
         
         
      2. To run with 4GB of RAM, modify the script to look like the following:
         
         java -Xms4096M -Xmx4096M -jar FileCatalystServer.jar -systray
         
         
         
   2. Service:  When running FileCatalyst Server as a Linux/Solaris Service, you may configure the application to use a different memory footprint by editing wrapper.conf:
      1. Stop FileCatalyst Server Service.
      2. Edit wrapper.conf found in the application installation directory (by default /opt/utechsoft/server/conf/wrapper.conf) using vi or another text editor.
      3. Enter the memory values you require for the following fields:
         
         # Initial Java Heap Size (in MB)
         wrapper.java.initmemory=1024
         # Maximum Java Heap Size (in MB)
         wrapper.java.maxmemory=4096
         
         Choose your values for minimum and maximum memory and enter it.
         
         
      4. Save and close the wrapper.conf file.
      5. Start up FileCatalyst Server Service.
         
         
3. MacOSX
   
   
   1. MacOSX configurations are managed by an Info.plist file residing inside the FileCatalystServer.app package which tells the system the parameters needed to start the application.
      1. To access the Info.plist, select the FileCatalystServer.app icon and right-click.
      2. Select Show Package Contents.
      3. Edit the info.plist with a text editor.
      4. To increase the memory used edit  the following line:
         
         <string>-Xms1024M -Xmx4096M</string>
         
         
      5. Save the file and close the editor.
         
         

FileCatalyst HotFolder

1. Windows

   1. Stand-alone:  When running FileCatalyst HotFolder stand-alone (directly launching the executable), the FileCatalyst HotFolder will run using a maximum of 1024 MB of memory.  This cannot be modified since the values are embedded inside the FCHotFolder.exe binary.
      
      
   2. Service:  When running FileCatalyst HotFolder as a Windows Service, you can configure the application to use either a smaller or larger memory footprint based on your needs:
      1. Stop FileCatalyst HotFolder Service.
      2. Open the fchf.conf found in the application installation directory (by default C:\Program Files\FileCatalyst HotFolder\fchf.conf) in a text editor.
      3. Locate the following entries in the file:
         
         # Initial Java Heap Size (in MB)
         wrapper.java.initmemory=1024
         # Maximum Java Heap Size (in MB)
         wrapper.java.maxmemory=4096
         
         
      4. Enter the desired variable Initial and Maximum Memory.
         
         
   3. Save the file.
   4. Start FileCatalyst HotFolder Service.
      
      
2. Linux
   
   
   1. Stand-alone:  Linux installations include basic startup scripts (fc_hotfolder.sh, fc_hotfolder_console.sh) which can be modified to use more memory.  Here is a sample from a launch script with 1GB minimum and 4GB maximum memory (non-continuous block):
      
      java -Xms1024 -Xmx4096M -jar FileCatalystHotFolder.jar -systray
      
      
      
   2. To run with 4GB of RAM, modify the script to look like the following:
      
      java -Xms4096M -Xmx4096M -jar FileCatalystHotFolder.jar -systray
      
      
   3. Service:  When running FileCatalyst HotFolder as a Linux/Solaris Service, you may configure the application to use a different memory footprint by editing wrapper.conf (/opt/utechsoft/hotfolder/conf/wrapper.conf).
   4. Enter the memory values you require for the following fields:
      
      # Java Additional Parameters
      # Initial Java Heap Size (in MB)
      wrapper.java.initmemory=1024
      # Maximum Java Heap Size (in MB)
      wrapper.java.maxmemory=4096
      
      Choose your values for minimum and maximum memory and enter it.
   5. Save and close the wrapper.conf file.
   6. Start up FileCatalyst HotFolder Service.
      
      
3. Mac OSX
   
   
   1. MacOSX configurations are managed by an Info.plist file residing inside the FileCatalystHotFolder.app package which tells the system the parameters needed to start the application.
      1. To access the Info.plist, select the FileCatalystHotFolder.app icon and right-click.
      2. Select Show Package Contents.
      3. Edit the Info.plist with a text editor.
      4. To increase the memory used edit  the following line:
         
         <string>-Xms64M</string>
         <string>-Xmx4096M</string>
         
      5. Save the file and close the editor.
         
         

FileCatalyst Central

1. Windows

   1. From the Service Manager application (Services.msc), stop the FileCatalyst Central Service.

   2. Locate the file mawrapper.conf in the FileCatalyst Central installation and open it in a text editor.

   3. To increase the memory used, edit the following lines:
      
      # Initial Java Heap Size (in MB)
      wrapper.java.initmemory=1024
      # Maximum Java Heap Size (in MB)
      wrapper.java.maxmemory=4096
      
      To maximize performance improvement we recommend that both values be identical, which will cause Java to allocate a contiguous block of memory.
      

   4. Close the text editor and start the FileCatalyst Central Service.
      
      
2. Linux
   1. Stop the FileCatalyst Central Service using:
      
      service fc_central stop
      
      
   2. Locate the file wrapper.conf in the FileCatalyst Central installation directory and within the /opt/utechsoft/central/conf/wrapper.conf directory and open it in a text editor.
      

   3. To increase memory used by Central, edit the following lines:
      
      # Initial Java Heap Size (in MB)
      wrapper.java.initmemory=1024
      # Maximum Java Heap Size (in MB)
      wrapper.java.maxmemory=4096
      
      To maximize performance improvement we recommend that both values be identical, which will cause Java to allocate a contiguous block of memory.
      

   4. Save the file and close the text editor.
      

   5. Start the FileCatalyst Central Service using the command:
      
      service fc_central start

Overview

With the release of FileCatalyst Central v3.7.3, we have added the ability to add and customize the Java Cipher Suite usage. This article will outline the steps needed to use custom Java Ciphers in Central.

If you have upgraded from an older version of Central (<v3.7.2) you will not see these settings in the configuration file. You will need to use this guide to add them to your configuration file.

Environment

FileCatalyst Central v3.7.3

Resolution

The default cipher settings are available in the maconfig.default file located in the installation directory of FileCatalyst Central. To add these settings to your existing configuration file use the following steps:

i) Shutdown the FileCatalyst Central service.
ii) Create a backup of the maconfig.conf file before modifying it. Once the back up is completed, open the maconfig.conf file in a text editor.
iii) Scroll to the bottom of the file and add the following settings to it:

## SSL Cipher restriction
# By default, accepted SSL ciphers are specified as part of the standard Java JRE.
# These can be modified to exclude less secure ciphers.
FCMonitoringAgent.config.ssl.restrict.ciphers=false

# If the restrict.cipher == true, you must supply a list of acceptable ciphers
# the application can utilize when opening up SSL server sockets.
# Below are standard ciphers found in SUN Java JRD 1.6.0_12
#FCMonitoringAgent.config.ssl.allowed.ciphers.00=SSL_RSA_WITH_RC4_128_MD5
#FCMonitoringAgent.config.ssl.allowed.ciphers.01=SSL_RSA_WITH_RC4_128_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.02=TLS_RSA_WITH_AES_128_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.03=TLS_DHE_RSA_WITH_AES_128_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.04=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.05=SSL_RSA_WITH_3DES_EDE_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.06=SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.07=SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.08=SSL_RSA_WITH_DES_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.09=SSL_DHE_RSA_WITH_DES_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.10=SSL_DHE_DSS_WITH_DES_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.11=SSL_RSA_EXPORT_WITH_RC4_40_MD5
#FCMonitoringAgent.config.ssl.allowed.ciphers.12=SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.13=SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
#FCMonitoringAgent.config.ssl.allowed.ciphers.14=SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA

iv) If you have a set of ciphers that you need to use please check that they are available in the current version of Java Cipher Suites. Please note that some Ciphers require a specific TLS version to be enabled. You will need to toggle those settings as well in the same configuration file. Search for the following parameters and change the ones that apply to your installation:

FCMonitoringAgent.config.deployment.security.defaultTransport=TLSv1
FCMonitoringAgent.config.deployment.security.SSLv2Hello=true
FCMonitoringAgent.config.deployment.security.SSLv3=false
FCMonitoringAgent.config.deployment.security.TLSv1=true
FCMonitoringAgent.config.deployment.security.TLSv1.1=false
FCMonitoringAgent.config.deployment.security.TLSv1.2=true

v) Change the parameter FCMonitoringAgent.config.ssl.restrict.ciphers to true. 

vi) Add your ciphers to the list incrementing them from .00 upward and uncommenting the parameter. Here is an example:

FCMonitoringAgent.config.ssl.allowed.ciphers.00=NAME_OF_CIPHER_ONE
FCMonitoringAgent.config.ssl.allowed.ciphers.01=NAME_OF_CIPHER_TWO
FCMonitoringAgent.config.ssl.allowed.ciphers.02=NAME_OF_CIPHER_THREE
FCMonitoringAgent.config.ssl.allowed.ciphers.03=NAME_OF_CIPHER_FOUR

vii) Once the modifications to your Central configuration file are complete save it and start the Central service.

1. Turn off the FileCatalyst Central service.
2. Locate the maconfig.conf file in the root of the install location of Central and open it in a text editor.
3. Search for "FCMonitoringAgent.config.max.records.to.retrieve" and uncomment the property (remove the "#"). Change the value to 10000. Your new parameter should look like:
   
   FCMonitoringAgent.config.max.records.to.retrieve=10000
   
   
   
4. Search for "FCMonitoringAgent.config.max.periodic.records.to.retrieve" and uncomment the property (remove the "#"). Change the value to 10000. Your new parameter should look like:
   
   FCMonitoringAgent.config.max.periodic.records.to.retrieve=10000
   
   
5. Save the changes to this file and close the text editor.
6. Start the FileCatalyst Central service.