Order Lookup - Message Transformer Installation

Owned by Dennis Navarro
Last updated: Oct 13, 2024 by Katie Price
3 min read

Order Lookup requires implementation from the solutions team to enable/customize the app functionality. Below are the steps to install the file collection service on a local device/server. 

Overview

The Message Transformer Windows Service is the client service that will run on the customer premise/infrastructure to read the files and load them into our middle-ware for review & transformation. It is best to install this service in on a device that will have access to these files.

Before proceeding with the below procedure please ensure you have met the Order Lookup - Technical Requirements

Installation Procedure

Pre-requisites

If you are not using the standard OneFlo format please contact your account manager

Set up the order file pick up location

Create the file location where the order files will be sent for Order Lookup to pick up the files from. efm will configure the service to collect these files. Once the location is set, please provide the location to your efm contact.

  • It is up to you where the files are placed but this location needs to be communicated with EFM.

  • Ideally please provide efm with the full UNC path of the files.

Example: 

C:\Users\Despatch\Documents\Oneflo\Order_lookup\

Adding an archive file location

Create a Sub-folder titled "Archive"

Installing the service will create this for you, if you haven’t set it up before hand

Example: 

C:\Users\Despatch\Documents\Oneflo\Order_lookup\Archive\

Please move any files created prior to today's date to archive

 

Before installing

  • Ensure this is on a machine or Server that is always running. 

  • Prepare your Windows Service User (or a user with a password that will not expire)

  • Your user should have full read/write/delete access to the provided directory. This is needed as the Service will move the files into an "Archive" sub-directory once processed.

  • Ensure you are running the latest version of  Microsoft .NET

Step 1: Download the installer

Download the installer by clicking here:

Step 2: Run the installer

Find the installer file. This can usually be found in the Downloads folder on your PC if it does not show in the web browser.

You will need to set the installation folder. Ensure this is on a machine or server that is always running

Step 3: Set the Message Transmitter Credentials

This step will ask you for the Client Id and Token. This is provided to you by efm.

  • ClientID: <client_id>

  • Client Token: <client_token>

Step 4: Confirm the service has been set up correctly

Access the directory of your files to confirm they have been migrated to the "Archive Folder"

Once the service has been installed, it will show up in the Services console under the name Message Transformer and is started automatically.

Troubleshooting: If the service has been installed correctly and is running, the permissions might need to be updated to allow the service to read the files in the folder.