Organizational Preferences

Parameter

Type

Description

autoRefreshMinutes

Integer

This is the preference around the refresh rate of the shipments page within 10-4 Freight Portal.

Available options are:

1, 2, 5, 10, 15, 30, 60 minutes

isManualShipmentEnabledFlag

Boolean

True = On
False = Off

showPCMilerRouteByDefaultFlag

Boolean

When on, PC Miler route will be displayed by default in Freight Portal.

True = On
False = Off

showGoogleRouteByDefaultFlag

Boolean

When on, Google route will be displayed by default in Freight Portal.

True = On
False = Off

geofenceRadiusInFeet

Integer

This is the preference for geofence radius.

Accepted values are between 52.8 - 26400 feet.

earlyIsAGoodThing

Boolean

This is a preference to determine is early is considered good in legacy reporting.

True = On
False = Off

earlyShipmentStatusMinutes

Integer

This is the number of minutes before the shipment scheduled/appointment time that it should be considered early.

Accepted values between 0 - 4320 minutes.

onTimeShipmentStatusMinutes

Integer

This is the number of minutes after the shipment scheduled/appointment time that it should be considered on time.

Accepted values between 0 - 4320 minutes.

inJeopardyShipmentStatusMinutes

Integer

This is the number of minutes after the shipment scheduled/appointment time that it should be considered in jeopardy.

Accepted values between 0 - 4320 minutes.

lateShipmentStatusMinutes

Integer

This is the number of minutes after the shipment scheduled/appointment time that it should be considered late.

Accepted values between 0 - 4320 minutes.

hasEarlyStatusDefined

Boolean

This defined if an organization tracks early on their shipments.

True = On
False = Off

hasInJeopardyStatusDefined

Boolean

This defined if an organization tracks in jeopardy on their shipments.

True = On
False = Off

showPendingShipmentsByDefaultFlag

Boolean

This determines if shipments in a pending status will show on the main shipments page in the Freight Portal.

True = On
False = Off

sortOptionFieldType

Integer

This determines the default order in the Freight Portal. Default Sort Order Enums

shipmentsToHistoryPageTimeframeInHours

Integer

This is the timeframe after a shipment has delivered that it will go to the history page.

Accepted values are:

12,24,36,72,168,336,504 hours

autoSetAtConsigneeToDeliveredFlag

Boolean

Flag to state that when a shipment arrives at the destination, mark it delivered.

True = On
False = Off

trackingLostMinutes

Integer

How long from the last position event do you consider tracking to be lost?

Accepts between 0-4320 minutes

hasTrackingLostDefined

Boolean

Flag to set if Tracking Lost is tracked on the organization.

True = On
False = Off

displayDeliveryStatusToDestination

Boolean

Determines if delivery status is displayed at the shipment or stop level.

True = Shipment Level
False = Stop Level

dwellTimeEnabled

Boolean

Flag to state if organization uses dwell time in their ETA calculations.

True = On
False = Off

dwellTimeMinutes

Integer

Number of time, in minutes, that shipments will consider dwell time at each stop on a shipment.

Accepted values between 1-1440

showEta

Boolean

Determines if 10-4 ETA is displayed in the Freight Portal.

True = On
False = Off

shipmentExpirationTimeFrameHours

When would you like shipments that DO NOT DELIVER to expire and move from the shipments page to the history page?

Accepted values are:

72,168,336,504 hours

temperatureAlertMinutes

Integer

Amount of time in minutes used to trigger temperature notifications.

temperatureAlertBelowMin

Integer

Minimum temperature

temperatureAlertAboveMax

Integer

Maximum temperature

allowCarrierReportedStopDatesOverride

Boolean

This is a flag to allow the carrier to override a previous stop actual on a shipment.

True = On
False = Off

displayCarrierProvidedActualsOnly

Boolean

This is a flag to only show carrier ETA on a shipment, even when a system one is available.

True = On
False = Off

showEta must be set to False when this is set to True.

dropTrailerPickupRulesEnabled

Boolean

Determines if drops trailer rules are set for pickups where isDropTrailer is in use.

True = On
False = Off

dropTrailerDeliveryRulesEnabled

Boolean

Determines if drops trailer rules are set for deliveries where isDropTrailer is in use.

True = On
False = Off

isDropTrailerSameDayPickup

Boolean

Sets on time to all day for the pickup date on the shipment.

isDropTrailerSameDayDelivery

Boolean

Sets on time to all day for the delivery date on the shipment.

dropTrailerWindowPickupTimeFrom

String

Open Time for Drop Trailer Pickups. Format in HH:MM:SS

dropTrailerWindowPickupTimeTo

String

Close Time for Drop Trailer Pickups. Format in HH:MM:SS

dropTrailerWindowDeliveryTimeFrom

String

Open Time for Drop Trailer deliveries. Format in HH:MM:SS

dropTrailerWindowDeliveryTimeTo

String

Close Time for Drop Trailer deliveries. Format in HH:MM:SS

hasRequiredAppointmentEarlyRules

Boolean

When set, ETA will be set to the appointment time if trending early.

True = On
False = Off

etaBaselineIncreaseOrDecrease

Bit

0 = Increases Only
1 = Increases or Decreases

etaBaselineEnabled

Boolean

True = On
False = Off

etaBaselineMinutes

Integer

Number of minutes for ETA baseline.

etaHotLoadBaselineIncreaseOrDecrease

Bit

0 = Increases Only
1 = Increases or Decreases

etaHotloadBaselineEnabled

Boolean

True = On
False = Off

etaHotloadBaselineMinutes

Integer

Number of minutes for priority ETA baseline.