<p>about your learning experience to help us improve.</p>

You've completed

cleanFiles/bookmap_Exploring_Extensibility_in_SAP_Digital_Man_en-US_learning-sap-com_lsc-prod.zip (MMCP-DROPZONE) - 2025-04-17T09:33:58.000Z

Registering the Create Alert Request API to the Service Registry

<div id="content"><p tabindex="0">In this lesson, we will more or less follow the guide to configure the alert service from SAP Help. This is a good example of how to register your own services to the Service Registry. When you register a third-party service, you will just need to know the structures and endpoint details. See this link <a target="_blank" href="https://help.sap.com/docs/sap-digital-manufacturing/operations-guide/configure-alerts-services">https://help.sap.com/docs/sap-digital-manufacturing/operations-guide/configure-alerts-services</a> The alert service allows you to create alerts within SAP DM and send mail notifications to the alert processors to ask them to work on the alert. The API is already part of the Service Registry by default, so you will also find it upon searching for it. However, the alert function in SAP DM allows you to set up custom alert types containing custom alert data. The custom alert data you configure is not part of the create alert service you find in the Service Registry by default. Therefore, as soon as you use custom alert data, you need to register the service yourself.</p><div class="kalturaVideoLessonWrapper"><div aria-label="" class="kalturaVideoLessonContainer" data-testid="video" id="1_nsgca75p"></div></div><div class="note"><div class="noteTitle"><span class="noteIcon"><img title="Note" src="/icons/note.svg"></span><span class="noteTitleText">Note</span></div><div class="noteBody"><p tabindex="0">This SAP Help page explains how to set up the SAP DM default destination. Link: <a target="_blank" href="https://help.sap.com/docs/sap-digital-manufacturing/production-process-designer/create-destination-for-sap-digital-manufacturing">https://help.sap.com/docs/sap-digital-manufacturing/production-process-designer/create-destination-for-sap-digital-manufacturing</a></p></div></div></div>

Create a Web Server

<div id="content"><div class="kalturaVideoLessonWrapper"><div aria-label="" class="kalturaVideoLessonContainer" data-testid="video" id="1_9vf3ck37"></div></div><div class="note"><div class="noteTitle"><span class="noteIcon"><img title="Note" src="/icons/note.svg"></span><span class="noteTitleText">Note</span></div><div class="noteBody"><a target="_blank" href="https://help.sap.com/docs/sap-digital-manufacturing/operations-guide/createalertrequest-schema">Here</a> is the link to the CreateAlertRequest Schema.</div></div></div>

Create a Schema

Create a Service / API Call

Exploring Customization in SAP Digital Manufacturing

Creating a Web Server for an API

In this video, we will create the web server needed for the API. The web server represents the API's endpoint and is the first object needed for the configuration. Please navigate to the Manage Web Server's app and select the Create button. First, we will give the web server a name. In this case, Alert underscore Server underscore DM 1040 as someone else already used the name alert underscore server. Normally, we would not create a second instance of an already existing web server, but for practicing it is okay to do so. In the header, you can also provide a description and select a plant. The plant can be used when an endpoint is only available for a certain plant, e.g., a machine, offers a web server with RestAPis for integration. In that case, the particular web service is only available for that one plant, and you may use the plant field to label that, but in most cases you can just leave it empty. For the alert service, we can leave the web server type as cloud service. In case we want to integrate an additional ERP or EWM endpoint, we would select on-premise service. For on-premise services, you first need to create the connection in the app configure production connectivity. For cloud services, this is not needed. And you can add the host URL right away. In this case, the API endpoint of SAPDM. Now, as the basis configuration is done, we will add a destination to the configuration. The destination is previously set up on SAP BTP and will be leveraged by the web server configuration for authentication. Below this video, you will find a hint on how to create the destination on SAPBP. The last step to finish the web server configuration is to add our web server to the DMC underscore cloud web server. This will make the services that are part of the web server available in the production process designer. For this, we navigate to the DMC underscore cloud web server and add the services. alert underscore server underscore DM 1040 as a connection. Congratulations. You have configured your first web server in SAPDM.

Creating an Alert Request Schema 

In this second demonstration, we will create the alert request schema as one example on how to create schemas. For the complete configuration of the alert service, a couple more schemas are needed, but this demonstration will show you everything you need to know to create the rest by yourself. To create a schema, navigate to the service registry. Inside the app, select the Schemis tab, and select the Create button. For the demonstration, the Demonstration, we will chose Create Alert Request M 1040 as the schema name. For the group, I will select the group user defined. Feel free to select a different group or to create one and none is available in your tenant. The group should help to structure the services and will later group the services also in the production process designer. To create a new group, just type the name into the field. When you save it, the group will be created in the background. For the basic schema setup, we will use the code option. as the code is available in SAP help for the create alert request. You may find a direct link in the box under the video. Usually, you would just use the from view to create the single data points. We will see this when we extend the structure by the sub-schemas. The sub-schemas were not contained in the code from SAP, help, as you may have chosen different names for the structures. We will now add them manually. Select edit followed by add to create a new element. For the additional elements, we will select the names, given in the SAP help page, with one exception which is the custom alert data structure. The first one is the processors. The data type for this is structure array and the schema is alert processor. You may use the alert processor schema from the alert management group or need to create a user-defined one before finishing the configuration of the create alert request. If you compare this demonstration to the SAP help page, you will find that we have skipped a couple of steps. These were the creation of the substructures as the creation process is the same. Next is the custom alert data. This time we will use the structure data type. For my demonstration, I already created the DM-1040 underscore alert data structure, but you won't find this on the help page as it is a custom data structure and needs to match your project's configuration in the manage alert data schemas and manage alert types apps. My structure contains an order, SS2, FF, plant, and serial underscore number field, but you may define it to your needs. Here it only serves as a demonstration. The name of this element needs to match the name you defined in the Manage Alert Data Data Schemas app. Lastly, we will add the Alert Notification Sub Schema. This time, it is a structure array again. With that, we have finished the schema creation. You have seen how to add fields and subschemas to assemble a complex data structure with multiple levels.

Creating a Service in SAP Digital Manufacturing 

In this final video of the lesson, we will bring all three elements together, the web server, the schemas, and now the service itself. To create the service, we will navigate back into the service registry and select the API Services tab. Select the create button. First, you will give a name to the service you are about to create. The name will also be its ID, if not specified otherwise. As for the schemas, the groups are available for structuring, and we will select the user-defined group. In the overview section, basics of the service are configured like the type, protocol, the web server we created earlier, and the path to the specific endpoint. While we only specified the base URL and the web server, we will now specify the path to the endpoint. SAPDM will take the base from the web sever and concatenate the path you specify here to get the URL. After the basics, the URL parameter and possible request body will flow. For the parameters, we need to specify. the name and data type. In this case, it is the alert type. As we are creating this for a custom alert type with custom alert data fields, you may even consider using the default value to make correct usage easier for the automation engineer using the service and production processes. The request body will be the schema we previously created. For a simple post call where you are not interested in the result of your call, this would already be it. But in most cases, you also want to want to retrieve the result of an API call. For this, we will add a response code with an expected response. I have already created the schema for the response and we'll just use it. You find the schema details in the alert service documentation. The API expert might have already noticed that I made a mistake in the URL path with the missing slash the system would not allow me to save. After the change the system allows me to save and we have successfully created the service.