MacroPoint

MacroPoint is a global freight visibility platform for shippers, brokers and 3PLs to get real-time visibility on the freight they have given to 3rd party carriers. MacroPoint provides GPS/Cell-based tracking of loads via the driver’s (smart) phone or in-cab ELD.

The Revenova TMS integration with MacroPoint contains two main features. The first is Carrier load tracking where updates are sent from MacroPoint and received in the TMS. The second feature provides Customer-specific load tracking information from the TMS to MacroPoint.

Inbound calls from MacroPoint for load status updates are processed by Platform Events.

Setup

Enter Credentials

Enable the MacroPoint integration by completing the following steps. 

1. Navigating to TMS Admin.

2. Select Credentials. 

3. Select the Global Services tab.

4. Find MacroPoint in the list and open the card. 

5. Check the Enabled, Send Updates, and Receive Updates boxes as needed.

6. Enter the User ID, Password 1, and Customer Number into the text fields. 

7. Click the Save button when finished.

The user ID and password to access the MacroPoint website are not valid for API connections.

Valid credentials are required from a MacroPoint subscription. MacroPoint provides the User ID, Password, and Customer Number. See examples in the table below.

Inbound Packet IP Ranges: Any load status post-backs from MacroPoint that do not originate from this IP mask are rejected as a security feature. Any changes to this range are provided by Revenova.

MacroPoint Website Settings

Upgrading from previous versions of the TMS may have outdated information. Check that the Remote Site Settings for the MacroPoint integration URL are up to date.

1. Click the Setup Gear icon in the top right corner.

2. From the drop-down, click Setup.

3. In the Quick Find Toolbar type Sites and click the link.

4. From the list of sites, copy the API Community URL.

5. Add the following extension to the end of the URL to match the example below: /services/apexrest/rtms/tmslistener

6. This URL will be pasted into the MacroPoint website.

Navigate to the MacroPoint website and log in.

1. Click the Update Company Preferences link.

2. Find the section labeled Please enter appropriate URLs: 

3. Paste the API Community URL into the necessary fields:

   • Location Updates

   • Order Status Changes

   • Trip Event Updates

   • Schedule Alerts

4. Save the changes.

The URL does not need to be entered into all of the MacroPoint fields. Only those that are applicable.

{API Community URL}/services/apexrest/rtms/tmslistener

Example: https://revenova.my.site.com/api/services/apexrest/rtms/tmslistener

The Salesforce-generated API Community URL is case sensitive.

Example Screenshot of URL added to MacroPoint:

Remote Site Settings

If upgrading from a previous release of the TMS, check that the Remote Site Settings for the MacroPoint integration URL are current.

1. Click the Setup gear icon in the top right corner.

2. From the drop-down, click Setup.

3. In the Quick Find Toolbar type Remote Site Settings and click the link.

4. From the list of remote sites find MacroPoint and click the Edit link.

5. Update the Remote Site URL to match the Service URL below: 

Service URL: https://macropoint-lite.com/api/1.0

Test Service URL: https://macropoint-lite.com/api/1.0

TMS Admin

Configuration

Tracking Update frequency (Minutes): The number of minutes between inbound load location updates from MacroPoint. The TMS does not process load location updates less than the entered value since the last load location update.

Use Platform Events For: Confirm the check box for MacroPoint is Checked.

Transportation Profile

The following fields are located in 2 places in the TMS. The first location is on the customer Transportation Profile record. The second location is on the Carrier Banner Lightning Web Component from the Load Tracking Administration LWC. Set the default values on the customer Transportation Profile or add to each load in the Load Tracking Administration LWC.

Tracking Notes: Custom notes that are sent with load tracking information. These notes display in the MacroPoint website UI in the Control Tower view and in notification emails.

Tracking Update Email List: Assign multiple email addresses to receive tracking notifications for a load. 

It is possible to set a default Tracking Provider for each Carrier on their Transportation Profile.

Tracking Provider: The default selection in the Load Tracking Admin LWC of tracking information for a load. 

Tracking Update Interval: Set the default amount of time between tracking updates. Values provided in the drop-down range from 15 minutes to 12 hours.

Tracking Duration: Set the default amount of time to track a load with MacroPoint. Values provided in the drop-down range from 1 hour to 7 days.

