Anatomy of an ADF 1.9 application

Document created by alfresco Employee on Sep 29, 2017Last modified by alfresco Employee on Oct 6, 2017
Version 2Show Document
  • View in full screen mode

This content is part of the Alfresco ADF getting started tutorial and describes how to understand your Angular application built using Alfresco ADF from the angular-cli-adf-app project. In the following sections we are going to discover the anatomy of the web application to understand the basis on the definition of an Angular application.

 

The Alfresco ADF application as a standard Angular application

 

As clearly described since the very beginning, an Alfresco ADF application is a standard Angular application. If you are not familiar with the Angular development, we suggest to go through the Tour of Heroes tutorial and the Architecture Overview. It is not an easy read the very first time, but as every new technology, it will appear understandable after some training.

As a standard Angular application, an Alfresco ADF application can be described as following.

 

An Alfresco ADF application has a root module named AppModule. The root module is the only Angular module (or NgModule) of the whole application, even if a service module named ADFModule is provided, containing all the ADF specific modules in one place.

 

An Alfresco ADF application is composed by Angular Components, some of them provided by Alfresco in its Alfresco Angular Components project. The Alfresco Angular Components are released as Open Source under the Apache 2.0 license.

 

An Alfresco ADF application uses Angular CLI as module bundler to incorporate assets that belong together and should be served to the client in a response to a single file request.

 

The structure of an ADF application

 

Now that we know how an Alfresco ADF application is related to a standard Angular application, let’s share more details about the application’s structure. Looking at the Alfresco ADF application into the file system, we can recognise all the modules and components introduced above. In the following picture is showed an example of Alfresco ADF application, built starting from the angular-cli-adf-app project.

 

 

The structure of the application is quite straightforward, if you know how an Angular application works. All the source code is defined into the src folder, detailed in its structure, into the following picture.

 

 

Below some highlights on the most important files and folders, for the correct execution of the angular-cli-adf-app application.

 

  • index.html This is the starting point for each session. The file is a regular HTML file, except for the <app-root> tag that links the root module, where all the magic happens. This file contains the <html>, <head> and <body> content, common to all the pages of our application.

 

  • main.ts This is the TypeScript file used for bootstrapping. This file indicates where to start bootstrapping, using the AppModule class (the Angular root module) declared into the app/app.module.ts file.

 

  • app folder. This folder contains the core content of the Angular application, defined by the root module and the components. In the following picture is showed the corresponding app folder of our angular-cli-adf-app application.

 

 

Below some highlights on the most important content in the app folder.

 

  • app.module.ts This is the TypeScript file containing the AppModule class (the Angular root module). This class defines:
    • The list of Angular components, used in the application. In this specific application they are hosted into the components folder.
    • The Angular routing to enable the navigation from one view to the next.
    • The bootstrapping component, in our case named AppComponent, stored into the app.component.* files.

 

  • app.component.css, html, spec.ts and ts Those files define a standard Angular component, controlling a patch of screen called a view. In particular:
    • app.component.css defines the specific stylesheet of the component.
    • app.component.html defines the HTML generated by the component (in this case, exactly where the tag <app-root> appears into the index.html file).
    • app.component.spec.ts is the Unit Tests in TypeScript for the component.
    • app.component.ts is the TypeScript file declaring the AppComponent class implementing the real business logic (and behavior) of the component.

 

  • The component folders. The folders contain all the Angular components used in the application. In the picture: DataTable, DocumentList, Home, Login and Viewer. The implementation of each Angular component, really depends on the component’s role and goal in each specific application. We won’t detail here the listed components, because some of them are extremely specific for this sample application.

 

Material 2 in ADF applications

 

Before moving a step further, there is another topic to discuss about the ADF applications: the stylesheet. ADF applications are designed and developed to work with the Material 2, the Google's Material Design components for Angular. We won’t discuss here the basis of that design language. If you want to learn more about it, you can start from the Official Documentation for a better understanding.

From a technical point of view, the relevant thing we are interested to share, is that every ADF application is designed according to Material 2. And this means:

 

 

  • Each ADF component generates the HTML portion, according to the Material 2. You can find the HTML template in the *.component.html file of each folder containing an ADF component.

 

  • Each ADF component can have a custom stylesheet declared into the *.component.css file. If you check into the angular-cli-adf-app application, in particular into each folder containing an ADF component, you can find a *.component.css file, or you cannot find it if the default Material 2 is enough. Those *.component.css files are exactly the place where we are going to act to customise the colours and stylesheet in general.

 

These are all the main basis to understand the anatomy of a standard Angular application built using Alfresco ADF, from the angular-cli-adf-app project.

Attachments

    Outcomes