The document library provides a user interface for setting aspects onto your documents. It gives you a list of available aspects to pick from. The list is generated within the document library services.

You can add your kb:article aspect to this list by configuring the document library services responsible for handing back document library aspects. This is implemented as a single Web script. As you might suspect, it hands back a JSON string that lists all of the aspect information for a given document. The JSON string looks like this:

{
   "current": ["cm:auditable", "sys:referenceable", "cm:titled",
               "cm:author","app:inlineeditable"],
   "visible": ["cm:generalclassifiable","cm:complianceable","cm:dublincore",
               "cm:effectivity","cm:summarizable","cm:versionable",
               "cm:templatable","cm:emailed","emailserver:aliasable",
               "cm:taggable"],
   "addable": [],
   "removeable": []
}

If you're not an expert on JSON, fear not. It's pretty straight forward. The JSON lists out four properties – current, visible, addable, and removeable. Each property has an array of aspects. The current property contains the array of all of the aspects that are currently applied to the document. The visible property contains the array of all of the aspects potentially available for the current document. The addable and removeable properties contain the arrays of aspects that can be added to or removed from the current document.

The document library uses this information within Alfresco Share to figure out how to render a meaningful user interface to the end user. All of this comes back from a single repository-side Web script. This Web script looks to a single configuration file to determine which aspects should be visible to the end user. This file is called aspects.get.config.xml.

You can make your kb:article aspect visible by adding it to this configuration file. You could also specify whether your kb:article aspect can be added or removed by document library users. The configuration is essentially as simple as the following code.

<aspects>
   <visible>
      ...
      <aspect name="{http://www.alfresco.org/model/knowledgebase/1.0}article" />
      ...
   </visible>
</aspects>

A full configuration example is provided at the end of this chapter. However, this is the general idea. This simple configuration adjustment enables the document library to work with your Knowledge Base article aspect.

The document library also provides a user interface that lets you run repository actions against your documents. The actions appear on the right-hand side of the document list page. Clicking on an action tells Alfresco Share to fire into the appropriate action handler within the document library services.

A Web script within Alfresco Share generates the list of actions. This Web script is configuration-driven just like the previous one. This means that you can adjust the list of actions through configuration without having to do any coding.

Suppose you wanted to add an action to the right-hand side of the document library. It's easy enough to do. You could adjust the Web script configuration file to appear something like this:

<documentList>
   <actionSets>
      <actionSet id="empty"></actionSet>
      <actionSet id="document">
         ...
         <action id="onActionArchive" type="action-link" permission=""
                 label="actions.document.archive" />
         ...
      </actionSet>

<actionSet id="locked">...</actionSet>
      <actionSet id="lockOwner">...</actionSet>
      <actionSet id="workingCopyOwner">...</actionSet>
      <actionSet id="folder">...</actionSet>
      <actionSet id="link">...</actionSet>
   </actionSets>
</documentList>

This configuration file lets you describe actions that are to be available for documents in various states. For example, you can define which actions should be available for documents that are locked. Or you can define which actions should be available for folders.

The new configuration for the new action is shown in bold. This describes a new action with the ID onActionArchive. It is to be made available when documents are selected in the document library.

You then need to define a JavaScript function that is responsible for handling this action within the browser. When you click on the new action, Alfresco Share will look for a browser-side JavaScript method named onActionArchive to handle the click. You need to supply a browser-side JavaScript file that defines this click handler.

The actions-common.get.head.ftl file defines what should appear in the HEAD of the HTML markup for the document list. You can modify this file to include your own <script> tag to pull in browser-side JavaScript. In the example that you'll install, you will have this file pull in JavaScript from the knowledgebase-action.js file.

The knowledgebase-action.js file defines the function that handles the click. It uses the Alfresco Share client-side API to call back to the Alfresco Share server with a proxy request. The proxy request asks Alfresco Share to call over to the Alfresco repository on behalf of the user. In other words, Alfresco Share will call over to the Alfresco repository and access the document library services on your behalf.

You might choose to have your JavaScript function make a proxy request over to one of the out-of-the-box document library Web scripts. Or you may choose to write your own Alfresco repository Web script as an action handler. It is completely up to you.