The MacroPoint integration supports multiple stops for the same Account location.

MacroPoint ELD Tracking (optional)

To use MacroPoint ELD tracking, a spreadsheet with Carrier information must be sent to MacroPoint with the following data: 

• Carrier Name

• Carrier Id (18-character Account Id – use CASESAFEID formula field to get this value)

• Carrier DOT

• Carrier MC Number

• Carrier NSC Number (Canada)

• Carrier CAAT (Mexico)

MacroPoint Shipper Method (optional)

Tracking sessions may be started with MacroPoint without a Tractor Number, Container/Trailer Number, or Driver Phone number. Carriers must be partnered on the MacroPoint website to enable this feature. If a Carrier is not partnered, an error displays when beginning a tracking session. Enter a Tractor Number, Container/Trailer Number, or Driver Phone number to begin the tracking session.

Carrier Load Tracking

Carrier load tracking is initiated on the Carrier Banner LWC. Click the antenna button to open the Load Tracking Administration LWC to begin tracking the load. 

Start and stop a tracking session by clicking the On and Off buttons. Active tracking sessions may be updated by changing load or Carrier tracking information and then click Update Tracking. See the table below for acceptable changes.

Load Field Set TMS35, Transportation Profile TMS7, and Transportation Profile TMS8 can be adjusted to display additional fields in the Load Tracking Administration modal. See the Field Set Summary for more information.

Start Load Tracking

The start new load tracking call sends load, Carrier, and stop information to MacroPoint. The Tracking Notes and Tracking Update Email List fields are sent in this call. The Tracking Number field is returned. The Start Time field on the Load Tracking Administration modal defaults to the appointment time of the pickup stop.

Set the Timezone on each customer Account record. If a customer Account does not have a Timezone value, a 24 hour appointment window is sent to MacroPoint instead of the appointment time.

See the section above regarding partnered Carriers to start a load tracking session.

Sample Start Load Tracking XML Request Payload

