Generis

CARA3
Customization Options

Doc v2
22 Mar 2011

This document is strictly confidential and may

be read only by Generis staff.
CONFIDENTIAL CARA3 - Customization Options

1. Document information
General Information Client Generis
Project Name CARA3
Document Name Customization Options
Current Version Doc v2
Date of Current 22 Mar 2011
Version

Document History Version Reason for Change Date

1.0 Initial Version 24 June
2010
2.0 Updated 22
March
2011

Doc v2 - 22 Mar 2011 Page 2

CONFIDENTIAL CARA3 - Customization Options

Table of contents

Customizing CARA v3 ............................................................................ 4

Introduction ......................................................................................... 4
Option 3 – Server extensions .............................................................. 7
Option 4 – UI Form Builder ............................................................... 11
Option 5 – Core product customization ............................................. 12

Doc v2 - 22 Mar 2011 Page 3

CONFIDENTIAL CARA3 - Customization Options

Customizing CARA v3
Introduction

CARA 3 CARA3 (and the underlying DocConfigurator) are built using the Ext
technology GWT extensions of the Google Web Toolkit. This is an open source
framework that provides fast performance and a wide range of UI
controls and functionality.

This guide describes some of the ways that you might extend the CARA
product.

Options There are multiple options available, ranging from least work (and risk) to
highest level of customization (and therefore risk).

 Option 1 – requesting new functions / configurations from Generis

and/or using existing configuration options

 Option 2 – Widget builder – add custom widgets with any external

web service call, or internal DQL.

 Option 3 – Server extensions: call custom code whenever there is

a server code call.

 Option 4 – UI Form Builder – use the Form Builder (from v3.2) to

build custom forms for CARA and either embed them in the
existing application screen (e.g. widgets panel) or have them
called from new menu items.

 Option 5 - full customization of the core product (this is not

recommended).

Continued on next page

Doc v2 - 22 Mar 2011 Page 4

CONFIDENTIAL CARA3 - Customization Options

Option 1 – New functions - Configuration

Overview This is the preferred option when changes to the application are required.
It involves requesting us to build a new functionality with a set of
accompanying configuration options.

Existing For a major number of functions, the DocConfigurator offers a set of

configurations options for configuration of the CARA UI.

New For new configurations required, Generis will be happy to build new or
configurations modify existing functions and create an associated configuration form
which will allow users to control the UI and associated functionality.

Doc v2 - 22 Mar 2011 Page 5

CONFIDENTIAL CARA3 - Customization Options

Option 2 – Widget Builder

Overview CARA comes with 5 default widgets that display in the Info Panel in the
right hand pane.

The Widgets Builder allows you to build widgets that can either be
embedded in this panel (which is designed to display information related
to a select document typically, but not necessarily), or as “pop-ups” –
these can be pop-ups called from a menu and can be related to a selected
document or not. They can also be embedded in other parts of the screen
(see final section).

Building a Widget This is described in the DocConfigurator Admin Manual, see that
document for full details.

Doc v2 - 22 Mar 2011 Page 6

CONFIDENTIAL CARA3 - Customization Options

Option 3 – Server extensions

Overview Any of the standard server operations in CARA can be modified or

extended, providing the ability to customize those actions. The complete
list is shown below.

Documentum addContentOperation
addRecipientsToActivityOperation
addSectionOperation
assignToNodeOperation
cancelCheckOutOperation
checkAuditConfigOperation
checkInOperation
checkOutOperation
completeActivityOperation
convertStructureToVDOperation
convertVDToStructureOperation
copyOperation
createAuditEventOperation
createPublishingLockOperation
dconConfigFactory
dconFormConfigFactory
dconSecurityLink
dconSequenceFactory
dconVAResolver
dctmOperation
delegateActivityOperation
deleteOperation
documentFactory
documentSaveOperation
exportToExcelOperation
folderSaveOperation
formatFactory
formFactory

Doc v2 - 22 Mar 2011 Page 7

CONFIDENTIAL CARA3 - Customization Options

insertStructureOperation
issueWorkflowOperation
lifecycleFactory
linkOperation
mailerConfigFactory
moveOperation
newCabinetOperation
newDocumentOperation
newFolderOperation
nodeBindOperation
operationFactory
publishingLockFactory
relationTypeFactory
releasePublishingLockOperation
removeActivityFromOutTrayOperation
removeActivityTypeOperation
removeContentOperation
removeNodeOperation
removePeriodicWorkflowOperation
removeRelationshipOperation
removeWorkflowOperation
repositoryFactory
repositoryObjectFactory
repositorySearchFactory
repositoryTypeFactory
repositoryUserFactory
repositoryViewFactory
restoreTrashOperation
saveActivityTypeOperation
savePeriodicWorkflowOperation
saveRelationshipOperation
saveSectionOperation
saveWorkflowOperation
saveWorkflowTemplateOperation
sendContentOperation

Doc v2 - 22 Mar 2011 Page 8

CONFIDENTIAL CARA3 - Customization Options

startActivityOperation
statusManagerChangeStateOperation
structureFactory
templateDAO
typeFactory
unassignNodeOperation
updateWorkflowTemplatePropertiesOperation
userCapabilitiesFactory
userPreferencesFactory
userPreferencesFactory
vDAddNodeOperation
vDCheckInOperation
workflowDAO

Alfresco NOTE that the following list is current as of build 3.0.153 and will be
extended as the remaining features for the production build of version 3.0
are added.
alfrescoOperation
cancelCheckOutOperation
checkInOperation
checkOutOperation
cmisFolderService
cmisObjectFactory
cmisObjectService
configFactory
dconConfigFactory
deleteOperation
documentFactory
documentSaveOperation
formFactory
newDocumentOperation
newFolderOperation
operationFactory
repositoryFactory
repositoryObjectFactory

Doc v2 - 22 Mar 2011 Page 9

CONFIDENTIAL CARA3 - Customization Options

repositorySearchFactory
repositoryTypeFactory
repositoryUserFactory
repositoryViewFactory
userPreferencesFactory

SharePoint To follow.

Doc v2 - 22 Mar 2011 Page 10

CONFIDENTIAL CARA3 - Customization Options

Option 4 – UI Form Builder

Overview CARA3 will come with a UI Form Builder. This is planned for the 3.2
release of the product (for version 3.0 forms would have to be built
directly using the Ext GWT extensions of Google Web Toolkit).

Form Builder The Form Builder being delivered with CARA3 will permit the
construction of forms based on the ExtGWT framework. This will further
extend the Widget Builder capabilities already in the product.

How to use the The forms can be used to create:

forms
 Custom forms called from custom server extensions
 Custom forms called to replace existing UI forms (requires
customization Option 4 below)
 Custom forms called from custom menus / buttons
 Custom screen layouts such as our CARA Portal.

Doc v2 - 22 Mar 2011 Page 11

CONFIDENTIAL CARA3 - Customization Options

Option 5 – Core product customization

Overview This option involves customizing the core product. We do not

recommend this as it MAY entail having to re-do the customizations with
each new build of the product that we deliver under maintenance releases.
If a customer wishes to customize the UI in this way, we could
alternatively provide the required code sections for modification and
allow customers to manage the code in our SVN repository, so that we
can include the code in the releases (since GWT compiles the code into
Javascript).

Otherwise, customers can use the ExtGWT builder to add / redesign the
UI as desired (documentation on this available from Sencha or Generis).

Doc v2 - 22 Mar 2011 Page 12