> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/devops/devops-de/code/branch-aktionen/branch-validate-verwenden.md).

# Branch Validate verwenden

Validate prüft die Metadaten Ihres Branches gegen eine Salesforce-Organisation, ohne bereitzustellen. Es bestätigt die Kompatibilität, stellt sicher, dass Abhängigkeiten erfüllt sind, und führt bei Bedarf Apex-Tests aus.

{% hint style="warning" %}

#### Geschrieben für die alte Benutzeroberfläche

Dieser Artikel wurde für die alte Benutzeroberfläche geschrieben. Die Anweisungen sind weiterhin verwendbar, aber die Screenshots sind veraltet. In einigen Fällen wurden die in den Anweisungen genannten Elemente verschoben oder geändert. Wenn Sie ein Element nicht finden können, siehe den [Wo ist es hin](/devops/devops-de/ubergang-zur-neuen-ui-ux/wo-ist-es-hin.md) Artikel.
{% endhint %}

## ![](https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FG5ZbxX918xOHwbAwAJ4n%2FSummary2-Small-Icon.svg?alt=media\&token=da26a67f-ff7f-47b3-8669-06be960dc2d7) Überblick <a href="#what-is-validate" id="what-is-validate"></a>

Die Funktion „Validate“ prüft die Komponenten Ihres Branches gegen eine Ziel-Salesforce-Org **ohne Bereitstellung**. Dadurch wird die Metadatenkompatibilität sichergestellt, Abhängigkeiten werden geprüft und bei Bedarf Apex-Tests ausgeführt. Durch die Validierung vor der Bereitstellung können Sie Probleme identifizieren und beheben, wodurch Bereitstellungsfehler reduziert werden. Die Validierung verhindert Fehler durch:

* Prüfung der Metadatenkompatibilität mit der Ziel-Org
* Sicherstellen, dass Abhängigkeiten erfüllt sind
* Ausführen von Apex-Tests (basierend auf der ausgewählten Teststufe)

Dieser Prozess gibt Ihnen die Sicherheit, dass die Bereitstellung erfolgreich sein wird. In diesem Artikel erfahren Sie, wie Sie einen Validierungsauftrag ausführen und die Ergebnisse anzeigen.

{% hint style="info" %}

#### Bewährte Vorgehensweisen

* Führen Sie Validate immer vor der Bereitstellung in UAT oder Production aus.
* Schließen Sie abhängige Komponenten ein, um Validierungsfehler zu vermeiden.
* Verwenden Sie **Lokale Tests ausführen** in niedrigeren Umgebungen für Prüfungen höherer Qualität.
* Verwenden Sie **Tests nicht ausführen** nur für schnelle Validierungen in Sandboxes.
* Prüfen Sie Protokolle sorgfältig, bevor Sie mit der Bereitstellung fortfahren.
* Führen Sie Validate erneut aus, nachdem Sie Konflikte behoben, Metadaten aktualisiert oder fehlende Abhängigkeiten abgerufen haben.
  {% endhint %}

## Branch-Validierungsauftrag ausführen

{% stepper %}
{% step %}

### Branch auswählen und Validierung starten

1. Klicken Sie auf **Code** über das Menü in der linken Seitenleiste.
2. Wähle einen Branch aus der Liste aus.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FMF5U2AgC0IVyRELJXWsv%2FUsingBranchValidate-Run-S01-01.png?alt=media&amp;token=9f7fd50e-f2b5-4053-ad43-1f58fd427c34" alt="" width="563"><figcaption></figcaption></figure></div>
3. Klicken Sie auf die **Drei vertikale Punkte ⋮** Dropdown-Menü neben Deploy.
4. Klicken Sie auf **Validieren**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2F9jej1YdpDM9j6srk602I%2FUsingBranchValidate-Run-S01-02.png?alt=media&amp;token=20471301-04fc-4b0b-938b-ae937eea405b" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Komponenten und Verbindungen auswählen

