# How to create a custom module

First go to [console.symbyoz.io](https://console.symbyoz.io)

![](/files/-LRln26ZS3m5ek9I3bSz)

If you don't know your back-office login & password click to "**Modify**" and copy the URL to a new page.

![](/files/-LRlndkD8ZzlgSLRv8Ei)

Connect to the back-office

![](/files/-LRlo-iK5EddLVTQq5PS)

On a left menu, go to : **Configuration** >> **Modules**

![](/files/-LRlqXO0nVlxXbl0p5iy)

Click on green button **Add new**

![](/files/-LRltFZkHhUW7Pre7Vq6)

Add Module Title (name appear in Back-office)\
Add Module Name (database classe name)\
Click on green button **Create**

![](/files/-LRlqz65Zbn52tWVFuyo)

Your module is now visible in module liste. \
Now we must add custom field inside\
Click to yellow button **Edit**

![](/files/-LRlsyll-_vTWiAhDo5-)

Click on **Module custom fields**&#x20;

![](/files/-LRluBv3mdJaqc77eiUc)

Here yo can see all fields inside your module. \
\&#xNAN;*Id*, *Created at* and *Updated at* are default fields from mongoDB document.\
Click to **Add New button** for add a new custom field

![](/files/-LRlvJiXAjaoV_s4ZbdW)

* [ ] Add a Field name
* [ ] Add a Field title
* [ ] Choose input type inside 25 customs fields type.
* [ ] Click to green button **Create**&#x20;

{% hint style="info" %}
The database, only manages 9 types of fields. \
You can change the type of a field in the back-office at any time, as long as it remains in the same database category (Array, String, Date, Number, File, Pointer, Boolean,  ...) \
Exemple : \
You can change **Text** to **Email** or **Phone...**\
But you cannot change **Text** to **Array**
{% endhint %}

![](/files/-LRlzDTaaowg2chvQYDw)

You can organize the display order of fields by Drag & Drop\
You can choose is a field is :&#x20;

* Compulsory
* Visible only by super-admin in back-office
* Unique
* Visible in filter
* Visible in module form (create or edit)
* Visible in module listing

{% hint style="info" %}
For generate your custom module you must click on  button  **Generate**
{% endhint %}

![](/files/-LRm0aSPmudYOD6HZj6Y)

Your custom module is now ready to use\
You can acces directly from left menu

![](/files/-LRm2CQ0pbloL45D_wuM)

![](/files/-LRm2Eg6l8zljlTg-u4x)


---

# 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.symbyoz.io/tutorials/create_new_module_symbyoz.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.
