Adobe form output using Gateway Services [OData] : SAP (2024)

  • Here is a small example to enhance the standard service by creating a custom entity set to print logo on the form.
    – Create an entity type with only one field. Logo (say).
    Create required associations — Association – PurchaseOrderNode is the primary node of PO based service. Hence adding association (Cardinality) will decide whether the GET_ENTITY will trigger or GET_ENTITYSET will trigger.Follow the below steps –
    Adobe form output using Gateway Services [OData] : SAP (1)– A popup will come up.
    Enter the required details.
    In my case – I am creating an entity type of name mediaControl.
    Adobe form output using Gateway Services [OData] : SAP (2)

    – After entering the details – Press OK.
    – On pressing OK button – An entity type gets created under Data Model.
    – If we expand the entity type. (in my case mediaControl). The properties are not available.
    Adobe form output using Gateway Services [OData] : SAP (3)–Now, we need to create a property – LOGO.
    –Double click on Properties Tab. A new view will open. On the right side.
    There we can add the fields that are required to be added in the entity set.
    In my case – I am creating a field name Logo of type Edm.String.
    Adobe form output using Gateway Services [OData] : SAP (4)–Add the field LOGO in the properties tab.
    Adobe form output using Gateway Services [OData] : SAP (5)–Now, the Entity set is added successfully. Save the project.
    –Now in order to create the required data provider methods – we need to regenerate the project, in order to generate the runtime artifacts of mediaControl entity.
    –Click on GENERATE (red) icon.
    Adobe form output using Gateway Services [OData] : SAP (6)
    Check if there are any errors… If any resolve the same and then again click on regenerate icon.
    –Now, Next step is to create the associations. However, it is not mandatory step. But, it is one of the factor, which decides the method ENTITY or ENTITYSET needs to be triggered.
    Below is the screenshot of how to create associations.
    –Select the Associations tab under Data Model folder. Right click on it. And select CREATE.
    Adobe form output using Gateway Services [OData] : SAP (7)

    –A popup will open. Enter the Association Name.
    In this case, I am creating ENTITYSET to print logo. Hence, the dependency is 1:1 considering PurchaseOrder as primary entity.
    Adobe form output using Gateway Services [OData] : SAP (8)
    Now click NEXT.

    In new window.
    Adobe form output using Gateway Services [OData] : SAP (9)

    –Select the dependent property. In this case. It is LOGO.
    –Select the field LOGO and click NEXT.
    Adobe form output using Gateway Services [OData] : SAP (10)

    –In next window – You can see, all the properties already created. Press FINISH.
    Adobe form output using Gateway Services [OData] : SAP (11)

    –After clicking the FINISH button, the Association and AssociationSet gets created.

    –You will be able to see the log. If any error occurs, solve it and follow the same process again to create Association.

    –If the operation is successful. You can see the created association under the node Associations.
    Adobe form output using Gateway Services [OData] : SAP (12)

    –As the structure is now available in the form of ENTITYSET. Now the next step is to populate data into the ENTITYSET.
    For that, we need to extend the Data provider class.

    –You can find the Data provider classes under the node Runtime Artifacts in t-code SEGW.
    For Purchase order, the class name is – CL_FDP_EF_PURCHASE_ORD_DPC_EXT.
    Adobe form output using Gateway Services [OData] : SAP (13)

    –If we need to fill data in our custom ENTITYSET. Then we need to write code in DPC_EXT class. The method that we use to write code to populate data is similar to the name of ENTITYSET name.
    For read operation we use GET_ENTITY method. For Query operation, we use GET_ENTITYSET method.

    –Now, In order to write code. Double click on the class DPC_EXT under runtime artifacts. An ALV will open up.
    Adobe form output using Gateway Services [OData] : SAP (14)

    –Double click on object name highlighted in the above screenshot.

    –On clicking the object, The class will open up. Now go to the method relevant to our custom entity type.
    Adobe form output using Gateway Services [OData] : SAP (15)

    OR

    You can directly right click on the DPC_EXT class. Click on the option Go to Workbench. The class will open up. Select relevant method (mentioned in above screenshot).
    OR

    Directly open the DPC_EXT class in SE24. And write the code in relevant method.

    –Now, the cardinality is 1:1. Hence, there will always be one record for one purchase order. Hence, we will enhance the GET_ENTITY method.

    –Now, as we are enhancing the standard gateway service, we need to use implicit enhancements to populate our custom data. These classes are non-modifiable.

    –In order to write our custom code – We need to redefine the method.
    below are the steps.
    1.Go to CHANGE mode.

    2.Select the method, in which you are going to write our code. And click on Redefine button.

    3. Please refer the below screenshot –
    Adobe form output using Gateway Services [OData] : SAP (16)

    4.On clicking the redefine button – the window will open with some standard commented code. Which is non-modifiable.
    Use implicit enhancement option to write custom code.

    5.In Advanced Adobe, There is no option to create GRAPHIC Node. Because there is no provision of Context in advanced adobe. As available in ABAP based adobe form.

    6.Hence, the alternative way to achieve this is – call the method
    cl_ssf_xsf_utilities=>get_bds_graphic_as_bmp.

    7.As we normally do in ABAP based adobe form. This method converts the image in hexadecimal format.

    8.The additional step is – Call function module ssfc_base64_encode And pass the output of cl_ssf_xsf_utilities=>get_bds_graphic_as_bmp.

    9.After execution of FM ssfc_base64_encode, The final output would be in a string format. This way, we can directly bind the string output to the IMAGE FIELD in our Adobe layout.
    And, we can achieve the logo (available in SE78) in our form output.
    Below is the code for the same.
    Adobe form output using Gateway Services [OData] : SAP (17)

    -> Below is the code for the same :
    ___________________________________________________________________________
    DATA:lv_objecttypetdobjectgrvalue‘GRAPHICS’,
    lv_nametypestxbitmaps-tdnamevalue‘SAP_LOGO’,
    lv_idtypetdidgrvalue‘BMAP’,
    lv_btypetypetdbtypevalue‘BCOL’,
    lv_fieldtypexstring,
    gv_logo typestring.

    *Callingclasstopopulatethetestprint.whichisavailableinSE78.
    callmethodcl_ssf_xsf_utilities=>get_bds_graphic_as_bmp
    exporting
    p_object=lv_object”‘GRAPHICS’
    p_name=lv_name”NameoftheSE78logoinsideQuotes
    p_id=lv_id”‘BMAP’
    p_btype=lv_btype
    receiving
    p_bmp=lv_field”v_fieldandg_logomustbetypedxstring
    exceptions
    not_found=1
    internal_error=2
    others=3.

    *Convertingthehexadecimalvalueofimagetostringformat(Base64Encoding)
    CALLFUNCTION‘SSFC_BASE64_ENCODE’
    EXPORTING
    bindata=lv_field
    IMPORTING
    b64data=gv_logo.

    IFsy-subrc=0.
    er_entity-logo=gv_logo.
    ENDIF.
    ___________________________________________________________________________

    – After writing the code. Activate the enhancement and class.

    – Important instructions regarding binding.
    When we are binding the data in adobe layout, we need to know the ENTITY, ENTITYSET and PROPERTIES.
    Sometimes, the ENTITYSET is different then what we use in adobe layout to bind the data. Hence, to get the exact name of the ENTITYSET. Open the MPC class and open the method DEFINE_ASSOCIATIONS.
    Adobe form output using Gateway Services [OData] : SAP (18)

    Method will open up. Scroll down and go to NAVIGATIONS.
    Adobe form output using Gateway Services [OData] : SAP (19)

    The highlighted property in above screenshot, is the updated entity type name, That we have to use to access the data in adobe.
    Regarding Binding – In case of GET_ENTITY, the data can be accessed by entity_type only. But in case of entity_set, we need to use the path as -> EntitySet.EntityType[*].

    – Nowbased on the examples discussed above for Media fetch.
    The code is in place. Data is available in the respective ENTITYSETS.
    But the method doesn’t gets triggered. The Logo doesn’t appear on the form.
    In order to invoke those methods (Specially, in which the dependent property is not the primary key (like purchase order)).
    in order to invoke the custom methods without having dependent property as primary key. We need to enhance the MPC_EXT class. Which is available under node Runtime Artifacts.
    Because the model is now changed. After addition of one more entity.
    Below are the steps to redefine the model –

    1.Open CL_FDP_EF_PURCHASE_ORD_MPC_EXT class (t-code SE24).
    Adobe form output using Gateway Services [OData] : SAP (20)

    2.In order to redefine the model, We need to redefine the corresponding method of MPC_EXT class. The method name to achieve the same is – DEFINE.

    Adobe form output using Gateway Services [OData] : SAP (21)

    3.Go to change mode and Select the DEFINE method and click on redefine button.

    4.Enhance the define method to add the required code mentioned below.

    Adobe form output using Gateway Services [OData] : SAP (22)

    ___________________________________________________________________________

    super->define().
    ___________________________________________________________________________

    –Same way – If we need to add any other field into the form, which standard is not providing. We need to create our custom entity set. Populate the data accordingly. Maintain the cardinality, redefine the required method. And bind it in the layout.

    –Binding in the LAYOUT.
    As the data is getting passed at runtime. When OData gets executed. Hence, While binding the data at layout, We cannot see the hierarchy. Hence we need to type the binding manually.
    Adobe form output using Gateway Services [OData] : SAP (23)

    Email Templates –

    The email templates can be accessed via FIORI tiles only.
    The catalog for the FIORI tiles is – SAP_BASIS_TCR_T.
    This needs to be added to your user ID. Security team helps you to add the catalog to your user ID.
    When the catalog gets added successfully under the ID. You can see the tiles on your FIORI home page by executing the t-code – /UI2/FLP.
    You can add the required tiles to your home page by click on Pin to Home page button.

    When you execute the tile. You will get an error (Sometimes). Not able to fetch data.
    In the details of error, You can find the service name.
    In order to resolve the issue, You need to add the service in t-code – /IWFND/MAINT_SERVICE.
    Same as mentioned in step – 1.

    Regarding Email and print settings. Everything is maintained at BRF+ level.
    E.g. Template, email address etc.
    In order to use the email templates – Click on the FIORI application “Maintain Email templates”.

    Adobe form output using Gateway Services [OData] : SAP (24)

    Click on predelivered email templates link. You can use standard or you can copy the same and make the required changes.

    Adobe form output using Gateway Services [OData] : SAP (25)

    On clicking any of the email template – You can see the data sources i.e. the CDS view, that is going to provide data to the email body.
    In my case, I have copied the PO default standard email template to custom one.

    Adobe form output using Gateway Services [OData] : SAP (26)

    There are chances that you are not able to see all entries of Email templates in FIORI application.
    This can happen only, If you front-end and back-end system is different.
    The possible cause is – You have not maintained the destination system in /IWFND/MAINT_SERVICE t-code.

    Adobe form output using Gateway Services [OData] : SAP (27)

    Creating Custom OData Service –

    • If in case, there is a requirement to create a custom OData Service out of standard one then —
      For Purchase Order ->
    1. Copy the project FDP_EF_PURCHASE_ORDER to custom one. Redefine the classes that are already defined in standard project. Because, the redefinition doesn’t get copied to custom project.
    2. After redefining all the required methods. Register the Z service in /IWFND/MAINT_SERVICE as specified in step – 1.
      The service can be retrieved from the SEGW project only. Just expand the project. Goto Runtime Artifacts.
    3. The term ending with SRV is the technical service name.
      Adobe form output using Gateway Services [OData] : SAP (28)
    4. Now assign the service name that you got in above step and assign it to the Adobe form in change mode.
      Adobe form output using Gateway Services [OData] : SAP (29)
    5. Still, If you trigger the form, It will result into ERROR.
    6. The last step is – Go to SPRO t-code -> SAP Reference IMG -> Cross Application Components -> Output Control.
      Adobe form output using Gateway Services [OData] : SAP (30)
    7. Execute – Define Output Types…..
      A new screen will open…..
    8. Search PURCHASE_ORDER in the list
      Adobe form output using Gateway Services [OData] : SAP (31)
    9. Double click on the PURCHASE_ORDER node. It will take you to the new screen… as available below.
      Adobe form output using Gateway Services [OData] : SAP (32)
    10. In the above screen – There is a callback class, which ultimately call the OData Service.
      If at all we are copying the standard gateway service to Z. Then we need to create a copy of callback class to Z.
    11. Now open the copied class in t-code SE24.
    12. Now access the method – GET_FDP_PARAMETER.
    13. Double clicking the method, will take you to the source code.
    14. At line number “12”, the standard service name is assigned. You need to change it to custom service in your custom class.
    15. After activation of your custom class. Assign the z class in SPRO on place of standard callback class.
    16. Now you can trigger your custom service.

      Creating Custom Adobe Form –

      The only process to create the adobe form is – Simply copy the standard form to Z.

      Copy Email templates or Form templates in FIORI application

      There are chances that you are not able to see all entries of Email templates in FIORI application. This can happen only, If you front-end and back-end system is different.
      The possible cause is – You have not maintained the destination system in /IWFND/MAINT_SERVICE t-code.

      Adobe form output using Gateway Services [OData] : SAP (33)

      Sometimes, while trying to copy the email template or form template, The copy button remains disabled.

      Adobe form output using Gateway Services [OData] : SAP (34)

      In Order to resolve this, you need to implement an SAP note – 2283716.

      Adobe form output using Gateway Services [OData] : SAP (35)

      This task is done from BASISteam.

      BRF+ configuration.

      The possible issue could be – Necessary KPRO settings that needs to be maintained in the system. This is Basis team’s task.
      The required SAP notes that needs to be used in the to setup KPRO is -Required BRF+ configuration needs to be maintained to use the Output channel.
      This is Functional person’s task.
      You can refer the SAP Blog on New Output Management in S4/HANA
      Sometimes, Even after doing the required BRF+ configuration – The output channel doesn’t work. The output do not gets executed.

      Adobe form output using Gateway Services [OData] : SAP (36)

      2279725 – Content repository for category SOMU.
      2462673 – Output remains with “To be output” status

  • Adobe form output using Gateway Services [OData] : SAP (2024)

    FAQs

    How do I test OData service in SAP gateway client? ›

    To test the new service from the Service Catalog, select the newly created service and choose SAP Gateway Client. If the SAP Gateway is located in the same ABAP system and you open the DDL editor with the relevant DDL source again, you will detect that a new decorator indicates a successfully activated OData service.

    How can I get data from OData service? ›

    Step 1: Go to SEGW transaction, Create a project.
    1. Step 2: Provide the project name, description and package. ...
    2. Step 3: Our project looks as below.
    3. Step 4: Now we need to build our Data model, first Create the Entity type by importing a DDIC Structure.
    9 Mar 2017

    How do I display an Adobe form in SAP? ›

    Procedure
    1. In the SAP system, call transaction SA38 and run program FP_CHK_REPORT. ...
    2. Under Form, enter the name of the form template to be checked. ...
    3. Under Activity, specify whether the system is to execute just the check or also an update.
    4. Under ADS Connection, specify the RFC connection to Adobe Document Services.

    How do I download Adobe forms in ABAP? ›

    Download adobe form into local system in PDF format.
    1. FP_JOB_OPEN.
    2. FP_FUNCTION_MODULE_NAME.
    3. FP_JOB_CLOSE.
    4. POPUP_TO_CONFIRM.
    5. SCMS_XSTRING_TO_BINARY.
    6. cl_gui_frontend_services=>gui_download.
    7. cl_gui_frontend_services=>execute.
    28 Dec 2020

    How do I test OData service? ›

    Test your first ODATA Service
    1. To test the service, open /IWFND/GW_CLIENT – SAP Netweaver Gateway Client transaction.
    2. Enter the service name and add $metadata at the end and Execute.
    3. Metadata of the service will be retrieved and the “HTTP Response will be 200”.
    4. Now enter the service name and add Entity Set name.
    9 Dec 2014

    How can I tell if OData is activated? ›

    Procedures
    1. Log on to your front-end server (your SAP Gateway system).
    2. In transaction SPRO , navigate to SAP Reference IMG SAP NetWeaver SAP Gateway OData Channel Administration General Settings Activate and Maintain Services. ...
    3. Verify that all the common OData services for SAP Fiori are active:

    How do I debug OData service? ›

    Debugging an Odata call

    Go to transaction SE80, and choose Utilities -> Settings. Set the user you want to debug and press Enter. Find the Data Provider Class method you want to debug, and position the cursor on the line where the breakpoint should be placed. Click the icon for External Break Point to set it.

    What is the difference between OData and JSON? ›

    JSON is just a data-interchange format based on JavaScript. REST is an architecture style whereas OData is a specific implemenation of REST designed to generate and consume data, which supports two formats, AtomPub and JSON.

    How does OData query work? ›

    OData defines two operators any and all that evaluate a Boolean expression on a collection. They can work on either collection properties or collection of entities. The request below returns People with Emails containing "ll@contoso.com". The Emails is a collection of primitive type string.

    How do I get metadata from OData? ›

    A browser opens that displays the service document. Add /$metadata to the URI in the address bar to view the metadata of the OData service. The metadata document displays the relevant information that the OData service provides for an OData client in a CSDL (Common Schema Definition Language).

    How do I display table data in Adobe form? ›

    Open the Adobe form layout. Drag “SubForm” UI Element from the library in to body pages of pdf layout. Now drag the “POItems” node from “Data View” tab in to the subform.

    How do I display an Adobe form? ›

    Steps to Required:
    1. Step1: Need to create a ODATA Project. Go to the Transaction SEGW and click and on Create Button to create a project.
    2. Step2: Implement the Code to Download the Adobe form. Redefine Define method marking Mime Type and the GET_STREAM. Now we need to redefine DEFINE Method in MPC_EXT class as below.
    19 Apr 2021

    What is the Tcode for Adobe form? ›

    SFP is the transaction code for creating adobe forms...

    How do I install Adobe Forms in SAP? ›

    So, How?
    1. Install the Additional Scenario – Adobe Document Services.
    2. Apply the CE_composition_environment_development_full configuration template.
    3. Configure Service Startup to Support ADS.
    4. Set up the ADS Group, User, and Authentication.
    5. Install Adobe Credentials.
    13 Sept 2007

    How do I activate Adobe Forms in SAP? ›

    First Simple Adobe Form
    1. Go to Tx- SFP.
    2. A form interface is required to pass the data to the form. ...
    3. Activate it. ...
    4. Now to create an adobe form, select the Form and provide a name and Create.
    5. Provide the interface and Save.
    6. Go to Layout tab.
    31 Dec 2015

    How do you download and upload Adobe forms in ABAP? ›

    Download the Interface and Form which you want to copy on the desktop. Step 1) Create a Interface and click on change button. Step 2) From Utilities menu select Uploading Interface as shown below. Upload the Interface which you have saved on your desktop earlier.

    How do I query OData from the postman? ›

    How to Learn OData on Postman
    1. Install Postman.
    2. Import the collection. Click the "Import" button on the top bar. Choose download from link and paste the Postman collection URL. You can find more details of Postman collection in Postman collection docs.

    Which tools are used to develop the OData services? ›

    SEGW(Gateway Builder) Tool

    This is most used approach in creating OData services.

    What are CRUD operations in OData? ›

    How to perfrom CRUD operations in OData
    MethodSQL OperationDescription
    CREATE_ENTITYInsertThis method is used to create/insert a new data in table
    UPDATE_ENTITYUpdate/ModifyThis method is used to update an existing data in table
    DELETE_ENTITYDeleteThis method is used to delete an existing data in table
    2 more rows
    26 Jan 2021

    Does OData service need to be activated? ›

    Verify that OData ICF nodes are activated for the OData service you registered as follows: In the service catalog, select the registered OData Service and, on the OData ICF node, select ICF Node. Choose Activate and confirm the dialog box. Save your entries.

    How does SAP OData work? ›

    SAP OData is a standard Web protocol used for querying and updating data present in SAP using ABAP, applying and building on Web technologies such as HTTP to provide access to information from a variety of external applications, platforms and devices. In SAP, we use SEGW transaction code to create an OData Service.

    What can you do to activate multiple OData services? ›

    In the Select System Alias for Activation task, enter the system alias. In the Select OData Services for Activation task, make sure that all services are selected that you want to activate. You can exclude some services that you do not want to activate. Choose Generate Task List Run .

    How do I enable gateway trace in SAP? ›

    How to Configure the Error Log Level
    1. Run transaction /IWFND/TRACES or /IWBEP/TRACES.
    2. Choose Add user (IWFND or IWBEP) or Request URI Prefix (IWFND only)
    3. Enter the user name (IWFND or IWBEP) or Request URI prefix (IWFND only)
    4. Change the log level from secure to full. This user setting is valid for 2 hours.

    Where can I find Odata service in SAP? ›

    Go to /IWFND/MAINT_SERVICE, use the filter to find the OData Service.

    Where can I find gateway services in SAP? ›

    SAP Gateway
    1. Open the SAP logon form.
    2. Choose the SAP system to connect to.
    3. Give User and Password and make the connection.
    4. Go to transaction SMGW.
    5. Choose the Goto menu from the drop down menu.
    6. Choose Parameters > Display.
    7. In the parameter list, find the values for gateway hostname and gateway service.

    Is OData SOAP or REST? ›

    OData 3.0 standards require OData users to follow REST principles. OData rests on HTML technology, which resolves the problem of being REST-based in a way. It supports two Protocols for Data Transfer, the XML-based Atom format and JSON.

    Is OData same as REST API? ›

    The AtomPub protocol is one of the best examples of REST API design. So, in a sense you are right - the OData is just another REST API and each OData implementation is a REST-ful web service. The difference is that OData is a specific protocol; REST is architecture style and design pattern.

    Is SAP OData a REST API? ›

    OData is a Web protocol based on REST, for querying and updating data, applying and building on Web technologies such as HTTP, Atom Publishing Protocol (AtomPub), and RSS (Really Simple Syndication) to provide access to information from a variety of applications.

    What is OData query parameters? ›

    System query options are query string parameters that control the amount and order of the data returned for the resource identified by the URL. The names of all system query options are optionally prefixed with a dollar ($) character. OData Protocol V4.

    What is the purpose of OData? ›

    The purpose of OData is to provide a protocol that is based on Representational State Transfer (REST) for create, read, update, and delete (CRUD) operations. OData applies web technologies such as HTTP and JavaScript Object Notation (JSON) to provide access to information from various programs.

    What is OData explain the advantages of OData? ›

    OData helps you focus on your business logic while building RESTful APIs without having to worry about the various approaches to define request and response headers, status codes, HTTP methods, URL conventions, media types, payload formats, query options, etc.

    What does metadata contain in OData? ›

    The metadata document contains the details of each entity that is accessible through the API, including fields, their names and labels, their data types, and the relationships (associations) between the entities.

    What is metadata in SAP OData? ›

    The OData $metadata file is a CSDL file that is made available to clients to help them discover the structure and organization of the entities, navigations, and the service operations that are available to manage resources beyond the usual create, retrieve, update, or delete operations.

    How do I get the OData response in JSON format? ›

    The OData JSON format can be requested using the $format query option in the request URL with the media type application/json, optionally followed by format parameters, or the case-insensitive abbreviation json which MUST NOT be followed by format parameters.

    How do I run OData service in SAP? ›

    Go to transaction code /IWFND/MAINT_SERVICE . Click on push button Add services . Now click back and go to main screen of transaction /IWFND/MAINT_SERVICE and find your service. A new screen will come, Execute the transaction and check the response .

    What can you use to test a standard OData interface? ›

    SAP Gateway Client

    The Gateway Client is a SAPGUI-based test tool for OData services that supports OData versions 2.0 and 4.0. You can access it using transaction /IWFND/GW_CLIENT .

    Where can I find OData service in SAP? ›

    Go to /IWFND/MAINT_SERVICE, use the filter to find the OData Service.

    How do I enable OData services in SAP? ›

    Procedure
    1. Log on to the SAP Gateway server as administrator.
    2. In Customizing for SAP NetWeaver, choose Gateway OData Channel Administration General Settings SAP NetWeaver Gateway to SAP System Activate and Maintain Services. ...
    3. On the Activate and Maintain Services screen, choose Add Service.

    Why do we need OData in SAP? ›

    SAP OData is a standard Web protocol used for querying and updating data present in SAP using ABAP, applying and building on Web technologies such as HTTP to provide access to information from a variety of external applications, platforms and devices. In SAP, we use SEGW transaction code to create an OData Service.

    What is the purpose of OData? ›

    The purpose of OData is to provide a protocol that is based on Representational State Transfer (REST) for create, read, update, and delete (CRUD) operations. OData applies web technologies such as HTTP and JavaScript Object Notation (JSON) to provide access to information from various programs.

    What is OData and how it works? ›

    The OData Protocol is an application-level protocol for interacting with data via RESTful interfaces. It supports the description of data models, editing and querying of data according to those models.

    What is OData format? ›

    OData supports two formats for representing the resources (Collections, Entries, Links, etc) it exposes: the XML-based AtomPub format and the JSON format. This document describes how OData resources are represented in JSON and [OData-Atom] describes the AtomPub representation.

    How do I read OData metadata? ›

    Add /$metadata to the URI in the address bar to view the metadata of the OData service. The metadata document displays the relevant information that the OData service provides for an OData client in a CSDL (Common Schema Definition Language).

    What is OData in simple terms? ›

    What is OData? The simplest definition of OData would be that it is a standardized protocol built over existing HTTP and REST protocols supporting CRUD (Create, Read, Update, Delete) operations for creating and consuming data APIs.

    What is the difference between rest and OData? ›

    REST stands for REpresentational State Transfer which is a resource based architectural style. Resource based means that data and functionalities are considered as resources. OData is a web based protocol that defines a set of best practices for building and consuming RESTful web services.

    What is REST API in SAP OData? ›

    An application programming interface (API) allows you to access data, for example, monitoring data. The OData API is implemented as a REST API and the technical protocol is Open Data Protocol (OData). This means that you can use standard HTTP methods (for example, the GET method) to call the API.

    How do I activate an OData service? ›

    Activate Available OData in SAP Gateway
    1. Go to transaction code /n/iwfnd/maint_service.
    2. Click on Add Service from the top header.
    3. At the next screen, ...
    4. The Select Backend Services will display the OData service. ...
    5. At the Add Service screen, click on Local Object so $TMP appears and then click execute on the bottom right.
    5 Aug 2020

    How do I transport OData service in SAP? ›

    Another option is to add this manually to the transport. The System Aliases are stored in table /IWFND/C_MGDEAM and can be added manually to the transport. After transport the System Aliases is set in target system.

    How do I add a field to OData service in SAP? ›

    1. Go to the Administrator work center.
    2. Navigate to the OData Service Explorer view.
    3. Change the selection to Custom OData services.
    4. Click New to create a new custom OData service;
    5. Edit the custom OData service.
    6. Select the required Object under Select Business Object.
    7. Expand and select the entities.

    Top Articles
    Latest Posts
    Article information

    Author: Kieth Sipes

    Last Updated:

    Views: 6017

    Rating: 4.7 / 5 (47 voted)

    Reviews: 86% of readers found this page helpful

    Author information

    Name: Kieth Sipes

    Birthday: 2001-04-14

    Address: Suite 492 62479 Champlin Loop, South Catrice, MS 57271

    Phone: +9663362133320

    Job: District Sales Analyst

    Hobby: Digital arts, Dance, Ghost hunting, Worldbuilding, Kayaking, Table tennis, 3D printing

    Introduction: My name is Kieth Sipes, I am a zany, rich, courageous, powerful, faithful, jolly, excited person who loves writing and wants to share my knowledge and understanding with you.