RAP / CDS / ODataintermediate

Service Definitions Part 4: Troubleshooting Activation and Exposure Gaps

Key takeaway

Fix the typical service definition problems: activation errors, entities or navigation missing in the service, actions not visible, and value helps that do not work — in a fixed checking order.

Explanation

📌 KEY POINTS
✅ Activation order matters: CDS → BDEFs → projections → service definition → binding.
✅ Missing navigation → the target entity is not exposed or the association not redirected.
✅ Missing action → not in the projection BDEF ("use action"), not in the service.
⚠️ After changing a published service, check the binding and clear caches.

━━━━━━━━━━━━━━━━━━━━
▶ WHERE WE ARE
Parts 1–3 built services. This part handles the situations where "something is missing in the service".

━━━━━━━━━━━━━━━━━━━━
▶ 1. ACTIVATION ERRORS

"Entity … does not exist or is not active" → activate the projection first; check spelling.
Errors about base vs projection → you exposed a view that cannot be exposed (e.g. a base view with a different provider contract); expose the projection.
Alias errors → duplicate alias or invalid characters.

💡 TIP: use "Activate All" (Ctrl+Shift+F3) for the whole chain after structural changes.

━━━━━━━━━━━━━━━━━━━━
▶ 2. ENTITY MISSING IN THE SERVICE

Not listed with "expose" in the service definition.
Service binding not re-published/refreshed after the change (the binding shows the old entity list).
Wrong service version or binding opened.\n\n━━━━━━━━━━━━━━━━━━━━\n▶ 3. NAVIGATION MISSING ($expand fails)\n• The target entity of the association is not exposed in the same service — RAP then removes the navigation property.
The association is not exposed in the projection's element list.
For compositions: the child is not redirected ("redirected to composition child") or the child projection is not exposed.

━━━━━━━━━━━━━━━━━━━━
▶ 4. ACTION OR OPERATION MISSING

Not declared in the base BDEF, or not used in the projection BDEF ("use action approve;").
The binding shows actions under the entity; if not there, the projection BDEF is the cause.
Visible in $metadata but button missing → UI annotation (#FOR_ACTION) problem, not service problem.
Button visible but disabled → feature control or authorization.

━━━━━━━━━━━━━━━━━━━━
▶ 5. VALUE HELP NOT WORKING

@Consumption.valueHelpDefinition points to an entity that is neither exposed nor reachable; for RAP services, the value-help entity is usually added automatically if it is accessible — if not, expose it explicitly.
The value-help entity has access control that filters everything for this user.
Element name in the annotation does not match the value-help entity's field.

━━━━━━━━━━━━━━━━━━━━
▶ 6. CHANGES NOT VISIBLE

Clear metadata caches (client and, if applicable, gateway).
Reload the app with cache cleared.

━━━━━━━━━━━━━━━━━━━━
▶ STEP BY STEP (CHECKING ORDER)

All objects active? 2. Entity exposed? 3. Binding refreshed/published? 4. $metadata contains it? 5. UI annotations? 6. Caches cleared?

✅ CHECKPOINT: you can locate any exposure gap within minutes.

Code example

ABAP Code

// ===== Symptom: $expand=_Supplier fails / navigation missing =====// Projection:define root view entity ZC_PurchReq  provider contract transactional_query  as projection on ZR_PurchReq{  key RequestUUID,      Supplier,      _Item : redirected to composition child ZC_PurchReqItem,      _Supplier                                 // exposed in the projection...} // Service definition BEFORE (navigation _Supplier silently removed):// define service ZUI_PURCHREQ {//   expose ZC_PurchReq     as PurchaseRequest;//   expose ZC_PurchReqItem as PurchaseRequestItem;// } // Service definition AFTER (target exposed -> navigation available):define service ZUI_PURCHREQ {  expose ZC_PurchReq     as PurchaseRequest;  expose ZC_PurchReqItem as PurchaseRequestItem;  expose I_Supplier      as Supplier;         // or a dedicated read-only projection} // ===== Symptom: action "approve" missing =====// projection BDEF must contain:   use action approve;// then: activate projection BDEF -> check binding entity actions -> $metadata // ===== Checking order =====// 1 objects active (Activate All: Ctrl+Shift+F3)// 2 entity exposed in service definition// 3 binding refreshed / published (correct version)// 4 $metadata contains entity / navigation / action// 5 UI annotations (#FOR_ACTION, facets, value help)// 6 caches cleared

Real project scenario

After a supplier association was added to the projection, the Fiori object page link to the supplier did not appear, and $expand=_Supplier returned an error. The developer spent hours checking the CDS association and annotations.
The cause was simple: the supplier entity was not exposed in the service definition, so RAP dropped the navigation property from the service. Exposing a read-only supplier projection fixed both the link and the $expand call. The team added "navigation target exposed?" to their service checklist.

Common mistakes

Activating objects in the wrong order and chasing follow-up errors.
Forgetting to expose association targets, losing navigation silently.
Expecting base BDEF actions to appear without "use action" in the projection.
Confusing a missing button (annotation) with a missing action (service).
Not refreshing the binding or clearing caches after changes.

Best practices

Use Activate All after structural changes.
Check $metadata to separate service problems from UI problems.
Expose every navigation target the app needs.
Keep projection BDEF "use" statements in sync with the base BDEF.
Keep a service troubleshooting checklist in the wiki.

Interview angle

Questions: "Navigation is missing in a RAP service — why?", "An action is not visible in the service — what do you check?"
Strong answer: navigation requires the association in the projection element list and the target entity exposed in the same service (compositions redirected); actions require declaration in the base BDEF and "use action" in the projection BDEF; then refresh the binding, check $metadata, and only then look at UI annotations and caches.

Practice this lesson

Quick check

1. An action exists in the base BDEF and works in DEV tests, but QAS metadata does not show it. What is the most likely cause?

2. A service definition does not activate: "entity ZC_PurchReqItem not found". What should you do first?

3. When does a navigation property appear in a RAP OData service?

Interview questions

1. An action exists in the base BDEF and works in DEV tests, but it is missing from the service metadata. What do you check?

Answer it in your own words first, then compare.

2. $expand on a supplier association fails in a RAP service, although the association exists in the projection. What is the cause?

Answer it in your own words first, then compare.

Practice more with Interview AI →

Reference-verified: the steps are checked against official SAP documentation and tutorials, and object and field names in the sample code are checked for consistency. The code has not been compiled or run on an SAP system by ERPClimb. Syntax marked release-dependent varies by SAP release, so check it in your own system.