Configuring and Testing SFTP

Objective

After completing this lesson, you will be able to create, edit, and view a connector end point for SFTP integrations and SFTP subscriptions.

SFTP

With SFTP, SAP Fieldglass sends or receives the file to/from the customer's file server, connecting with exchanged credentials, to a specified folder location with a given name on a schedule, called a subscription.

There are three components for SFTP transferred integrations:

  1. the Connector itself (the code to extract or populate the specified data),
  2. the End Point (the server location, access credentials, and file details), and
  3. the Subscription (connecting the connector and end point while also scheduling the job).
Image showing how SFTP moves a connector to a subscription to an end point before going into the other ERP system.

Creating, Viewing, and Editing Connector End Points

SFTP integrations utilize what are called End Points. End points define the properties of the server that SAP Fieldglass will communicate with to complete the SFTP integration.

End Points must be set up for each connector file to be retrieved or placed on the SFTP server. Setting up an End Point defines the server, its access and authentication credentials, the specific port used to access the server, file location, and file name, as well as any encoding.

Image showing the position of the End Point between the connector/subscription and the other ERP system.

Create a Connector End Point

Here's how you would create a connector End Point for an SFTP integration with WorkingNet.

Viewing a Connector End Point

Once you have set up your end point, you are able to view and maintain end points via the End Points tile.

From here you can view the details of all connector end points set up for the company, as well as edit, copy, deactivate, and remove the end point.

Integration End Point List View.
( 1 ) End Point List
In the End Point List, you can sort by active, inactive, or all End Points, or by the End Point ID. Here, the WRKT_PUT_Security_Worker_Download is selected.
Integration End Point Details Page with Modification Log highlighted.
( 2 ) Details Tab
On the Details tab the SFTP Setup will be displayed on this page. You are able to see the Username, host, and port to which the SFTP is configured, as well as the script and any additional settings.
An Integration End Point Modification Log with Edit button highlighted.
( 3 ) Modification Log
The Modification Log tab shows the details of when an end point was created, modified, enabled, or disabled. You can also edit, copy, remove, or activate/deactivate the End Point by clicking the appropriate button at the top right of the page.
Integration End Point Edit Page with highlights on Basic and SFTP Setup areas.
( 4 ) Basic Setup Information
The Basic Setup information -the ID, Category, and Activity - cannot be changed. If any of these details must be changed, you'll need to create a new endpoint.
( 5 ) Setup
You can only make changes to SFTP Setup itself, such as the Host, Port, Authentication Type, and additional details like encoding and the Time Zone.

Subscriptions

A subscription is the SAP Fieldglass service that triggers data transfer on a predefined schedule.

The subscription sends or retrieves a connector to or from a specified location—such as WorkingNet’s servers—and links the connector with the end point, acting as the conduit for an SFTP transferred integration.

Create a New Subscription

Setting up a an SFTP subscription occurs in the Connectivity step in the Connector Setup Wizard.

Starting from that point, here's how you'd create a new subscription to integrate the Active Worker Single Line Download connector for WorkingNet.

Test and Maintain an SFTP Integration

Here's how to test the subscription and end point.

Please note that the connector, end point, and subscription must be enabled before you can test.

Summary

SFTP integrations in SAP Fieldglass enable automated file transfers between SAP Fieldglass and customer file servers through three key components: connectors, end points, and subscriptions.

Key Points:

  • End Points define server connection properties including the SFTP server location, authentication credentials (username/password or public key), port number (default 22), directory path, file name, and optional settings like encoding and time zones.
  • Subscriptions act as schedulers that trigger automated data transfers on predefined schedules, linking connectors with end points and specifying delivery timing (minute, hour, date, month, day) and notification settings.
  • Creating end points requires immutable basic setup where the ID, category, and activity cannot be changed after creation, though SFTP setup details like host, port, and authentication can be modified later.
  • Testing integrations involves three steps: enabling the connector, end point, and subscription, then using the "Run Now" feature to execute the subscription and verifying results through the Integration Audit Trail or Monitor Activity tile.
  • Best practices for scheduling subscriptions include aligning with business processes, avoiding weekend runs due to maintenance windows, minimizing subscription frequency for easier auditing, and allowing sufficient processing time for large data sets.