> For the complete documentation index, see [llms.txt](https://help.security.gallagher.com/knowledge-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/creating-controller-7000s-or-6000s.md).

# Creating Controller 7000s or 6000s

### Introduction

Controller 7000s and 6000s are the central field controllers for the Command Centre system. They are a processing board for an intruder alarm and access control system. All variants of the Controller 7000 and 6000 can operate on their own, or can have an optional Reader Module connected.

***

### Configuration

To create a new Controller 7000 or 6000, perform the following procedures in Gallagher Configuration Client:

1. Click **Configure** from the menu bar, then **Hardware**.

   The **Hardware** List Window opens (in [tree view](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/list-windows/tree-view.md)).
2. **Right click** and select **New\...Controllers** and the appropriate Controller type, (i.e. **Controller 7000** or **Controller 6000** ).

   By default the **General** tab displays.
3. Complete the fields as required.

   For further detail see [General tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/general-tab.md).
4. Click the **Event Response** tab, and configure as required.

   For further detail see [Event Response tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/event-response-tab.md).
5. If this Controller is not mounted in a cabinet or, if the cabinet door opens, continuous tamper alarms will be generated. To prevent this from happening, select the **Status and Overrides** tab and select the **Disable Front Tamper** and/or **Disable Rear Tamper** check box/s.

   **Note:** The Controller 6000 and 7000 have a **Disable Front Tamper** and a **Disable Rear Tamper** checkbox so the tampers can be enabled/disabled independently.
6. Click each tab in turn and configure the Controller properties as required:

<details>

<summary>Setup tab</summary>

1. Click the **Setup** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-fce7c4414bb113ffac3449e38a8b7989a4532a9b%2Fcontroller6000_setuptab.png?alt=media)
2. If the Controller is a Starter Kit Controller or 2-Door Controller, check the **Restricted Controller** check box and select the Controller type from the drop-down list.

   **Notes:**

   * Both the Controller 6000 Starter Kit and 2-Door are not compatible with versions of Command Centre earlier than vEL7.30

     Both the Controller 7000 Starter Kit and 2-Door are only supported from th following Command Centre versions onwards:

     * vELvEL9.00 MR7,
     * vEL9.10 MR6,
     * vEL9.20 MR3,
     * vEL9.30 MR1, and
     * vEL9.40
   * It is not possible to assign more than 2 Doors to a 2-Door Controller.
   * Starter Kit Controllers must be configured as Starter Kit Controllers. 2-Door Controllers must be configured as 2-Door Controllers. Failure to do so will result in an *‘Controller with wrong type created’* alarm being generated. The Controller will stop accepting messages from the Controller Service resulting in *‘Part not found problems’*.
   * Any Standard, Enhanced or High Sec Controller will work normally (even if configured as a Starter Kit Controller or 2-Door Controller), assuming your licence and door limits are not breached.
   * Once saved, the **Restricted Controller** type cannot be changed.
   * Command Centre must be licensed to use a Starter Kit Controller. Command Centre is limited to communicating with one Starter Kit Controller per system.
