Guidelines for Using the Generated Service

Query Operation in BOR and RFC at Runtime

• Perform filtering, and queries on Properties available only in the Data Model root node (the properties you have flattened at design time).

• Only Properties of type import and export are supported for filtering and in ranges table.

  At design time, map only the Properties of type import in order to enable filtering capabilities at runtime. You get an error when you attempt to map Properties of type export.

Read Operation in BOR and RFC at Runtime

You can request to view or display any data regardless of the depth of the Data Object containing the data.

At design time, the level of the node for a Data Object in the hierarchy of Data Objects is not affected at runtime.

Create Operation in BOR and RFC at Runtime

• You can create new values for Properties available only under the root node of the Data Model.

  At design time, all the Properties that are placed directly under the root node (flatten) during mapping, are used.

• Tables and table Properties can have new values added to them in the SAP backend system. However, only the first line of the table Properties will be filled.

  At design time, map the table node and the table Properties directly under the root node, so that you can fill it at runtime.

• For BOR, at the end of the Create operation, the runtime process automatically executes BAPI TRANSACTIONAL COMMIT.

• For RFC, at the end of the Create operation, the runtime process does not execute BAPI TRANSACTIONAL COMMIT. The RFC is expected to it .

• At the end of the Create operation, the runtime process executes the Read operation after the Create operation for the Properties directly under the root node.

  At runtime, the results in the client after the Create operation is a reflection of the Properties directly mapped under the root node at design time.

Update Operation in BOR and RFC at Runtime

• You execute the Update operation regardless of the depth of the Data Object containing the data to be changed.

• The runtime Update flow supports the PUT method of OData.

  Note

  You should provide values for all fields of the Data Object in your client request (the payload of the node should be full).

  If any field is left empty, you risk updating the backend value for that field with an empty value.

• The runtime flow of the Update operation has an automatic logic to read the entire object in SAP Gateway before performing the Update operation. This logic enables the generator to provide additional data from other Data Objects that are related to the Update operation but have not been executed in the specific process.

  The additional data come from the Read operation. In such cases, the Data Object's of the Read operation and the Update operation must to be the same at design time.

  Where a Data Object is mapped at design time for only the Update operation, at runtime, there is no automatic Read before Update process.

  Where the Update operation is decentralized and available in more than one Data Object at design time, then the runtime automatically processes the Read operation before the Update operation.

• You can update the values in a specific line or row of a table.

• For BOR, at the end of the Create operation, the runtime process automatically executes BAPI TRANSACTIONAL COMMIT.

• For RFC, at the end of the Create operation, the runtime process does not execute BAPI TRANSACTIONAL COMMIT.

Delete Operation in RFC and BOR at Runtime

• At runtime the Delete operation can be executed only on the Properties that have been mapped directly in the root node at design time.

• The OData service payload is not relevant.

• For BOR , at the end of the Create operation, the runtime process automatically execute BAPI TRANSACTIONAL COMMIT.

• For RFC, at the end of the Create operation, the runtime process does not execute BAPI TRANSACTIONAL COMMIT.

Query

• At runtime, you execute the Query operation only on Properties that have been mapped directly in the root node at design time.

• Filtering is supported only for Properties of type input.

• Runtime query results are based on the batch execution (including the search help exit) of the Search help function module in the backend system.

  Therefore in the backend, you can get search help results that may not be available or may be different from the results you get when using the SAP Gateway service (OData service).

Read

• You execute the Read operation regardless of the depth of the Data Object containing the data to be changed.

• Drill down for table entities is not supported.

• Paging of the entire table is supported.

Create

• At runtime, you execute the Create operation only on Properties that have been mapped directly in the root node at design time.

• At the end of the Create operation, the runtime process executes the Read operation after tha Create operation on Properties in the root node Data Object.

  The results of the Create operation presented in the client is the Properties that were mapped directly under the root node, at design time, after processing the Read operation after the Create operation.

Update

• You can execute the Update operation only on simple Data Objects with 0..1 cardinality.

• There is no logic for the Read operation before the Update operation. Since Screen Scraping is based on transactional business processes, there is the assumption that all required data is already available, so you can change the data coming from the SAP Gateway (OData) service.

• The runtime Update flow supports the PUT method of OData.

  Note

  You should provide values for all fields of the Data Object in your client request (the payload of the node should be full).

  If any field is left empty, you risk replacing the backend value for that field with an empty value.

Delete

• At runtime, the Delete operation can be executed only on the Properties that have been mapped directly in the root node at design time.

• The OData service payload is not relevant.