Managing Service Requests and Results

Objective

After completing this lesson, you will be able to create service requests and process service results

Service Requests App Overview

The Service Requests app allows users to create service requests for previously onboarded services and to receive results from external service providers.

Note

Prerequisites

There are important prerequisites before using the Service Requests app:

  • You have either the Data Scientist or the Master Data Manager role assigned to your user.

    Note

    The Master Data Manager role only has READ access to service requests information.
  • You have onboarded and activated the required service through the Services app.

Create Service Request

After navigating to the Service Requests app, the user will see the list of existing service requests and related information. The user can submit a new service request by selecting Create.

Screenshot of an SAP Service Requests interface. It shows the SAP logo, a search bar, and various filters for Service Provider Name, Service Type, and Service Status. Two entries are listed under Service Requests: one for the Beet/Wheat Yield Prediction Service with Request Number 12, Subscribed status, latest result received on Mar 12, 2024, and Not yet processed status with 3 total results and 2 unprocessed results; the other for the Sugar Beet Yield Prediction Service with Request Number 11, Subscribed status, latest result received on Mar 26, 2024, and Processing failed status with 11 total results and 6 unprocessed results. A highlighted Create button is also visible.

Under Select Service, the user sees the list of active services available and can choose the service from which they wish to request data.

Note

You can only select a single service for a service request.
Screenshot of an SAP interface for creating a new service request. The page is titled Create New Service Request with a Select Service step highlighted. Under 1. Select Service, there is a prompt to Select the service you would like to request data from. Two active services are listed: Beet/Wheat Yield Prediction Service and Sugar Beet Yield Prediction Service, both are of the Yield Prediction Service type. The version for Beet/Wheat Yield Prediction Service is 1.0.1 and for Sugar Beet Yield Prediction Service is 1.0.0. There is a search bar and a series of icons for adjusting views and settings.

The user has access to a wizard that supports with entering the information required by the external service in a stepwise manner. The user must provide the additional information required.

Note

The exact steps in the wizard depend on the configuration of the service by the external service provider. Refer to /metadata for more information on how this works.

In our example, the user must select the Key Performance Indicator (KPI), Crop and Crop Zones to be used.

If the service also requires additional manual user input, the corresponding fields are available in a final step of the wizard under the Additional Parameters section.

In this case, the user must enter the contract ID of the service.

At any time, the user can cancel the creation of the service request by clicking on the X located on the top-right corner of the screen. The user can also go back to a previous step by selecting the step name within the wizard flow.

Screenshot of an SAP interface for creating a new service request, shown in four stages: 1. Select KPI: - Title: Create New Service Request - Steps indicated: Select Service (completed), Select KPI (current step) - Under 2. Select KPI, KPI Definitions list one entry: Prediction: KPI Yield Vista with description Prediction of Yield in tons per hectare from Vista and unit of measure Tons per Hectare. - A Step 3 button is visible. 2. Select Crop Zone: - Title: Create New Service Request - Steps indicated: Select Service (completed), Select KPI (completed), Select Crop Zone (current step) - Under 4. Select Crop Zone, Crop Zones list two entries: Wheat Season 2023 - Field 0 and Wheat Season 2023 - Field 1, both with the crop Wheat and variety common wheat. - A Step 5 button is visible. 3. Select Crop: - Title: Create New Service Request - Steps indicated: Select Service (completed), Select KPI (completed), Select Crop (current step) - Under 3. Select Crop, Crops list two entries: Sugar beet and Wheat with corresponding descriptions. - A Step 4 button is visible. 4. Additional Parameters: - Title: Create New Service Request - Steps indicated: Select Service (completed), Select KPI (completed), Select Crop (completed), Select Crop Zone (completed), Additional Parameters (current step) - Under 5. Additional Parameters, there is a field labeled Contract ID: with a value displayed. - A Review button is visible.

When the required information has been maintained, the user can select Review to view a summary of the information provided in the previous steps, and Edit to modify any section that might need changes.

When this is done, the user can select Submit Request to complete the process, or Cancel to stop the request creation.