<ns0:Order
	xmlns:ns0="http://macropoint-lite.com/xml/1.0">
	<ns0:TrackVia>
		<ns0:Number Type="Mobile">7203399862</ns0:Number>
	</ns0:TrackVia>
	<ns0:TrackStartDateTime>2024-03-13 00:00 CT</ns0:TrackStartDateTime>
	<ns0:Notifications>
		<ns0:Notification>
			<ns0:PartnerMPID>5313778</ns0:PartnerMPID>
			<ns0:IDNumber>L-2</ns0:IDNumber>
			<ns0:TrackDurationInHours>1</ns0:TrackDurationInHours>
			<ns0:TrackIntervalInMinutes>15</ns0:TrackIntervalInMinutes>
		</ns0:Notification>
	</ns0:Notifications>
	<ns0:Carrier>
		<ns0:Name>Email Carrier One</ns0:Name>
		<ns0:CarrierID>001Ox00000CnPRVIA3</ns0:CarrierID>
	</ns0:Carrier>
	<ns0:TripSheet>
		<ns0:StopSequencingRequired>True</ns0:StopSequencingRequired>
		<ns0:Stops>
			<ns0:Stop>
				<ns0:StopID>Stop 1</ns0:StopID>
				<ns0:SequenceNumber>1</ns0:SequenceNumber>
				<ns0:Name>Chicago Pizza</ns0:Name>
				<ns0:StopType>Pickup</ns0:StopType>
				<ns0:Address>
					<ns0:Line1>181 W. Madison St.</ns0:Line1>
					<ns0:City>Chicago</ns0:City>
					<ns0:StateOrProvince>IL</ns0:StateOrProvince>
					<ns0:PostalCode>60602</ns0:PostalCode>
				</ns0:Address>
				<ns0:StartDateTime>2024-03-13T09:00:00-0500</ns0:StartDateTime>
				<ns0:EndDateTime>2024-03-13T22:00:00-0500</ns0:EndDateTime>
			</ns0:Stop>
			<ns0:Stop>
				<ns0:StopID>Stop 2</ns0:StopID>
				<ns0:SequenceNumber>2</ns0:SequenceNumber>
				<ns0:Name>Los Angeles Lighting</ns0:Name>
				<ns0:StopType>DropOff</ns0:StopType>
				<ns0:Address>
					<ns0:Line1>2765 E Olympic Blvd</ns0:Line1>
					<ns0:City>Los Angeles</ns0:City>
					<ns0:StateOrProvince>CA</ns0:StateOrProvince>
					<ns0:PostalCode>90023</ns0:PostalCode>
				</ns0:Address>
				<ns0:StartDateTime>2024-03-13T11:00:00-0500</ns0:StartDateTime>
				<ns0:EndDateTime>2024-03-14T00:00:00-0500</ns0:EndDateTime>
			</ns0:Stop>
			<ns0:Stop>
				<ns0:StopID>Stop 3</ns0:StopID>
				<ns0:SequenceNumber>3</ns0:SequenceNumber>
				<ns0:Name>Chicago Blackhawks</ns0:Name>
				<ns0:StopType>Pickup</ns0:StopType>
				<ns0:Address>
					<ns0:Line1>1901 W Madison St</ns0:Line1>
					<ns0:City>Chicago</ns0:City>
					<ns0:StateOrProvince>IL</ns0:StateOrProvince>
					<ns0:PostalCode>60612</ns0:PostalCode>
				</ns0:Address>
				<ns0:StartDateTime>2024-03-14T09:00:00-0500</ns0:StartDateTime>
				<ns0:EndDateTime>2024-03-14T22:00:00-0500</ns0:EndDateTime>
			</ns0:Stop>
			<ns0:Stop>
				<ns0:StopID>Stop 4</ns0:StopID>
				<ns0:SequenceNumber>4</ns0:SequenceNumber>
				<ns0:Name>Los Angeles Lighting</ns0:Name>
				<ns0:StopType>DropOff</ns0:StopType>
				<ns0:Address>
					<ns0:Line1>2765 E Olympic Blvd</ns0:Line1>
					<ns0:City>Los Angeles</ns0:City>
					<ns0:StateOrProvince>CA</ns0:StateOrProvince>
					<ns0:PostalCode>90023</ns0:PostalCode>
				</ns0:Address>
				<ns0:StartDateTime>2024-03-14T11:00:00-0500</ns0:StartDateTime>
				<ns0:EndDateTime>2024-03-15T00:00:00-0500</ns0:EndDateTime>
			</ns0:Stop>
		</ns0:Stops>
	</ns0:TripSheet>
	<ns0:EmailCopiesOfUpdatesTo>test@revenova.com, dev@revenova.com</ns0:EmailCopiesOfUpdatesTo>
	<ns0:Notes>Default tracking notes for Chicago Pizza</ns0:Notes>
</ns0:Order>

Sample XML Start Load Tracking XML Response Payload

<OrderResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Status>Success</Status>
    <OrderID>FB93D3FE546749F5A3385D1E2961A12B</OrderID>
    <TrackingRequestID>A04EE941BEC446419749D8433885C654</TrackingRequestID>
    <Errors/>
</OrderResult>

TMS Field Updates

See MacroPoint Create Order documentation here.

Update Load Tracking

The update tracking call sends new load and stop information to MacroPoint. The Tracking Notes and Tracking Update Email List fields may be updated and sent in this call. See the tables below for acceptable and unacceptable field changes.

During an active tracking session there are a limited number of load fields that may be changed.

When fields require changing from the Unacceptable table below, stop the current tracking session. Make any necessary changes in the TMS, and begin a new tracking session.

Click the Update Tracking button to send the API call with the new tracking information.

Acceptable Changes

Unacceptable Changes

Sample Update Load Tracking Request Payload

