Topics

• Home Page
  • Folder Tree
  • File Live Table
  • File Upload
• Folder View
• File View
• Recent Files Macro
• Migration from Older Versions

Home Page

On the application home page there is a splitter with the tree of folders on the left and the file live table on the right. To get started you should create a folder. Right click on the root node and select 'New Folder'. Type the folder name then press Enter. Next you can upload a file in the folder you have just created. Select the folder in the tree and on the right, above the empty table, click on 'New File'. Browse the file system to select the desired file or drag and drop it on the dedicated area. Click 'Back' after the file is uploaded and you should see the file in the live table.

Folder Tree

The folder tree lists the root folders and some special nodes:

• Orphan Folders: the folders that don't have the home page (we call it the drive) as their parent. Normally you shouldn't have orphan folders, but in case you do you can easily fix this by dragging them either into the root of the tree or in any of the non-orphan folders.
• All Files: this is a meta node that gives you quick access to the list of all files found on the drive (the application space).
• Orphan Files: the list of files that don't have a parent folder. Normally you shouldn't have orphan files, but in case you do you can easily fix this by moving them to an existing folder.
• Active Jobs: the list of 'file system' jobs that are currently running. You have to know that whenever you perform a modification like deleting a folder or moving some files a job is triggered that runs in the background to perform that operation. Most of the operations are performed instantly so you don't get to see the active jobs, but sometimes if you do large batch operations this view can be used to check the progress. Also, some jobs may require you to answer some questions. For instance, when you move a folder you may need to specify whether to overwrite or not an existing file. This question will be asked on the Active Jobs view.

You can organize the folders by drag and drop or you can use the context menu to create new folders or to rename them. When you select a folder the file live table gets updated to list only the files from that folder.

File Live Table

The file live table lists the files associated with the currently selected node in the tree (e.g. the files from the selected folder). If you whish to copy or move some files you have to select them, click on the Cut or Copy button from above the live table, then select the target folder from the tree and click on the Paste button from above the live table.

File Upload

To upload a new file in the current folder you have to click on the New File button from above the live table.

Below the drop zone you can see the previous uploads. This includes finished uploads, uploads in progress and even canceled uploads. You can clear the list of uploads. After you upload your files you can go back to the list view which should include the new files.

Folder View

The tree context menu has an entry to open the folder. This will take you to the folder view, which lists the subfolders and the files. You can navigate up and down the tree hierarchy by clicking on the subfolders or on the parent entry ('..'), or by using the breadcrumb.

File View

Clicking on a file link from the file live table will take you to the file view. Here you can view or play the file. Most of the standard file types are supported:

• in case of text files the Code Macro is used to display the file content using highlighting specific for each file type.
• in case of image file the image is displayed inline.
• in case of audio and video files the file is played using the JW Player, when present, or if the browser supports HTML5 audio/video playback then the native players are used.
• in case of PDF files the PDF Viewer is used, when present.
• in case of office files the Office Viewer is used, but you need to connect your wiki to an office server first.

Recent Files Macro

Starting with version 2.0RC2 there is a macro available to list the files that have been recently uploaded. You can add this macro as a gadget in a dashboard.

The following macro parameters are available:

Migration from Older Versions

Starting with version 2.0-milestone-1 the File Manager has a new way to organize the files and folders, which is not compatible with older versions. Fortunately, after you upgrade the File Manager you'll get on the File Manager home page a warning message and a button to migrate your files from the old structure to the new one.

Installation Steps

This paid extensions requires  XWiki 14.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.

Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Installing Paid Apps on Subwikis

If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:

Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.

Options

The price is per year and varies depending on the support level and the number of users.

Benefits

What do you get when you purchase an XWiki extension?

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes

v2.8

Tasks done:

• #104 Upgrade parent to 14.10-1.

Bugs fixed:

• #80 Can't access a folder that was copied in another folder.

• #96 User cannot use folder that was uploaded or created with files when folder name starts with dot.

• #99 Folder download does not produce the correct archive after you replace its content.

v2.7.1

Upgrades:

• #100 Upgrade Licensor dependency to version 1.25

v2.7

Improvements:

• #92 Disable attachment section for uploaded file page and its siblings.

Bugs fixed:

• #79 Two folders having the same name, except one with a trailing space character, are displayed two times.

• #78 Two folders having the same name, except one with a trailing space character, are considered having the same content.

v2.6.1

Upgrades

• #89 Upgrade Licensor dependency to version 1.24.3
• Upgrade PDF Viewer Macro dependency to version 2.5.2

v2.6

Tasks done:

#63 Update root pom artifact id from "application-filemanager-pom" to "application-filemanager"

#76 Upgrade parent to 13.10-3

Upgraded licensing version to 1.24.1.

