Add Activity

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
You can add new discretionary activities for workflow process activities.
To add a discretionary workflow activity to a case from the case details page, the work details page, or the Activities tab in the Case Information widget:
  1. Click Add Activity.
  2. Select the type of discretionary activity that you want to add.
  3. Specify a name for this activity that you and others who must work on this activity can understand.
  4. Click OK.

Configuration properties

Set or modify configuration properties for the view in the Configuration properties tab.
Table 1. Add Activity view
Property Description Data type
Target Object Store Name The repository name that the view needs to connect to. String
Case Identifier The identifier of the case instance required by the view. String
Get Repository Name Service The service to retrieve the repository name that is associated with the case activity. String
Appearance
Hide Add Activity Button Allows to hide the default Add Activity button from the Case Details page. Boolean
Color style Defines the button color style.  
Shape style Defines the button shape style.  
Size Defines the button size style.  
Outline only Defines an outline-only appearance for the button. Boolean
Icon Changes the button appearance to an icon. String
Width Changes the width of the button. String
Icon location The location of the icon relative to the button text.  
Ghost style Changes the button appearance with no solid fill (the body of the button adopts the look of the background). Boolean

Events

You can assign the following types of event handlers to events:

Filter Add Activities: Apply custom filters to discretionary activities.

addActivitiesList is an array of objects of all discretionary activities for current case which can be customized. Each activity array is an object of: activityID (ID of the activity), activityDisplayName (default display name of the activity) and state ( state of the activity).

It returns the addActivitiesList with customizable objects for discretionary activities, each defined by activityID,

activityDisplayName (default display name of the activity) and state (YES, NO, LOCK)

The different states of activity:
  • YES - Include in the add activity list. This is the default state.
  • NO - Do not include in the add activity list.
  • LOCK - Include in the add activity list, but activity display name is not customizable.
For example, refer to the following code sample to customize discretionary activities:
var customizedAddActivityList=addActivitiesList;
customizedAddActivityList.forEach(function(discretionaryActivity){
        if (discretionaryActivity.activityID =="SolnID_Activity1"){
                discretionaryActivity.state= "NO"; 
        }
        else if (discretionaryActivity.activityID =="SolnID_Activity2"){
                 discretionaryActivity.state= "LOCK";
                 discretionaryActivity.activityDisplayName= "New Activity Name";
        }
});
return customizedAddActivityList;

Methods

For the methods that are available in the Add Activity view, see Add Activity JavaScript API.

Additional resources
For more information about how to create a coach or page, see Building coaches.
For more information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see View properties. For other UI views, see UI toolkit.