> For the complete documentation index, see [llms.txt](https://developer.kizen.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.kizen.com/docs/concepts/smartconnectors/smartconnector-design-best-practices.md).

# SmartConnector Design Best Practices

{% hint style="success" %}
**Audience:** Administrators, Developers, Integrators, Solution Architects 

**Purpose:** Introduces the four areas of <code class="expression">space.vars.smartconnector</code> design best practices: SQL design, execution variable design, load step sequencing, and running and testing.
{% endhint %}

## Overview

A <code class="expression">space.vars.smartconnector</code> that is configured thoughtfully in development is far more likely to behave predictably in production. The practices in this section reflect patterns that experienced teams use to ensure data integrity, correct <code class="expression">space.vars.entity</code> sequencing, and reliable credential management across their <code class="expression">space.vars.smartconnector</code> pipelines.

The best practices guide is organized into four areas. Work through them in order when building a new <code class="expression">space.vars.smartconnector</code>, or use them as a reference when reviewing an existing one.

| Section                                                                                                                                                     | What it covers                                                                                                                                                           |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [SQL Design](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-sql-design-best-practices.md)                               | Structuring SQL output tables to ensure column mappings are correct, values are typed accurately, and output is clean before it reaches variable mapping                 |
| [Execution Variable Design](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-execution-variable-design-best-practices.md) | Defining and referencing execution variables so values pass correctly between the SQL processor and downstream steps                                                     |
| [Load Step Design](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-load-step-design-best-practices.md)                   | Sequencing load steps and configuring matching rules so <code class="expression">space.vars.entities</code> are written to the correct destination in the correct order  |
| [Running and Testing](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-running-and-testing-design-best-practices.md)      | Validating <code class="expression">space.vars.smartconnector</code> behavior against real data before committing to a live run and interpreting results with confidence |

***

## What's Next

The next topic is [SmartConnector SQL Design Best Practices](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-sql-design-best-practices.md), which covers the practices that prevent data integrity problems at the source. SQL Design explains why `SELECT *` should never appear in a <code class="expression">space.vars.smartconnector</code> output table, why transformation logic belongs in the SQL script rather than chained load steps, and how to validate SQL output before configuring load steps

<details>

<summary>Related Topics</summary>

* [SmartConnector Execution Variable Design Best Practices](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-execution-variable-design-best-practices.md)
* [SmartConnector Load Step Design Best Practices](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-load-step-design-best-practices.md)
* [SmartConnector Running and Testing Design Best Practices](/docs/concepts/smartconnectors/smartconnector-design-best-practices/smartconnector-running-and-testing-design-best-practices.md)

</details>


---

# 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://developer.kizen.com/docs/concepts/smartconnectors/smartconnector-design-best-practices.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.