1. Klicken Sie auf **Hinzufügen** für jede Branch-Komponente, die in die Validierung aufgenommen werden soll.
2. (Optional) Klicken Sie auf **Alle hinzufügen** um alle Komponenten zur Validierung hinzuzufügen.
3. Klicken Sie auf **Weiter**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FwOzj9OAMyIqbaRJjaIbx%2FUsingBranchValidate-Run-S02-01.png?alt=media&amp;token=3b2a29c0-8e62-4943-adbe-6ccc82ee5592" alt="" width="563"><figcaption></figcaption></figure></div>
4. Klicken Sie auf **Auswählen** für die Salesforce-Org-Verbindung, die als Ziel-Org für die Validierung verwendet werden soll.
5. Klicken Sie auf **Weiter**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FM5hBgK6zJvsUlgSQnqmM%2FUsingBranchValidate-Run-S02-02.png?alt=media&amp;token=36f0a878-363f-415e-82b0-85fb76bcdfa9" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Zerstörerische Änderungen auswählen

{% hint style="info" %}
Standardmäßig werden alle vor- und nachgelagerten zerstörerischen Änderungen hinzugefügt.
{% endhint %}

1. (Optional) Um eine zerstörerische Änderung aus der Validierung zu entfernen, klicken Sie auf **Hinzugefügt**.
2. Klicken Sie auf **Weiter**.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FVTbXVP1YBS0c9LJ8pdq0%2FUsingBranchValidate-Run-S03-01.png?alt=media&amp;token=14cbc49b-bafe-4d09-906f-339a90a86ab8" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Validierung konfigurieren und ausführen

1. Klicken Sie auf die **Tests ausführen** Dropdown-Menü, um die auszuführende Apex-Teststufe auszuwählen. Eine Beschreibung der einzelnen Stufen finden Sie in der folgenden Tabelle.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2F7vNJLaSjbWM3DnqUV1BM%2FUsingBranchValidate-Run-S04-01.png?alt=media&amp;token=bdbbd178-ad81-4c07-8852-d4b2502e67cf" alt="" width="563"><figcaption></figcaption></figure></div>

<table><thead><tr><th width="180.333251953125">Teststufe</th><th>Beschreibung</th></tr></thead><tbody><tr><td><strong>Standard</strong></td><td>Führt nur die im Paket enthaltenen Tests aus.</td></tr><tr><td><strong>Tests nicht ausführen</strong></td><td>Überspringt alle Apex-Tests (nur in Nicht-Produktions-Organisationen zulässig).</td></tr><tr><td><strong>Lokale Tests ausführen</strong></td><td>Führt alle Tests in der Organisation aus, außer denen aus installierten verwalteten Paketen.</td></tr><tr><td><strong>Alle Tests ausführen</strong></td><td>Führt jeden Test in der Organisation aus, einschließlich der Tests verwalteter Pakete.</td></tr><tr><td><strong>Relevante Tests ausführen</strong></td><td>Führt nur die für die ausgewählten Komponenten und ihre Abhängigkeiten relevanten Tests aus. Diese Option verwendet die Funktion „RunRelevantTests“ von Salesforce, um automatisch zu bestimmen, welche Tests ausgeführt werden sollen. Weitere Details finden Sie unter <a href="https://help.salesforce.com/s/articleView?id=release-notes.rn_apex_run_relevant_tests.htm&#x26;release=260&#x26;type=5">Salesforce-Hilfe</a>.</td></tr><tr><td><strong>Angegebene Tests ausführen</strong></td><td>Ermöglicht das Festlegen einzelner Testklassen oder -methoden, die ausgeführt werden sollen.</td></tr></tbody></table>

