README.md

Component Docs Index

Below is an index of the documentation for ADF. The User Guide section discusses particular techniques in depth. The other sections are references for the ADF libraries. Click the name of an item to see its documentation or click the source link to see its main source file. Note that ADF is developed continuously, so the source files for some items may be listed here before their documentation is available.

See the Version Index for a list of components ordered by the ADF version where they were introduced.

Components are sometimes marked with an icon to show their status. No icon indicates that the component is complete and suitable for normal use. The other status levels are:

• Deprecated - The component is still available but is now obsolete and will probably be removed in a future version of ADF.
• Experimental - The component is available for experimentation but not fully complete and tested for production code.
• Internal - The component is available for internal test use but not meant to be used in production

There is also a set of ADF tutorials that describe how to accomplish tasks step-by-step. See the Tutorials index for the full list.

Contents

• User Guide
• ADF Core
• ADF Content Services
• ADF Process Services
• ADF Insights

User guide

• Angular Material Design
• Form Extensibility and Customisation
• Internationalization in ADF
• Theming
• Typography
• Walkthrough - adding indicators to highlight information about a node

(Back to Contents)

ADF Core

Contains a variety of components used throughout ADF. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
About component	This component allow you to have a general overview of the version of ADF installed and the status of the Content service and Process service.	Source
Buttons menu component	Displays buttons on a responsive menu.	Source
Card view component	Displays a configurable property list renderer.	Source
Accordion group component	Adds a collapsible panel to an accordion menu.	Source
Accordion component	Creates a collapsible accordion menu.	Source
Comment list component	Shows a list of comments.	Source
Comments component	Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content.	Source
Data column component	Defines column properties for DataTable, Tasklist, Document List and other components.	Source
Datatable component	Displays data as a table with customizable columns and presentation.	Source
Form field component	A form field in an APS form.	Source
Form list component	Shows APS forms as a list.	Source
Form component	Shows a Form from APS	Source
Start form component	Displays the Start Form for a process.	Source
Text mask component	Implements text field input masks.	Source
Info drawer layout component	Displays a sidebar-style information panel.	Source
Info drawer component	Displays a sidebar-style information panel with tabs.	Source
Language menu component	Displays all the languages that are present in the "app.config.json" or the default one (EN).	Source
Login component	Authenticates to Alfresco Content Services and Alfresco Process Services.	Source
Infinite pagination component	Adds "infinite" pagination to the component it is used with.	Source
Pagination component	Adds pagination to the component it is used with.	Source
Host settings component	Validates the URLs for ACS and APS and saves them in the user's local storage	Source
Sidebar action menu component	Displays a sidebar-action menu information panel.	Source
Sidenav layout component	Displays the standard three-region ADF application layout.	Source
Sorting picker component	Selects from a set of predefined sorting definitions and directions.	Source
Empty content component	Provides a generic "Empty Content" placeholder for components.	Source
Error content component	Displays info about a specific error.	Source
Toolbar divider component	Divides groups of elements in a Toolbar with a visual separator.	Source
Toolbar title component	Supplies custom HTML to be included in a Toolbar component title.	Source
Toolbar component	Simple container for headers, titles, actions and breadcrumbs.	Source
User info component	Shows user information.	Source
Viewer component	Displays content from an ACS repository.	Source

Directives

Name	Description	Source link
Context menu directive	Adds a context menu to a component.	Source
Highlight directive	Adds highlighting to selected sections of an HTML element's content.	Source
Logout directive	Logs the user out when the decorated element is clicked.	Source
Node delete directive	Deletes multiple files and folders.	Source
Node favorite directive	Selectively toggles nodes as favorites.	Source
Node permission directive	Selectively disables an HTML element or Angular component	Source
Node restore directive	Restores deleted nodes to their original location.	Source
Upload directive	Uploads content in response to file drag and drop.	Source

Models

Name	Description	Source link
Form field model	Contains the value and metadata for a field of a Form component.	Source
Comment process model	Represents a comment added to a Process Services task or process instance.	Source
Product version model	Contains version and license information classes for Alfresco products.	Source
User process model	Represents a Process Services user.	Source
Bpm user model	Contains information about a Process Services user.	Source
Ecm user model	Contains information about a Content Services user.	Source

Pipes

Name	Description	Source link
File size pipe	Converts a number of bytes to the equivalent in KB, MB, etc.	Source
Mime type icon pipe	Retrieves an icon to represent a MIME type.	Source
Node name tooltip pipe	Formats the tooltip for a Node.	Source
Text highlight pipe	Adds highlighting to words or sections of text that match a search string.	Source
Time ago pipe	Converts a recent past date into a number of days ago.	Source
User initial pipe	Takes the name fields of a UserProcessModel object and extracts and formats the initials.	Source

