Introduction
Integration Assessment, a capability of SAP Integration Suite, allows you to evaluate and maintain consistent use of integration technologies across your integration landscape. It is based on the Integration Solution Advisory Methodology (ISAM) and utilizes a workflow-based based approach to gather requirements and choose the appropriate integration technology for specific integration needs.
Previously, the workflow was entirely UI-driven, but we now offer specific APIs to facilitate better integration with external systems.
The sections below will guide you on how to utilize the APIs to integrate the process with external systems. It will provide examples, which will help you to use the APIs for yourself.
Preconditions
To follow the examples, the following preconditions must be fulfilled:
The examples given in the article point to the API endpoint of the EU10 landscape (https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1). The specific endpoint you need to use will be visible in the service key of the related Integration Assessment API service instance.
For accessing the UI, this article assumes the subdomain 'thisisanexample', resulting in the URL https://thisisanexample.intas.cfapps.eu10.hana.ondemand.com
Workflow
The example in this article will demonstrate how to create and process business solution requests and interface request using the API. The primary concept is to generate all the request entities via APIs while handling the requirement analysis and technology selection via the UI. This way, external systems can initiate the workflow, while the more complex technology selection is directly offered by the service. At the end of the technology selection, users can download a PDF summary of the selections made and process this further in an external system.
Create Business Solution Request
The first step to initially start the workflow is to create the business solution request. This can be easily achieved via the API.
POST on https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1/Request with body
{
"Name": "New Business Solution Request"
}
see full specification here
This call will create a new business solution request and return the newly created entity. It is important to note down the id property as we need this for upcoming calls. We assume the id value '8deb4b5c-0679-4048-ad9c-fd4956a0025c'.
The business solution request is represented by the technical entity Request. If it is created initially, it will be created in draft status. You can see the possible states a Request can have in the API description here.
Answer Business Solution Request Questionnaire
For further processing the questionnaire for the request needs to be answered. You can do that by accessing following URL: https://thisisanexample.intas.cfapps.eu10.hana.ondemand.com/app/index.html#/Worklist/SolutionRequest/8deb4b5c-0679-4048-ad9c-fd4956a0025c
Note that the GUID attached at the end of the URL is the one from the previously created request.
This step may be skipped in case you define an empty questionnaire for the Business Solution Request
Submitting the request and adding an Interface Request is not necessary as this is done via API in the next step.
Create Interface Request
A new Interface Request can be created by using the API
POST on https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1/CreateInterfaceRequest
{
"Name": "New Interface Request",
"RequestId": "8deb4b5c-0679-4048-ad9c-fd4956a0025c",
"StyleId": "15562407-5770-45ea-aa26-b9e6cd36ab12",
"SourceApplicationInstances": [
{"Id": "42b4a6f6-310f-40b2-bcd8-625fbce558dd"}
],
"TargetApplicationInstances": [
{"Id": "46b37842-b7fa-404f-a5b7-d919c6400dc2"},
{"Id": "c4be1e2b-a581-4759-b7bb-12e639f2452a"}
]
}
see full specification here
Beside a name for the interface request you also need to provide additional parameters:
- RequestId: The id of the previously generated request.
- StyleId: The id of the style to use. In this case the id refers to the style "Process Integration", which is part of the standard content delivered. You can get the ids of the styles in your system by using the respective API.
- Source/TargetApplicationInstances: The ids of the source and target application instances. The ids can be also retrieved via API. The ids given here are examples only and do not refer to any standard content.
By using this API multiple entities in the backend are created, the business solution request itself remains in state draft.
The API will also return the id of the generated interface request. We assume
07d31b7a-eb9f-4091-89c7-37913cd7a392 for now.
Submit Business Solution Request
After the interface request was created and the questionnaire for the business solution request was answered (or deactivated), the request can be submitted.
PATCH on https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1/Request('8deb4b5c-0679-4048-ad9c-f...
{
"Status": "new"
}
see full specification here
The call to the API triggers the state change of the request and sets it open.
Process Interface Requests
After the request is submitted, the individual interface requests need to be processed and a technology must be selected. As mentioned earlier, this should be done using the Integration Assessment UI. With the ID of the previously generated interface requests, you can construct the URL to access the interface request by appending the id.
In our case, the URL is https://thisisanexample.intas.cfapps.eu10.hana.ondemand.com/app/index.html#/Worklist/InterfaceAssessment/07d31b7a-eb9f-4091-89c7-37913cd7a392
By accessing this URL and starting to process the interface request, the related business solution request will change its status to in progress.
After the technology has been selected, you are also able to download a PDF report of the interface request. You may use this file and attach it to an external system to document the technology selection.
Complete Business Solution Request
After all interface requests have been processed, you are able to complete the request.
PATCH on https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1/Request('8deb4b5c-0679-4048-ad9c-f...
{
"Status": "completed"
}
see full specification here
The call to the API triggers the state change of the request and sets it to completed.
In case you want to remove the business solution request completely you can also delete the entity:
DELETE on https://intas-api.cfapps.eu10.hana.ondemand.com/intas/entities/v1/Request('8deb4b5c-0679-4048-ad9c-f...
see full specification here
Summary
This blog article has shown how to use the Integration Assessment APIs to manage the request workflow. By doing so, it is possible to integrate the Integration Assessment into external systems and workflows.