Screenshot of an SAP interface for reviewing a new service request: Title: Review Sections listed: 1. Services Selection: - Name: Yield Prediction Service - Description: (Empty) - Edit option available 2. KPIDefinitions Selection: - Name: Prediction: KPI Yield Vista - Description: Prediction of Yield in tons per hectare from Vista - Edit option available 3. Crops Selection: - Name: Wheat - Description: Wheat - Edit option available 4. CropZones Selection: - Names: - Wheat Season 2023 - Field 0 - Wheat Season 2023 - Field 1 - Description for both: Organic common wheat 2023 - Edit option available 5. AdditionalParameters Selection: - Name: Contract ID - Value: c00cd4c4-79a0-436b-a50f-8881566bb93c - Edit option available At the bottom, Submit Request and Cancel buttons are visible.

If all the provided information is correct and complete, the service request will be created and added to the list of Subscribed service requests. If the external service does not accept the request, the user will receive a popup message with the error description.

From the Service Requests start page, the user can access a specific request to verify the details that were maintained during creation.

If a service is no longer required or valid, the user has the option to Unsubscribe from it on the details page of the service request.

Note

You cannot revert the unsubscription of a service request.
Screenshot of an SAP interface for the Yield Prediction Service request with details: Title: #12 - Yield Prediction Service Request Status: Subscribed Created On: Mar 7, 2024, 4:28:02 AM Created By: (information blurred) Service Details: - Service Name: Yield Prediction Service - Service Version: 1.0.1 - Service Type: Crop related Predictions - Service Status: Active - Service Provider Name: Vista GmbH - Remote Sensing in Geosciences Tabs for Request and Results are visible, with the Request tab open. Sections listed: 1. KPIDefinitions: - Name: Prediction: KPI Yield Vista - Description: Prediction of Yield in tons per hectare from Vista 2. Crops: - Name: Wheat - Description: Wheat 3. CropZones: - Name: Wheat Season 2023 - Field 0 Description: Organic common wheat 2023 - Name: Wheat Season 2023 - Field 1 Description: Organic common wheat 2023 4. AdditionalParameters: - Name: Contract ID - Value: c00cd4c4-79a0-436b-a50f-8881566bb93c Buttons for Unsubscribe, various actions, and closing the interface are also visible.

Process Service Results

After the service request is submitted, the Service Requests app allows a user to analyze and process incoming service results provided by the external service provider.

Note

Prerequisites

  • You have either the Data Scientist or the Master Data Manager role assigned to your user.
  • You have already created the service request and it is visible in the list of service requests.

Hint

The frequency of result generation depends on the configuration of the service by the external service provider. The process of result generation is asynchronous, so it might take time for the results for a request to show up. For example, to provide yield predictions, the service provider will need to run calculations in-season once the specific crop started growing, which could be a few months after the service request is submitted.

To access the results provided by a service, the user can select a service request and navigate to the Results tab. Multiple results can be retrieved for a single service request.

The Receiving Status column indicates whether the external service successfully computed the results using one of the following values:

  • Data received: The external service sent data without errors
  • Data received with errors: The external service sent data but also returned errors
  • No data received: The external service only returned errors
Screenshot of an SAP interface for the Yield Prediction Service request with details: Title: #12 - Yield Prediction Service Request Status: Subscribed Created On: Mar 7, 2024, 4:28:02 AM Created By: (information blurred) Service Details: - Service Name: Yield Prediction Service - Service Version: 1.0.1 - Service Type: Crop related Predictions - Service Status: Active - Service Provider Name: Vista GmbH - Remote Sensing in Geosciences Tabs for Request and Results are visible, with the Results tab open. Results Section: - Filters for Active (3) and Archived (0) - Three entries listed with details: 1. Received At: Mar 12, 2024, 5:18:51 AM - Receiving Status: Data received - Status of Last Processing Run: Not yet processed - Last Processing Date: (empty) 2. Received At: Mar 11, 2024, 10:18:46 AM - Receiving Status: Data received - Status of Last Processing Run: Not yet processed - Last Processing Date: (empty) 3. Received At: Mar 7, 2024, 4:30:32 AM - Receiving Status: Data received - Status of Last Processing Run: Processing failed - Last Processing Date: Mar 13, 2024, 2:04:42 PM Buttons for Unsubscribe, various actions, and closing the interface are also visible.