In the case of knowledgebase-action.js, the function asks Alfresco Share to invoke a custom action handler. You add the action handler to the document library services by defining a new Web script in the repository. This Web script responds to the POST method. It is written in the style of the Alfresco Share repository Web scripts and uses a library that allows it to handle one document or multiple documents at once.

The Web script considers the incoming document nodes. If they are valid, the script sets the kb:status property of the documents to the value of Archived. This indicates an Archived lifecycle state in your Knowledge Base.

Alfresco Share lets you configure the workflows that can be launched from within the document library. As before, the document library uses a Web script to determine which workflows should be shown to the end user for selection. There is a single Web script file that you can tweak:

/org/alfresco/modules/documentlibrary/workflow.get.html.ftl

You can edit the file and modify its contents to include the following fragment:

<div class="field">
   <select id="${el}-type" name="type" tabindex="0">
      <option value="wf:review" selected="selected">Review &amp; Approve</option>
      <option value="wf:articleapproval">KB Article Review &amp; Approve</option>
      <option value="wf:adhoc">Adhoc Task</option>
   </select>
</div>

The section shown in bold is new. By adding that in, the selector for the document library will let you choose the wf:articleapproval workflow. This ID matches the ID of the workflow declared in the kb-approval-process-definition.xml file that defines your workflow. Alfresco Share will then make the wf:articleapproval workflow available to your users.

You define forms within the share-config-custom.xml file. Within this file, you can override everything from a form definition for a particular content type to all aspects of the form presentation system. The configuration file specification follows. There's a lot that you can do!

<config>
   <forms>
      <default-controls>
         <type name="type" template="path">
            <control-param name="name">value</control-param>
         </type>
      </default-controls>
      <constraint-handlers>
         <constraint type="id" validation-handler="function" [message-id="key"]
            [message="string"] [event="string"] />
      </constraint-handlers>
      <dependencies>
         <js src="path" />
         <css src="path" />
      </dependencies>
   </forms>
</config>

<config evaluator="node-type" condition="type">
   <forms>
      <form [id="string"] [submission-url="url"]>
         <view-form template="path" />
         <edit-form template="path" />
         <create-form template="path" />
         <field-visibility>
            <show id="string" [for-mode="view|edit|create"] [force="boolean"] />
            <hide id="string" [for-mode="view|edit|create"] />
         </field-visibility>
         <appearance>
            <set id="string" appearance="fieldset|panel" [parent="string"]
                 [label="string"] [label-id="key"] [template="path"] />
            <field id="string" [label-id="key"] [label="string"] [description-
                   id="key"] [description="string"]
                  [read-only="boolean"] [mandatory="boolean"] [set="string"]>
               <control [template="path"]>
                  <control-param name="name">value</control-param>
               </control>

<constraint-handlers>
                  <constraint type="id" validation-handler="function" [message-
                              id="string"] [message="string"] [event="string"] />
               </constraint-handlers>
            </field>
         </appearance>
      </form>
   </forms>
</config>

Imagine that the Forms engine is asked to render an edit-form for your Knowledge Base article. It begins by looking for a configuration block that is appropriate for your article. This configuration block defines the template to use for the form as well as all of the controls.

In your Knowledge Base content model, you allowed any kind of content to be an article. In fact, you explicitly sought to use aspects so as to make things more flexible. Thus, you can provide your form for cm:content. This is the base content type within Alfresco.

The configuration block might look like this:

<config evaluator="node-type" condition="cm:content">
   <forms>
      <default-controls>
         <type name="text"
               template="/org/alfresco/components/form/controls/textfield.ftl" />
      </default-controls>
      <form>
         <edit-form template="/2-column-edit-form.ftl" />
         <field-visibility>
            <show id="kb:articletype" />
            <show id="kb:status" for-mode="view" />
         </field-visibility>
         <appearance>
            <field id="kb:articletype" label="Article Type"
                   description="Knowledge Base Article Type" />
            <field id="kb:status" label="Status" description="Approval Status" />
         </appearance>
      </form>
   </forms>
</config>

When the Forms engine is asked to render an edit-form for a content object of type cm:content, it will gather together all of the configuration blocks and will include yours. Your configuration block instructs the Forms engine to do the following:

