Aspera Faspex provides an efficient way to send files anywhere in the world. This plug-in demonstrates how to use of Aspera Faspex with IBM Content Navigator.
- Application server running on Java 8
- IBM Content Navigator 3.0.2 or later
- IBM FileNet Content Manager and/or IBM Content Manager
- Linux (preferred) or Windows versions supported by IBM Content Navigator
- FileNet Content Engine Java API
- Servlet API
- Apache Commons Configuration
- Apache Commons Lang
- JUnit
- Mockito
- Gradle or Apache Maven and Ant
- Dojo Toolkit full source
- Register and configure the plug-in in ICN.
- Add the Send via IBM Aspera menu action to the document context menus of the desktop.
Note: A valid SSL/HTTPS certificate is needed to connect to the Aspera server. For debugging and development purposes, you can add the ICNAPCertValidationOff environment variable and set the value to TRUE to disable the validation.
You can enable the IBM Content Navigator server debug logs by setting the application-level logging to Debug from the Settings page of the IBM Content Navigator admin client.
You can enable the IBM Content Navigator client debug logs adding the logLevel parameter with the value of 4 (Debug) to the URL of IBM Content Navigator. Example: http://localhost:9080/navigator/?logLevel=4
The Aspera log files are located in the directory that contains Aspera files. The path to the Aspera files can be found from ICN server debug logs.
CIWEB.aspera Debug: ... com.ibm.ecm.extension.aspera.AsperaPlugin.applicationInit() created folder structure for resources: /tmp/aspera-plugin-resources
Additional debug details can be added to Aspera log files by adding an environment variable named ICNAPDebugModeOn with the value of TRUE. The caveat is that if you enable debug mode, the transfer will abort unless the Aspera server is configured to support it. To enable this support, add the following entry under the <default> tag of the aspera.conf file on the server:
Note: This should be removed as soon as it's no longer needed as this can fill up the disk on the server if enabled for an extended period of time.
<aspshell_commands>
<command>ascp4 -S. -DD</command>
</aspshell_commands>
The server doesn't need to be restarted after adding the entry.
Compiled class files instead of the JAR file can be loaded by using the Class file path option when installing the plug-in. Uncompressed JavaScript files can be loaded by adding the debug parameter to the URL of ICN, http://localhost:9080/navigator/?debug=true.
The JavaScript unit tests can be run by going to the DOH runner page, http://localhost:9080/navigator/util/doh/runner.html?test=../../plugin/aspera/getResource/aspera/test/tests.js&paths=aspera,../navigator/plugin/aspera/getResource/aspera, after loading ICN from the browser.
- Clone or download the plug-in from GitHub.
- Copy the navigatorAPI.jar and Jace.jar files to lib/icn directory under the plug-in's root directory.
- Update the paths in the dojo-build/gradle.properties or dojo-build/build.properties file.
- Build the plug-in JAR file by running './gradlew jar' / 'gradlew.bat jar' or 'mvn package'.
- An error may occur intermittently while files are being sent. The error can occur more often on Windows and when multiple concurrent requests are being processed.
- When the error occurs on Windows, a pop-up dialog that says "ascp4 Application has stopped working" is opened in the ICN server and needs to be closed manually.