RAP - Action Popup: Dynamic Field Control Using Abstract Entity & Annotations

-

Hello Everyone! 👋

RAP Action Popup: Dynamic Field Control Using Abstract Entity & Annotations

⚠️ Note: Applicable only to SAP Fiori elements for OData V4. The behavior may vary depending on the SAP UI5 version. Observed working in SAP S/4HANA 2023+ (SAP UI5 1.120+).

Step 1: Define the Action in Metadata Extension / Projection View

annotate view ZC_RootEntity with {
  @UI: { 
    lineItem: [ 
      { 
        position: 10, 
        type: #FOR_ACTION, 
        dataAction: 'ActionWithPopup', 
        label: 'Action With Popup' 
      }  
    ]  
  } 
  FieldName;
}

Step 2: Create an Abstract Entity (Popup)

@EndUserText.label: 'Action with Popup'
define abstract entity ZD_ActionWithPopup {

  @Consumption.valueHelpDefinition: [
    { entity: { name: 'ZI_ActionPropBehvValue', element: 'Behaviour' } }
  ]
  @EndUserText.label: 'Behaviour'
  Behaviour : abap.char( 1 );
  
  @EndUserText.label: 'Field 1'
  Field : abap.char( 10 );

  // Used as a comparison value (instead of hardcoding in XML)
  @UI.hidden: true
  @UI.defaultValue: 'M'
  mandatoryDefaultValue : abap.char( 1 );
}

Step 3: Expose the Action in Behavior Definition (BDEF)

define behavior for ZR_RootEntity alias RootEntity
...
{
  action ActionWithPopup parameter ZD_ActionWithPopup result [0..1] $self;
}

Step 4: Expose the Action in Projection BDEF

define behavior for ZC_RootEntity alias RootEntity
...
{
  use action ActionWithPopup;
}

Step 5: Create Service Definition & Binding

Create a Service Definition to expose the entity. Then create a Service Binding (OData V4) to make it available for UI consumption.

Step 6: Add Dynamic UI Logic in Annotations.xml

Create a new Fiori application using Fiori App Generator in VS Code or BAS. Then navigate to the annotations file:

project_name/webapp/annotations/annotation.xml

<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="local">
    <Annotations Target="SAP__self.ActionWithPopup/Field">
        <Annotation Term="Common.FieldControl">
            <If>
                <Eq>
                    <Path>Behaviour</Path>
                    <String>R</String>
                </Eq>
                <EnumMember>Common.FieldControlType/ReadOnly</EnumMember>
                <If>
                    <Eq>
                        <Path>Behaviour</Path>
                        <Path>mandatoryDefaultValue</Path>
                    </Eq>
                    <EnumMember>Common.FieldControlType/Mandatory</EnumMember>
                    <EnumMember>Common.FieldControlType/Optional</EnumMember>
                </If>
            </If>
        </Annotation>

        <Annotation Term="UI.Hidden">
            <If>
                <Eq>
                    <Path>Behaviour</Path>
                    <String>H</String>
                </Eq>
                <Bool>true</Bool>
                <Bool>false</Bool>
            </If>
        </Annotation>
    </Annotations>
</Schema>

🎥 Demo: Dynamic Field Control Using Abstract Entity & Annotations

🔗 References

Comments

Post a Comment

Popular posts from this blog

Fiori URL Generation and Navigation Using CL_LSAPI_MANAGER

-
Hello Everyone!👋 Fiori URL Generation and Navigation Using CL_LSAPI_MANAGER CL_LSAPI_MANAGER - This class allows you to easily generate SAP Fiori Launchpad URLs or trigger intent-based navigation. You’ll find it useful when you need to: Launch Fiori apps from the SAP GUI Generate dynamic Fiori URLs using semantic objects, actions, and parameters Share specific Fiori app links via email Navigate directly to transactions, and more DATA(lo_lsapi) = cl_lsapi_manager=>get_instance( ). " Generate URL to launch a Fiori app DATA(lv_flp_app_url) = cl_lsapi_manager=>create_flp_url( object = 'MaintenanceObject' " Semantic Object action = 'listFunctionalLocStructure' " Action system_alias = 'LOCAL' " SM59 Alias for FES parameters = VALUE #( name = 'DY_TPLNR' value = '0001' ) ). " Generate URL to launch a tran...
Read more

RAP - Real Time UI Updates Using Event-Driven Side Effects

-
Hello Everyone! 👋 Real-Time UI Updates in RAP Using Event-Driven Side Effects We've all come across situations where something changes in the backend, and we want those updates to automatically reflect in the UI without manually refreshing the page. In traditional setups, we used ABAP Channels for this but how can we achieve the same in RAP? Here's a simple example: I'm updating the travel status in one class/report, while the app is open in parallel. As soon as the status is updated in the backend, it automatically reflects in the UI no refresh needed! This is made possible through Event-Driven Side Effects . This is useful when: Background jobs update data We want to notify users with messages in real time Multiple users are working on the same data simultaneously Step 1 – Add the event-driven side effects in the BDEF managed with additional save .... .. define behavior for YR_YABS_TRAVEL...
Read more

ABAP - Create CSV Files Easily Using CL_CSV_FACTORY

-
Hello Everyone! 👋 Create CSV Files Easily in ABAP Using CL_CSV_FACTORY In many scenarios, we need to download internal table data in CSV format. Often, the requirements vary for example, using different field separators such as semicolon (;), comma (,). Additionally, we may need to include a header row and format fields like date, time, or timestamp. All of this can be handled very easily using the CL_CSV_FACTORY class. The best part is that this class is also available in the SAP Public Cloud. Step 1 – Select the Data SELECT FROM vbak FIELDS vbeln, vbtyp, erdat INTO TABLE @DATA(lt_test) UP TO 10 ROWS. Step 2 – Create a Simple CSV with Header This example generates a CSV using a semicolon as the delimiter and includes the header row automatically. DATA(lv_xstring_v1) = cl_csv_factory=>new_writer( )->set_delimiter( ';' )->set_write_header( abap_tr...
Read more