Services

Name	Description	Source link
Card item types service	Maps type names to field component types for the Card View component.	Source
Card view update service	Reports edits and clicks within fields of a Card View component.	Source
Activiti alfresco service	Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS).	Source
Form rendering service	Maps an APS form field type string onto the corresponding form widget component type.	Source
Form service	Implements Process Services form methods	Source
Node service	Gets Alfresco Repository node metadata and creates nodes with metadata.	Source
Process content service	Manipulates content related to a Process Instance or Task Instance in APS.	Source
Alfresco api service	Provides access to an initialized AlfrescoJSApi instance.	Source
Apps process service	Gets details of the Process Services apps that are deployed for the user.	Source
Auth guard bpm service	Adds authentication with Process Services to a route within the app.	Source
Auth guard ecm service	Adds authentication with Content Services to a route within the app.	Source
Auth guard service	Adds authentication to a route within the app.	Source
Authentication service	Provides authentication to ACS and APS.	Source
Comment content service	Adds and retrieves comments for nodes in Content Services.	Source
Comment process service	Adds and retrieves comments for task and process instances in Process Services.	Source
Content service	Accesses app-generated data objects via URLs and file downloads.	Source
Cookie service	Stores key-value data items as browser cookies.	Source
Deleted nodes api service	Gets a list of Content Services nodes currently in the trash.	Source
Discovery api service	Gets version and license information for Process Services and Content Services.	Source
Favorites api service	Gets a list of items a user has marked as their favorites.	Source
Highlight transform service	Adds HTML to a string to highlight chosen sections.	Source
Log service	Provides log functionality.	Source
Nodes api service	Accesses and manipulates ACS document nodes using their node IDs.	Source
Notification service	Shows a notification message with optional feedback.	Source
Page title service	Sets the page title.	Source
People content service	Gets information about a Content Services user.	Source
People process service	Gets information about Process Services users.	Source
Renditions service	Manages prearranged conversions of content to different formats.	Source
Search configuration service	Provides fine control of parameters to a search.	Source
Shared links api service	Finds shared links to Content Services items.	Source
Sites service	Accesses and manipulates sites from a Content Services repository.	Source
Storage service	Stores items in the form of key-value pairs.	Source
Thumbnail service	Retrieves an SVG thumbnail image to represent a document type.	Source
Translation service	Supports localisation.	Source
Upload service	Provides access to various APIs related to file upload features.	Source
User preferences service	Stores preferences for components.	Source
Bpm user service	Gets information about the current Process Services user.	Source
Ecm user service	Gets information about a Content Services user.	Source

Widgets

Name	Description	Source link
Content widget	Shows the content preview.	Source

Other classes and interfaces

Name	Description	Source link
Data Table Adapter interface	Defines how table data is supplied to DataTable and Tasklist components.	Source
Form Field Validator interface	Defines how the input fields of Form and Task Details components are validated.	Source
Search Configuration interface	Provides fine control of parameters to a search.	Source

(Back to Contents)

ADF Content Services

Contains components related to Content Services. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Breadcrumb component	Indicates the current position within a navigation hierarchy.	Source
Dropdown breadcrumb component	Indicates the current position within a navigation hierarchy using a dropdown menu.	Source
Content metadata component	Displays and edits metadata related to a node.	Source
Content node selector panel component	Opens a Content Node Selector in its own dialog window.	Source
Content node selector component	Allows a user to select items from a Content Services repository.	Source
Content action component	Adds options to a Document List actions menu for a particular content type.	Source
Document list component	Displays the documents from a repository.	Source
Add permission dialog component	Displays a dialog to search for people or groups to add to the current node permissions.	Source
Add permission panel component	Searches for people or groups to add to the current node permissions.	Source
Add permission component	Searches for people or groups to add to the current node permissions.	Source
Permission list component	Shows node permissions as a table.	Source
Search check list component	Implements a checklist widget for the Search Filter component.	Source
Search chip list component	Displays search criteria as a set of "chips".	Source
Search control component	Displays a input text which shows find-as-you-type suggestions.	Source
Search date range component	Implements a date range widget for the Search Filter component.	Source
Search filter component	Represents a main container component for custom search and faceted search settings.	Source
Search number range component	Implements a number range widget for the Search Filter component.	Source
Search radio component	Implements a radio button list widget for the Search Filter component.	Source
Search slider component	Implements a numeric slider widget for the Search Filter component.	Source
Search sorting picker component	Provides an ability to select one of the predefined sorting definitions for search results:	Source
Search text component	Implements a text input widget for the Search Filter component.	Source
Search component	Searches items for supplied search terms.	Source
Sites dropdown component	Displays a dropdown menu to show and interact with the sites of the current user.	Source
Like component	Allows a user to add "likes" to an item.	Source
Rating component	Allows a user to add ratings to an item.	Source
Tag actions component	Shows available actions for tags.	Source
Tag list component	Shows tags for an item.	Source
Tag node list component	Shows tags for a node.	Source
File uploading dialog component	Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.	Source
Upload button component	Activates a file upload.	Source
Upload drag area component	Adds a drag and drop area to upload files to ACS.	Source
Upload version button component	Activates a file version upload.	Source
Version list component	Displays the version history of a node in a Version Manager component.	Source
Version manager component	Displays the version history of a node with the ability to upload a new version.	Source
Webscript component	Provides access to Webscript features.	Source