3. The **Time Zone** section of the screen is automatically populated with the same time zone the Command Centre Server is in.

   If you require another city/time zone, you can select one from the drop-down **Quick list**, and the POSIX time zone string in the **Actual value** field will be updated.

   **Note:** If you change the time zone the Controller will restart when you **Apply** your change.

   The formatting rules for time zone strings are as follows:

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Time Zone string format is:</strong></p><p>{STDName}{Offset}[{DSTName}{Offset},{Start rule},{End rule}]</p><p>Offsets are in Americocentric form, (i.e. multiplied by -1 in order to make US timezones positive).</p><p>The Start and End rules can be omitted if there is no daylight saving. The rules can be written in one of the following three formats:</p><ul><li><strong>Jn</strong> - where n = {1-365} (Day of year, but Feb 29 never counted)</li><li><strong>n</strong> - where n = {0-365} (Day of year)</li><li><strong>Mm.w.d</strong> - where m=month {1-12}, w=week of month {1-5} (5=last), d=day of week {0(Sun)-6(Sat)}</li></ul><p>These can be followed by an optional changeover time in format:</p><p>/hh[:mm[:ss]] - default is 2:00:00.</p><p>If the daylight savings offset is omitted, then one hour more than the standard offset is assumed.</p><p><strong>Example:</strong></p><p>New Zealands timezone string is: NZST-12NZDT,M10.1.0,M3.3.0, which means New Zealand is 12 hours ahead of GMT, our daylight savings (of one hour) starts on the first Sunday of October and finishes on the third Sunday of March, both at the default time of 2am.</p></div>
4. The **Calendar** drop-down list contains a list of all the special calendars configured in the system for the operator's division. One special calendar may be assigned to each Controller in the system.

   By default, no special calendar will be assigned to the Controller. However, if you require one to be assigned, select the appropriate special calendar from the drop-down list.

   This Controller will use both the special calendar selected as well as the default calendar for its scheduling operations. The default calendar provides cycle and special day assignments, while the special calendar provides special day assignments only, with the possibility of overriding special day settings from the default calendar.

   **Note:** Refer to [Creating a Special Calendar](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/calendars/creating-a-special-calendar.md) for further detail about special calendars.
5. The **Hardware** section allows you to:
   * alter the HBUS, Aperio, OSDP, Schlage and Sensor devices used as required, and/or
   * alter the type of reader board (plug-in module) to be configured. For further explanation see [Linking devices to Controllers](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/linking-devices-to-controllers.md).
6. For a Controller 6000, the **Enable Secondary Ethernet Link** checkbox provides the option to switch to the secondary ethernet link either on failure of the primary link or on failure to connect to the Command Centre server.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-deef1231de485f528520fda15190465cf969fb86%2Fftc6000_2ndethernetlink.png?alt=media)

   When checked, the secondary ethernet link on the Controller is enabled if one is present, otherwise it has no affect.
7. The **DipSwitch 1 controls the diagnostic web interface** checkbox should be ticked if requested by Gallagher Technical Support. Otherwise, leave this option unticked.

   **Important:** If Dip Switch 1 is to be used to control the diagnostic web interface, Dip Switch 1 needs to be physically ‘ON’ on the Controller as well as this checkbox being enabled.
8. The **Logging** section allows you to configure the verbosity of diagnostic logs from this Controller which are written into the Command Centre log file. The log level can be changed to a value from **Off**, (i.e. least verbose) to **Trace**, (i.e. most verbose).

</details>

<details>

<summary>Network tab</summary>

1. Click the **Network** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ab52910f792c979f978fafc7ea99762b0aeb3e42%2Fcontroller7000_networktab_generalsubtab.png?alt=media)

   **Note:** The screenshot above is for the **Network** tab of the Controller 7000. The differences for the from the Controller 6000 are:

   * there is an additional **OneLink** option in the 'Network Method' section on the Controller 7000.

     OneLink utilises Gallagher Cloud Services to enable Controller 7000s to connect to the on-premises Command Centre Server over the internet. It does not appear for Controller 6000s as they do not support OneLink connection. See [OneLink Configuration](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/onelink-configuration.md) for further instructions.
   * Controller 6000 properties only have the **General** sub-tab, whereas Controller 7000s have two additional sub-tabs:
     * The **Dual Ethernet** sub-tab includes configuration options for a secondary ethernet adapter. See [Configuring Secondary Ethernet operation mode](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/configuring-secondary-ethernet-operation-mode.md) for further instructions.
     * The **802.1x** sub-tab enables sites to configure Controller 7000s for 802.1x. See [Configuring a Controller 7000 or 7000 Single Door for 802.1x](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/configuring-a-controller-7000-or-7000-single-door-for-802-1x.md) for further instructions.
2. Enter the **MAC Address** for the Controller.

   The MAC Address for each Controller is stuck to the actual Controller PCB.

   **Note:** A MAC address range is included in your license file and will be checked against when a MAC address is saved here. If you receive a "MAC address out of range" error message, check your license file to see what range is valid.