2. Klicken Sie auf die Umschalter der Bereitstellungseinstellungen, um die Einstellungen zu aktivieren. Eine Erläuterung jeder Einstellung finden Sie in der folgenden Tabelle.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FWELpcaRxByblsA4xU5sv%2FUsingBranchValidate-Run-S04-02.png?alt=media&amp;token=270d6f7f-6196-4ddb-915b-e99697f2203e" alt="" width="563"><figcaption></figcaption></figure></div>

<table><thead><tr><th width="280.333251953125">Einstellung</th><th>Beschreibung</th></tr></thead><tbody><tr><td><strong>Profil-Einstellungen nur für ausgewählte Komponenten bereitstellen</strong></td><td>Nur validieren <strong>Profileinstellungen</strong> für die Komponenten, die Sie für diesen Validierungsauftrag ausgewählt haben.</td></tr><tr><td><strong>Berechtigungssatz-Einstellungen nur für ausgewählte Komponenten bereitstellen</strong></td><td>Nur validieren <strong>Berechtigungssatz-Einstellungen</strong> für die Komponenten, die Sie für diesen Validierungsauftrag ausgewählt haben.</td></tr></tbody></table>

3. Klicken Sie auf **Ausführen** um den Validierungsauftrag zu starten.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FhNODemQFTXTfjNO7ZtlL%2FUsingBranchValidate-Run-S04-03.png?alt=media&amp;token=70c26313-2d7e-4c25-ab0e-e14d1d37988b" alt="" width="563"><figcaption></figcaption></figure></div>
4. Nach dem Start des Validierungsauftrags wird er auf der **Aktivitäten** Registerkarte.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FJhBpFgtfYNxvAoIUKmQv%2FUsingBranchValidate-Run-S04-04.png?alt=media&amp;token=89903300-4024-41fc-b150-8fd7069477cd" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}

## Validierungsergebnisse <a href="#how-to-check-validation-status" id="how-to-check-validation-status"></a>

{% stepper %}
{% step %}

### Ergebnisse anzeigen

1. Klicken Sie auf die **Aktivitäten** Registerkarte.
2. Überprüfe, dass der **Validierung** Job-Status **Abgeschlossen**.

{% hint style="info" %}
Wenn während des Validierungsauftrags ein Fehler auftritt, ändert sich sein Status zu **Ausnahme**. Prüfen Sie das Protokoll des Validierungsauftrags, um die Fehler zu identifizieren.
{% endhint %}

<table><thead><tr><th width="159.6666259765625">Auftragsstatus</th><th>Beschreibung</th></tr></thead><tbody><tr><td><strong>In Warteschlange</strong></td><td>Auftrag wurde erstellt und wartet auf die Ausführung.</td></tr><tr><td><strong>Wird ausgeführt</strong></td><td>Auftrag wird ausgeführt.</td></tr><tr><td><strong>Abgeschlossen</strong></td><td>Auftrag erfolgreich abgeschlossen.</td></tr><tr><td><strong>Ausnahme</strong></td><td>Auftrag mit Fehlern abgeschlossen.</td></tr></tbody></table>

3. Klicken Sie auf die **Validierung** ist.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FIQKZ9cXeOX0VWlWEaQbo%2FUsingBranchValidate-View-S01-01.png?alt=media&amp;token=f2cdae89-d121-4a69-92d8-99293ef6f6d1" alt="" width="563"><figcaption></figcaption></figure></div>
4. Die **Validieren** Die Ergebnisseite listet Informationen zum Auftrag und ein detailliertes Protokoll des Auftrags auf.

   <div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FIe0U497ovIZblH7YmIjN%2FUsingBranchValidate-View-S01-02.png?alt=media&amp;token=7fb837f7-1f7c-437e-813b-8c92b2b9661b" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Protokoll prüfen (keine Fehler)

Im Protokoll des Validierungsauftrags umfassen die Details:

* Vorhandensein von Destructive Changes-Objekten.
* Anzahl und Liste der validierten Komponenten.
* Art und Ergebnisse des Apex-Testlaufs.
* Abgeschlossene Validierungsschritte.

