Enable Action through Configuration
After you define a custom action as an extension with the above steps, you need to enable the custom action configuration so as to display the action in the CentraSite Business UI. To enable a custom action configuration, follow these steps:
Important: | The action configuration parameters initially defined in the configuration file are editable and cannot be protected. |
1. Open the custom configuration file.
2. Locate the Actions Configuration section under CLL Configuration.
The configuration snippet looks like this:
<CLLConfigurations>
<Actions>
<Action id="SaveAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/01_Save.gif"
class="com.softwareag.centrasite.api.csom.action.impl.SaveAct
ionImpl">
INMCL_ACTION_SAVE
</Action>
<Action id="EditAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/02_Edit.gif"
class="com.softwareag.centrasite.api.csom.action.impl.EditActi
onImpl">
INMCL_ACTION_EDIT
</Action>
<Action id="NewVersionAction" inbox="false" bulk="true" group="basic"
icon="images/system/actionbar/03_NewVersion.gif"
class="com.softwareag.centrasite.api.csom.action.impl.NewVer
sionActionImpl">
INMCL_ACTION_VERSION
</Action>
<Action id="DeleteAction" inbox="false" bulk="true" group="basic"
icon="images/system/actionbar/04_Delete.gif"
class="com.softwareag.centrasite.api.csom.action.impl.Delete
ActionImpl">
INMCL_ACTION_DELETE
</Action>
<Action id="DownloadDocumentAction" isAllowedForGuest="true"
inbox="false" bulk="true" group="attach"
icon="images/system/actionbar/download_32x32.png"
class="com.softwareag.centrasite.api.csom.action.impl.Downl
oadDocumentActionImpl">
INMCL_ACTION_DOWNLOADDOCS
</Action>
<Action id="AttachDocumentAction" timeout="600000" inbox="false"
bulk="false" group="attach"
icon="images/system/actionbar/08_Attach.gif"
class="com.softwareag.centrasite.api.csom.action.impl.AttachDo
cumentActionImpl">
INMCL_ACTION_ATTACH
</Action>
<Action id="Export" isAllowedForGuest="true" inbox="false" bulk="true"
group="attach" icon="images/system/actionbar/Export.gif"
class="com.softwareag.centrasite.api.csom.action.impl.ExportAc
tionImpl">
INMCL_ACTION_EXPORT
</Action>
<Action id="WatchAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/watch.png"
class="com.softwareag.centrasite.api.csom.action.impl.WatchAc
tionImpl">
INMCL_ACTION_WATCH
</Action>
<Action id="UnwatchAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/unwatch.png"
class="com.softwareag.centrasite.api.csom.action.impl.Unwatch
ActionImpl">
INMCL_ACTION_UNWATCH
</Action>
<Action id="AddToListAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/AddtoList_32x32.png"
class="com.softwareag.centrasite.api.csom.action.impl.AddToLi
stActionImpl">
INMCL_ACTION_ADD_TO_LIST
</Action>
<Action id="RemoveFromListAction" inbox="false" bulk="true"
group="moniter"
icon="images/system/actionbar/RemovefromList_32X32_up.png"
class="com.softwareag.centrasite.api.csom.action.impl.RemoveF
romListActionImpl">
INMCL_ACTION_REMOVE_FROM_LIST
</Action>
<Action id="Consume" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/consume.png"
class="com.softwareag.centrasite.api.csom.action.impl.ConsumeA
ctionImpl">
INMCL_ACTION_CONSUME
</Action>
<Action id="ApproveAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Approve.png"
class="com.softwareag.centrasite.api.csom.action.impl.Approve
ActionImpl">
NMCL_ACTION_APPROVE
</Action>
<Action id="RejectAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Reject.png"
class="com.softwareag.centrasite.api.csom.action.impl.RejectA
ctionImpl">
INMCL_ACTION_REJECT
</Action>
<Action id="RevertAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Revert.png"
class="com.softwareag.centrasite.api.csom.action.impl.RevertAc
tionImpl">
INMCL_ACTION_REVERT
</Action>
<Action id="ViewReportAction" inbox="false" bulk="false"
group="moniter" icon="images/system/actionbar/ViewReport.png"
class="com.softwareag.centrasite.api.csom.action.impl.ViewRe
portActionImpl">
INMCL_ACTION_VIEW_REPORT
</Action>
<Action id="DeleteNotificationAction" inbox="true" bulk="true"
group="moniter" icon="images/system/actionbar/04_Delete.gif"
class="com.softwareag.centrasite.api.csom.action.impl.DeleteN
otificationActionImpl">
INMCL_ACTION_DELETE_NOTIFICATION
</Action>
<Action id="Permission" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Permission_32x32_up.png"
class="com.softwareag.centrasite.api.csom.action.impl.Permiss
ionActionImpl">
INMCL_ACTION_PERMISSION
</Action>
</Actions>
</CLLConfigurations>
3. Append the required custom action (for example, "Change Owner") configuration statement as below:
<Action id="ChangeOwnerAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/ChangeOwner.gif"
class="com.softwareag.centrasite.api.csom.action.impl.ChangeOwnerAc
tionImpl">
INMCL_ACTION_CHANGE_OWNER
</Action>
wherein,
Parameter | Denotes |
Action id | A unique identifier for the action, in this example "ChangeOwnerAction". It uniquely distinguishes an action in the CentraSite registry. If you wish to reset the action at a later stage, you identify the action using this id. |
class | The implementation class of "com.softwareag.centrasite.api.csom.action.impl.Cha ngeOwnerActionImpl" interface. |
INMCL_ACTIVITY | The i18n string to display the action in CentraSite Business UI. If you want to specify a localized name, enter the message ID starting with a prefix "INMBU" (in this example, INMCL_ACTION_CHANGE_OWNER). The action will internally identify the message ID, and display the localized name, if available in the message database. Else, if you specify a name without INMBU prefix, the action will simply display a plain text name. |
4. Now the Actions Configuration section looks similar to this.
<CLLConfigurations>
<Actions>
<Action id="SaveAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/01_Save.gif"
class="com.softwareag.centrasite.api.csom.action.impl.SaveActi
onImpl">
INMCL_ACTION_SAVE
</Action>
<Action id="EditAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/02_Edit.gif"
class="com.softwareag.centrasite.api.csom.action.impl.EditAc
tionImpl">
INMCL_ACTION_EDIT
</Action>
<Action id="NewVersionAction" inbox="false" bulk="true" group="basic"
icon="images/system/actionbar/03_NewVersion.gif"
class="com.softwareag.centrasite.api.csom.action.impl.NewVersi
onActionImpl">
INMCL_ACTION_VERSION
</Action>
<Action id="DeleteAction" inbox="false" bulk="true" group="basic"
icon="images/system/actionbar/04_Delete.gif"
class="com.softwareag.centrasite.api.csom.action.impl.DeleteA
ctionImpl">
INMCL_ACTION_DELETE
</Action>
<Action id="DownloadDocumentAction" isAllowedForGuest="true"
inbox="false" bulk="true" group="attach"
icon="images/system/actionbar/download_32x32.png"
class="com.softwareag.centrasite.api.csom.action.impl.DownloadD
ocumentActionImpl">
INMCL_ACTION_DOWNLOADDOCS
</Action>
<Action id="AttachDocumentAction" timeout="600000" inbox="false"
bulk="false" group="attach"
icon="images/system/actionbar/08_Attach.gif"
class="com.softwareag.centrasite.api.csom.action.impl.AttachD
ocumentActionImpl">
INMCL_ACTION_ATTACH
</Action>
<Action id="Export" isAllowedForGuest="true" inbox="false" bulk="true"
group="attach" icon="images/system/actionbar/Export.gif"
class="com.softwareag.centrasite.api.csom.action.impl.ExportAc
tionImpl">
INMCL_ACTION_EXPORT</Action>
<Action id="WatchAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/watch.png"
class="com.softwareag.centrasite.api.csom.action.impl.WatchAct
ionImpl">
INMCL_ACTION_WATCH
</Action>
<Action id="UnwatchAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/unwatch.png"
class="com.softwareag.centrasite.api.csom.action.impl.UnwatchA
ctionImpl">
INMCL_ACTION_UNWATCH</Action>
<Action id="AddToListAction" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/AddtoList_32x32.png"
class="com.softwareag.centrasite.api.csom.action.impl.AddToLis
tActionImpl">
INMCL_ACTION_ADD_TO_LIST
</Action>
<Action id="RemoveFromListAction" inbox="false" bulk="true"
group="moniter"
icon="images/system/actionbar/RemovefromList_32X32_up.png"
class="com.softwareag.centrasite.api.csom.action.impl.RemoveFr
omListActionImpl">
INMCL_ACTION_REMOVE_FROM_LIST
</Action>
<Action id="Consume" inbox="false" bulk="true" group="moniter"
icon="images/system/actionbar/consume.png"
class="com.softwareag.centrasite.api.csom.action.impl.ConsumeA
ctionImpl">
INMCL_ACTION_CONSUME
</Action>
<Action id="ApproveAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Approve.png"
class="com.softwareag.centrasite.api.csom.action.impl.ApproveA
ctionImpl">
INMCL_ACTION_APPROVE
</Action>
<Action id="RejectAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Reject.png"
class="com.softwareag.centrasite.api.csom.action.impl.Reject
ActionImpl">
INMCL_ACTION_REJECT
</Action>
<Action id="RevertAction" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Revert.png"
class="com.softwareag.centrasite.api.csom.action.impl.RevertA
ctionImpl">
INMCL_ACTION_REVERT
</Action>
<Action id="ViewReportAction" inbox="false" bulk="false"
group="moniter" icon="images/system/actionbar/ViewReport.png"
class="com.softwareag.centrasite.api.csom.action.impl.ViewRepo
rtActionImpl">INMCL_ACTION_VIEW_REPORT</Action>
<Action id="DeleteNotificationAction" inbox="true" bulk="true"
group="moniter" icon="images/system/actionbar/04_Delete.gif"
class="com.softwareag.centrasite.api.csom.action.impl.Delete
NotificationActionImpl">
INMCL_ACTION_DELETE_NOTIFICATION
</Action>
<Action id="Permission" inbox="false" bulk="false" group="moniter"
icon="images/system/actionbar/Permission_32x32_up.png"
class="com.softwareag.centrasite.api.csom.action.impl.Permissi
onActionImpl">
INMCL_ACTION_PERMISSION
</Action>
<Action id="ChangeOwnerAction" inbox="false" bulk="false" group="basic"
icon="images/system/actionbar/ChangeOwner.gif"
class="com.softwareag.centrasite.api.csom.action.impl.ChangeO
wnerActionImpl">
INMCL_ACTION_CHANGE_OWNER
</Action>
</Actions>
</CLLConfigurations>
5. To enable an action entry for bulk usage, change “false” to “true”. Similarly, if the action is already available for bulk usage and you want to revert back, set the value to “false”.
6. Save and close the configuration file.
7. Restart Software AG Runtime.