3. Entering the **Serial Number** of the Controller is optional and can be found printed on one of the Controller labels.
4. Click the radio button for the appropriate **Network Method**, i.e. either **Automatic (DHCP)** or **Manual**.

   **Automatic (DHCP)** is the preferred method, but if you select **Manual** the **Controller Address** section changes as shown below:

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-be74178e745e10c2371c03c4b543259d0f738f8e%2Fcontroller6000_networktab_automaticdhcp.png?alt=media)
5. Enter the **IP Address**, (i.e. TCP-IP Address), **Subnet** and **Gateway** information for the Controller.

   This information will be provided by the IT Department for the organisation, or the IT provider of the network.

   **Note:** By default, the **Subnet** and **Gateway** fields are populated with the first subnet mask and gateway from one of the server's ethernet adaptors with a non-zero gateway.

   If there is no IT support for this site, and it is a localised and dedicated LAN built for Command Centre, there are some standards that you can apply to the configuration of the Controllers, as described next:

   <table><thead><tr><th width="133">Configuration Parameter</th><th>Description</th></tr></thead><tbody><tr><td>IP Address</td><td><p>The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of TCP-IP address space for private networks:<br>Class A From 10.0.0.0 to 10.255.255.255<br>Class B From 172.16.0.0 to 172.31.255.255<br>Class C From 192.168.0.0 to 192.168.255.255<br>These TCP-IP addresses have been set aside specifically for use when it is not necessary (or desirable) for the attached devices to be available on the Internet. If one of these TCP-IP addresses were accidentally broadcast on the Internet they would be ignored by the routing firewall server and would cause no conflict issues.<br>The first block is a single Class "A" network number, the second block is a set of 16 contiguous Class "B" network numbers, and the third block is a set of 256 contiguous Class "C" network numbers.<br><br><strong>Notes:</strong></p><ul><li>Each device, (i.e. Computer, Printer, Controller) on the localised LAN must have a unique TCP-IP address. Each address used must however be in the same Subnet Mask range.<br>This means as an example, if you use the Class "B" TCP-IP address range, each TCP-IP address assigned to the localised LAN must start with 172.16 and then be unique, (e.g. 172.16.0.1, 172.16.0.2, 172.16.0.3, 172.16.0.4, etc.)</li><li>Command Centre or Command Centre 9.40 relaxes duplicate IP address restrictions to better support DHCP, NAT, and OneLink configurations. Controllers are no longer blocked from sharing IP addresses, and IP details are no longer cleared when duplicates are detected. Network IP uniqueness remains the responsibility of the site configuration.</li></ul></td></tr><tr><td>Subnet</td><td>There are default Subnet Mask settings for the three class categories:<br><br>Class A From 10.0.0.0 to 10.255.255.255<br>Default Subnet Mask is 255.0.0.0<br>Class B From 172.16.0.0 to 172.31.255.255<br>Default Subnet Mask is 255.255.0.0<br>Class C From 192.168.0.0 to 192.168.255.255<br>Default Subnet Mask is 255.255.255.0<br>Use the associated Subnet Mask appropriate for the TCP-IP class used. The Subnet Mask differentiates between the network and client parts of the TCP-IP address. The "255's" identify the network section and the "0's" identify the clients.<br>For a Class "B" TCP-IP address the network identification numbers are "172.16" and will be identical for each TCP-IP address on that network. The following two numbers of the TCP-IP address uniquely identify each device on the network.</td></tr><tr><td>Gateway</td><td>Gateway settings when used in general LAN configurations provide a path to a different network environment. In a localised LAN environment for Gallagher there is no physical connection to a different network, so the Gateway setting is ineffective.<br>On single Subnet networks, it is recommended the Gateway information be set exactly as the TCP-IP address used, or alternatively 0.0.0.0</td></tr><tr><td>Enable custom DHCP</td><td>This checkbox allows sites to use their own Dynamic Host Configuration Protocol (DHCP) service to assign IP addresses to their controllers automatically, without physically needing to be at the controller.<br>See <a href="https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/configuring-a-controller-for-dhcp.md">Configuring a Controller for DHCP</a> for further detail.</td></tr></tbody></table>