The Forms engine will look to the <edit-form> element's template attribute to determine which FreeMarker file to use for the form layout. If this isn't provided, it will use the default form layout.

The Forms engine then begins to walk through the properties of the content object. For each property, it must determine which control to use as well as look to the configuration to inform the control about what appearance settings to use.

Consider the kb:status property of type d:text. The Forms engine has to figure out what kind of control to render to the screen for this field. The Forms engine has a number of default controls set up out of the box for the Data Dictionary types (such as d:text).

However, you can also override the default controls as shown in the previous <default-controls> element. You've indicated that text fields should use a specific FreeMarker template. This overrides the out-of-the-box settings. You can also provide form-specific overrides for the view-form if you wish.

The Forms engine renders all of the controls onto the screen by invoking FreeMarker for all of the individual controls. The FreeMarker files are located in the share.war file but you can also override them or implement your own by placing your templates under the /web-extension/templates directory.

This is just an example of what you can do with the Forms engine. As you can see from the full configuration settings, you can also do things like indicate browser-side constraints. You'll install a Forms configuration file as part of the sample file installation process.

Begin by adding a custom workflow to your Alfresco repository. A custom workflow comprises a process definition file and a workflow bootstrap file. The latter consists of a Spring bean that informs the Alfresco repository of the new workflow process definition.

From the following directory:

copy the following files:

to:

Now you'll introduce a custom Web script that will act as an HTTP POST handler for your Archive action.

From the following directory:

copy the following files:

to:

At this point, you will inform the document library to make your custom kb:article aspect visible.

From the following directory:

copy the following file:

to:

The Document Library page in Alfresco Share features a list of actions along the right-hand side. You would like to add a new Archive action to this list.

When users click the Archive action, an HTTP POST should be performed to the Alfresco repository server. The Web script on that side will put your content into an Archived state.

From the following directory:

copy the following files:

to:

Earlier, you defined your new custom workflow process and bootstrapped it into the Alfresco repository. You would now like to configure Alfresco Share so that your workflow process appears for end users. You will enable end users to select your workflow and launch it.

From the following directory:

copy the following file:

to:

Alfresco Share comes out of the box with the ability to render metadata forms for viewing and editing content objects. All you need to do is provide the form definitions and associate them to your kb:article aspect. You can do all of this within the Alfresco Share configuration file.

From the following directory:

copy the following file:

to:

<installLocation>	omcatsharedclassesalfrescoweb-extension

If you worked through Chapter 15, then you will need to overwrite a file with the same name.

You will also need to copy in the template for your form.

From the following directory:

copy the following file:

to:

<installLocation>	omcatsharedclassesalfrescoweb-extensionsite-webscripts

Your custom message bundle defines text values for the default locale. If you want to provide additional bundles for other locales, you just need to assign the correct suffix extensions.

From the following location:

copy the following file:

to:

If you worked through Chapter 15, then you will need to overwrite a file with the same name.

To include your own custom message bundle along with the Alfresco Share message bundles so that you can fully support I18N with your new site preset, you need to override the Spring bean responsible for doing so.

From the following location:

copy the following file:

to:

If you worked through Chapter 15, then you will need to overwrite a file with the same name.

The web.xml file is a required file for the ROOT Web application. If it already exists in your Tomcat server, you can skip to the next step. If it doesn't exist, you may have to create the following directory structures by hand.

From the following location:

copy the following file:

to:

From the following location:

copy the following files:

to:

From the following location:

copy the following file:

to:

The following files should be placed into this directory:

<installLocation>	omcatsharedclassesalfrescoextension

Defines a custom Knowledge Base – article approval workflow

