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:

Image illustrating how SAP Fieldglass sends a connector back to upload data into the ERP system.
  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.

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:

  1. API, or
  2. SOAP.

API

The second 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 an API are sent in real-time on a per transaction basis, so it provides a more seamless integration experience than the other methods.

Because of the complexity of API-based integrations, setup is not a function available within Configuration Manager.

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

SOAP

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.

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.

SOAP Edit Details in the Webservice Setup Process
( 1 ) WSDL
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)
( 2 ) License Key
The password used on the web service request. To Set up a SOAP Web Service transferred integration, you have to have at least one Web Service license set up per buyer tenant.
( 3 ) Username
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 in 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.

Summary

Web services integrations enable direct system-to-system communication using HTTPS protocol, eliminating the need for SFTP servers by establishing encrypted SSL connections between web servers and browsers where the client controls the integration schedule.

Key Points:

  • Two primary web services methods: API (Application Programming Interface) provides real-time, per-transaction integration with customizable server interfaces, while SOAP (Simple Object Access Protocol) uses XML-based messaging for batch integrations
  • SOAP configuration requirements: Setup requires a WSDL link that provides connection instructions, a license key for authentication, and a dedicated non-personal user account for web services credentials
  • Web services connection process: The client/supplier system calls the SAP Fieldglass web service to trigger connectors, either uploading formatted data to SAP Fieldglass or requesting downloads that SAP Fieldglass sends back to the client system
  • Key advantage over SFTP: Web services uses HTTPS communication protocol with SSL encryption, allowing direct system calls without requiring an intermediary SFTP server, and gives clients control over when connections are established
  • WSDL (Web Services Description Language): Provides the XML protocol format and instructions that describe how SAP Fieldglass will connect with specific client systems as collections of network endpoints