6. Click the radio button for the appropriate **Server Address**, (i.e. either **Default Server Address** or **Custom Server Address** ).

   If you selected **Automatic (DHCP)** for the "Network Method", and you select **Custom Server Address**, this section will change as shown below:

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-78fe37918cc46b64318f4ea5a50fb34e7bf9b6d9%2Fcontroller6000_networktab_customserveraddress_automaticnwmethod.png?alt=media)

   If you selected **Manual** for the "Network Method", and you select **Custom Server Address**, this section will change as shown below:

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ba84d4309ea4cb51aeb10548cc61854a995aa7f9%2Fcontroller6000_networktab_customserveraddress_manualnwmethod.png?alt=media)
7. If this Controller is separated from the Server by a firewall, so it can still contact the Command Centre Server, enter the IP Address.
8. Controllers must be able to make use of Domain Name Servers (DNS) in disaster recovery situations, especially where backup servers reside on different subnets.

   See [Configuring DNS Servers for Controllers](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/configuring-dns-servers-for-controllers.md) for the procedure.
9. Controller 6000s and 7000s support both IPv4 and IPv6. A Controller that needs to communicate with IPv4 external systems must be assigned IPv4 addresses as per existing configuration procedures.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>To assign an IPv6 address additional to IPv4:</strong></p><ol><li>The only supported method of address allocation for the Controller 6000 and 7000 is an auto configuration via router advertisements. The Controller 6000 and 7000 will only accept IPv6 auto configuration if it is either already configured for IPv6 communication or the Controller was booted with DIP switch 2 on.</li><li>Check the <strong>Enable IPv6</strong> checkbox.<br>The <strong>Enable IPv6</strong> section changes as shown below if you selected <strong>Manual</strong> as the Network Method above:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-cf3f7bace6ee9748c97ff5ee6062f41d7300121d%2Fcontroller6000_networktab_enableipv6.png?alt=media" alt=""></li><li><p>Click either the <strong>Network Prefix</strong> or <strong>Address</strong> radio button and enter appropriate details.</p><ul><li><strong>Network Prefix</strong> contains a pre-populated network prefix combo field containing all subnet prefixes available at the Command Centre server machine. The interface identifier of the Controller is pre-populated based on the entered MAC address.</li><li>The <strong>Address</strong> field is free text field to provide complete IPv6 address instead. The given address shall be from the list of IPv6 addresses assigned to the Controller through the auto-configuration process. Hostname is not supported here.</li></ul></li></ol></div>

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>To assign only an IPv6 address:</strong></p><ul><li>IPv4 address can be NULL in this case.</li><li>DIP switch 3 should be ON as well as DIP switch 2.</li><li>Reset is the same as above.</li></ul></div>
10. Click the **Enable NAT** checkbox if your site wants Command Centre to communicate with multiple Controllers on different networks.

    Selecting **Enable NAT** expands the section as shown below:

    ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-79af42012b8788960fbeab782e9d3b224ac7ff85%2Fcontroller6000_networktab_enablenat.png?alt=media)

    Refer to [Configurable Ports - NAT Solution](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/configurable-ports-nat-solution.md) for further detail.

</details>

<details>

<summary>Inputs tab <em>(if the Controller has a Plug-in Module connected)</em></summary>

1. Click the **Inputs** tab.

   This tab allows you to link inputs to the Controller. The number of inputs available will depend on what was selected for the **Plug-in Module** (on the **Setup** tab), as follows:

   <table><thead><tr><th width="158">If...</th><th>Then there will be a maximum of...</th></tr></thead><tbody><tr><td>4H or 4R Module,</td><td>12 inputs.</td></tr><tr><td>8H or 8R Module,</td><td>24 inputs.</td></tr></tbody></table>

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-1a5dd33adb2dd187f08ff788f575df1e4c1df65a%2Fcontroller7000_inputstab_inputs.png?alt=media)

   The screenshot above is for the **Inputs** tab of the Controller 7000. The **Reserved Inputs** sub-tab allows sites whose Controller 7000s are housed in cabinets to use physical tamper inputs (rather than optical tampers), and to also reserve power supply inputs and create alarms with the Controller 7000 as a source.

   **Notes:**

   * The Controller 6000 does NOT have a **Reserved Inputs** sub-tab.
   * Operators require the "Edit Site" privilege to reserve inputs.