<?xml version="1.0" encoding="UTF-8"?>
<process-definition xmlns="urn:jbpm.org:jpdl-3.1" name="wf:articleapproval">

   <swimlane name="initiator" />

   <start-state name="start">
      <task name="wf:submitReviewTask" swimlane="initiator" />
         <event type="node-leave">

            <!-- Call script once the package exists i.e. on node-leave -->
            <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">

               <!-- Check you have a document attached to the package -->
               <!-- Apply the KB Aspect (kb:status) if not set already. -->
               <!-- Note: The default kb:status property is draft -->
                  <script>
                var l = bpm_package.children.length;
                if (l > 0)
                {
                          for (var i = 0, child = null; l > i; i++)
                          {
                            child = bpm_package.children[i];
                      if (!child.hasAspect("kb:status"))
                      {
                         child.addAspect("kb:status");
                         child.save();
                      }
                          }
                }
                else
                {
                   if (logger.isLoggingEnabled())
                   {
                      logger.log("Error: Package has no content. Length: " +
                         bpm_package.children.length + " Package: " + bpm_package);
                   }
                }
                </script>
            </action>
         </event>
      <transition name="" to="review" />
   </start-state>

   <swimlane name="reviewer">
       <assignment actor-id="#{bpm_assignee.properties['cm:userName']}" />
   </swimlane>

<task-node name="review">
      <!-- Update the status to In Review when you enter this task -->
      <event type="node-enter">
         <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
            <script>
               for (var i = 0, child = null,
                    l = bpm_package.children.length; l > i; i++)
               {
                  child = bpm_package.children[i];
                  child.properties["kb:status"] = "Pending Approval";
                  child.save();
               }
            </script>
         </action>
      </event>

      <task name="wf:reviewTask" swimlane="reviewer">
         <event type="task-create">
            <script>
               if (bpm_workflowDueDate != void)
               {
                  taskInstance.dueDate = bpm_workflowDueDate;
               }
               if (bpm_workflowPriority != void)
               {
                  taskInstance.priority = bpm_workflowPriority;
               }
             </script>
          </event>
      </task>
      <transition name="reject" to="rejected" />
      <transition name="approve" to="approved"/>
   </task-node>

   <task-node name="rejected">
      <!-- Update the status to Draft when you enter this task -->
      <event type="node-enter">
         <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
            <script>
               for (var i = 0, child = null,
                    l = bpm_package.children.length; l > i; i++)
               {
                  child = bpm_package.children[i];
                  child.properties["kb:status"] = "Draft";
                  child.save();
               }
            </script>
         </action>
      </event>
      <task name="wf:rejectedTask" swimlane="initiator" />
      <transition name="" to="end" />
   </task-node>

   <task-node name="approved">

<!-- Update the status to Approved when you enter this task -->
      <event type="node-enter">
         <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
            <script>
               for (var i = 0, child = null,
                    l = bpm_package.children.length; l > i; i++)
               {
                  child = bpm_package.children[i];
                  child.properies["kb:status"] = "Current";
                  child.save();
               }
            </script>
         </action>
      </event>

      <task name="wf:approvedTask" swimlane="initiator" />
      <transition name="" to="end" />
   </task-node>

   <end-state name="end" />

   <event type="process-end">
      <!-- Update the status to Approved when you enter this task -->
      <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
         <script>
            if (cancelled)
            {
               for (var i = 0, child = null,
                    l = bpm_package.children.length; l > i; i++)
               {
                  child = bpm_package.children[i];
                  if (child.hasAspect("kb:status"))
                  {
                     child.properties["kb:status"] = "Draft";
                     child.save();
                  }
                  if (logger.isLoggingEnabled())
                  {
                     logger.log("Workflow cancelled, status reset to Draft");
                  }
               }
            }
            if (logger.isLoggingEnabled())
            {
               logger.log("Workflow completed");
            }
         </script>
      </action>
   </event>

</process-definition>

Code snippet extensionkb-approval-process-definition.xml

Bootstraps the custom workflow into the Alfresco repository

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN'
   'http://www.springframework.org/dtd/spring-beans.dtd'>
<beans>

   <bean id="parallel.workflowBootstrap" parent="workflowDeployer">
      <property name="workflowDefinitions">
         <list>
            <props>
               <prop key="engineId">jbpm</prop>
               <prop key="location">
                  alfresco/extension/kb-approval-process-definition.xml
               </prop>
               <prop key="mimetype">text/xml</prop>
               <prop key="redeploy">false</prop>
            </props>
         </list>
      </property>
   </bean>

</beans>

Code snippet extensionkb-workflow-context.xml

The following files should be placed into this directory:

Defines the POST action handler Web script for the document library services

