Configuring Web Services

Objective

After completing this lesson, you will be able to identify how and when to use Web Services to set up a simple object access protocol integration.

Web Services

The third type of integration is the Web Service.

Web Services connections allow the integrated systems to call directly to each other using the common Hypertext Transfer Protocol Secure, recognizable as the "HTTPS" that precedes most website URLs.

Unlike SFTP, Web Services is a communication protocol, not a connector protocol. It uses Secure Sockets Layer (SSL) to establish an encrypted link between the web server and a web browser, which eliminates the need for an SFTP server.

With Web Services, the client or a designated third party controls the integration schedule, and the connector is specified whenever a connection is established.

Web Services Connections

Web Services connections work in the following manner:

  1. The client/supplier system "calls" the SAP Fieldglass Web Service to trigger the respective connector.
  2. For an upload request, the call sends formatted data to SAP Fieldglass. SAP Fieldglass responds with a message indicating either the success or failure of the upload. For a download request, the client's call indicates the connector you want to trigger, and then SAP Fieldglass sends that data back to the client/supplier system. The client system extracts and processes the data.
Image illustrating how SAP Fieldglass sends a connector back to upload data into the ERP system

Web Services Methods

But that’s a general example. The actual connection process depends on which of the two Web Services methods WorkingNet would use:

  • API, or
  • SOAP.

API

One type of Web Service integration is API.

An API is an Application Programming Interface, a customizable part of a server that receives requests and sends responses. Basically, it's an interface that allows specific types of data to be interpreted by other systems.

Transactions through API send in real-time on a per transaction basis, so it provides a more seamless integration experience than the other methods.

Image illustrating how an API acts as an intermediary for processing and sharing data between SAP Fieldglass and other ERP systems

An API requires two pieces of information to access an API application and process data: an application key and an active web service (username/password).

SOAP

The other type of Web Service integration is SOAP, or Simple Object Access Protocol. SOAP is an XML-based messaging protocol for exchanging the data that SAP Fieldglass uses for batch integrations.

Specifically, SOAP uses an XML protocol called Web Services Description Language, or WSDL. The WSDL is basically the format and ‘instructions’ for how to connect or integrate; it describes the specific web service as collections of network endpoints.

Basically, SOAP is the manner in which the systems will use the web to connect, and WSDL provides the instructions for how SAP Fieldglass will connect with the specific WorkingNet system.

Screenshot of the SOAP Edit Details in the Webservice Setup Process
1WSDL: The WSDL link for your environment is provided at the top of the setup Web Service page in the connector set up wizard along with a link to the web services technical documentation. https://<env_code>.fgvms.com/ws2/services/connectorn
2License Key: Selecting this tile presents a list of integration connectors that have been enabled, as well as tabs to access all available connectors that can be enabled and/or configured. This makes it easier to find and access the connector needed without having to search through all of the connectors.
3Username: For administrative purposes, a separate user account dedicated solely to Web Services should be created. For accurate auditing purposes, this should not be a real person’s account; it should only be used as a credential for Web Services connections.

Set Up a SOAP Web Service

Setting up a Web Services integration occurs in the Connectivity step of the Connector Setup Wizard.

Starting from that point, here’s how you’d create a new Web Services integration for the Active Worker Single Line Download connector for WorkingNet.

ExerciseStart Exercise

Summary

  • Web Services Overview: Web Services enable direct system integration using HTTPS, establishing encrypted links without needing an SFTP server.
  • API Integration: APIs provide real-time data transactions and they require two pieces of information to access an API application and process data: an application key and an active web service (username/password).
  • SOAP Integration: SOAP uses XML-based protocols like WSDL for batch data exchanges, providing detailed instructions for system connections.
  • SOAP Setup: Setting up a SOAP Web Service requires a dedicated user account, WSDL link, and license key, performed via the Connector Setup Wizard.

Learning

SAP FacebookSAP YoutubeSAP LinkedIn