# Admin Panel

**You can create a custom admin panel.**

* make custom data fields: numeric, text, checkbox, password
* data fields will be accessible in BJS
* admin panels can be created via BJS
* bot run customized command on field saving
* supports severals panels with titles and differents fields

**Benefits:**

* making options for saving any api keys, secure and unsecure data
* can run any BJS logic from panel. For example: it will be possible create text field with button "Send this message to all chats" from App.
* make any quick statistic and information. Bot dashboards and etc

![](https://3310729168-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LVh0yg9olT-QWqi3AYt%2F-Lt3KafBilmChcGZm0Xg%2F-Lt3MyvxZezcpNpHPTWM%2Fimage.png?alt=media\&token=f09c86ed-ce15-4dc3-bcf2-8ba4610866f5)

## Methods

### Define new Admin Panel

Admin Panel - this is a combination of several panels. Each panel have title, icon, description and one or more fields:

For adding panel:

`AdminPanel.setPanel({ panel_name: PANEL_NAME, data: PANEL_OPTIONS });`

PANEL\_OPTIONS - it is JSON option for this panel

**Example**

![](https://3310729168-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LVh0yg9olT-QWqi3AYt%2F-LtJL-ahFXM244hqD-dk%2F-LtJWZ1Vl4wcuNbjneOC%2Fimage.png?alt=media\&token=476b6bd1-95bd-42af-ad00-200a1f03ded6)

```javascript
var panel = {
  // Panel title
  title: "Admin Information",
  description: "Please fill here your admin id",
  // order index
  index: 0,
  icon: "key",
  // save button title - default "SAVE"
  button_title: "SAVE",
  // command called on saving
  // not necessary
  /* on_saving:{
     command: "/on-saving",
     // if you need user
     user_id: user_id // Get it via Bot.sendMessage(user.id)
  },
  */
  
  // Fields for this Panel
  // here 1 field only
  fields: [
    {
      name: "ADMIN_ID",
      title: "Admin ID",
      description: "you can get your admin_id with BJS Bot.sendMessage(user.id)",
      type: "string",
      placeholder: "your admin id",
      // value: 100,   // default value
      // hidden: true  // if you need hidden field. By default - false
    }
    // another fields here
    // if needed
    // ...
  ]
}

AdminPanel.setPanel({
  panel_name: "AdminInfo",
  data: panel
  // force: true // default false - save fields values
});
```

#### Force

Default is false. All old values for the fields are retained.

If true - all old values for fields are reassigned.

#### Fields

It is array of fields. One panel can have several fields. It is also possible panel without any field.

Fields can have name, value, title, description, type, placeholder and icon

#### Field type

| Type     | Description    |
| -------- | -------------- |
| checkbox | Text input     |
| integer  | Text input     |
| float    | Text input     |
| string   | Text input     |
| password | Password input |
| text     | Text field     |

###

### Getting field value from Panel

{% hint style="success" %}
Use this method for getting one value from panel
{% endhint %}

```javascript
var admin_id = AdminPanel.getFieldValue({
  panel_name: "AdminInfo", // panel name
  field_name: "ADMIN_ID" // field name
})

Bot.sendMessage(admin_id)
```

### Setting field value to Panel

{% hint style="success" %}
Use this method for setting one value to panel
{% endhint %}

```javascript
var result = AdminPanel.setFieldValue({
  panel_name: "AdminInfo", // panel name
  field_name: "ADMIN_ID", // field name
  value: 15236125
})

Bot.sendMessage(result) // true
```

###

### Getting all fields values from Panel

{% hint style="success" %}
Use this method for getting several/all values from panel
{% endhint %}

```javascript
var values = AdminPanel.getPanelValues("AdminInfo");
Bot.inspect(values);
// will be like:
// { ADMIN_ID: 100 }
```

###  

### Getting panel data

```javascript
var panel = AdminPanel.getPanel("AdminInfo")
Bot.inspect(panel);

// can modify panel
// panel.fields[0].value = 1000
// panel.fields[0].tite = "my admin id"
// AdminPanel.setPanel("AdminInfo", panel);
```

###

### Getting panel field data

```javascript
var panel_field = AdminPanel.getPanelField({
  panel_name: "AdminInfo", // panel name
  field_name: "ADMIN_ID" // field name
})

Bot.inspect(panel_field);
```

### Icons

You can use all icons from [https://ionicons.com](https://ionicons.com/)

## Good practices

{% hint style="success" %}
Use admin panels to create a **configuration**
{% endhint %}

Define Admin Panels in `/config` command with `AdminPanel.setPanel` method.

Then use `AdminPanel.getPanelValue` method for getting any field's value

{% hint style="success" %}
Use admin panels to create a bot **dashboard**
{% endhint %}

Panel without fields can dispay any informations. Use this.

{% hint style="success" %}
Use admin panels to create admin reactions
{% endhint %}

You can launch any bot command on panel saving. It is good for making any admin command execution. Use `on_saving`: 

```javascript
var panel = {
  // Panel title
  title: "Call secure command",
  description: "It is secure command",
  // order index
  index: 0,
  icon: "key",
  // save button title - default "SAVE"
  button_title: "RUN",
  // command called on saving
  // not necessary
  on_saving: {
     command: "/secure-command",
     // if you need user
     user_id: user_id // Get it via Bot.sendMessage(user.id)
  }
}

AdminPanel.setPanel("SecureCommand", panel);
```


---

# 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://help.bots.business/bjs/admin-panel.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.