SAP MDG · COMMUNITY
What are the main MDG Application Framework APIs and when should I use each one?
Use Change Request API for explicit CR lifecycle control, External Model API for read-only entity and hierarchy access, Governance API for governed multi-CR processing, Convenience API for simplified single-CR/single-object processing, and Context API for current process context.
Use Change Request API for explicit CR lifecycle control, External Model API for read-only entity and hierarchy access, Governance API for governed multi-CR processing, Convenience API for simplified single-CR/single-object processing, and Context API for current process context.
The MDG Application Framework provides five main APIs: Change Request, External Model, Governance, Convenience, and Context. Use Change Request API for explicit CR lifecycle control, External Model API for read-only entity and hierarchy access, Governance API for governed processing across change requests, Convenience API for simpler single-CR maintenance, and Context API for current process context. The documented class/interface mapping is: `IF_USMD_CREQUEST_API`/`CL_USMD_CREQUEST_API`, `IF_USMD_MODEL_EXT`/`CL_USMD_MODEL_EXT`, `IF_USMD_GOV_API`/`CL_USMD_GOV_API`, `IF_USMD_CONV_SOM_GOV_API`/`CL_USMD_CONV_SOM_GOV_API`, and `IF_USMD_APP_CONTEXT`/`CL_USMD_APP_CONTEXT`.
Process flow
- Identify the five APIs: Change Request, External Model, Governance, Convenience, and Context.
- Choose the API based on whether the task is CR processing, read-only access, governed processing, simplified single-object processing, or context access.
- Use `IF_USMD_CREQUEST_API` / `CL_USMD_CREQUEST_API` for explicit change request lifecycle control.
- Use `IF_USMD_MODEL_EXT` / `CL_USMD_MODEL_EXT` for read-only entity and hierarchy access.
- Use `IF_USMD_GOV_API` / `CL_USMD_GOV_API` for governed processing across change requests.
- Use `IF_USMD_CONV_SOM_GOV_API` / `CL_USMD_CONV_SOM_GOV_API` for simplified single-change-request processing.
- Use `IF_USMD_APP_CONTEXT` / `CL_USMD_APP_CONTEXT` for process-context data.
- Call `CL_USMD_APP_CONTEXT=>GET_CONTEXT` to obtain the context interface when needed.
Business Function: `MDG_FOUNDATION`
Required for MDG in EhP5 to use Change Request, External Model, and Context APIs.
Business Function: `MDG_FOUNDATION_2`
Required additionally in EhP6 for Governance and Convenience APIs.
Referenced tables
| Object | Purpose |
|---|---|
TADIR | Repository object directory entry used in the related ABAP source-code-editor guidance, including Original System. |
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
- What class implements IF_USMD_GOV_API?
- Give me the interface/class mapping for MDG APIs.
- 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?
- Is the Change Request API still developed?
- Which API should I use only to read MDG data?
- Can External Model API read hierarchies?
- Why was Governance API introduced?