> 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/external-systems/configuring-an-external-system.md).

# Configuring an External System

### Introduction

This topic describes how to configure an External System in Command Centre.

An External System in Command Centre represents a connection to middleware, (i.e. a third-party developed application or service running on a Windows PC that interfaces to an external system).

**Note:** Operators require the "Edit Site" operator privilege to be able to add, modify and delete External Systems.

***

### Configuration

To configure an external system, perform the following procedure:

1. Click **Configure** from the menu bar, then **External Systems**.

   The **External Systems** 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\...External System**.

   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. Click the **Alarm Instructions** tab, and configure as required.

   For further detail see [Alarm Instructions tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/alarm-instructions-tab.md).
6. Click each tab in turn and configure the external system properties as required:

<details>

<summary>API Setup tab</summary>

1. Click the **API Setup** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ed0ce78f416f851c35ddc2f1a0ea106f66ce5b4e%2Fextsystem_connectionstab.png?alt=media)
2. Select the appropriate **Controller** from the drop-down list.

   **Note:** If a Controller is selected, the **Server** field becomes compulsory.
3. Select the appropriate External System Server from the **Server** drop-down list.
4. Click the appropriate radio buttons in the "Identity" section of this screen.

   <table><thead><tr><th width="132">Radio Button</th><th>Description</th></tr></thead><tbody><tr><td>Unique</td><td>This radio button allows you to assign an identity string to this External System such that all FTCAPI communication related to this item will be tagged with the assigned identity.<br>This field is limited to a maximum of 64 characters.</td></tr><tr><td>Same as</td><td>This radio button allows you to link the identity of this External System to be the same as another.<br><br><strong>Note:</strong> If 'Same as' is selected, the <strong>Configuration</strong> tab disappears, therefore go to Step 7.</td></tr></tbody></table>

</details>

<details>

<summary>Configuration tab</summary>

1. Click the **Configuration** tab.

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

   This screen allows you to assign a system type and a configuration string to the External System. The **System Type** drop-down list defaults to "Generic", and will only be populated with the supported middleware 'plug-in' system types it finds in your Command Centre license file.
2. Is your site licensed for middleware plug-ins?

   <table><thead><tr><th width="96">If...</th><th width="360">and you...</th><th>then go to...</th></tr></thead><tbody><tr><td>yes</td><td>want to use a plug-in for this External System,</td><td>Step 3.</td></tr><tr><td>yes</td><td>do <strong>not</strong> want to use a plug-in for this External System,</td><td>Step 7.</td></tr><tr><td>no</td><td></td><td>Step 7.</td></tr></tbody></table>
3. Select the middleware plug-in to be used, from the **System Type** drop-down list.

   **Note:** The "Configuration" section of this screen becomes populated according to the plug-in selected, (e.g. the following screen example demonstrates how the screen will look when the **ASCII Text** plug-in is selected). For instructions on how to configure your selected plug-in, refer to the appropriate release note, located in the `‘Utilities\System Interfaces’` folder of the Gallagher Installation files.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-9992cc7de6bc3c30ca12ecc7edf5961ca2c5573d%2Fextsystem_configurationtab_asciitext.png?alt=media)
4. For the ASCII Text plug-in, enter the **IP Address** and **Port** of the terminal server that acts as a Serial-TCP/IP protocol converter for the plug-in.

   **Note:** You must use a terminal server that allows multiple concurrent connections. This is required as the plug-in creates a new separate connection for each message and some terminal servers take a long time to close them. This has been tested using a ‘Moxa Nport 5150 serial device server’.
5. For the ASCII Text plug-in, complete any other "Configuration" details as required:

   <table><thead><tr><th width="192">Field</th><th>Description</th></tr></thead><tbody><tr><td>Maximum number of messages to queue</td><td>This field determines the maximum number of messages that the ASCII Text plug-in will hold in a queue while the connection between the FTCAPI Middleware Framework (FMF) and the Terminal Server is down. When the queue is full the oldest message is discarded when a new message arrives.<br>Limited to a maximum of 500 messages.</td></tr><tr><td>Discard messages after</td><td>Checking this field allows you to enter the length of time that messages will be held in the ASCII Text plug-ins queue.<br>Limited to 1-9999 seconds.</td></tr></tbody></table>

</details>

7. Click the **Cameras** tab if you want to associate a DVR Camera(s) with this External System.

   For further details see [Cameras tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/cameras-tab.md).
8. Click the **Icons** tab if you want to change the Icon Set for this external system.

   For further details regarding the **Icons** tab, see [Icons](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/icons.md).
9. Click the **Custom Fields** tab if you want to add and assign a custom field value to this external system.

   For further details regarding the **Custom Fields** tab, see [Custom Fields](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/custom-fields.md).
10. Click the **Notes** tab if you want to add a note(s) about this external system.

    For further details regarding the **Notes** tab, see [Notes](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/notes.md).
11. Click **OK** to exit and save your changes.

    Click **Cancel** to exit without saving your changes.

    Click **Apply** to save your changes and stay in this window.

### Result

A new External System has been created and displays in the External Systems window under the 'External System Server', with no children.

**Note:** A new External System can be saved even if some of the properties are not entered, however it will not function correctly until all the properties are entered.

***

### Editing and Deleting external systems

Refer to [Editing items](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/editing-items.md) and [Deleting items](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/deleting-items.md) for procedures on how to edit and delete external systems.

**Notes:**

* The External System will only allow the deletion if it does not have any children, (i.e. no External System Items referencing it).
* If an item is on a Site Plan you will not be able to delete it until it is removed from the Site Plan.

### In This Section

* [Configuring an External System Item](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/external-systems/configuring-an-external-system/configuring-an-external-system-item.md)


---

# 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/external-systems/configuring-an-external-system.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.
