Action Item (AI)

Action Item represents an action, which the user is expected to perform. For example of such actions: create a new quote, modify some prices, check some values, etc.

Create/Update

The Action Item can be created/updated:

• manually (e.g. on a Custom Form tab by a user)

• from a logic (e.g. from Actionable Insights) using the ActionItemApi. To retrieve the object, use api.actionItemApi().

• via Context Linking action (for example as a button on chart on a dashboard)

View

You can see the list of Actions on several places:

• the Home Page dashboard in portlet My Actions

• in menu User Profile › Actions

• some documents can be configured to show Actions on a tab on their detail page (see Dynamic Tabs or Detail Page Layout). Such tab shows only Action Items having this document as parent.

Fields

uniqueName – (String) unique name of the item

summary – (String) Short description (summary) of the required action.

description – (String) Long description of the action.

actionItemType – (ActionItemType)

assignedTo, completedBy – (Integer) user id

dueDate – (Date Time)

status – (ActionItemStatus)

originatorTypedId – (String) TypedId of an object, which caused the creation of this Action Item.

parentTypeId – (String) TypedId of an object, to which this Action Item belongs. The action will be shown up on an actions tab of this parent object.

parentTabName – (String) name/id of the tab, on which should this Action Item be displayed (note, that the parent can have more tabs)

sourceContext – (JSON) When a logic creates new Action Item, it can place to sourceContext field the information about "why" this action was created. Structure of the JSON data object is up to developer. For example, in Actionable Insights accelerator, when a Watcher creates new Action Item, it places here information about what issue it found out, e.g. what’s wrong.

targetContext – (JSON) When a logic creates new Action Item, it can place to targetContext field the information about "what should be done". Structure of the JSON data object is up to developer. For example, in Actionable Insights accelerator, the Watcher places here info, what the user should do - e.g. create new quote, use these products, etc.)

outputs – (Map) contains results from the calculation logic. This field will be populated only after the actionItem logic was executed either by Action Item detail page or using groovy api for Action Items.

attribute1..30 – (String) Fields for storing information, which is visible by the user in the Custom Form list page, and also query-able via api.find().

attributeExtension – Additional attributes fields, which can be used in similar was as attribute1..100 fields. See Attribute Extension fields.