> 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/command-centre-client/configuring-command-centre/administration/site-plans/creating-new-site-plan-items/site-plan-design-tools/add-widget.md).

# Add Widget \<W>

Use the following procedure to select a widget to be displayed on a Site Plan:

**Note:** Value widgets do not show the alarm state of the item.

1. Click the ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-aff8707c2fefa278fb8b4419abdfe88d8b14e195%2Fsiteplan_addwidgetbutton.png?alt=media) **Add Widget** button on the Designer Toolbar. Alternatively, press < **W** >.

   A browse tool displays.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-05269ea8039fe2b73c00dff51ea29927684481ef%2Fsiteplan_addwidgetbrowsetool.png?alt=media)
2. Click on the widget you want displayed on the Site Plan.

   The widget appears on the Site Plan.

   A display properties panel also appears to the right-hand side of the Designer Panel for the currently selected widget, (i.e. the widget with the orange square around the outer edge). Some of the display properties are common to all widget types.

   Fence Voltage widget

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

   Zone Count widget

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-053d35832d1dc2ef01855f860788a4622f0f1d6d%2Fsiteplan_widgetdisplayproperties2.png?alt=media)

   Cardholder Count widget

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-24324b2e86359ef23d6c15730cb97ea510e38326%2Fsiteplan_widgetdisplayproperties3.png?alt=media)

   **Note:** If no widget is selected the properties panel is not visible.
3. Click the **Close** button.

   The browse tool closes.
4. What type of widget have you added?

   <table><thead><tr><th width="166">If a...</th><th>then you can associate...</th></tr></thead><tbody><tr><td>Fence Voltage widget,</td><td>a Fence Zone with this widget, by clicking on the <strong>Associated Fence Zone</strong> field, and selecting one from the Fence Zones listed.<br><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-e5e05324be3889fbd7a8c44b0d71fce8fdfabb3a%2Fwidget_associatedfencezone.png?alt=media" alt=""><br><br><strong>Note:</strong> If necessary, search for the Fence Zone you want by entering characters in the Search field and/or apply the Division filter to narrow search results.<br>The name of the Fence Zone selected also populates the <strong>Label</strong> field.</td></tr><tr><td>Zone Count widget or a Cardholder Count widget,</td><td><p>an Access Zone(s) with this widget, as follows:</p><ol><li>Click on the <strong>Manage Access Zones</strong> button.<br>The Manage Access Zones pop-up displays.<br><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-336e1875dc63a19adccb253589de7213a130878d%2Fsiteplan_widget_manageaccesszones_popup.png?alt=media" alt=""></li><li>If necessary, search for the Access Zone(s) you want by entering characters in the <strong>Search</strong> field and/or apply the Division filter to narrow search results.<br>The grid becomes populated with Access Zones that match the search criteria.</li><li>Check the Access Zone you want, or multiple Access Zones by holding down the &#x3C;<strong>Ctrl</strong>> key while you check each Access Zone, and click the <img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-92204bd9709ee1a4359d9fd489c8b5975d10d93b%2F42714.png?alt=media" alt=""> <strong>Add Selected</strong> button.<br>The selected Access Zone(s) appear in the Selected Access Zones grid.</li><li>Click the <strong>OK</strong> button.<br>The Manage Access Zones pop-up closes and the Associated Access Zones grid is populated with the selected Access Zone(s).<br><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-032a06b31c207078d3e130a3942c43b2c7a9135b%2Fwidget_associatedaccesszones.png?alt=media" alt=""></li></ol></td></tr></tbody></table>
5. If required, the widget name that appears on the Site Plan can be changed by typing a new name in the **Label** field, or it can be removed altogether by not populating the **Label** field.
6. Perform the necessary action, as follows:

<details>

<summary>Resize the widget</summary>

1. Move the mouse cursor anywhere on the widget.
2. When the cursor changes to a "four-headed arrow" click the mouse button.

   An orange square appears around the widget and name.
3. Click the appropriate **Size** option, (i.e. Small, Medium or Large).

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

   The widget changes size accordingly, but the name of the widget does not resize with it.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-c44a330abbf72288685d125407fcf8ab2c9e25b1%2Fwidgeticon_1.png?alt=media)
