Adding Semantic Objects as Related Apps

You can display multiple semantic objects under the Related Apps button in the manifest.json file.

You can configure the relatedAppsSettings parameter in the manifiest.json file as shown in the example below:

{
  "sap.ui.generic.app": {
    "pages": [
      {
        "entitySet": "SEPMRA_C_PD_Product",
        "component": {
          "name": "sap.suite.ui.generic.template.ListReport",
          "list": true
        },
        "pages": [
          {
            "entitySet": "SEPMRA_C_PD_Product",
            "component": {
              "name": "sap.suite.ui.generic.template.ObjectPage",
              "settings": {
                "showRelatedApps": true,
                "relatedAppsSettings": {
                  "0": {
                    "semanticObject": "EPMProduct"
                  }
                }
              }
            },
            "pages": [
              {
                "navigationProperty": "to_ProductText",
                "entitySet": "SEPMRA_C_PD_ProductText",
                "component": {
                  "name": "sap.suite.ui.generic.template.ObjectPage"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

With this setting, all related apps from the app's URL and from the manifest.json file are displayed on the UI under the Related Apps button.

Adding Semantic Objects with Required Action on Related App Settings

You can display multiple semantic objects under the Related Apps button in the manifest.json file.

{
  "sap.ui.generic.app": {
    "pages": [
      {
        "entitySet": "SEPMRA_C_PD_Product",
        "component": {
          "name": "sap.suite.ui.generic.template.ListReport"
        },
        "pages": [
          {
            "entitySet": "SEPMRA_C_PD_Product",
            "component": {
              "name": "sap.suite.ui.generic.template.ObjectPage",
              "relatedAppsSettings": {                
                "EPMProduct": {
                  "semanticObject": "EPMProduct"
                },
                "STTA_WD20": {
                  "semanticObject": "STTA_WD20",
                  "semanticObjectAction": {
                    "0": {
                      "action": "Multi_View"
                    },
                    "1": {
                      "action": "Tree_Table"
                    }
                  }
                }
              }
            }
          }
        ]
      }
    ]
  }
}

You must ensure that you define the same semantic object list object-key and there corresponding semanticObject value.

In the code sample for "semanticObject" : "EPMProduct", semanticObjectAction is not defined. In this case, all the semanticObjectAction excluding the ones with SemanticObjectUnavailableActions annotation are displayed in the related apps list.

If semanticObjectAction list is defined in the manifest as shown for "semanticObject": "STTA_WD20", then only the ones defined in the list are shown in the related apps. In this case, SemanticObjectUnavailableActions annotation is not considered.

If the semanticObjectAction list is defined in the manifest as an empty object such as "semanticObjectAction":{} provided in the sample code, then no action from the semantic object of the current application is considered.

Overriding Related App Settings With Extension API

If the same project is deployed under multiple semantic objects or actions, and the application needs to display related apps based on the deployed semantics environment, you can override the related app settings using modifyRelatedAppsSettings extension API in the manifest.json file.

See the following sample code about modifying related app settings based on the deployed semantic environment:

modifyRelatedAppsSettings: function (oRelatedAppSetting, sCurrentSemanticObject, sEntityTypeName) {
    if (sCurrentSemanticObject === "EPMProduct") {
        oRelatedAppSetting = {
            ...oRelatedAppSetting,
            // adding additional semantic object and action to the existing related app settings.
            "EPMSalesOrder": {
                semanticObject: "EPMSalesOrder",
                semanticObjectAction: {
                    0: {
                        action: "display"
                    }
                }
			}
        }
    }
    return oRelatedAppSetting;
}

Supporting the Mapping of Default Links in Related Apps

When working with default links, if the technical field name of the field on the object page and the corresponding field in the target app differ, application developers can define a mapping between these fields. This mapping enables passing the context between these fields even though their technical field names are different.

To create this mapping, you can use Common.SemanticObject and Common.SemanticObjectMapping annotation as shown in the following sample codes:

<Annotations Target="com.c_salesordermanage_sd.SalesOrderManage">
    <Annotation Term="Common.SemanticObject" String="SalesOrder"/>
    <Annotation Term="Common.SemanticObjectMapping">
        <Collection>
            <Record Type="Common.SemanticObjectMappingType">
                <PropertyValue Property="LocalProperty" PropertyPath="SoldToParty"/>
                <PropertyValue Property="SemanticObjectProperty" String="Customer"/>
            </Record>
        </Collection>
    </Annotation>
</Annotations>

annotate view SalesOrderManage with {
   @Consumption.semanticObject: 'SalesOrder'
   @Consumption.semanticObjectMapping.additionalBinding: [{element: 'Customer', localElement: 'SoldToParty'}]
   Customer
}

entity SalesOrderManage
@(
  Common: {
    SemanticObject: 'SalesOrder',
    SemanticObjectMapping: [
      {
        LocalProperty: SoldToParty,
        SemanticObjectProperty: 'Customer'
      }
    ]
  }
)

Adding Additional Links to Related Apps

Application developers can add additional links under the Related Apps button of the object page header. The links originate from the additional semantic objects defined in the manifest.json file, as shown in the following example:

"SalesOrderManageObjectPage": {
    "type": "Component",
    "id": "SalesOrderManageObjectPage",
    "name": "sap.fe.templates.ObjectPage",
    "options": {
        "settings": {
            "contextPath": "/SalesOrderManage",
            "showRelatedApps": true,
            "additionalSemanticObjects": {
                "ProductCollection": {
                    unavailableActions: ["displayFactSheet", "reorderProduct"],
                    mapping: {
                        "SoldToParty": "Client",
                         .
                         .
                    }
                },
                "Customer": {
                    "unavailableActions": ["manage"],
                    "mapping": {
                        "SoldToParty": "Customer"
                    }
                }
            },
            ....
            ....
        }
    }
}

In the previous example , additionalSemanticObjects is the manifest setting that you need to add under the object page section of the manifest.json file. ProductCollection and Customer refer to the additional semantic objects from which we get additional links that are displayed under the Related Apps button.

The array of unavailable actions defined in the preceding settings denote those navigation actions of the semantic object which should not be displayed under the Related Apps button. displayFactSheet and reorderProduct will not appear in the Related Apps menu (unless they happen to be actions defined for other additional semantic objects and are not part of the unavailable actions there).

Mapping, defined for a semantic object, consists of key value pairs. The key defines the way in which the source application (object page) passes the context. The value represents the term used for the same entity in the target app. In the example above, an object page context for SoldToParty like "SoldToParty"="001" is passed using the specified target name (Customer) instead of SoldToParty. So the target will receive "Customer"="001" in the app context.

You can also use the allowedActions key in the manifest.json file to define the exact list of semantic object links to be displayed under the Related Apps button:

"SalesOrderManageObjectPage": {
    "type": "Component",
    "id": "SalesOrderManageObjectPage",
    "name": "sap.fe.templates.ObjectPage",
    "options": {
        "settings": {
            "contextPath": "/SalesOrderManage",
            "showRelatedApps": true,
            "additionalSemanticObjects": {
                "SalesOrder": {
                    allowedActions: ["create", "managev2"],
                "ProductCollection": {
                    allowedActions: ["displayFactSheet"],
                    mapping: {
                        "SoldToParty": "Client",
                         .
                         .
                    }
                },
            },
            ....
        }
    }
}

In this example, three application links will appear in the Related Apps menu.