Directives

Name	Description	Source link
Node download directive	Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive.	Source
Node lock directive	Locks a node.	Source
Node share directive	Creates and manages public shared links for files.	Source
Folder create directive	Creates folders.	Source
Folder edit directive	Allows folders to be edited.	Source
Inherited button directive	Update the current node by adding/removing the inherited permissions.	Source
File draggable directive	Provides drag-and-drop features for an element such as a div.	Source

Models

Name	Description	Source link
Document library model	Defines classes for use with the Content Services node API.	Source
Permissions style model	Sets custom CSS styles for rows of a Document List according to the item's permissions.	Source

Services

Name	Description	Source link
Content node dialog service	Displays and manages dialogs for selecting content to open, copy or upload.	Source
Custom resources service	Manages Document List information that is specific to a user.	Source
Document actions service	Implements the document menu actions for the Document List component.	Source
Document list service	Implements node operations used by the Document List component.	Source
Folder actions service	Implements the folder menu actions for the Document List component.	Source
Node permission dialog service	Displays dialogs to let the user set node permissions.	Source
Node permission service	Manages role permissions for content nodes.	Source
Search filter service	Registers widgets for use with the Search Filter component.	Source
Search query builder service	Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.	Source
Rating service	Manages ratings for items in Content Services.	Source
Tag service	Manages tags in Content Services.	Source

Other classes and interfaces

Name	Description	Source link
Search Widget interface	Specifies required properties for Search filter component widgets.	Source

(Back to Contents)

ADF Process Services

Contains components related to Process Services. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Apps list component	Shows all available apps.	Source
Create process attachment component	Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance	Source
Create task attachment component	Displays Upload Component (Drag and Click) to upload the attachment to a specified task	Source
Process attachment list component	Displays attached documents on a specified process instance	Source
Task attachment list component	Displays attached documents on a specified task.	Source
People component	Displays users involved with a specified task	Source
People list component	Shows a list of users (people).	Source
People search component	Searches users/people.	Source
Process comments component	Displays comments associated with a particular process instance and allows the user to add new comments.	Source
Process filters component	Collection of criteria used to filter process instances, which may be customized by users.	Source
Process instance details component	Displays detailed information on a specified process instance	Source
Process instance header component	Sub-component of the process details component, which renders some general information about the selected process.	Source
Process instance tasks component	Lists both the active and completed tasks associated with a particular process instance	Source
Process list component	Renders a list containing all the process instances matched by the parameters specified.	Source
Start process component	Starts a process.	Source
Checklist component	Shows the checklist task functionality.	Source
Start task component	Creates/Starts new task for the specified app	Source
Task details component	Shows the details of the task ID passed in as input.	Source
Task filters component	Shows all available filters.	Source
Task header component	Shows all the information related to a task.	Source
Task list component	Renders a list containing all the tasks matched by the parameters specified.	Source
Task standalone component	This component can be used when there is no form attached to a task.	Source

Directives

Name	Description	Source link
Process audit directive	Fetches the Process Audit information the PDF or JSON format.	Source
Task audit directive	Fetches the Task Audit information in PDF or JSON format.	Source

Models

Name	Description	Source link
Filter model	Contains classes related to filters in Process Services.	Source
Task details model	Information about a task.	Source

Services

Name	Description	Source link
Process filter service	Manage Process Filters, which are pre-configured Process Instance queries.	Source
Process service	Manages Process Instances, Process Variables, and Process Audit Log.	Source
Task filter service	Manage Task Filters, which are pre-configured Task Instance queries.	Source
Tasklist service	Manages Task Instances.	Source

(Back to Contents)

ADF Insights

Contains components for Process Services analytics and diagrams. See the library's README file for more information about installing and using the source code.

Components

Name	Description	Source link
Widget component	Base class for standard and custom widget classes.	Source
Analytics generator component	Generates and shows charts	Source
Analytics report list component	Shows a list of all available reports	Source
Analytics component	Shows the charts related to the reportId passed as input	Source
Diagram component	Displays process diagrams.	Source

(Back to Contents)