Skip to content
English
Customer portal
Go to Tai Software
  • There are no suggestions because the search field is empty.

Integration Source Settings Reference

Glossary of the named key/value source settings staff enter on an integration source to configure a Tai TMS connector, with accepted values.

A curated glossary of the named key/value source settings staff enter on an integration source to configure a connector in the Tai TMS.

Overview

An integration source in the Tai TMS carries a set of named parameters — source settings — in addition to the standard credential fields (User Name, Password, License Key, Account Number). Each source setting is a key and a value that a specific connector reads to change its behavior: which environment to talk to, which features are on, how often to track, how long to wait for a response, and so on. This article is a reference for the notable keys and the values they accept.

This is a curated, non-exhaustive reference. Different connectors read their own settings, and new ones are added over time, so a key not listed here may still be valid for a given integration. When in doubt, confirm the exact key and value with the setup notes for that connector or with Tai Client Success. Two general rules apply almost everywhere: key names are matched case-insensitively by most connectors (a few are exact-case, noted below), but values are safest entered exactly as lowercase true / false because some connectors compare the value case-sensitively; and boolean settings that are absent are treated as off/false unless a specific default is noted below.

How it works

When a connector runs, it looks up the source settings on the integration source by name and interprets each value — as a boolean (true / false), a number, a text string, or an enum name. If a required setting is missing, most connectors raise a clear user-facing error naming the setting. If an optional setting is missing, the connector falls back to its documented default. The tables below group the most commonly used settings by area.

Business rules & limits

Trucker Tools (Smart Capacity) settings

  • smartcapacity — What it does: Turns on Smart Capacity (capacity matching) and lets the shipment-status subscriber pick up loads for this source.; Accepted values: true to enable. Enter as lowercase true (the value is compared case-sensitively).
  • bookItNow — What it does: Turns on Book It Now for the source.; Accepted values: true to enable.
  • submitquoted — What it does: Submits loads to Trucker Tools at Quote status instead of the default Committed status.; Accepted values: true to submit at Quote (lowercase, case-sensitive); otherwise Committed.
  • testing — What it does: Routes capacity calls to the Trucker Tools staging host instead of production.; Accepted values: true for staging; absent/false for production.
  • secretkey — What it does: The signing key used to build the request signature (paired with the account number and user name). Required for all Trucker Tools calls.; Accepted values: The secret string issued by Trucker Tools.
  • ContactEmail — What it does: The broker contact email stamped on posted loads and capacity syncs. Any key whose name starts with ContactEmail is read (case-insensitively).; Accepted values: An email address.
  • contactEmail (exact case) — What it does: The broker contact email on Trucker Tools location-tracking (load track) requests. Unlike the other keys, this one is matched case-sensitively, so a key spelled ContactEmail will not be picked up here.; Accepted values: An email address.

Note: for Trucker Tools, the API key is the License Key credential field and the signed values are the Account Number and User Name credential fields — those are standard record fields, not named source settings. The Password field is not used by this connector. If the License Key or secretkey is missing, calls fail with a message such as "Integration Source License Key cannot be null" or "Integration Source Parameter: secretKey cannot be null"; Smart Capacity also requires the Account Number and User Name.

MacroPoint / driver-tracking settings

  • DriverTrackFrequency — What it does: How often the driver's position is requested (the tracking interval).; Accepted values: A number of minutes: 10, 20, 30, 45, 60, 120, 240, 360, 480, or 720. Defaults to 240 (4 hours) when missing or not a recognized name/number. The parser does not reject other numbers (for example 15) and does not fall back to the default for them, so enter only the listed values. Named forms (e.g. OneHour, FourHours) also parse but must match exactly, so the numeric value is safest.
  • MacroPointId — What it does: The MacroPoint identifier notified for the load. Required for MacroPoint tracking.; Accepted values: The MacroPoint account/partner ID string.
  • PartnerMPID — What it does: A second (partner) MacroPoint ID to also notify for the load.; Accepted values: A MacroPoint ID string; optional.
  • GeofenceInMiles — What it does: Geofence radius applied to stops, in miles. Applied to the first pickup and last drop; applied to middle stops only when the stop-type/geofence feature is on.; Accepted values: A whole number of miles; blank or non-numeric is treated as 0.
  • EmailCopiesOfUpdatesTo — What it does: Emails copies of tracking updates to the customer staff email.; Accepted values: true / false.
  • SendCustomerName — What it does: Includes the customer name in the MacroPoint request.; Accepted values: true / false.
  • UnitOfTemperature — What it does: Temperature unit used for cold-chain tracking.; Accepted values: A unit string; defaults to Fahrenheit when not set. Used only when cold-chain tracking is enabled and the shipment has a desired temperature.
  • StartTrackHoursOffset — What it does: Shifts the tracking start time earlier/later by a number of hours.; Accepted values: A whole number from -24 to 24; values outside that range or non-numeric are ignored (treated as 0).
  • RequirePODImage — What it does: Requires a proof-of-delivery image.; Accepted values: true / false; defaults to true when not set.
  • RequireSignature — What it does: Requires a delivery signature.; Accepted values: true / false; defaults to true when not set.
  • ShipperReferenceNumber — What it does: Includes the shipper reference number as a customer UDF on the notification.; Accepted values: true / false.
  • CustomerPONumber — What it does: Includes the customer PO number as a customer UDF on the notification.; Accepted values: true / false.
  • StopSequencingRequired — What it does: Whether stop sequencing is enforced on the trip sheet.; Accepted values: true / false; treated as true unless set to false, and true when the setting is absent.

