|
Purpose With InputAssistant and GuiXT Controls, you have a convenient way to use SAP OData services in GuiXT. SAP has implemented numerous OData services, particularly in newer SAP systems; these also form the basis of the Fiori apps. GuiXT supports the currently used OData versions v2 and v4. SAP has already integrated all necessary authorization checks into the services, so there is no risk of displaying data to a user, or allowing them to modify data, for which they are not authorized. SAP provides a catalog of all OData services on the "SAP Business Accelerator Hub" website. In addition to the standard SAP OData services, you can also access services you have developed yourself. In GuiXT, all OData "CRUD" operations (Create, Read, Update, Delete) are supported. Additionally, there are the following functions: Logon, Logoff, Execute and ConvertValues, and for batch processing: CreateBatch, RequestBatch, FetchBatchResult, FetchAllBatchResults, DeleteBatch. |
|
GuiXT
Parameters "sap/opu/odata/sap/API_MAINTENANCEORDER/MaintenanceOrder" It consists of the ICF path prefix ("sap/opu/odata/sap"), the technical service name ("API_MAINTENANCEORDER") and the entity set ("MaintenanceOrder").
2 result Default: "" In conjunction with the "expand" parameter, "result" specifies a comma separated list of GuiXT variables: one additional GuiXT table variable for each navigation property. See below for the details.
3 key Default: ""
Quoting and URL encoding are applied automatically: single quotes are doubled, and characters such as
4 filter Default: ""
5 top Default: ""
6 skip Default: ""
7 fetchsize Default: ""
8 orderby
Default: ""
9 expand Default: ""
10 options Default: ""
11 urloptions Default: ""
12 headervariables Default: ""
13 cache Default: ""
You may use the ClearCallCache command to reset the cache.
14 message Default: ""
15 etag Default: ""
16 delayMs Default: ""
System variables set by OData.Read
Example: Read a maintenance order, including its operations
|
|
GuiXT
Parameters
2 values Default: "" In conjunction with the "navigation" parameter, "values" specifies a comma separated list of GuiXT variables: the first variable is the header structure, followed by one additional GuiXT table variable for each navigation property, to perform a "deep insert" (header and dependent items in a single call).
3 headervariables Default: ""
4 etag Default: ""
5 navigation Default: ""
6 message Default: ""
7 options Default: ""
8 result Default: ""
9 newetag
System variables set by OData.Create
|
|
GuiXT
Parameters
2 key Default: ""
Quoting and URL encoding are applied automatically: single quotes are doubled, and characters such as
3 values Default: ""
4 headervariables Default: ""
5 etag Default: ""
6 navigation Default: ""
7 message Default: ""
8 options Default: ""
9 result Default: ""
15 newetag System variables set by OData.Update
|
|
GuiXT
Parameters
2 key Default: ""
Quoting and URL encoding are applied automatically: single quotes are doubled, and characters such as
3 headervariables Default: ""
4 etag Default: ""
5 message Default: ""
6 options Default: "" System variables set by OData.Delete
|
|
Establishes a session with the SAP system (authentication, CSRF token, user format settings). Calling OData.Logon explicitly is optional: OData.Read, OData.Create, OData.Update, OData.Delete and OData.Execute perform an implicit logon with default settings if no session exists yet. Use OData.Logon explicitly if you need a non-default authentication mode, user, password or ticket.
GuiXT
Parameters You can append " authmode=sso" to the server name as a shortcut to select Single Sign-On without using the separate "authmode" parameter.
2 service Default: "sap/opu/odata"
3 authmode Default: ""
4 user Default: "*"
5 password Default: "*"
6 ticket Default: ""
7 headervariables Default: ""
8 message Default: ""
9 timeoutseconds Default: 300 System variables set by OData.Logon
|
|
Closes the current session (disposes the HTTP connection and clears all "V[_odata*]" GuiXT variables). Takes no parameters.
GuiXT
|
|
Calls an OData FunctionImport or Action (a named, RPC-style operation) - as opposed to OData.Read, which is limited to entity set queries. "$filter", "$top", "$skip", "$orderby", "$expand" and automatic paging are not supported.
GuiXT
Parameters
2 result Default: ""
3 parameters Default: ""
4 values Default: ""
5 headervariables Default: ""
6 navigation Default: ""
7 method Default: "GET"
8 message Default: ""
9 options Default: ""
10 cache Default: ""
11 fromFile Default: ""
12 toFile Default: ""
13 toTempFile Default: ""
14 key Default: "" System variables set by OData.Execute
Example: Add a notification attachment
|
|
Converts the values of a GuiXT structure or table variable according to the conversion options.
GuiXT
Parameters
2 result
3 options Default: ""
4 direction Default: "both"
5 odataVersion Default: "v2"
Starts a new batch. Subsequent OData requests are collected and sent to the server together as a single batch request.
GuiXT
Parameters Please observe:
2 transactional Default: "X" Typical usage
Sends the accumulated batch requests to the server. After the call, the results of each individual request can be retrieved separately. Subsequent single OData calls do not overwrite the batch results; these remain available until the next OData.CreateBatch call or an explicit OData.DeleteBatch.
GuiXT
Parameters
1 message Default: ""
2 returnstatus Default: ""
3 returnrequestbody Default: ""
Retrieves the result of the request with the given index. The corresponding request message, if any, is also returned.
GuiXT
Parameters
1 index
Fetches the results of all requests.
GuiXT
Removes the current batch with all results.
GuiXT
Reads metadata of a service (entities, properties, associations and navigation properties)
GuiXT
Parameters "sap/opu/odata/sap/API_MAINTENANCEORDER/MaintenanceOrder"
2 result Default: ""
The ReadMetadata function always returns distinct values. For example, if your return variable contains the two columns EntityName and EntityType only, you obtain a list of all entities of the service, with their type. If one of the column names is "Association", all associations of the service are returned. The following columns are filled in this case:
If one of the column names is "NavigationProperty", all navigation properties of the service are returned. The following columns are filled in this case:
3 entitytype Default: ""
4 entityname Default: ""
5 urloptions Default: ""
6 cache Default: "session"
7 message Default: ""
Components InputAssistant + GuiXT Controls |