# Optimate BGYS

## Connection Requirements

{% stepper %}
{% step %}

### IP

IP Address of the Optimate BGYS.
{% endstep %}

{% step %}

### Port

Port number of the Optimate BGYS.
{% endstep %}

{% step %}

### Username

Username of the Optimate BGYS that has access to API.
{% endstep %}

{% step %}

### Password

Password of the Optimate BGYS that has access to API.
{% endstep %}

{% step %}

### View ID

This is the **reference for the View record** from which data will be read. It accepts values of type **number** or **string**.

* **Number format:** The unique ID of the View (e.g., `5`).
* **String format:** The full system name (`{Module.SystemName}.{View.SystemName}`, e.g., `MyModule.MyView`).
  {% endstep %}

{% step %}

### Profile ID

This is the **reference for the Profile record** to be used during data reading. It accepts values of type **number** or **string**. The requesting user must be a member of the selected profile.

* **Number format:** The unique ID of the Profile (e.g., `5`).
* **String format:** The system name of the Profile (e.g., `MyProfile`).
  {% endstep %}

{% step %}

### Hostname Field

The name of the column in your list that contains the device hostnames.
{% endstep %}

{% step %}

### IP Address Field

The name of the column in your list that contains devices IP address. This field is optional.
{% endstep %}

{% step %}

### First Seen Field

The name of the column in your list that contains devices first seen field. This field is optional.
{% endstep %}

{% step %}

### Last Seen Field

The name of the column in your list that contains devices last seen field. This field is optional.

{% hint style="info" %}
First seen and last seen fields dates will be displayed in the format **YYYY-MM-DDTHH:MM:SS.ssssssZ** (e.g., `2025-08-11T19:45:32.123456Z`), which is an ISO 8601 UTC timestamp or in the Epoch format (e.g., `1708430400`). You need to change the formats if you want to view these fields. You can add the remaining fields as you wish.
{% endhint %}
{% endstep %}

{% step %}

### SSL

Use SSL for connection. (default: **Encrypted**).
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
Please perform a connection test to ensure there is a valid connection to the Optimate BGYS host. When the discovery operation is finalized you will be able to see the details on the Assets page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.octoxlabs.com/adapters/adapters/optimate-bgys.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
