Run Statuses | Yext Hitchhikers Platform

Overview

There are six possible statuses for a given Connector run:

• In Progress
• Completed
• Completed with Errors
• Failed
• Aborted
• Canceled
• Ready for Review (Dry Runs only)

Each status is outlined in more detail below.

Run Statuses

In Progress

A Connector is considered In Progress while it is actively running. You can view the progress bar and relative percentage of completion, but note that the percentage is an estimate.

If a dry run is initiated, the “Dry Run” pill will be visible to signify that the current run in progress is a dry run. See the Dry Runs reference for more information.

Completed

A Connector run is considered Completed when the run completes successfully with no errors.

Completed with Errors

A run with a status of Completed with Errors was able to complete, but certain errors occurred that prevented the entire set of data to be processed as expected. The errors are most commonly at the field level, where an entity will fail to be processed. These failures are generally not inherent to the Connector itself, and attempting to upload the same data via any interface (such as the Entities API or Entity Edit) would likely result in the same errors.

Common errors include:

• Invalid field value (due to validation such as exceeding a character limit, an unsupported format for a Date field, etc.)
• Missing required field

When an error occurs at the field level, the update for that particular entity will fail, but all other entities will be processed as expected. The run will complete, but it’s recommended that users investigate the failing entities so they can be properly ingested.

Additionally, if ETL diagnostics are present on a particular entity, a Connector that is running in Default mode will have a Completed with Errors status. ETL diagnostics may occur if a transform fails to execute on a specific value in a row. These are considered ETL diagnostics (as opposed to entity diagnostics), since no fields are mapped at the time of the transform execution. Therefore, Yext cannot definitively match the row to an Entity ID, which means the system is unable to process the row entirely, and the row is dropped prior to the execution of the mapping stage.

Note that the presence of ETL diagnostics when running in Comprehensive mode results in an Aborted status.

Failed

A Connector run is considered Failed when an ETL diagnostic prevents the run from executing entirely. Failed runs will show a total of zero entities processed, since the Connector was not able to successfully extract and parse source data.

This scenario might occur when the provided URL for an API request is incorrect or an unsupported file format is uploaded.

Aborted

Any run that is prevented from executing is considered Aborted. This status will apply to:

• Any run where a Run Breaker is triggered
• Any run in Comprehensive Mode for which an ETL error occurred during the Transform or Load stage (these might include Function Transform timeouts or an improperly configured Format Dates Transform). These types of errors can result in the loss of entire rows of data. Since Comprehensive Mode is destructive and deletes any missing rows of data, we need to prevent the deletion of entities that become missing due to a failure that results in these unresolved rows. Therefore, any runs in Comprehensive Mode with an ETL diagnostic due to an error occurring after the Extraction step are aborted.
• Any run where the configuration is invalid

Canceled

When a run is manually canceled by a user, the status will display as Canceled. Any updates to entities that were made during the Connector run prior to its cancellation will not be reverted, and only future updates that would have been made if the run completed are prevented.

Ready for Review

This status applies only to dry runs. A connector run is considered Ready for Review when a dry run has completed (with or without errors). At this point, the user can either approve or abandon the run.

After the run is initiated, seven days are allotted to review and approve or abandon the run. After seven days, the run will automatically be abandoned.

Approving the run will initiate the load step and the run will return to an In Progress state. Abandoning the run will prevent the potential updates from ever being applied to the account.

See the Dry Runs reference for more information.