Extending the Interface of an OData Entity Using Custom Fields

[simon_xu2]

The OData service model delivered in SAP Multichannel Foundation for Utilities is built via the Gateway Service Builder (SEGW) tool. Depending on the business needs, the Gateway service model can be extended on different levels:

1. OData entity structure extension (adding append structure with custom fields)
2. Addition of new OData entities
3. OData entity logic extension (for example, adding additional validations)

In this blog, we will illustrate how to add a custom field to an existing entity. Extension on other levels ( new OData entities, etc.) will be covered in another blog post.

The common situation a customer faces is that the field a customer requires is not in our standard structure of an OData entity.

Example:

  Customer requirement:  The OData entity should include Nationality information.

1. Start SEGW in the SAP CRM system and create a new service model project ZCRM_UTILITIES_UMC.
2. Right click on Data Model, select Redefine OData service (GW).
3. Select CRM_UTILITIES_UMC as a service to be redefined.
4. Select all entities to be included in the new service.
5. Please check the API structure and make sure if it exists in the backend interface.
6. In SE80, add append structure to CRMS_IU_UMC_ACCOUNT.
7. Add field Nationality.
8. Since we always do move-corresponding in our implementation behind each entity, newly added field should become visible in the entity after adding to the service model.  

   

9.Back to SEGW, add a new attribute to the Account entity structure.

10.Choose Generate model.

11.The newly added field should become visible in the service metadata.