SAP MDG · UTILITIES

Which MDG Application Framework API should I use, and what are the main interfaces/classes and limitations?

Use External Model API for read-only entity/hierarchy access, Governance API for governed processing of multiple change requests, Convenience API for simpler single-CR/single-object maintenance, Change Request API for explicit legacy CR lifecycle control, and Context API for process metadata.

Use External Model API for read-only entity/hierarchy access, Governance API for governed processing of multiple change requests, Convenience API for simpler single-CR/single-object maintenance, Change Request API for explicit legacy CR lifecycle control, and Context API for process metadata.

The MDG Application Framework provides five main APIs: Change Request, External Model, Governance, Convenience, and Context. In short, choose External Model for read-only access, Governance for governed processing across CRs, Convenience for simplified single-CR maintenance, Change Request for explicit legacy CR control, and Context for process metadata.

Process flow

  1. Verify MDG configuration, active model, CR types, workflow, and required business functions.
  2. Select the API by scope and caller layer.
  3. Respect one-model-per-instance and LUW restrictions.
  4. Instantiate the chosen API correctly.
  5. Set environment/context when required.
  6. Build entity keys and data references.
  7. Create or select the change request and enqueue entities.
  8. Read existing data before change scenarios when needed.

Referenced tables

ObjectPurpose
USMD120CChange request type data used in the related example logic.
USMD1601Process assignment for change request types used in the related example logic.
USMD1210Change request notes table used in the related example logic.

The remaining configuration, implementation details, and testing guidance continue from this answer more…

Related questions and keywords

Alternative questions

  • What APIs does the MDG framework provide?
  • Which interfaces are available for MDG governance and entity data?
  • What are the main MDG Application Framework APIs?

Possible questions

  • Which API should I use?
  • What is the difference between Governance and Convenience API?
  • What can the Change Request API do that other APIs cannot?
  • Which API should I use only to read MDG data?
  • Can External Model API read hierarchies?
  • Why was Governance API introduced?

Keywords

IF_USMD_CREQUEST_APIIF_USMD_MODEL_EXTIF_USMD_GOV_APIIF_USMD_CONV_SOM_GOV_APIIF_USMD_APP_CONTEXTCL_USMD_CREQUEST_APICL_USMD_MODEL_EXTCL_USMD_GOV_APICL_USMD_CONV_SOM_GOV_APICL_USMD_APP_CONTEXTChange Request APIExternal Model APIGovernance APIConvenience APIContext APIREAD_ENTITYWRITE_ENTITYGET_INSTANCESET_ENVIRONMENTCHECK_CREQUEST_DATASAVEREFRESH_BUFFERSSTART_WORKFLOW