<Order xmlns="http://macropoint-lite.com/xml/1.0" >
    <TrackVia>
        <Number Type="Mobile">{CellNumber}</Number>
        <Number Type="VehicleID">{VehicleNumber}</Number>
        <Number Type="TrailerID">{TrailerNumber}</Number>
    </TrackVia>
    <TrackStartDateTime>2022-12-01T12:00Z</TrackStartDateTime>
    <Notifications>
        <Notification>
            <PartnerMPID>{MPID}</PartnerMPID>
            <IDNumber>{UniqueShipmentID}</IDNumber>
            <TrackDurationInHours>{TrackDurationInHours}</TrackDurationInHours>
            <TrackIntervalInMinutes>{TrackIntervalInMinutes}</TrackIntervalInMinutes>
    <Carrier>
        <Name>{Carrier Name}</Name>
        <CarrierID>{CarrierID}</CarrierID>
    </Carrier>
    <TripSheet>
        <Stops>
            <Stop>
                <Name>{StopName}</Name>
                <StopType>{StopType}</StopType>
                <Address>
                    <Line1>{Line1}</Line1>
                    <Line2>{Line2}</Line2>
                    <City>{City}</City>
                    <StateOrProvince>{StateOrProvince}</StateOrProvince>
                    <PostalCode>{PostalCode}</PostalCode>
                    <Country>{Country}</Country>
                </Address>
                <Latitude>{Latitude}</Latitude>
                <Longitude>{Longitude}</Longitude>
                <StartDateTime>2022-12-01T12:00Z</StartDateTime>
                <EndDateTime>2022-12-01T12:00Z</EndDateTime>
                <SequenceNumber>{SequenceNumber}</SequenceNumber>
                <StopID>{StopID}</StopID>
                <LastStopEventCompleted>{Arrived/Departed}</LastStopEventCompleted>
            </Stop>
            <Stop>
                <Name>{StopName}</Name>
                <StopType>{StopType}</StopType>
                <Address>
                    <Line1>{Line1}</Line1>
                    <Line2>{Line2}</Line2>
                    <City>{City}</City>
                    <StateOrProvince>{StateOrProvince}</StateOrProvince>
                    <PostalCode>{PostalCode}</PostalCode>
                    <Country>{Country}</Country>
                </Address>
            </Stop>
        </Stops>
    </TripSheet>
    <EmailCopiesOfUpdatesTo>{EmailCopiesOfUpdatesTo}</EmailCopiesOfUpdatesTo>
    <Notes>{OrderNotes}</Notes>
</Order>

No response payload is sent back from MacroPoint to this request.

TMS Field Updates

See MacroPoint Change Order documentation here.

Stop Load Tracking

The stop load tracking call sends a request to MacroPoint to end the current tracking session.

Sample XML End Tracking Session Request Payload

'https://macropoint-lite.com/api/1.0/orders/stoporder/7C915EA32EA349FCBDBCB3E2F0506D9'

No response payload is sent back from MacroPoint to this request.

TMS Field Updates

See MacroPoint Stop Order documentation here.

Load Updates from MacroPoint (PUSH into Revenova)

Update Load Location

The update load tracking call receives the latest location data from MacroPoint. 

Sample Curl Location Updates Callback Request Payload

'https://CustomerSpecifiedURL?MPOrderID={1}&ID={2}&Latitude={3}&Longitude={4}&Uncertainty={5}&Street1={6}&Street2={7}&Neighborhood={8}&City={9}&State={10}&Postal={11}&Country={12}&LocationDateTimeUTC={13}&ApproxLocationDateTimeInLocalTime={14}&DataSource={15}&MPTrackingRequestID={16}&Locator={17}'

TMS Field Updates

See MacroPoint Location Updates documentation here.

Update Order Status

The update order status call receives the latest load information from MacroPoint. 

Sample Curl Order Status Callback Request Payload

'https://CustomerSpecifiedURL?MPOrderID={1}&MPTrackingRequestID={2}&ID={3}&Code={4}&Message={5}'

TMS Field Updates

See MacroPoint Order Status documentation here.

Update Trip Events

The update trip events call receives the latest stop arrival/departure data from MacroPoint. 

Sample Curl Trip Events Callback Request Payload

'https://CustomerSpecifiedURL?MPOrderID={1}&TrackingRequestID={2}&ID={3}&Stop={4}&Event={5}&EventDateTime={6}&StopID={7}&ApproxLocationDateTimeInLocalTime={8}&Latitude={9}&Longitude={10}&Street1={11}&Street2={12}&Neighborhood={13}&City={14}&State={15}&Postal={16}&Country={17}&UpdatedBy={18}&UnLocode={19}'

TMS Field Updates

See MacroPoint Trip Events documentation here.

Update Load Schedule Alerts

The update load location call receives the latest load schedule alerts from MacroPoint.

Sample Curl Schedule Alerts Callback Request Payload

