Book Image

Alfresco Developer Guide

Book Image

Alfresco Developer Guide

Overview of this book

Table of Contents (17 chapters)
Alfresco Developer Guide
Credits
About the Author
About the Reviewers
Preface
Index

Web Client Config Elements


The web client is configured using an XML format proprietary to Alfresco. At a high level, there are two types of configuration elements in the XML. The first type uses an evaluator for condition-specific configuration. The second includes unconditional configuration elements. This section contains one table for each type of configuration element. The tables include what they do and where they can be found out of the box.

Conditional Configuration Elements

This table lists elements that are conditional. Conditional elements use one of the three evaluators: node-type, aspect-name, or string-compare. For example, the out of the box Languages configuration element is shown here:

<config evaluator="string-compare" condition="Languages">
      <!-- the list of available language files -->
      <languages>
         <language locale="en_US">English</language>
      </languages>
</config>

The following table lists conditional configuration elements:

Evaluator

Condition

What it does

Where it is defined

node-type

[node type]

Configuration for nodes matching a specific node type. Typically used for property sheets, but can be used for any conditional configuration based on node type.

web-client-config-properties.xml

aspect-name

[aspect name]

Configuration for nodes that have a matching aspect applied. Typically used for property sheets, but can be used for any conditional configuration based on aspect name.

web-client-config-properties.xml

string-compare

Server

Commented out by default; specifies host name and port when using Alfresco behind a proxy.

web-client-config.xml

string-compare

Languages

Lists the languages in the login drop-down.

web-client-config.xml

string-compare

Views

View selections available in the web client ("list", "details", and "icons")

web-client-config.xml

string-compare

Node Event Listeners

Lists JSF-managed beans that the BrowseBean should notify on changes.

web-client-config.xml

string-compare

Command Servlet

Lists the available servlet command processors.

web-client-config.xml

string-compare

Advanced Search

Configures types, folders, aspects, and properties listed on the advanced search page.

web-client-config.xml

string-compare

Dashboards

Dashboard layouts and dashlets shown on My Alfresco.

web-client-config.xml

string-compare

Sidebar

Lists available sidebar plug-ins ("Navigator", "Shelf", and "Open Search").

web-client-config.xml

string-compare

Space Wizards

Lists the folder types that show up when you use the Advanced Space Wizard.

web-client-config.xml

string-compare

Action Wizards

Lists the types, aspects, and transformers to show in drop-downs when configuring a rule action. Also used to configure condition handler and action handler classes.

web-client-config.xml

string-compare

cm:folder icons

Lists the icon images to show as choices when a user creates a folder.

web-client-config.xml

string-compare

fm:forums icons

Specifies the high-level "forums" icon.

web-client-config.xml

string-compare

fm:forum icons

Specifies the "forum" icon.

web-client-config.xml

string-compare

fm:topic icons

Specifies the icons related to different post types.

web-client-config.xml

Unconditional Configuration Elements

Some web client config elements do not use an evaluator. They are just children of alfresco-config/config. For example, this is the start of the out of the box configuration element for wcm:

<alfresco-config>
   <config>
      <wcm>
         <workflows>
            wcmwf:submit,scwf:noApprovalSubmit
         </workflows>

...

The following table shows the unconditional web client configuration elements:

Configuration Element

What it does

Where it is defined

client

Controls various client settings such as the error page, the login page, the number of items you see in certain lists, the default location the user sees on login, and the from email address.

web-client-config.xml

navigation

Configures navigational overrides based on node-type, aspect-name, or other evaluators.

web-client-config-navigation.xml

wizards

Defines multi-step dialogs, or wizards. See Chapter 5.

web-client-config-wizards.xml

dialogs

Defines dialog icon, JSP, and managed beans.

web-client-config-dialogs.xml

actions

Defines UI Actions and action groups. See "Action Groups" in this Appendix.

Various

wcm

Defines the workflows available from within a web project, default view size, XForms widgets, link checking polling frequency, and deployment progress polling frequency.

web-client-config-wcm.xml