v2.5.5

Improvements

• #58 Fix several German translations

v2.5.4

Update the PDF Viewer Macro dependency to version 2.3.3
Update the Licensing dependency version to 1.22

v2.5.3

Bugs fixed:

• #53 Unregistered users cannot download multiple files (package) on Tomcat
• #27 Large stacktrace in console when there is a folder that contains # or $ in its name
• #28 When creating a folder with ## in its name, characters inserted after are not saved

Upgrades:

• PDF Viewer Macro 2.3.2
• Licensing Application 1.21.1

v2.5.2

Bugs fixed:

• #51 The recent files panel can break

v2.5.1

Updated the Licensing dependency to version 1.20
Updated the PDF Viewer Macro dependency version to 2.3

v2.5

Improvements:

• #42 Thumbnails of images have inconsistent dimensions in 'New file' tab.
• #44 Make the "Replace the following file" option clearer to the users.

Update the minimal supported version to XWiki 11.10.
Update the Licensing dependency to version 1.19.

v2.4

New features:

• #34 Add warning/options when uploading a document with the same name but different case.

Improvements:

• #6 Add thumbnails to images files.

Bugs fixed:

• #33 Warnings for deprecated usage of method when using File Manager Pro.

v2.3

Add support for creating drives anywhere in the wiki (any nested wiki page)
Update minimal supported XWiki version to 9.11
Fix some deprecation warning message displayed in the logs

v2.2.11

Show the file path in the files live table and when hovering the files on the Recent Files panel.
Fix: File Manager doesn't work when installed on multiple wikis
Fix: You don't receive a warning message when a large file could not be deleted from File Manager UI

v2.2.10

 Move Application Extension Point to ApplicationsPanelEntry page.

v2.2.9

Fix logged warning messages when using the application.
Fix: Additional message displayed on the application home page when there is no valid license
Fix: Cache with name "unique.documentReference" already exist when upgrading file manager

v2.2.8

Update the Licensing dependency to version 1.13.8
Update the PDF Viewer dependency to version 1.9.4

v2.2.7

Update the Licensing dependency to version 1.13.4.

v2.2.6

Update the PDF Viewer Macro dependency to version 1.9.2.
Update the Licensing dependency to version 1.13.3.

v2.2.5

Update the PDF Viewer Macro dependency to version 1.9.1.
Update the Licensing dependency to version 1.13.2.
Update the JW Player Macro dependency to version 2.1.3.
Updated translations

The "language" macro is not in the list of registered macros. Verify the spelling or contact your administrator.

v2.2.4

Bugs fixed:
#4 A failed upload is not always properly notified.
#5 Cannot upload files on IE9.

v2.2.3

Update the PDF Viewer Macro dependency to version 1.8.3.
Update the Licensing dependency to version 1.13.

v2.2.2

Update the Licensing dependency to version 1.12.2.

v2.2.1

Update the PDF Viewer Macro dependency to version 1.8.1.
Update the Licensing dependency to version 1.12.1.

v2.2

Update the PDF Viewer Macro dependency to version 1.8.
Update the Licensing dependency to version 1.8.
Improve the message displayed when there is no valid license.

v2.1

Initial paid version.

Extension details

License

• GNU Lesser General Public License 2.1

Sources

• https://github.com/xwikisas/application-filemanager/tree/master/application-filemanager-ui

Issues

• GitHub

Type

• xar

Developed by

• XWiki SAS

Compatibility

• Requires  XWiki 14.10 or above.

Dependencies

• com.xwiki.filemanager:application-filemanager-api 2.8
• com.xwiki.licensing:application-licensing-licensor-api 1.25
• org.webjars:angularjs 1.3.8
• org.webjars:angular-ui-bootstrap 0.12.0
• org.webjars:angular-file-upload 2.2.2
• org.xwiki.platform:xwiki-platform-job-webjar 14.10
• org.xwiki.platform:xwiki-platform-tree-webjar 14.10
• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 14.10
• org.xwiki.platform:xwiki-platform-rendering-macro-include 14.10
• org.xwiki.rendering:xwiki-rendering-macro-html 14.10
• org.xwiki.platform:xwiki-platform-localization-source-wiki 14.10
• org.xwiki.platform:xwiki-platform-sheet-ui 14.10
• org.xwiki.platform:xwiki-platform-search-solr-ui 14.10
• org.xwiki.platform:xwiki-platform-jodatime 14.10
• org.xwiki.platform:xwiki-platform-rendering-macro-code 14.10
• org.xwiki.platform:xwiki-platform-office-macro 14.10
• com.xwiki.pdfviewer:macro-pdfviewer-ui 2.5.2
• org.xwiki.contrib:macro-jwplayer 2.1.3