> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_inboundqueue.md).

# comtrol\_InboundQueue

{% hint style="info" %}
Generated from the staging database schema, with descriptions drafted by agents ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/db/tables/comtrol_InboundQueue.md).
{% endhint %}

## Description

One Comtrol message received, split into its fields (message type, device model, transaction ID, sequence number, status and room parts), waiting to be applied to Snapfix. Empty on staging.

<details>

<summary><strong>Table Definition</strong></summary>

```sql
CREATE TABLE `comtrol_InboundQueue` (
  `id` int NOT NULL AUTO_INCREMENT,
  `uuid` varchar(255) DEFAULT NULL,
  `basicauth_base64` varchar(255) DEFAULT NULL COMMENT 'made up of the user and pass',
  `uhll_mm_messagetype` varchar(255) DEFAULT NULL COMMENT '2 character. usually 17 maid code',
  `uhll_dmm_devicemanufmodel` varchar(255) DEFAULT NULL COMMENT '3 character. we will use the number 353 but we have to confirm this with Comtrol',
  `uhll_rr_reserved` varchar(255) DEFAULT NULL COMMENT '2 digit. always set to 00',
  `uhll_tttt_transactionid` varchar(255) DEFAULT NULL COMMENT '4 digit. counter from 0001 to 9999 and wraps back to 0001',
  `uhll_ssss_seqno` varchar(255) DEFAULT NULL COMMENT '4 digit. counter from 0001 and the last message in a sequence will be 9999',
  `uhll_status_ddd_dfid` varchar(255) DEFAULT NULL COMMENT '3 digit descriptor for the type of data this one message element represents',
  `uhll_status_lll_length` varchar(255) DEFAULT NULL COMMENT '3 digit descriptor for the length of the data',
  `uhll_status_xx_data` varchar(255) DEFAULT NULL COMMENT 'The data itself with a total length of lll bytes',
  `uhll_room_ddd_dfid` varchar(255) DEFAULT NULL COMMENT '3 digit descriptor for the type of data this one message element represents',
  `uhll_room_lll_length` varchar(255) DEFAULT NULL COMMENT '3 digit descriptor for the length of the data',
  `uhll_room_xx_data` varchar(255) DEFAULT NULL COMMENT 'The data itself with a total length of lll bytes',
  `snapfixSynced` tinyint DEFAULT '0',
  `fDeleted` tinyint DEFAULT '0',
  `fCreatedTs` bigint DEFAULT NULL,
  `fModifiedTs` bigint DEFAULT NULL,
  `fDeletedTs` bigint DEFAULT NULL,
  `fServerTs` bigint DEFAULT NULL,
  `uuid_tUser_CreatedBy` varchar(255) DEFAULT NULL,
  `uuid_tUser_ModifiedBy` varchar(255) DEFAULT NULL,
  `uuid_tUser_DeletedBy` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `uuid` (`uuid`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=latin1
```

</details>

## Columns

| Name                        | Type         | Default | Nullable | Extra Definition | Comment                                                                          |
| --------------------------- | ------------ | ------- | -------- | ---------------- | -------------------------------------------------------------------------------- |
| id                          | int          |         | false    | auto\_increment  |                                                                                  |
| uuid                        | varchar(255) |         | true     |                  |                                                                                  |
| basicauth\_base64           | varchar(255) |         | true     |                  | made up of the user and pass                                                     |
| uhll\_mm\_messagetype       | varchar(255) |         | true     |                  | 2 character. usually 17 maid code                                                |
| uhll\_dmm\_devicemanufmodel | varchar(255) |         | true     |                  | 3 character. we will use the number 353 but we have to confirm this with Comtrol |
| uhll\_rr\_reserved          | varchar(255) |         | true     |                  | 2 digit. always set to 00                                                        |
| uhll\_tttt\_transactionid   | varchar(255) |         | true     |                  | 4 digit. counter from 0001 to 9999 and wraps back to 0001                        |
| uhll\_ssss\_seqno           | varchar(255) |         | true     |                  | 4 digit. counter from 0001 and the last message in a sequence will be 9999       |
| uhll\_status\_ddd\_dfid     | varchar(255) |         | true     |                  | 3 digit descriptor for the type of data this one message element represents      |
| uhll\_status\_lll\_length   | varchar(255) |         | true     |                  | 3 digit descriptor for the length of the data                                    |
| uhll\_status\_xx\_data      | varchar(255) |         | true     |                  | The data itself with a total length of lll bytes                                 |
| uhll\_room\_ddd\_dfid       | varchar(255) |         | true     |                  | 3 digit descriptor for the type of data this one message element represents      |
| uhll\_room\_lll\_length     | varchar(255) |         | true     |                  | 3 digit descriptor for the length of the data                                    |
| uhll\_room\_xx\_data        | varchar(255) |         | true     |                  | The data itself with a total length of lll bytes                                 |
| snapfixSynced               | tinyint      | 0       | true     |                  | 0 = pending, 1 = applied, -1 = failed.                                           |
| fDeleted                    | tinyint      | 0       | true     |                  |                                                                                  |
| fCreatedTs                  | bigint       |         | true     |                  |                                                                                  |
| fModifiedTs                 | bigint       |         | true     |                  |                                                                                  |
| fDeletedTs                  | bigint       |         | true     |                  |                                                                                  |
| fServerTs                   | bigint       |         | true     |                  |                                                                                  |
| uuid\_tUser\_CreatedBy      | varchar(255) |         | true     |                  |                                                                                  |
| uuid\_tUser\_ModifiedBy     | varchar(255) |         | true     |                  |                                                                                  |
| uuid\_tUser\_DeletedBy      | varchar(255) |         | true     |                  |                                                                                  |

## Viewpoints

| Name                                                                                     | Definition                                                                                                                                                               |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [integrations](https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-14.md) | Property management system (PMS) integrations (mappings, room statuses, inbound and outbound queues, webhooks), Deputy, and the keys of the Open API and the vendor API. |

## Constraints

| Name    | Type        | Definition             |
| ------- | ----------- | ---------------------- |
| PRIMARY | PRIMARY KEY | PRIMARY KEY (id)       |
| uuid    | UNIQUE      | UNIQUE KEY uuid (uuid) |

## Indexes

| Name    | Definition                         |
| ------- | ---------------------------------- |
| PRIMARY | PRIMARY KEY (id) USING BTREE       |
| uuid    | UNIQUE KEY uuid (uuid) USING BTREE |

## Relations

```mermaid
erDiagram


"comtrol_InboundQueue" {
  int id PK
}
```

***

> Generated by [tbls](https://github.com/k1LoW/tbls)


---

# 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.snapfix.com/engineering-reference/db/tables/comtrol_inboundqueue.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.