Click on a result to view the details.

  • If the status is Result received with errors or Data received, the user can view the results in JSON format in the Result tab and decide whether they want to further process the data. Screenshot of an SAP interface for the Yield Prediction Service request with detailed results: Title: #12 - Yield Prediction Service Request Status: Subscribed Created On: Mar 7, 2024, 4:28:02 AM Created By: (information blurred) Service Details: - Service Name: Yield Prediction Service - Service Version: 1.0.1 - Service Type: Crop related Predictions - Service Status: Active - Service Provider Name: Vista GmbH - Remote Sensing in Geosciences Tabs for Results and Request are visible, with the Results tab open. Left Panel: - Filters for Active and Archived - Active results listed with details: 1. Received At: Mar 12, 2024, 5:18:51 AM - Receiving Status: Data received - Status of Last Processing Run: Not yet processed - Last Processing Date: (empty) 2. Received At: Mar 11, 2024, 10:18:46 AM - Receiving Status: Data received - Status of Last Processing Run: Not yet processed - Last Processing Date: (empty) 3. Received At: Mar 7, 2024, 4:30:32 AM - Receiving Status: Data received - Status of Last Processing Run: Processing failed - Last Processing Date: Mar 13, 2024, 2:04:42 PM Right Panel (Details for Mar 12, 2024, 5:18:51 AM): - Media Type: application/json - Number of Items: 2 - Received At: Mar 12, 2024, 5:18:51 AM - Target Entity: KPIValues - Size: 420 Byte - Receiving Status: Data received - Status of Last Processing Run: Not yet processed - Last Processing Date: (empty) - Result tab showing JSON data with two entries including kpiDefinition_ID, entity_ID, entityType, and predictedValue. Buttons for Unsubscribe, archiving, various actions, and closing the interface are also visible. A button labeled Process Result is at the bottom right.
  • If the status is Result received with errors or No result received, the External Errors tab provides further information on what has caused the error.
Vista Wheat Yield Prediction Service subscription page showing request status as Subscribed. The service version is 1.0.11, and the service type is Crop related Predictions. Service status is Inactive, created on Dec 5, 2023. Recent result received on Dec 6, 2023, at 3:59:21 AM with status Data received with errors, displaying an error message code 0001 indicating Warning: yield prediction not available for CropZone 80f50723-599d-4c7b-a683-575eaa6176de. Previous result received on Dec 5, 2023, successfully processed.

The user can process the data by clicking Process Results.

A popup will be displayed where the user can set the option to overwrite existing values. If this option is not set, then the processing will be aborted in case an overwrite is required.

If the process runs successfully, the Status of Last Processing Run for the result changes to Successfully Processed, and the data will be available in the respective target entity.

Note

Currently, a user cannot process each data entry individually within a result.

However, they can process the same result multiple times, if required. A user can also process previous results, in which case, a popup will inform you that you are about to import a previous result set and ask for confirmation.

Yield Prediction Service subscription page showing request status as Subscribed. The service version is 1.0.1 with service type Crop related Predictions, and service status set as Active, created on Mar 7, 2024. Recent result received on Mar 12, 2024, at 5:18:51 AM with status Data received and Successfully processed, displaying prediction values in JSON format. Previous result received on Mar 11, 2024, at 10:18:46 AM not yet processed and result received on Mar 7, 2024, at 4:30:32 AM failed processing. A confirmation box for processing the results to overwrite existing values warns that Errors will be skipped during processing with two options to Process or Close.

If an error occurred during the processing, the impacted entries will be skipped. To get more information on the errors, you can use the Processing Log tab that provides detailed information on the errors.

Service request #1 details for Mar 7, 2024, at 4:30:32 AM showing receiving status as Data received and status of last processing run as Processing failed. Log entries table includes two processing runs: the first on Mar 13, 2024, which failed, and the second on Mar 7, 2024, which succeeded. Response for the failed process shows an error message Entity already exists along with entity details in JSON format.

You have analyzed and processed service results. If the processing was successful, the data will be available in the respective SAP Intelligent Agriculture target entities.

Log in to track your progress & complete quizzes