Timeouts (all vendors that use the shared call plumbing)

  • DispatchTimeout — What it does: How long dispatch calls to this vendor wait for a response.; Accepted values: Whole seconds. Default 30; a blank or non-numeric value is ignored and the default applies.
  • ImagingTimeout — What it does: How long document/imaging calls wait for a response.; Accepted values: Whole seconds. Default 30; blank or non-numeric is ignored.
  • TrackingTimeout — What it does: How long tracking calls wait for a response.; Accepted values: Whole seconds. Default 30; blank or non-numeric is ignored.

Calls that do not use one of these three settings use a 15-second default (rating calls are also 15 seconds and have no working per-source override). The shipment-locations service has its own 30-second timeout, set in application settings, not on an integration source.

Authentication back-off setting

  • allowedFailureCount — What it does: How many authentication failures a source may record before it is flipped to the authentication-error state (it flips when the count exceeds this number). Read by integrations that count failures per source (for example EPay, CargoChief, MyCarrierPackets, Parade, TriumphPay, RoadSyncPay, HubTrans, Greenscreens).; Accepted values: A whole number. Defaults to 5 when absent or non-numeric. Not used by the bulk-marking paths (rating lane calls and the Trucker Tools driver-track pull), which flip after four recorded failures.

The failure count itself is zeroed every day at 04:00 UTC for sources not already in the authentication-error state, and saving the integration source resets both the count and the error state. See the integrations and credentials internal reference.

Highway (onboarding & carrier-alert) system-managed settings

Highway's onboarding and carrier-monitoring syncs use the standard credential fields (the Highway API key). The settings below are written by the Tai TMS itself, not entered by staff — they are run-to-run bookkeeping. Recognize them so you don't hand-edit them; clearing them changes what the next sync reprocesses or skips.

  • FailedCarrierAlertIds — What it does: Comma-separated ids of Highway carrier-monitoring alerts that failed to apply. The next carrier-alert sync skips these so it doesn't retry them forever.; Accepted values: System-managed comma-separated id list (64-bit ids). Clear it to let those alerts be retried.
  • FailedOnboardingPacketIds — What it does: Comma-separated ids of Highway onboarding packets that failed to process; skipped on subsequent onboarding syncs.; Accepted values: System-managed comma-separated id list.
  • CarrierJobId — What it does: The last enqueued background-job id for Highway's carrier onboarding/alert paging, persisted so a duplicate enqueue is skipped while the prior run is still pending/running (idempotency).; Accepted values: System-managed job id; do not set by hand.
  • BulkUploadJobId — What it does: The equivalent job-dedup id for Highway's carrier bulk-upload job.; Accepted values: System-managed job id; do not set by hand.

Note: the last-processed carrier-alert id is remembered on the broker carrier record (as a carrier parameter), not on the integration source, so it is not a source setting even though it is part of the same resume mechanism. A generic JobId source parameter serves the same idempotency purpose for other connectors (for example DAT and the RMIS onboarding delta sync); Highway uses the connector-specific names above instead.

EPay settings

  • DocumentRetrieval — What it does: Opts the source in to the hourly EPay document-page pull. Without it the pull skips this source entirely.; Accepted values: true (matched case-insensitively here). There is no longer a global switch that overrides it.
  • LastTransDocPageGetDate — What it does: Remembers when documents were last pulled for the source (the pull looks back one day when it is empty).; Accepted values: System-managed date; do not set by hand.
  • testing — What it does: Marks a sandbox source. On the beta environment the hourly document pull only considers sources that have it.; Accepted values: true. EPay code paths read this key with different case rules (some exact-case, such as testing/true in the hourly pull and Testing/True in the AR transaction path), so confirm the spelling with the connector setup notes.

EPay also does not auto-activate a carrier as an EPay payee when the carrier has a factoring company recorded; that is carrier data, not a source setting.