'https://CustomerSpecifiedURL?MPOrderID={1}&ID={2}&StopType={3}&StopID={4}&StopName={5}&AddressLine1={6}&City={7}&State={8}&PostalCode={9}&ScheduleAlertCode={10}&ScheduledStartTimeInLocalTimeForStop={11}&ScheduledEndTImeInLocalTimeForStop={12}&ScheduleAlertText={13}&DistanceToStopInMiles={14}&EtaToStop={15}&ETALocalTimeZoneOffset={16}&MPTrackingRequestID={17}'

TMS Field Updates

See MacroPoint Schedule Alerts documentation here.

Customer Load Tracking

The MacroPoint integration supports sending tracking updates from the TMS to MacroPoint. Two pieces of customer information data are required.

1. The MacroPoint Customer ID (MPID) specifies the customer that the data is for. 

2. The customer load ID specifies which load the data applies to.

Enter the MacroPoint Customer ID into the Tracking Customer ID field on the customer's Transportation Profile record. The Tracking Customer ID is a value provided by MacroPoint and is unique to the customer's MacroPoint account. This value represents the customer requesting visibility of the load and tracking updates.

The Tracking Number (Customer) must be entered on the load record. This value is usually sent in an EDI204 as the Bill of Lading number or another load reference. The customer may have a regular method for generating this number. A Flow/process to automate entering the number is usually possible.

• The Tracking Number (Customer) field should ONLY contain a value if sending API updates to a tracking provider.

• The Tracking Customer ID and the Tracking Number (Customer) fields should NOT be the same value.  

The following load status updates can be sent from the TMS to the customer through MacroPoint:

• Load ID 

• Stop Appointment Time 

• Stop Arrival, Stop Departure 

• Load Location Change/Updates

  • Coordinates of the Location

  • Latitude/Longitude - Last Reported Geolocation

Customer load tracking is initiated on the Customer Banner LWC. Click the antenna button to open the Load Tracking Administration LWC to begin tracking the load.  

Begin tracking the customer load by completing the following tasks.

1. Select MacroPoint as the Tracking Provider from the picklist.

2. Add the Tracking Number (Customer) field.

3. Click the On button.

Click the Off button to stop tracking the load.

Send Load Location

The load location call sends the latest load location data to MacroPoint. 

Sample Send Load Location XML Payload (Location Update)

<TMSLocationData xmlns="http://macropoint-lite.com/xml/1.0">
  <Sender>
    <LoadID>ABC123</LoadID>
  </Sender>
  <Requestor>
    <MPID>123456</MPID>
    <LoadID>Load-123</LoadID>
  </Requestor>
  <AllowAccessFrom>
    <MPID>123456</MPID>
  </AllowAccessFrom>
  <Location>
    <Coordinates>
      <Latitude>41.396900</Latitude>
      <Longitude>-81.662491</Longitude>
    </Coordinates>
    <CreatedDateTime>2020-01-01T12:00:00Z</CreatedDateTime>
  </Location>
</TMSLocationData>

Fields sent in Payload

See MacroPoint location update documentation here.

Send Load Event

The load location event call sends the latest stop location event data to MacroPoint.

<TMSStopEventData xmlns="http://macropoint-lite.com/xml/1.0">
     <Sender>
          <LoadID>ABC123</LoadID>
     </Sender>
     <Requestor>
          <MPID>123456</MPID>
          <LoadID>Load-123</LoadID>
     </Requestor>
     <Stop>
     <Name>Shipper</Name>
          <StopType>PickUp</StopType>
          <Address>
               <Line1>6050 Oak Tree Blvd</Line1>
               <City>Independence></City>
               <StateOrProvince>OH</StateOrProvince>
               <PostalCode>44131</PostalCode>
          </Address>
          <SequenceNumber>1</SequenceNumber>
     </Stop>
     <Event>
          <Name>Arrived</Name>
          <CompletedDateTime>2020-01-01T12:00:00Z</CompletedDateTime>
     </Event>
</TMSStopEventData>

Fields sent in Payload

See MacroPoint location event documentation here.

API Field Mapping

The following table relates TMS data fields with the equivalent MacroPoint fields used in API calls.

* Fields marked with an asterisk are required.

MacroPoint Codes

The following table contains some of the codes sent by MacroPoint that can appear in the TMS user interface. Some of the codes represent errors, and others indicate a status.