Synchronization job states

Synchronization job states

A synchronization job state tells you where a background synchronization run is in its lifecycle. The lifecycle uses five states: Pending, Running, Completed, Failed, and Cancelled. A job can start in Pending, move into Running, and finish in Completed or Failed. Cancelling a pending job moves it to Cancelled.

Before you start

The job history is the list of runs belonging to a project, so you need the project context before you inspect a run. The page uses the project context, and the controls available for a job depend on that job's current state.

Prerequisites

• Know which project contains the synchronization job.
• Open the project job route with the project's identifier.
• For an active job, expect the progress area and a cancellation control only when cancellation is available for that job.

With the project identified, find its job history.

Find a synchronization job

Use the project's job history to reach saved runs and refresh the list before inspecting a run.

Prerequisites

• Know the project whose jobs you need to inspect.

Steps

1. Open the project's jobs page.
2. Select Refresh, then wait for the job list to reload.

Result: The project's Activity & Jobs page shows the most recent job information returned for that project.

Use this list to read the job history.

Read the job history

A job row summarizes the run's current state, timing, progress, document count, stage, and any error information so you can decide what to do next.

Prerequisites

• Open the project's job history.

Steps

1. Read the status badge to identify whether the job is Pending, Running, Completed, Failed, or Cancelled.
2. Read the created time, duration, document count, progress, current stage, and error information shown for the row.
3. Select a completed or failed job row to open its details.

Result: You can identify the job's lifecycle state and read the progress or outcome details available for that state.

Select a completed or failed job row to expand it. A completed job opens its completion summary. A failed job opens Job Failed, followed by the error stage and error text when those values are present.

When you know the job's state, choose the control for that state.

Act on an available job state

State-dependent controls let you refresh the list, request cancellation for an active job, or remove documents associated with a finished job.

Prerequisites

• Open a project's job history.
• Use an active job when Cancel is available.

Steps

1. Select the action that matches the job's state:

   If you need to…	Select…
   Refresh the job list	Refresh
   Cancel an active job	Cancel, then Are you sure?
   Delete a finished job with no created documents	Delete Job, then Confirm Delete?
   Delete a finished job with created documents	Delete <n> Docs, then Confirm Delete?

   While cancellation is in progress, the control reads Cancelling....

Result: The selected state-dependent request is issued from the job row, subject to the job's lifecycle state and available action.

After the action, handle the outcome shown for the job.

Handle different job outcomes

The job outcome determines which information you can open and which action belongs next.

Prerequisites

• Have the project's job history open.

Steps

1. Use the job's status to choose one path:

   If the job is…	Read or select…
   Pending	Read its basic progress information while it waits to start.
   Running	Read its current stage and progress while it is active.
   Completed	Open the row to read its completion summary.
   Failed	Open the row to read Job Failed, the error stage, and the error text.
   Cancelled	Read the final cancelled status.
   Empty	Select Configure & run documentation generation → to reach the configuration route.
   Unavailable	Read the load message and follow the recovery direction in When a job does not load or finish.

Result: You use the information and controls that belong to the job's current outcome.

If the page shows a load, failure, empty, or stalled message, use the matching response below.

When a job does not load or finish

Use the message on screen to identify whether the page is loading, empty, unavailable, failed, or stalled.

Prerequisites

• Have the project job history open.

Steps

1. Read the message in the first column, then follow the matching instruction in the What to do column.

Result: You have a response for the message shown on the job history page.

Once the message is resolved, continue from the job's current state.

Know what comes next

The next action depends on the state the job reaches: continue monitoring an active run, inspect a completion summary after Completed, or read the failure details after Failed.