Installation
Client Installation Instructions
Installation Details
The default installation location of the Alfred Desktop application is in:
C:\Program Files (x86)\Xenit Solutions\Alfred Desktop
The Alfred Desktop executable (Xenit.Fred.exe) is located in this directory. During installation shortcuts to launch Alfred Desktop are installed in the start menu.
The mongoDB application, a single standalone executable, is installed in the dependencies folder in the default installation location:
C:\Program Files (x86)\Xenit Solutions\Alfred Desktop\dependencies
The mongo database is used to support the metadata caching mechanism in the Alfred Desktop application. It hosts the local cache database. The mongo database application process is controlled by the Alfred Desktop application. The local cache database is configured in such a way that it is only accessible from the local machine.
Local application resources like:
- Bookmarks
- User specific settings
- Log files
- Local cache database files
- Offline content files and local working copies of content files
are stored in the user’s roaming profile (%APPDATA% folder).
Clean Installation
Contact your system administrator for more information about the location of the Alfred Desktop set-up file.
- Download the set-up file to your local disk.
- Open the folder from the “alfred-desktop-3.8.MICRO.BUILD-setup.msi” file download location and double click on it.
- Click on next.
- If you do not want to use the standard setting, browse to the folder in which you wish to install the Alfred Desktop application.
- Click on “Install”.
- The application is now being installed.
- Click on “Next”.
- Alfred Desktop has been installed. Click on “Finish” to complete the installation process.
In the program menu tree, new commands are now available under the XeniT Solutions folder:
- Alfred Desktop: starts the application
- Uninstall Alfred Desktop: removes the application from your computer
Upgrading from Fred client 3.5 or older to Alfred Desktop client 3.8 or newer
Alfred Desktop 3.8 and newer versions use a different settings location than Fred 3.5 and older versions. This is a local folder for each user and a lot of configuration files can be found at this location, most notably the bookmarks, saved searches and favorites.
By default, this settings location is %AppData%\Roaming\Xenit\Fred for
Fred 3.5 or older installations. The default settings location for
Alfred Desktop 3.6 or newer installations is
%AppData%\Roaming\Xenit\Alfred Desktop.
When the user starts Alfred Desktop for the first time it checks if he/she already has content at the old settings location from Fred. The content of the old settings location is then copied to the new settings location. That way the user keeps all bookmarks, saved searches and favorites from previous installations.
Backend Installation Instructions
The Alfred Desktop Backend consists of 4 separate amps. Each amp has to be installed for the Alfresco version and edition you currently have installed.
File Name Format Description
The file name format is described below contain the following abbreviations:
- XX describes the major version number of the module
- YY describes the minor version number of the module
- ZZ describes the micro version number of the module
- AA describes the build version number of the module
- BB is the Alfresco release type:
- enterprise
- community
- C.D is the version of Alfresco:
- 5.0
- 5.1
- 5.2
- 6.0
- 6.1
Dynamic Extensions Module Package
The Alfred API Backend amp is the new backend module that is introduced since Alfred Desktop 3.6. This module is the platform on which Alfred API as well as other XeniT products are based.
File name format: alfresco-dynamic-extensions-repo-CD-XX.YY.ZZ.amp
Install Procedure:
Download the latest Dynamic Extensions AMP from our GitHub page:
Use the Module Management Tool to install the AMP in the Alfresco repository of your choosing. After restarting Alfresco, the Dynamic Extensions Control Panel[^2] will be available.
Note: Accessing the Control Panel requires an admin account
Alfred API Backend Module Package
The Alfred API Backend amp is the new backend module that is introduced since Alfred Desktop 3.6. This module is the standard backend being used for all XeniT products.
File name format: apix-impl-CD-amp-XX.YY.ZZ.amp
Use the Module Management Tool to install the AMP in your Alfresco repository.
Alfred Desktop Addon Backend Module Package (required)
The Alfred Desktop Addon Backend amp contains part of the backend that could not be included in the Alfred API Backend amp. This module contains only Alfred Desktop specific web scripts, behaviors, etc.
File name format:
alfred-desktop-backend-addon-alfresco-BB-C.D-XX.YY.ZZ.AA.amp
Alfred Desktop Legacy Backend Module Package (optional)
The Alfred Desktop Legacy Backend module provides backend compatibility with older versions of Alfred Desktop that do not use the new Alfred API Backend. It provides the previous endpoints that contains the functionality that has been replaced by the Alfred API Backend amp in the latest version.
File name format:
alfred-desktop-backend-legacy-alfresco-BB-C.D-XX.YY.ZZ.AA.amp
How to install
AMP files can be installed into the Alfresco WAR using the Module Management Tool.
- Stop the running Alfresco server (
./alfresco.sh stop) - Copy the following modules to the directory
$ALFRESCO/amps[^3]alfresco-dynamic-extensions-repo-CD-XX.YY.ZZ.ampapix-impl-CD-amp-XX.YY.ZZ.ampalfred-desktop-backend-addon-alfresco-BB-C.D-XX.YY.ZZ.AA.amp- Optional:
finder-workflow-de-amp-XX.YY.ZZ.amp
- Apply the amp modules (
./bin/apply_amps.sh) - Optional Step:
Copyalfred-desktop-backend-legacy-alfresco-BB-C.D-XX.YY.ZZ.AA.ampto the directory$alfresco/amps[^4].
This module package depends on
alfred-desktop-backend-addon-alfresco-BB-C.D-XX.YY.ZZ.AA.amp
to be installed. - Apply the amp modules (
./bin/apply_amps.sh) - Start the Alfresco server (
./alfresco.sh start)
When the Alfresco server is started, the Alfred Desktop backend will be
installed. Look at your Alfresco/Tomcat server logs
($TOMCAT/logs/catalina.out[^5]) when Alfresco/Tomcat is starting up,
for possible problems.
You can find more information on installing Alfresco Module Packages in the Alfresco documentation.