> For the complete documentation index, see [llms.txt](https://archivedocs.stackstate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://archivedocs.stackstate.com/5.1/develop/developer-guides/custom_synchronization_stackpack/how_to_configure_custom_synchronization.md).

# How to configure a custom synchronization

## Overview

Synchronizations are defined by a data source and several mappings from the external system topology data into StackState topology elements using Component and Relation Mapping Functions, as well as Component and Relation Templates. `Custom Synchronization` StackPack delivers a Synchronization called `default auto synchronization`. You can [find more on Synchronizations](/5.1/develop/developer-guides/synchronizations_and_templated_files.md) or proceed to edit `default auto synchronization` following the instructions below.

## Edit default auto synchronization

### Step 1

It's recommended that you change the `Synchronization Name` and add a `Description` if needed. There is no action required on `Plugin`, it uses the `Sts` plugin to synchronize data from StackState Agent V3.

### Step 2

There is no action needed here. However, you can observe the data source, component, and relation identity extractor, as well as whether this synchronization processes historical data. The recommended setting here is to keep this setting off.

### Step 3

This is where the Component Mappings are defined. The `Custom Synchronization` StackPack defines a `default component mapping` which can be seen at the bottom of the wizard for all "Other Sources".

Here you can define all your own component mappings for different resources.

### Step 4

This is where the Relation Mappings are defined. The `Custom Synchronization` StackPack defines a `default relation mapping` which can be seen at the bottom of the wizard for all `Other Sources`.

Here you can define all your own relation mappings for different sources.

### Step 5

Verify all the changes and click "Save". On the popup dialog that appears right after saving click "Confirm" to unlock this synchronization from the `Custom Synchronizations` StackPacks.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://archivedocs.stackstate.com/5.1/develop/developer-guides/custom_synchronization_stackpack/how_to_configure_custom_synchronization.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