<webscript>
   <shortname>Archive</shortname>
   <description>
      Document List Action - Archive Knowledge Base articles
   </description>
   <url>/slingshot/doclib/action/archive/site/{site}/{container}</url>
   <format default="json">argument</format>
   <authentication>user</authentication>
   <transaction>required</transaction>
</webscript>

Code snippet extension emplateswebscriptsorgalfrescoslingshotdocumentlibraryactionarchive.post.desc.xml

Scriptable controller for the POST action handler Web script

<import resource="classpath:/alfresco/templates/webscripts/org/alfresco/slingshot 
                  /documentlibrary/action/action.lib.js">

/**
 * Archive multiple files action
 * @method POST
 */

/**
 * Entrypoint required by action.lib.js
 *
 * @method runAction
 * @param p_params {object} Object literal containing files array
 * @return {object|null} object representation of action results
 */
function runAction(p_params)
{
   var results = [];
   var files = p_params.files;
   var file, fileNode, result, nodeRef;

   // Must have array of files
   if (!files || files.length == 0)
   {
      status.setCode(status.STATUS_BAD_REQUEST, "No files.");
      return;
   }

   for (file in files)
   {
      nodeRef = files[file];
      result =
      {
         nodeRef: nodeRef,
         action: "archiveFile",
         success: false
      }

      try
      {
         fileNode = search.findNode(nodeRef);
         if (fileNode === null)
         {
            result.id = file;
            result.nodeRef = nodeRef;
            result.success = false;
         }
         else
         {
            if (fileNode.properties["kb:status"] != "Current")
            {

// Only knowledge base articles with staus "Current" may be archived
               status.setCode(status.STATUS_BAD_REQUEST, "No Current");
               return;
            }
            else
            {
               result.id = fileNode.name;
               result.type = fileNode.isContainer ? "folder" : "document";
               result.nodeRef = nodeRef;

               // set the kb:status property to "Archived"
               fileNode.properties["kb:status"] = "Archived";
               fileNode.save();

               result.success = (result.nodeRef !== null);
            }
         }
      }
      catch (e)
      {
         result.id = file;
         result.nodeRef = nodeRef;
         result.success = false;
      }

      results.push(result);
   }

   return results;
}

/* Bootstrap action script */
main();

Code snippet extension emplateswebscriptsorgalfrescoslingshotdocumentlibraryactionarchive.post.json.js

Template view for the POST action handler Web script

<#import "action.lib.ftl" as actionLib />
<@actionLib.resultsJSON results=results />

Code snippet extension emplateswebscriptsorgalfrescoslingshotdocumentlibraryactionarchive.post.json.ftl

This file should be placed in the following location:

Defines the availability of aspects within the document library

<aspects>
 <visible>
  <aspect name="{http://www.alfresco.org/model/content/1.0}generalclassifiable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}complianceable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}dublincore" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}effectivity" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}summarizable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}versionable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}templatable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}emailed" />
  <aspect name="{http://www.alfresco.org/model/emailserver/1.0}aliasable" />
  <aspect name="{http://www.alfresco.org/model/content/1.0}taggable" />
  <aspect name="{http://www.alfresco.org/model/knowledgebase/1.0}article" />
 </visible>

 <!-- Aspects that a user can add. Same as "visible" if left empty -->
 <addable>
 </addable>

 <!-- Aspects that a user can remove. Same as "visible" if left empty -->
 <removeable>
 </removeable>
</aspects>

Code snippet extension emplateswebscriptsorgalfrescoslingshotdocumentlibraryaspects.get.config.xml

The following file should be placed in this location:

Custom Alfresco Share configuration file

<alfresco-config>
   <!-- Put Share Client in debug mode -->
   <!--
      <config replace="true">
         <flags>
            <client-debug>true</client-debug>
            <client-debug-autologging>true</client-debug-autologging>
         </flags>