4. Click the mouse button anywhere away from the widget so the orange square around the outer egde disappears.

</details>

<details>

<summary>Move the widget</summary>

1. Move the mouse cursor to anywhere on the widget.
2. When the cursor changes to a "four-headed arrow" click and hold down the mouse button.
3. Drag the widget to its new position and release the mouse button.

   **Note:** If you have given the widget a name, the name moves with the widget.
4. Click the mouse button anywhere away from the widget so the orange square around the outer edge disappears.

</details>

<details>

<summary>Move the widget name</summary>

1. Move the mouse cursor to anywhere on the widget label, and when the cursor changes to a "four-headed arrow" click and hold down the mouse button.
2. Drag the label to its new position and release the mouse button.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-10cf4970c7f70a28975c39a44d545a452d8a9cd1%2Fwidgeticon_2.png?alt=media)
3. Click the mouse button anywhere away from the widget so the orange square around the outer edge disappears.

</details>

7. Check the **Show Value** checkbox if you want the relevant value to be displayed on the widget, (i.e. Fence Voltage, Zone Count or Cardholder Count).

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-9333ebba4a60a9c5cf70da6d4428416d8fd1ea54%2Fwidgeticonvoltage.png?alt=media) ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-bd6ffb99ff50d01b36dec487e847a37e24c308d4%2Fwidgeticonaccesszone.png?alt=media) ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-7d5b458bd975a2408015f7b7d9b750e963698783%2Fwidgeticonchcount.png?alt=media)

   If you check the **Show Value** checkbox for the Cardholder Count widget, you then have the option to either include **All Cardholders Entries**, or **Cardholders Entries in the last \<xx> hours** which allows you to configure a time span.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-21513fe653279b99a3088b2491814d69ea92e99f%2Fwidget_chcount_showvalue.png?alt=media)

   **Note:** Cardholders will be removed from the count if their entry to the zone occurred more than \<xx> hours in the past, and if there are multiple zones being monitored and the person moves between those internal zones.
8. The Zoom level hide/show options (shown below) will be available if the Site Plan is a **Site Map / Building Plan** type, (i.e. it allows progressive disclosure).

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

   These checkboxes allow you to configure whether the widget will be visible or not on the Site Plan, depending on the zoom level applied.

   **Notes:**

   * They show the current zoom value if they are not ticked.
   * If the item is in alarm the hide/show settings are ignored.
9. Click the ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-fe05ac2129433f6dc27bbda571a1406e293e9910%2Fsiteplan_savebutton.png?alt=media) **Save** button to save your changes. Alternatively, press < **Ctrl** + **S** >.

   **Note:** The colour of the widget in operational mode will depend on the voltage and thresholds that have been configured for the Fence Zone in the Configuration Client.

   **Fence Voltage widget**

   | <p><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-395278950b25b53be27da0d86593c222ac943285%2Fwidget_fencezoneok.png?alt=media" alt=""><br>Fence Zone OK</p> | <p><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-dccec446527c6d81a9e7a5216aedc94ede0754c8%2Fwidget_fencezonewarning.png?alt=media" alt=""><br>Fence Zone Warning</p> | <p><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-46cd4b2ab2fe2383ff8fbb0d238ccd5f468e4ba3%2Fwidget_fencezonealert.png?alt=media" alt=""><br>Fence Zone Alert</p> |
   | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

   **Zone Count widget**

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

   **Cardholder Count widget**

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

### Removing Widgets

Widgets can be removed from a Site Plan, as follows:

1. Click the ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-f683c46f16eb59812f01d70680a91a8cc3bc7e79%2Fsiteplan_selectbutton.png?alt=media) **Select** button. Alternatively, press < **S** >.
2. Move the mouse cursor onto the widget you want to remove.
3. When the cursor changes to a "four-headed arrow", (![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-c967973be266d1939ee43ccde25fc707e184c697%2F4headed_arrow.png?alt=media)) click the mouse button.

   An orange square appears around the widget.
4. Press the < **Delete** > button on your keyboard.

   The widget disappears from the Site Plan.


---

# 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/command-centre-client/configuring-command-centre/administration/site-plans/creating-new-site-plan-items/site-plan-design-tools/add-widget.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.