2. Assign each Input to the correct address. For details on how to create an Input, refer to [Creating Inputs and Outputs](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-inputs-and-outputs.md).
3. If applicable, click the **Reserved Inputs** sub-tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-847e6bde4015290cc8be0e72c7a81be48fdd2dc5%2Fcontroller7000_inputstab_reservedinputs.png?alt=media)

   By default, all the Reserved Inputs will have "—None Selected --". They will however already be populated if the **Reserve inputs on creation of I/O module** checkbox has been ticked on the Server Properties **Reserved Input Defaults** tab.
4. If the fields are not already populated or have been changed, and you want to set the site defaults from the Server Properties, click the **Use Site Defaults** button, otherwise select the required input for each field.

   The number of inputs available for each field is determined by what type of Plug-in Module was selected on the **Setup** tab, as follows:

   <table><thead><tr><th width="158">If...</th><th>then each field will have...</th></tr></thead><tbody><tr><td>4H or 4R Module,</td><td>1 - 12 inputs to select from.</td></tr><tr><td>8H or 8R Module,</td><td>1 - 24 inputs to select from.</td></tr></tbody></table>

   **Notes:**

   * If Input 1 is already in use, ticking the **Use Input 1 for cabinet tamper** checkbox will generate the following message:

     *"Input is assigned as a tamper input. Please remove the first input from this controller."*
   * If you attempt to assign an input more than once, the following error message displays:

     *"Cannot reserve input, it is already allocated"*.
   * When reserved inputs are configured for **Cabinet Front Tamper** and **Cabinet Rear Tamper**, the optical tampers on the Controllers **Status and Overrides** tab are disabled, (i.e. the **Disable Front Tamper** and **Disable Rear Tamper** checkboxes).
   * The **Clear All** button can be used to clear reserved inputs and return them to "—None Selected --".

   As inputs are reserved, they become disabled (greyed out) on the **Inputs** sub-tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-b660a8e559200459b74b037b094a5cb25c0abe5e%2Fcontroller7000_inputstab_inputs2.png?alt=media)

</details>

<details>

<summary>EOL Resistors tab</summary>

This tab allows you to configure End-of-line (EOL) resistances for the Controller.

For further detail see [Configuring EOL Resistors for devices](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/configuring-eol-resistors-for-devices.md).

</details>

<details>

<summary>HBUS Devices tab</summary>

This tab allows you to assign HBUS devices to the Controller.

For further detail see [Configuring HBUS Devices](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/configuring-hbus-devices.md).

</details>

<details>

<summary>Software tab</summary>

This tab allows you to assign device software to the Controller.

Refer to either [Assigning Device Software to devices](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/device-software/assigning-device-software-to-controllers.md), or [Upgrading Multiple Controllers](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/device-software/upgrading-multiple-controllers.md) if you are upgrading the firmware on multiple Controllers.

</details>

7. Click **OK**.

### Result

A Controller has been created. The Controller name now displays within the **Hardware** List Window.

***

### Hints

{% hint style="info" %}
**Re-sync Databases**

Performing a **Re-sync Databases** action on a Controller (via the Controller context menu), deletes the card database at the Controller and automatically re-populates it.
{% endhint %}

{% hint style="info" %}
**Purge Pending Messages**

Performing a **Purge Pending Messages** action on an offline Controller (via the Controller context menu), will clear the queue of outgoing messages and bring the Controller online. Operators require either the "Advanced User" or "Maintenance Override" privilege in the division of the Controller to perform this action.

**WARNING:** The Purge Pending Messages action is only intended to be used on an offline Controller that will be restarted with Dip Switch 2 active. Dip Switch 2 indicates to the server that the Controller wants all configuration data, if the Controller is only offline due to network connectivity and the message queue is cleared then important configuration messages may be purged with this tool.
{% endhint %}


---

# 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://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-controllers/creating-controller-7000s-or-6000s.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.