</config>
   -->

   <!-- Add a custom page type -->
   <config evaluator="string-compare" condition="SitePages" replace="true">
      <pages>
         <page id="calendar">calendar</page>
         <page id="wiki-page">wiki-page?title=Main_Page</page>
         <page id="documentlibrary">documentlibrary</page>
         <page id="discussions-topiclist">discussions-topiclist</page>
         <page id="blog-postlist">blog-postlist</page>
         <page id="links">links</page>
         <page id="tasks">tasks</page>
         <page id="knowledgebase">knowledgebase</page>
      </pages>
   </config>

   <!-- Specify another theme as the default theme -->
   <config evaluator="string-compare" condition="WebFramework">
      <web-framework>
         <application-defaults>
            <theme>default</theme>
         </application-defaults>
      </web-framework>
   </config>

   <!-- Form definition for cm:content -->
   <config evaluator="node-type" condition="cm:content">
      <forms>
         <form>

            <!-- 2 column template -->
            <edit-form template="/2-column-edit-form.ftl" />

            <field-visibility>

               <show id="sys:node-dbid" for-mode="view" />

               <show id="kb:articletype" />

               <show id="kb:status" for-mode="view" />

            </field-visibility>

            <appearance>
               <field id="sys:node-dbid" label="KBID"
                      description="Knowledge Base ID" />
               <field id="kb:articletype" label="Article Type"
                      description="Knowledge Base Article Type" />
               <field id="kb:status" label="Status"
                      description="Approval Status" />
            </appearance>

</form>
      </forms>
   </config>

</alfresco-config>

Code snippet web-extensionshare-config-custom.xml

The following file should be placed in this location:

A two-column edit-form for metadata in Alfresco Share

<#import "/org/alfresco/components/form/form.lib.ftl" as formLib />

<#if error?exists>
   <div class="error">${error}</div>
<#elseif form?exists>

   <#assign formId=args.htmlid + "-form">
   <#assign formUI><#if args.formUI??>${args.formUI}<#else>true</#if></#assign>

   <#if formUI == "true">
      <@formLib.renderFormsRuntime formId=formId />
   </#if>

   <div id="${formId}-container" class="form-container">

      <#if form.showCaption?exists && form.showCaption>
         <div id="${formId}-caption" class="caption">
         <span class="mandatory-indicator">*</span>
         ${msg("form.required.fields")}</div>
      </#if>

      <#if form.mode != "view">
         <form id="${formId}" method="${form.method}" accept-charset=
         "utf-8" enctype="${form.enctype}" action="${form.submissionUrl}">
      </#if>

      <div id="${formId}-fields" class="form-fields">
        <#list form.structure as item>
            <#if item.kind == "set">
               <@renderSetWithColumns set=item />
            <#else>
               <@formLib.renderField field=form.fields[item.id] />
            </#if>
         </#list>
      </div>

<#if form.mode != "view">
         <@formLib.renderFormButtons formId=formId />
         </form>
      </#if>

   </div>
</#if>

<#macro renderSetWithColumns set>
   <#if set.appearance?exists>
      <#if set.appearance == "fieldset">
         <fieldset><legend>${set.label}</legend>
      <#elseif set.appearance == "panel">
         <div class="form-panel">
            <div class="form-panel-heading">${set.label}</div>
            <div class="form-panel-body">
      </#if>
   </#if>

   <#list set.children as item>
      <#if item.kind == "set">
         <@renderSetWithColumns set=item />
      <#else>
         <#if (item_index % 2) == 0>
         <div class="yui-g"><div class="yui-u first">
         <#else>
         <div class="yui-u">
         </#if>
         <@formLib.renderField field=form.fields[item.id] />
         </div>
         <#if ((item_index % 2) != 0) || !item_has_next></div></#if>
      </#if>
   </#list>

   <#if set.appearance?exists>
      <#if set.appearance == "fieldset">
         </fieldset>
      <#elseif set.appearance == "panel">
            </div>
         </div>
      </#if>
   </#if>
</#macro>

Code snippet web-extensionsite-webscripts2-column-edit-form.ftl

The following file should be placed in this location:

Customization that includes additional JS reference

<#include "../component.head.inc">

<!-- Actions -->
<@script type="text/javascript" src="${page.url.context}/components/
documentlibrary/actions.js"></@script>

<!-- Simple Dialog -->
<@script type="text/javascript" src="${page.url.context}/
modules/simple-dialog.js"></@script>

<!-- Copy-To -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/copy-to.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/copy-to.js"></@script>

