For the complete documentation index, see llms.txt. This page is also available as Markdown.

Streams

Understand import streams, their list and actions, and the workflow for creating, configuring, mapping, and running them.

After you create or edit an import, the import details view is where you manage its streams, mappings, schedules, and runs.

A stream is a feed of records from a selected source that the Import Tool writes to target entities in your tenant. When you run the import, all enabled streams in that import run together.

Import details view with schedule, streams, and run actions
Import details with the schedule, stream list, Dry run, Run options, and New stream actions

Stream list

An import can contain multiple stream configurations. For each stream, the list shows Enabled, Name, Source entity, Target type, Settings, and Actions. The settings summarize the connection, delta configuration, and maximum record limit. Use the edit icon to open the stream row and access its configuration tabs.

Additionally, the import details view provides actions for the entire import and for individual streams. Check the tabs to review each set of actions.

Action
Description

View this job in the dashboard

Open the import on the Dashboard

Run history

Review previous runs and per-stream logs

Run order

Open the Run Order dialog to arrange streams on the Run order tab and review the same relationships on the Dependency graph tab. See Run order and dependencies.

View mapped sample

Review the mapped output after a dry run. The action is unavailable until you run a dry run first.

Health thresholds

Override the default health settings for this import

Delete

Remove the import

+ New stream

Create a stream in this import

Dry run

Preview the import without writing the results

Run options

Open the available full, delta, and force run actions

Import actions menu with dashboard, history, order, sample, thresholds, and delete actions
Actions available for an import
Action
Description

Edit mapping

Open or update the field mapping between source and target

View imported data

Review records imported by this stream. See Imported Data.

View mapped sample

Review mapped output after you run a dry run

Check schema

Detect divergence between source and target, for example fields that are not mapped

View in dashboard

Open the stream on the Dashboard

Delete

Remove the stream

Stream actions menu with mapping, imported data, mapped sample, schema, and dashboard actions
Actions available for an individual stream

Stream workflow

Use the following guides in sequence:

  1. Creating Streams – add a stream and define its connection, source record, keys, and target type.

  2. Configuring Streams – configure the source, target, keys, composite behavior, deletes, routing, and health.

  3. Field Mapping – map and transform source fields, then save and publish the mapping.

  4. Running and Monitoring Imports – schedule or run the import, review history and dependencies, and inspect results.

Last updated

Was this helpful?