Common / cross-integration settings

  • testing — What it does: Shared convention across many connectors (Trucker Tools, Truckstop, MacroPoint Capacity, and payment integrations such as Global Payments, CardConnect, and Axle Payments) to route to the provider's sandbox/staging environment instead of production.; Accepted values: true for sandbox/staging; absent/false for production.
  • staffid — What it does: On Truckstop Book It Now, links an integration source to a specific user (the source is used for a user when this value contains the signed-in user's ID).; Accepted values: The user ID value. Because the match is a text "contains" check, a value can list several IDs, and an ID that happens to be part of a longer ID will also match — avoid ambiguous IDs.
  • AccessToken / RefreshToken / TokenExpiration — What it does: OAuth token material stored on OAuth-based sources (for example Truckstop). Normally written and refreshed automatically by the Tai TMS, not entered by hand.; Accepted values: System-managed token values and an expiration timestamp.
  • TermsAndConditions — What it does: Records that terms and conditions were accepted for a source (for example Truckstop).; Accepted values: The accepted terms/conditions identifier; written by the app when the user agrees.

Frequently asked questions

What values does the DriverTrackFrequency setting accept?

A number of minutes from a fixed set: 10, 20, 30, 45, 60, 120, 240, 360, 480, or 720 (10 minutes through 12 hours). If the setting is missing or the value is not recognized, the Tai TMS defaults to 240, which is every 4 hours. Be careful with numbers that are not on the list: the parser accepts them as-is rather than substituting the default, so stick to the listed values. The named forms (such as OneHour or FourHours) also parse, but the match is case-sensitive, so entering the plain number of minutes is the most reliable.

Do source-setting values need specific capitalization?

Key names are matched case-insensitively by most connectors, so ContactEmail and contactemail usually resolve the same (Trucker Tools location tracking is an exception and needs contactEmail exactly). Values are less forgiving: several connectors compare the value case-sensitively (for example Trucker Tools smartcapacity and submitquoted), so a boolean should be entered as exactly lowercase true or false. When a setting is not taking effect despite being present, check the key and value casing first.

What does testing do, and is it the same everywhere?

testing = true tells a connector to use the provider's sandbox/staging environment instead of production. It is a shared convention used across many integrations — capacity, load boards, and payment providers all honor it. The concept is the same everywhere: turn it on only for test accounts, and make sure it is off for live accounts, otherwise real calls go to a sandbox and return nothing useful.

A required setting is missing — how will I know?

Most connectors validate required settings up front and raise a user-facing error that names the missing item, for example "Integration Source Parameter: secretKey cannot be null" or a message that MacroPoint requires a valid MacroPointId. If a broker reports a hard failure right when an integration runs, read the error text — it usually points straight at the missing key or credential.

How do I make a vendor wait longer before timing out?

Set DispatchTimeout, ImagingTimeout, or TrackingTimeout on the integration source to a whole number of seconds; each defaults to 30 seconds and a blank or non-numeric value is ignored. Other calls use a 15-second default that is not configurable per source.

How do I make an integration more (or less) tolerant of authentication failures?

For integrations that count failures per source, add an allowedFailureCount setting with a whole number; the source flips to the authentication-error state once its count exceeds that number (default 5). Bulk-marked sources (rating lane calls and the Trucker Tools driver-track pull) ignore it and flip after four recorded failures. The count is zeroed daily at 04:00 UTC unless the source is already in the error state, and saving the source resets the error state.

Why isn't an EPay source pulling documents?

The hourly EPay document-page pull only runs for sources that opted in with DocumentRetrieval set to true; sources without it are skipped. A source in an authentication-error state is also skipped, and on beta only sources marked testing are considered.

Is this list everything?

No. This is a curated set of the most commonly used and highest-impact settings. Each connector can read additional settings specific to it, and settings are added over time. If you encounter a key that is not here, do not assume it is invalid — confirm it against the connector's setup notes or with Tai Client Success.

Where are the public-API edge rate-limit (Cloudflare) settings? I can't find them on an integration source.

They aren't source settings. The edge rate-limit sync is configured globally, not per organization: its Worker URL comes from application settings and its bearer token from Azure Key Vault, and the per-organization/per-API-key limits it syncs live in their own rate-limit data, not on an integration source record. So there is no Cloudflare integration source or source setting to edit here — look to global application settings and Key Vault instead. It also runs in production only.

What is the difference between a credential field and a source setting?

Credential fields (User Name, Password, License Key, Account Number) are fixed slots on every integration source record. Source settings are named key/value pairs added to that record to configure a particular connector's behavior. For example, Trucker Tools reads the License Key and Account Number from the credential fields but reads secretkey, smartcapacity, and ContactEmail from source settings.

The AccessToken / RefreshToken values look blank or keep changing — should I set them?

Generally no. On OAuth-based sources like Truckstop, those token settings are written and refreshed automatically by the Tai TMS as part of the login flow. They are expected to change and should not normally be entered or edited by hand. If authentication is failing, prefer re-running the connector's authorization flow rather than pasting token values directly.