Enable Activity through Configuration
After you define a custom activity as an extension with the above steps, you need to enable the activity configuration so as to display the activity in the CentraSite Business UI. To enable the custom activity configuration, follow these steps:
Important: | The activity configuration parameters initially defined in the configuration file are editable and cannot be protected. |
1. Open the custom configuration file.
2. Locate the Activities Configuration section under CLL Configurations.
The configuration snippet looks like this:
<CLLConfigurations>
<Activities>
<Activity id="Create Assets"
class="com.softwareag.centrasite.api.activity.impl.CreateAssetAc
tivityImpl">
INMCL_ACTIVITY_CREATE_ASSET
</Activity>
<Activity id="Global Reports"
class="com.softwareag.centrasite.api.activity.impl.GlobalReport
ActivityImpl">
INMCL_ACTIVITY_GLOBAL_REPORTS
</Activity>
<Activity id="Manage Organizations"
class="com.softwareag.centrasite.api.activity.impl.ManageOrganiz
ationsImpl">
INMCL_ACTIVITY_MANAGE_ORGANIZATIONS
</Activity>
</Activities>
</CLLConfigurations>
3. Append the required custom activity (for example, "Create Report Templates") configuration statement as below:
<CLLConfigurations>
<Activities
<Activity id="Create Report Templates"
class="com.softwareag.centrasite.api.activity.impl.CreateRepor
tTemplatesImpl">
INMCL_ACTIVITY_CREATE_REPORT _TEMPLATES
</Activity>
</Activities>
</CLLConfigurations>
wherein,
Parameter | Denotes |
id | A unique identifier for the activity, in this example "Create Report Templates". It uniquely distinguishes an activity in the CentraSite registry. If you wish to reset the activity at a later stage, you identify the activity using this id. |
class | The implementation class of "com.softwareag.centrasite.api.activity.Activity" interface. |
INMCL_ACTIVITY | The i18n string to display the activity in CentraSite Business UI. If you want to specify a localized name, enter the message ID starting with a prefix "INMCL" (in this example, "INMCL_ACTIVITY_CREATE_REPORT_TEMPLATES"). The activity 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 activity will simply display a plain text name. |
4. Now the Activities Configuration section looks similar to this.
<CLLConfigurations>
<Activities>
<Activity id="Create Assets"
class="com.softwareag.centrasite.api.activity.impl.CreateAsset
ActivityImpl">
INMCL_ACTIVITY_CREATE_ASSET
</Activity>
<Activity id="Global Reports"
class="com.softwareag.centrasite.api.activity.impl.GlobalRepor
tActivityImpl">
INMCL_ACTIVITY_GLOBAL_REPORTS</Activity>
<Activity id="Manage Organizations"
class="com.softwareag.centrasite.api.activity.impl.ManageOrgani
zationsImpl">
INMCL_ACTIVITY_MANAGE_ORGANIZATIONS
</Activity>
<Activity id="Create Report Templates"
class="com.softwareag.centrasite.api.activity.impl.CreateReport
TemplatesImpl">
INMCL_ACTIVITY_CREATE_REPORT_TEMPLATES
</Activity>
</Activities>
</CLLConfigurations>
5. Locate the Activities Configuration section under BUI Configurations.
<UIProperties>
<Activities noOfActivitiesInMainNav="5">
<Activity refId="Create Assets"
numOfProfilesPerRow="3"
token="activity:Create Assets"/>
<Activity refId="Global Reports"
token="activity:Global Reports"/>
<Activity refId="Manage Organizations"
token="activity:Manage Organizations"/>
</Activities>
</UIProperties>
The configuration snippet looks like this:
6. Append the defined custom activity (for example, "Create Report Templates") configuration statement as below:
<Activity refId="Create Report Templates"
token="customactivity:Create Report Templates"/>
wherein,
Parameter | Denotes |
refId | Refers to an unique identifier id for the activity, as defined in the CLL Configurations. |
token | The place tokenizer of the activity that helps in rendering the activity as a deep link URL. Important: | Be aware that for rendering any custom activity, the place tokenizer should contain the prefix customactivity:. Thus for example, a custom activity "Create Report Templates" would have the place tokenizer read as "customactivity:Create Report Templates". |
|
7. Now the Activities Configuration section looks similar to this.
<UIProperties>
<Activities noOfActivitiesInMainNav="5">
<Activity refId="Create Assets"
numOfProfilesPerRow="3"
token="activity:Create Assets"/>
<Activity refId="Global Reports"
token="activity:Global Reports"/>
<Activity refId="Manage Organizations"
token="activity:Manage Organizations"/>
<Activity refId="Create Report Templates"
token="customactivity:Create Report Templates"/>
</UIProperties>
8. Save and close the configuration file.
9. Restart Software AG Runtime.