-You also need node.js (LTS) installed to build it locally from source code. -
- -**Note:** The latest version of the Alfresco Content platform is required due to the application using the latest [REST APIs](https://docs.alfresco.com/5.2/pra/1/topics/pra-welcome.html) developments. - -## Features - -The concept of this example is a simple user interface which makes accessing files in the Alfresco Content Services repository easy. - -Often Content Management systems provide more capabilities out of the box than most users need; -providing too many capabilities to these users prevents them from working efficiently, -so they may end up using unsanctioned file management solutions which presents a proliferation of content storage -and collaboration solutions as well as compliance issues for organizations. - -This application demonstrates how the complexity of Content Management can be simplified -using the Alfresco Application Development Framework to easily and quickly create custom solutions for specific user cases. - -### User Interface - layout - -There are three main areas of the application controlled by the [Layout component](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/layout): - -1. [Application Header](#header) -2. [Side Navigation](#side-navigation) -3. [Document List](#document-list-layout) - - - -### Header - -The application [header](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/header) has three main elements. - -1. [Logo and Color](#logo-and-color) -2. [Search](#search) -3. [Current User](#current-user) - - - -#### Logo and Color - -Logo & app primary color - logo and color are configurable by updating the -[app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json) file in the root folder of the project. -Please refer to the [Application Configuration](/getting-started/configuration) documentation for more information on how to change the logo and color. - -#### Search - -The application [Search](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/search) - -uses the [ADF Search Component](https://github.com/Alfresco/alfresco-ng2-components/tree/master/lib/content-services/search). -The app provides a 'live' search feature, where users can open files and folders directly from the Search API results. - - - -If you type `Enter` in the text input area, you are going to see [Search Results](#search-results) page -with advanced filtering and faceted search. - -#### Current User - -[Current User](https://github.com/Alfresco/alfresco-content-app/tree/development/src/app/components/current-user) - -displays the user's name, and a menu where users can logout. -Optionally through updating the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json) -a language switching menu can be displayed. - - - -### Side Navigation - -The application [side navigation](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/sidenav) has two features: -a button menu and navigation links. - - - -#### New button - -The New button displays a menu which provides three actions: - -- Create a new folder - provides a dialog which allows the creation of a new folder, the folder name is mandatory and the description is optional. -- Upload a file - invokes the operating system file browser and allows a user to select file(s) to upload into their current location in the content repository. -- Upload a folder - invokes the operating system folder browser and allows a user to select a folder to upload to their current location in the content repository. - -When an upload starts the [upload component](https://github.com/Alfresco/alfresco-ng2-components/tree/master/lib/content-services/upload) -is displayed which shows the user the progress of the uploads they have started. -The upload dialog persists on the screen and can be minimized; users are able to continue using the application whilst uploads are in progress -and uploads can be canceled which will stop uploads in progress or permanently delete already completed uploads. - - - -#### Navigation - -The navigation links are configurable via the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json). -Default configuration creates two sections. -See [Navigation](/getting-started/navigation) for more information about configuring the side navigation. - -### Document List Layout - -The main area of the application is composed of several individual ADF components: - -1. [Breadcrumb](https://alfresco.github.io/adf-component-catalog/components/BreadcrumbComponent.html) -2. [Toolbar](https://alfresco.github.io/adf-component-catalog/components/ToolbarComponent.html) -3. [Document List](https://alfresco.github.io/adf-component-catalog/components/DocumentListComponent.html) -4. [Pagination](https://alfresco.github.io/adf-component-catalog/components/PaginationComponent.html) - - - -The application has seven different Document List views which share commonalities between each view and subtle differences depending on the content being loaded which are explained below. - -#### Personal Files - -Personal Files retrieves all content from the logged in user's home area (`/User Homes/| Action | -File | -Folder | - - -
|---|---|---|
| View | -- Opens the selected file using the Preview component, - where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository. - | -Not applicable | -
| Download | -Downloads single files to the user's computer, when multiple files are selected they are compressed into a ZIP and then downloaded. | -Folders are automatically compressed into a ZIP and then downloaded to the user's computer. | -
| Edit | -Not applicable | -The folder name and description can be edited in a dialog. | -
| Favorite | -- Toggle the favorite mark on or off for files and folders, when multiple items are selected - and one or more are not favorites then the mark will be toggled on. - | -|
| Copy | -- Files and folders can be copied to another location in the content repository using the - content-node-selector component; - once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). - | -|
| Move | -- Files and folders can be moved to another location in the content repository using the - content-node-selector component; - once the move action has completed the user is notified and can undo the action (which moves the items back to the original location). - | -|
| Share | -- Create and copy a link to a file that can be shared, the links are accessible without granting permissions to the file, and do not require users to login to the application. Share links can automatically expire based on a date, the minimum expiry date is controlled by the Content Services repository, which is 1 day from the date of creation. - | -- Not applicable. - | -
| Delete | -- Files and folders can be deleted from their location in the content repository; - once the delete action has completed the user is notified and can undo the action (which restores the items from the trash). - | -|
| Manage Versions | -- Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog; - once each action has completed the list of versions is updated according to the change. - | -Not applicable | -
| Permissions | -- Permissions on a file can be adjusted as required in a number of ways; disable inheritance from the parent folder, change a user or groups role and grant users/groups access. - | -Not available | -
| Action | +File | +Folder | + + +
|---|---|---|
| View | ++ Opens the selected file using the Preview component, + where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository. + | +Not applicable | +
| Download | +Downloads single files to the user's computer, when multiple files are selected they are compressed into a ZIP and then downloaded. | +Folders are automatically compressed into a ZIP and then downloaded to the user's computer. | +
| Edit | +Not applicable | +The folder name and description can be edited in a dialog. | +
| Favorite | ++ Toggle the favorite mark on or off for files and folders, when multiple items are selected + and one or more are not favorites then the mark will be toggled on. + | +|
| Copy | ++ Files and folders can be copied to another location in the content repository using the + content-node-selector component; + once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). + | +|
| Move | ++ Files and folders can be moved to another location in the content repository using the + content-node-selector component; + once the move action has completed the user is notified and can undo the action (which moves the items back to the original location). + | +|
| Share | ++ Create and copy a link to a file that can be shared, the links are accessible without granting permissions to the file, and do not require users to login to the application. Share links can automatically expire based on a date, the minimum expiry date is controlled by the Content Services repository, which is 1 day from the date of creation. + | ++ Not applicable. + | +
| Delete | ++ Files and folders can be deleted from their location in the content repository; + once the delete action has completed the user is notified and can undo the action (which restores the items from the trash). + | +|
| Manage Versions | ++ Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog; + once each action has completed the list of versions is updated according to the change. + | +Not applicable | +
| Permissions | ++ Permissions on a file can be adjusted as required in a number of ways; disable inheritance from the parent folder, change a user or groups role and grant users/groups access. + | +Not available | +