ABAP client library to use the IBM Watson APIs. This is a Community SDK written by ABAPers for the ABAPers in the Open Source community, to provide easy usage of IBM Watson Developer Services in innovation initiatives combined with any SAP Application which is run on SAP NetWeaver 7.50 and above, such as SAP Business Suite or SAP S/4HANA on-premises edition. It is the choice and responsibility of application developers how this Community SDK is used.
Additionally, as the ABAP SDK is a community release it is not updated with the same schedule as IBM-supported SDKs. Please see more information in Questions.
| abap-sdk-nwas | abap-sdk-scp |
|---|---|
| for SAP NetWeaver AS ABAP 7.50+ | for SAP Cloud Platform ABAP Environment 2002+ |
| tested on SAP Business Suite and SAP S/4HANA on-premises edition | |
this repository |
Table of Contents
Version v1.0.0 of the SDK has been released and includes breaking changes - see what's changed in the migration guide.
- You need an IBM Cloud account.
The client library is provided as ABAP Git Repository. Proceed as follows to clone the ABAP SDK code to your SAP system.
- Install abapGit, using the abapGit Docs
- Use abapGit to clone the ABAP SDK Git repository into your SAP system.
- Assign the ABAP SDK to the package
ZIBMCwhen performing setup of the abapGit repository.
The following SAP profile parameter settings are recommended.
icm/HTTPS/client_sni_enabled = TRUE
ssl/ciphersuites = 135:PFS:HIGH::EC_P256:EC_HIGH
ssl/client_ciphersuites = 150:PFS:HIGH::EC_P256:EC_HIGH
wdisp/ssl_ignore_host_mismatch = TRUE
The client library respects the ABAP proxy settings. If you are using a central proxy server that is not already configured in your SAP system, proceed as follows.
- Logon to the SAP system and call transaction SICF.
- Click Execute (or press F8).
- Select menu item Client → Proxy Settings.
- On tab Global Settings: Select Proxy Setting is Active and No Proxy Setting for Local Server.
- On tabs HTTP Log and HTTPS Log specify the proxy Host Name and Port. If the proxy server requires logon credentials, also specify User Name and Password.
- Click Execute (F8) and OK.
Communication between SAP and the IBM Cloud is secured by the Transport Layer Security (TLS) protocol, also known as Secure Sockets Layer (SSL). SSL requires certificates that must be stored on the SAP application server in the Personal Security Environment (PSE). Transaction STRUST is used to maintain the PSE.
If a call to an IBM Cloud service failed due to a missing SSL certificate, check the ICM trace file to find the required certificate. To do so, call transaction SMICM and select menu item Goto → Trace File → Display End. Alternatively, call transaction AL11 and navigate to file DIR_HOME/dev_icm. Find last entry in trace file that indicates error SSSLERR_PEER_CERT_UNTRUSTED, as shown in the example below.
[Thr nn] Peer not trusted
[Thr nn] Certificate:
[Thr nn] Certificate:
[Thr nn] Subject: CN=*.watsonplatform.net, O=INTERNATIONAL BUSINESS MACHINES CORPORATION, L=Armonk, SP=New York, C=US
[Thr nn] Issuer: CN=GeoTrust RSA CA 2018, OU=www.digicert.com, O=DigiCert Inc, C=US
[Thr nn] Serial Number: 05:1C:46:1B:6E:C2:29:48:BD:F0:03:B3:A6:87:1A:5B
[Thr nn] Verification result:
[...]
[Thr nn] SignerCert:
[Thr nn] Certificate:
[Thr nn] Subject: CN=GeoTrust RSA CA 2018, OU=www.digicert.com, O=DigiCert Inc, C=US
[Thr nn] Issuer: CN=DigiCert Global Root CA, OU=www.digicert.com, O=DigiCert Inc, C=US
[Thr nn] Serial Number: 05:46:FE:18:23:F7:E1:94:1D:A3:9F:CE:14:C4:61:73
[Thr nn] Verification result:
[...]
[Thr nn] SignerCert:
[Thr nn] Certificate:
[Thr nn] Subject: CN=DigiCert Global Root CA, OU=www.digicert.com, O=DigiCert Inc, C=US
[...]
[Thr nn] << ---------- End of Secu-SSL Errorstack ----------
[Thr nn] Target Hostname="stream.watsonplatform.net"
[Thr nn] SSL NI-hdl 463: local=9.152.20.145:56542 peer=169.48.115.62:443
[Thr nn] <<- ERROR: SapSSLSessionStartNB(sssl_hdl=3fef0000c70)==SSSLERR_PEER_CERT_UNTRUSTED
[Thr nn] *** ERROR => SSL handshake with stream.watsonplatform.net:443 failed: SSSLERR_PEER_CERT_UNTRUSTED (-102)
[Thr nn] The peer's X.509 Certificate (chain) is untrusted
The SSL error stack shows the SSL certificate chain, which in the example above looks like follows:
| Certificate Authority Type | Certificate Authority (CA) |
|---|---|
| end-user | *.watsonplatform.net |
| intermediate | GeoTrust RSA CA 2018 |
| root | DigiCert Global Root CA |
You can install any of these SSL certificates. However, it is recommended to install the root CA certificate.
Download the appropriate SSL certificate from the provider's website, for example https://www.digicert.com/digicert-root-certificates.htm. Store the certificate file on your computer.
Proceed as follows to add the downloaded SSL certificate to your SAP system's Standard SSL Client PSE.
- Logon to the SAP system and call transaction STRUST.
- Switch to edit mode (press according tool bar icon).
- If a local PSE file does not exist already, create it by right-clicking on
SSL client SSL Client (Standard)and selecting Create from context menu. Keep all default settings in next popup dialog. - In Certificate section, click Import (alternatively select menu item Certificate → Import). Choose the certificate file that you have downloaded and import the certificate.
- Click button Add to Certificate List.
- Click Save (F3).
It is recommended to restart the ICM after a new SSL certificate has been applied to the PSE. To do so, proceed as follows.
- Logon to the SAP system and call transaction SMICM.
- Select menu item Administration → ICM → Restart → Yes.
Before you can access a specific service from your SAP system, you must create a service instance in the IBM Cloud and obtain credentials. The credentials can be shared among multiple end users of the SAP system, but you must ensure that the selected plan is sufficient to support the expected number of calls or the expected data volume. Please note that some plans may have restrictions on the allowed methods, so make sure to select the right plan for your purpose.
All currently supported services support IAM authentication (see below). Service credentials consist of an API Key and a URL. Both the API Key and the URL are character values that can be viewed through the IBM Cloud dashboard and need to be provided as parameters i_apikey and i_url to method zcl_ibmc_service_ext=>get_instance.
You can store the values with your application, but it is suggested to do that in an encrypted format. Using cloud services usually creates costs based on usage for the owner of the service instance, and anyone with the credentials can use the service instance at the owner's expenses. If you want to distribute the costs over multiple cost centers, you need to create a service instance and provide service credentials for each cost center separately.
Service credentials and other parameters that must be specified at Watson service wrapper ABAP class instantiation can also be provided in table ZIBMC_CONFIG. This table has three keys:
| Table Key | Description |
|---|---|
| SERVICE | The ABAP class name without prefix ZCL_IBMC_ |
| INSTANCE_UID | ID chosen by application developer that must be provided by application as parameter to method zcl_ibmc_service_ext=>get_instance() |
| PARAM | The parameter name |
List of configuration parameters in table ZIBMC_CONFIG
| Parameter Name | Default Value | Description |
|---|---|---|
| URL | service-dependent | Watson service url |
| APIKEY | Watson service API keys | |
| PROXY_HOST | Proxy server | |
| PROXY_PORT | Proxy server port | |
| AUTH_NAME | service-dependent | Authorization, IAM or basicAuth |
| SSL_ID | CLIENT | SSL Identity, defines PSE for SSL certificates: CLIENT or ANONYM |
Identity and Access Management (IAM) is a bearer-token based authentication method. Token management is either performed by the ABAP SDK or must be implemented by the SDK user.
If a value for apikey is provided by the caller in method zcl_ibmc_service_ext=>get_instance(), the ABAP SDK generates a bearer-token under the cover when needed and refreshes it when it is about to expire.
If apikey is not provided for method zcl_ibmc_service_ext=>get_instance(), the ABAP SDK user must implement an individual token management. Before a service method is called the first time, a valid bearer-token must be provided to the Watson service wrapper ABAP class instance as follows:
lo_service_class->set_bearer_token( i_bearer_token = '...' ).Afterwards, service methods can be called as long as the provided token is valid. When the token has expired, the method above must be called again with a new (refreshed) bearer-token as parameter.
The client library is delivered as package ZIBMC. Once the Git Repository has been cloned to the SAP system, a Watson service instance is wrapped by an ABAP class instance.
The following Watson services are currently supported:
| Service | ABAP Class Name |
|---|---|
| Compare and Comply | ZCL_IBMC_COMPARE_COMPLY_V1 (*) |
| Discovery | ZCL_IBMC_DISCOVERY_V1 |
| Language Translator | ZCL_IBMC_LANG_TRANSLATOR_V3 |
| Natural Language Classifier | ZCL_IBMC_NAT_LANG_CLASS_V1 |
| Natural Language Understanding | ZCL_IBMC_NAT_LANG_UNDRSTND_V1 |
| Personality Insights | ZCL_IBMC_PERSONAL_INSIGHTS_V3 (*) |
| Speech to Text | ZCL_IBMC_SPEECH_TO_TEXT_V1 |
| Text to Speech | ZCL_IBMC_TEXT_TO_SPEECH_V1 |
| Tone Analyzer | ZCL_IBMC_TONE_ANALYZER_V3 |
| Visual Recognition | ZCL_IBMC_VISUAL_RECOGNITION_V3 (*) |
| ZCL_IBMC_VISUAL_RECOGNITION_V4 (*) | |
| Watson Assistant | ZCL_IBMC_ASSISTANT_V1 |
| ZCL_IBMC_ASSISTANT_V2 |
(*) Deprecated service; will be discontinued in the future.
Using the client library requires two steps:
- Create an instance of the Watson service wrapper ABAP class by calling method
zcl_ibmc_service_ext=>get_instance.
data:
lo_service_class type <ABAP Class Name>.
zcl_ibmc_service_ext=>get_instance(
exporting
i_url = <url>
i_apikey = <api key>
...
importing
eo_instance = lo_service_class ).- Call the Watson service API endpoint by invoking the corresponding class method.
try.
lo_service_class->method(
exporting
is_input = ...
importing
es_output = ... ).
catch zcx_ibmc_service_exception into data(lo_service_exception).
...
endtry.Text to Speech Example
* List all voices provided by Watson Text to Speech
" declare variables
data:
lv_apikey type string value '...',
lo_text_to_speech type ref to zcl_ibmc_text_to_speech_v1,
lo_service_exception type ref to zcx_ibmc_service_exception,
ls_voice type zcl_ibmc_text_to_speech=>t_voice,
lt_voices type zcl_ibmc_text_to_speech=>t_voices.
" get Watson Text-to-Speech service instance
zcl_ibmc_service_ext=>get_instance(
exporting
i_url = 'https://api.kr-seo.text-to-speech.watson.cloud.ibm.com/instances/<uuid>'
i_apikey = lv_apikey
importing
eo_instance = lo_text_to_speech ).
" call Watson Text-to-Speech service to retrieve available voices
try.
lo_text_to_speech->list_voices(
importing
e_response = lt_voices ).
catch zcx_ibmc_service_exception into lo_service_exception.
message lo_service_exception type 'E'.
endtry.
" evaluate voices
loop at lt_voices-voices into ls_voice.
...
endloop.Natural Language Understanding Example
* Analyze www.ibm.com using Watson Natural Language Understanding
" declare variables
data:
lv_apikey type string value '...',
lo_instance type ref to zcl_ibmc_nat_lang_undrstnd_v1,
lo_service_exception type ref to zcx_ibmc_service_exception,
ls_parameter type zcl_ibmc_nat_lang_undrstnd_v1=>t_parameters,
ls_analysis_results type zcl_ibmc_nat_lang_undrstnd_v1=>t_analysis_results.
" get Watson Natural Language Understanding service instance
zcl_ibmc_service_ext=>get_instance(
exporting
i_url = 'https://api.eu-de.natural-language-understanding.watson.cloud.ibm.com/instances/<uuid>'
i_apikey = lv_apikey
i_version = '2019-07-12'
importing
eo_instance = lo_instance ).
" set the input parameters
ls_parameters-url = 'www.ibm.com'.
ls_parameters-return_analyzed_text = zcl_ibmc_service=>c_boolean_true.
ls_parameters-features-entities-emotion = zcl_ibmc_service=>c_boolean_true.
ls_parameters-features-entities-sentiment = zcl_ibmc_service=>c_boolean_true.
ls_parameters-features-keywords-emotion = zcl_ibmc_service=>c_boolean_true.
ls_parameters-features-keywords-sentiment = zcl_ibmc_service=>c_boolean_true.
" call Watson Natural Language Understanding service to analyze URL www.ibm.com
try.
lo_instance->analyze(
exporting
i_parameters = ls_parameters
importing
e_response = ls_analysis_results ).
catch zcx_ibmc_service_exception into lo_service_exception.
message lo_service_exception type 'E'.
endtry.
" retreive analysis results from ls_analysis_results
Language Translator Example
* Translate text from English to German using Watson Language Translator
" declare variables
data:
lv_apikey type string value '...',
lo_lang_translator type ref to zcl_ibmc_lang_translator_v3,
lo_service_exception type ref to zcx_ibmc_service_exception,
ls_request type zcl_ibmc_lang_translator_v3=>t_translate_request,
lv_text type string,
ls_trans type zcl_ibmc_lang_translator_v3=>t_translation_result.
" get Watson Language Translator service instance
zcl_ibmc_service_ext=>get_instance(
exporting
i_url = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/<uuid>'
i_apikey = lv_apikey
i_version = '2018-05-01'
importing
eo_instance = lo_lang_translator ).
" store text to be translated into ls_request and set the languages
lv_text = 'Welcome'.
append lv_text to ls_request-text.
ls_request-model_id = 'en-de'.
ls_request-source = 'EN'.
ls_request-target = 'DE'.
" call Watson Language Translator service to translate the text in ls_request
try.
lo_lang_translator->translate(
exporting
i_request = ls_request
i_contenttype = 'application/json'
i_accept = 'application/json'
importing
e_response = ls_trans ).
catch zcx_ibmc_service_exception into lo_service_exception.
message lo_service_exception type 'E'.
endtry.
" retreive translation results from ls_trans
GitHub Pages contain the ABAP Client Library for Watson API Reference.
The ABAP SDK is a Community SDK for IBM Watson, created by the IBM Watson development community and SAP's ABAP development community - written by ABAPers from IBM Cloud, IBM Services and IBM Systems. Therefore as a community release it is not updated with the same schedule as IBM-supported SDKs, and does not include support by IBM. For more information on IBM-supported SDKs and the update policy, please see https://cloud.ibm.com/docs/watson?topic=watson-using-sdks
If you have questions about the IBM Watson services or are having difficulties using the APIs, please ask a question at IBM Support Forums or Stack Overflow.
This library is licensed under the Apache 2.0 license.
- Christian Bartels
- Joachim Rese
- Jochen Röhrig
- Aleksandar Debelic
- Bradley Knapp (Sponsor)
- Devraj Bardhan (Sponsor)
- Sean Freeman (Sponsor)
In addition, we would like to thank the abapGit contributors and the SAP Mentors of this team.