<div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2F7jZ2Zo6GTswLdv6qF1GO%2FUsingBranchValidate-View-S02-01.png?alt=media&amp;token=43785a97-4118-4be9-afb4-25f7f177ec58" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Protokoll prüfen (mit Fehlern)

Wenn ein Fehler im Validierungsauftrag auftritt, prüfen Sie das Protokoll, um die Ursache zu finden. Konzentrieren Sie sich auf Einträge mit **\[error]**. Die folgenden Screenshots zeigen einen Validierungsauftrag, bei dem einer Salesforce-Org mehrere Komponenten fehlen, die im Branch enthalten sind.

<div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FkZFC3qKPu3soCbwRjJHg%2FUsingBranchValidate-View-S03-01.png?alt=media&amp;token=6b2e39e5-48a1-4f7b-bf55-51edd2a311e5" alt="" width="563"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://578823411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FukmpgbJMZ8P4v97u4OHA%2FUsingBranchValidate-View-S03-02.png?alt=media&amp;token=4553a42c-7a93-4447-9b17-b67eb9da71e6" alt="" width="563"><figcaption></figcaption></figure></div>

Die vollständige Protokolldatei ist unten dargestellt:

{% code expandable="true" %}

```
[Jan 1, 2026 3:14 PM]: [info] Auftrag gestartet
[Jan 1, 2026 3:14 PM]: [info] Erstellung des Salesforce-Projekts gestartet
[Jan 1, 2026 3:14 PM]: [info] Erstellung des Salesforce-Projekts abgeschlossen
[Jan 1, 2026 3:14 PM]: [info] Abrufen der Salesforce-Komponenten gestartet
[Jan 1, 2026 3:14 PM]: [info] Abrufen der Salesforce-Komponenten abgeschlossen
[Jan 1, 2026 3:14 PM]: [info] Erstellen der Manifeste gestartet
[Jan 1, 2026 3:14 PM]: [info] Erstellen der Manifeste abgeschlossen
[Jan 1, 2026 3:14 PM]: [info] Salesforce-Metadatenvalidierung gestartet
[Jan 1, 2026 3:14 PM]: [error] Validierung fehlgeschlagen
[Jan 1, 2026 3:14 PM]: [info] Anzahl der validierten Komponenten: 2
[Jan 1, 2026 3:14 PM]: [info] ValidateJobId: 0Afg5000001uyNVCAY
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: LightningCommunityUtils
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: objective.Owner
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [info] Validierte Komponenten: Example_Test_Object_1__c, CustomObject; Example_Test_Object_2__c, CustomObject
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: objectives
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: Account__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: LightningCommunityUtils
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.SuccessGoal__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Variable existiert nicht: LightningCommunityUtils
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Schema.Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanController: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: GuidUtil
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: DML erfordert den Typ SObject oder SObject-Liste: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: EncryptHelper
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: portalSession
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: EncryptHelper
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: portalSession
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: DML erfordert den Typ SObject oder SObject-Liste: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: DML erfordert den Typ SObject oder SObject-Liste: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: EncryptHelper
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: portalSession
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: DML erfordert den Typ SObject oder SObject-Liste: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: objective
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: PortalSession__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: EncryptHelper
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Variable existiert nicht: portalSession
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: Ungültiger Typ: Objective__c
[Jan 1, 2026 3:14 PM]: [error] ApexClass SuccessPlanControllerTest: DML erfordert den Typ SObject oder SObject-Liste: Objective__c
[Jan 1, 2026 3:14 PM]: [info] Validierungs-Teststufe: Standard
[Jan 1, 2026 3:14 PM]: [error] Auftrag fehlgeschlagen: Salesforce-Metadatenvalidierung fehlgeschlagen
```

{% endcode %}
{% endstep %}
{% endstepper %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/devops/devops-de/code/branch-aktionen/branch-validate-verwenden.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.