App Extensibility: My Inbox

Use

You can extend the My Inbox app according to your business needs for different aspects. For this purpose, the following extensibility options are available:

Change the list view (S2)
Change the detail view (S3)
Extend the application with additional views

Further Extensibility Entities

Business Add-Ins (BAdIs)

To extend My Inbox and add custom code in the Task Gateway Service, you can use the following Business Add-Ins:

BAdIs in the Back-End System

The BAdI below is only relevant if you are implementing the My Inbox app for your SAP Business Workflow.

Before Update BAdI (/IWWRK/BADI_WF_BEFORE_UPD_IB)
You can use BAdI /IWWRK/BADI_WF_BEFORE_UPD_IB to handle decision runtime in the following cases:
- Step type for the workflow task is not User Decision.
- You want to execute an action before the work item is updated with the user decision.
  For more information, see SAP Help Portal at http://help.sap.com under Technology Platform SAP Gateway SAP Gateway 2.0 Content Information Content Guide SAP Gateway Content Guide SAP Gateway Supported OData Channel Scenarios Workflow Services Workflow Task Service: Central Hub Deployment with IW_BEP Backend Installation Workflow User Exits .
To provide the custom attributes definition and data, an enhancement spot is provided on the IW_BEP add-on (to be implemented on the backend system on which the IW_BEP add-on is deployed). You can provide implementations filtered by the Task Definition ID. For this, you must provide an implementation to the /IWWRK/BADI_TGW_CUSTOM_ATTR BAdI in the /IWWRK/ES_TGW_CUSTOM_ATTRIBUTE enhancement spot. After implementing the BAdI, you can consume the custom attribute as follows: Use navigation property CustomAttributeDefinitionData in entity TaskDefinition to navigate to the CustomAttributeDefinition collection.

BAdIs in the Gateway System

Task Gateway: Change subject in query (/IWPGW/BADI_TGW_TASK_QUERY)
You can use this BAdI to change the task title for all items on the list screen.
Task Gateway: Modify task data (/IWPGW/BADI_TGW_TASK_DATA)
You can use this BAdI to change the task title or task description on the detail screen.
Task Gateway: Provide user details (/IWPGW/BADI_TGW_USER_DETAIL)
You can use this BAdI to change the user details on the detail screen.

For more information, see SAP Help Portal at http://help.sap.com under Technology Platform SAP Gateway SAP Gateway 2.0 Content Information Content Guide SAP Gateway Content Guide SAP Gateway Supported OData Channel Scenarios Workflow Services Workflow Task Service: Central Hub Deployment with IW_BEP Backend Installation Workflow User Exits .

Extension Points

For My Inbox, for example, the following extension points are available:

View	Extension Point	Use
S2.view.xml	CustomerExtensionForObjectListItem	Allows you to replace the list item template with your custom list item template on the list screen. Make sure that the ID of your custom list template is the same as the ID of the standard list item template.
S3.view.xml	CustomerExtensionForObjectHeader	Allows you to replace the header of the detail screen with your custom header.
S3.view.xml	CustomerExtensionForInfoTabContent	Allows you to define the content you want to display on the Info tab.
S3.view.xml	CustomerExtensionForNoteTabContent	Allows you to define the content you want to display on the Note tab.
S3.view.xml	CustomerExtensionForAttachmentTabContent	Allows you to define the content you want to display on the Attachment tab.
S3.view.xml	CustomerExtensionForAdditionalTabs	Allows you to create additional tabs.
S3.view.xml	CustomerExtensionForAdditionalDetails	Allows you to display additional information on the detail screen.
S3.view.xml	CustomerExtensionForObjectLinkTabContent	Allows you to define the content you want to display on the Object Link tab.
S3.view.xml	CustomerExtensionForHistoryTabContent	Allows you to display the content you want to display on the History tab.
ViewSubstitution.view.xml	CustomerExtensionForSubstitutionRowHeader	Allows you to add columns in the substitution table.
ViewSubstitution.view.xml	CustomerExtensionForSubstitutionRowData	Allows you to add column list items in the substitution table.
TaskUI_S3.view.xml	CustomerExtensionForNoteTabContent	Extends the note tab content.

If there are additional fields available in the OData service, you can display these fields on the UI. For more information about extension points, see section Extensibility in the SAP S/4HANA UI Technology guide.

UI Controller Hooks

To plug in and execute custom code to My Inbox, for example, the following hooks are available in the controller code:

Controller	Hook	Use
S2.controller.js	extHookGetCustomFilter	Allows you to create custom filters that can be used for filtering the workflow.
S2.controller.js	extHookChangeFilterItems	Allows you to replace the standard filters with custom filters based on the filter key.
S2.controller.js	extHookChangeSortConfig	Allows you to change those properties that can be used for sorting the workflow tasks.
S2.controller.js	extHookChangeGroupConfig	Allows you to change those properties that can be used for grouping the workflow tasks.
S2.controller.js	extHookChangeMassApprovalButtons	Allows you to add, remove, and change the action buttons on the list screen in mass action mode.
S2.controller.js	extHookGetPropertiesToSelect	Allows you to retrieve additional attributes for Task entity from the back-end system.
S3.controller.js	extHookChangeFooterButtons	Allows you to add, remove, and change the action buttons (for example, claim, release, and forward) on the detail screen.
S3.controller.js	extHookGetEntitySetsToExpand	Allows you to retrieve additional entities from the back-end system.
S3.controller.js	extHookOnDataLoaded	Allows you to perform additional requests and process the retrieved data.
Forward.controller.js	extHookChangeListSizeLimit	Allows you to change the number of recipients displayed on the forward screen.
ViewSubstitution.controller.js	extHookAddFooterButtonsForSubs	Allows you to add buttons for the substitution screen.
S2_TaskList.controller.js	extHookChangeFooterButtonsForExpertMode	Allows you to add, modify or delete the footer buttons, which are displayed once the task is selected in the expert view.

If there are additional UI controller hooks available in the controller code, you can extend the UI controller code. For more information about UI controller hooks, see section Extensibility in the SAP S/4HANA UI Technology guide.

Display of UI Controls

As an example, the following UI controls can be hidden from the app UI:

View	Controller ID	Use
S3.view.xml	MIBNoteIconTabFilter	Allows you to hide the Note tab on the detail screen.
S3.view.xml	MIBAttachmentIconTabFilter	Allows you to hide the Attachment tab on the detail screen.

More Information

For a general description of the extensibility options and procedures, see Extensibility in the SAP S/4HANA UI Technology guide.