OSM Worldwide - File Feeds Setup Guide

Overview

This guide outlines the process to onboard OSM WorldWide with Narvar via file feed setup. 

Details needed

  • Account Alias — An identifier for the merchant to identify the OSM WorldWide integration in future.
  • Sftp Folder Path — A path where OSM WorldWide will upload the data. OSM WorldWide provides this path.
  • Sftp Host — The hostname or IP address of the SFTP server where files will be uploaded. 
  • Sftp Username — The username used to authenticate and access the SFTP server.
  • Sftp Password — The password associated with the SFTP username for authentication.
  • Sftp Port — The port number used for the SFTP connection. 

Steps to be completed

Merchant Actions 
  • Contact the OSM Worldwide POC with the sample format attached and request the SFTP details for file feed setup. Share the public key (generation steps are included below) with the carrier so they can provide:
    • SFTP Host
    • SFTP Folder Path
    • SFTP Username
    • SFTP Password
    • SFTP Port
  • After you receive the SFTP details, follow the steps in “Narvar Setup Steps” to complete setup in Narvar Hub.
  • After setup is complete, copy and save the SFTP details for future reference. 

    • Steps to setup file feeds - 
      • OSM WorldWide requires RSA key-based authentication for SFTP connections instead of traditional username and password. Generate the SSH RSA key pair manually.
      • Follow the instructions below to generate an RSA key pair and share the required information with the carrier for SFTP configuration.
        • Complete these steps using a command-line terminal:
          • Mac or Linux: Use the default Terminal
          • Windows: Use Git Bash or WSL (Windows Subsystem for Linux)
        • Open your terminal:
          • Mac: Applications → Utilities → Terminal
          • Linux: Launch Terminal from applications
          • Windows: Open Git Bash or WSL terminal
        • Create a directory to store your key pair: mkdir <retailer_name> Example: mkdir asda
        • Navigate into the directory: cd <retailer_name> && pwd (This prints the path where your keys will be saved.)
        • Generate the RSA key pair: ssh-keygen -t rsa -m PEM
        • When prompted, enter the file path to save the key inside the directory you created, for example: /path/to/<retailer_name>/id_rsa
        • Press Enter twice to leave the passphrase empty.
        • After completion, confirm these files were created:
          • id_rsa (private key)
          • id_rsa.pub (public key)
        • Verify the keys:
          • cat id_rsa
          • cat id_rsa.pub
        • Share the public key with the carrier:
          • Public Key (id_rsa.pub without any trailing email/comment)
        • After the carrier confirms SFTP configuration is complete, use the Base64-encoded version of the private key as the password during the Narvar setup process. Use a Base64 encoder tool to generate the encoded value.

          Important: Do not modify the key before encoding or after generating the encoded version.

    Sample Format - samplefile_osmworldwide

Carrier Actions
  • Enable the Tracking Feed.
  • Start sending the tracking data files to the SFTP location provided. Narvar consumes these files to support Track & Notify features.
Narvar Setup Steps

This illustrates the process with an example. Follow the steps below to add carrier integrations. Use the link above to access the specific carrier setup guide.

  • Log in to Narvar Hub and navigate to the Menu > Carrier > Carrier Integration.

  • Click Add Carrier in the top right corner.

  • Choose the carrier to add from the Carrier List drop-down. 

  • If you can’t find your carrier in the search/dropdown, click the “can’t find your carrier? Contact us” CTA.

  • Fill the form. The Narvar team contacts you.

  • Once you find your carrier, select FileFeed from the Select Source Type list and click Next

  • Enter the required SFTP details, including Account Alias, SFTP folder path, SFTP host, SFTP username, SFTP password, and SFTP port.

  • If the account alias already exists for OSM WorldWide, a message appears. Use a different alias.

  • If the entered SFTP details are correct, clicking TEST shows a “Validation successful” message.

  • If the entered SFTP details are incorrect, clicking TEST shows a “Validation Failure” message. Confirm the details with OSM WorldWide. If the details are correct, contact your Narvar representative.

  • After testing is complete, click Finish. A pop-up appears with the SFTP details. Copy them for future reference.

  • After closing the pop-up, you will be redirected to the Carrier Integrations page, where OSM WorldWide appears as an integrated carrier. 

Edit/Update Flow

If details change (account alias or any other SFTP details), follow the steps below.

  • Log in to Narvar Hub and navigate to Menu > Carrier > Carrier Integrations 
  • Find the carrier integration that needs to be updated and click the Edit icon.

  • Update the account alias or the SFTP details. 
  • Test and validate.

  • On successful validation, a successful validation message appears. Click Update.
  • View and copy the details for future reference.

      

  • You will be redirected to the Carrier Integrations page, where the updated OSM WorldWide appears with the latest timestamp.

Checklist for Retailers

☑ Details as required above are ready
☑ Entered correctly in Narvar UI
☑ Validated and successful message seen
☑ View and copy SFTP details for future reference. 

 
 

Comments

0 comments

Please sign in to leave a comment.