<!-- Move-To -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/move-to.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/move-to.js"></@script>

<!-- Details -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/details.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/details.js"></@script>

<!-- Tag Library -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/taglibrary/taglibrary.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/taglibrary/taglibrary.js"></@script>

<!-- Assign Workflow -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/workflow.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/workflow.js"></@script>

<!-- People Finder Assets (req'd by Assign Workflow)  -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
components/people-finder/people-finder.css" />
<@script type="text/javascript" src="${page.url.context}/
components/people-finder/people-finder.js"></@script>

<!-- Manage Permissions -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/permissions.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/permissions.js"></@script>

<!-- Manage Aspects -->
<@link rel="stylesheet" type="text/css" href="${page.url.context}/
modules/documentlibrary/aspects.css" />
<@script type="text/javascript" src="${page.url.context}/
modules/documentlibrary/aspects.js"></@script>

<!-- KB Archive Action -->
<script type="text/javascript" src="${page.url.context}-extension/
components/documentlibrary/knowledgebase-actions.js"></script>

Code snippet web-extensionsite-webscriptsorgalfrescocomponentsdocumentlibraryactions-common.get.head.ftl

This file should be placed in the following location:

Includes additional archive action for documents

<documentList>

   <actionSets>

      <actionSet id="empty"></actionSet>

      <actionSet id="document">
         <action id="onActionDownload" type="simple-link"
                 href="{downloadUrl}" label="actions.document.download" />
         <action id="onActionDetails" type="action-link" permission="edit"
                 label="actions.document.edit-metadata" />
         <action id="onActionUploadNewVersion" type="action-link"
                 label="actions.document.upload-new-version" />
         <action id="onActionEditOnline" type="action-link"
                 permission="edit,online-edit"
                 label="actions.document.edit-online" />
         <action id="onActionEditOffline" type="action-link"
                 permission="edit" label="actions.document.edit-offline" />
         <action id="onActionCopyTo" type="action-link"
                 label="actions.document.copy-to" />
         <action id="onActionMoveTo" type="action-link" permission="delete"
                 label="actions.document.move-to" />
         <action id="onActionDelete" type="action-link" permission="delete"
                 label="actions.document.delete" />
         <action id="onActionAssignWorkflow" type="action-link"
                 label="actions.document.assign-workflow" />
         <action id="onActionManagePermissions" type="action-link"
                 permission="permissions"
                 label="actions.document.manage-permissions" />
         <action id="onActionManageAspects" type="action-link" permission="edit"

label="actions.document.manage-aspects" />
         <action id="onActionArchive" type="action-link" permission=""
                 label="actions.document.archive" />
      </actionSet>

      <actionSet id="locked">
         <action id="onActionDownload" href="{downloadUrl}" type="simple-link"
                 label="actions.document.download" />
      </actionSet>

      <actionSet id="lockOwner">
         <action id="onActionDownload" href="{downloadUrl}" type="simple-link"
                 label="actions.document.download-original" />
      </actionSet>

      <actionSet id="workingCopyOwner">
         <action id="onActionUploadNewVersion" type="action-link"
                 label="actions.document.upload-new-version" />
         <action id="onActionDownload" href="{downloadUrl}" type="simple-link"
                 label="actions.document.download-again" />
         <action id="onActionCancelEditing" type="action-link"
                 label="actions.document.cancel-editing" />
      </actionSet>

      <actionSet id="folder">
         <action id="onActionDetails" permission="edit" type="action-link"
                 label="actions.folder.edit-metadata" />
         <action id="onActionMetadata" type="simple-link" href="{folderDetailsUrl}"
                 label="actions.folder.view-metadata" />
         <action id="onActionCopyTo" type="action-link"
                 label="actions.folder.copy-to" />
         <action id="onActionMoveTo" permission="delete" type="action-link"
                 label="actions.folder.move-to" />
         <action id="onActionDelete" permission="delete" type="action-link"
                 label="actions.folder.delete" />
         <action id="onActionManagePermissions" permission="permissions"
                 type="action-link" label="actions.folder.manage-permissions" />
         <action id="onActionManageAspects" type="action-link" permission="edit"
                 label="actions.folder.manage-aspects" />
      </actionSet>

      <actionSet id="link">
         <action id="onActionDelete" permission="delete" type="action-link"
                 label="actions.link.delete" />
      </actionSet>

   </actionSets>

</documentList>

Code snippet web-extensionsite-webscriptsorgalfrescocomponentsdocumentlibrarydocumentlist.get.config.xml

The following file should be placed in this location:

Includes additional reference to custom workflow

<#assign el=args.htmlid>
<script type="text/javascript">//<![CDATA[
 Alfresco.util.ComponentManager.get("${el}").setMessages(${messages});
//]]></script>
<div id="${el}-dialog" class="workflow">
<div id="${el}-title" class="hd"></div>
<div class="bd">
<form id="${el}-form" action="" method="post">
<input type="hidden" name="date" id="${el}-date" value="" />
<div class="yui-g">
<h2>${msg("header.type")}</h2>
</div>
<div class="field">
<select id="${el}-type" name="type" tabindex="0">
<option value="wf:review" selected="selected">Review &amp; Approve</option>
<option value="wf:articleapproval">KB Article Review &amp; Approve</option>
<option value="wf:adhoc">Adhoc Task</option>
</select>
</div>
<div class="yui-g">
<h2>${msg("header.people")}</h2>
</div>
<div class="yui-ge field">
<div class="yui-u first">
<div id="${el}-peoplefinder"></div>
</div>
<div class="yui-u">
<div id="${el}-peopleselected" class="people-selected"></div>
</div>
</div>
<div class="yui-g">
<h2>${msg("header.date")}</h2>
</div>
<div class="field">
<input id="${el}-dueDate-checkbox" name="-" type="checkbox" value=
"${msg("label.due-date.none")}" tabindex="0"/>&nbsp;
<span id="${el}-dueDate"><label for="${el}-dueDate-checkbox">
${msg("label.due-date.none")}</label></span>
</div>
<div id="${el}-calendarOverlay" class="calendar-overlay">
<div class="bd">
<div id="${el}-calendar" class="calendar"></div>
</div>
</div>

<div class="yui-g">
<h2>${msg("header.comment")}</h2>
</div>
<div class="field">
<textarea id="${el}-comment" name="description" rows="3" tabindex="0"></textarea>
<span>${msg("label.comment.max-length")}</span>
</div>
<div class="bdft">
<input type="button" id="${el}-ok" value="${msg("button.assign")}" tabindex="0" />
<input type="button" id="${el}-cancel" value=
"${msg("button.cancel")}" tabindex="0" />
</div>
</form>
</div>
</div>

Code snippet web-extensionsite-webscriptsorgalfrescomodulesdocumentlibraryworkflow.get.html.ftl

The following files should be copied into your Tomcat ROOT Web application at the following location:

Defines a browser-side event handler for the Archive action in Alfresco Share

/**
 * DocumentList "Archive" action
 *
 * @namespace Alfresco
 * @class Alfresco.DocumentList
 */
(function()
{
 /**
* Backup single document.
*
* @method onActionBackup
* @param file {object} Object literal representing one or more file(s) or
   folder(s) to be actioned
*/

Alfresco.doclib.Actions.prototype.onActionArchive =
 function DL_onActionArchive(file)
 {
this.modules.actions.genericAction(
{
 success:
 {
event:
{
 name: "metadataRefresh"
},
message: this.msg("message.archive.success", file.displayName)
 },
 failure:
 {
message: this.msg("message.archive.failure", file.displayName)
 },
 webscript:
 {
name: "archive/site/{site}/{container}",
method: Alfresco.util.Ajax.POST
 },
 params:
 {
site: this.options.siteId,
container: this.options.containerId
 },
 config:
 {
requestContentType: Alfresco.util.Ajax.JSON,
dataObj:
{
 nodeRefs: [file.nodeRef]
}
 }
});
 };
})();

Code snippet ROOTshare-extensioncomponentsdocumentlibraryknowledgebase-actions.js

Includes additional custom CSS used by the document library

.doclist .onActionArchive a
{
 background-image: url(images/kbarchive-16.png);
}

Code snippet ROOTshare-extensioncomponentsdocumentlibraryknowledgebase-documentlist.css