# How to create a custom module

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlman3JlAQCkwN5xY_%2F-LRln26ZS3m5ek9I3bSz%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2022.44.49.png?alt=media\&token=14b96595-160b-40e6-8235-16cfbcd233c7)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlman3JlAQCkwN5xY_%2F-LRlndkD8ZzlgSLRv8Ei%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2022.47.43.png?alt=media\&token=f27cfb1c-aa63-4819-a887-dd176579da75)

Connect to the back-office

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlman3JlAQCkwN5xY_%2F-LRlo-iK5EddLVTQq5PS%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2022.48.39.png?alt=media\&token=f358b79c-543d-43ec-ac27-378e3a7545a3)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlp70B7xiZKTDYxw3k%2F-LRlqXO0nVlxXbl0p5iy%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.00.00.png?alt=media\&token=3d552811-d4fa-410f-9dd3-0613d0e38817)

Click on green button **Add new**

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRltFZkHhUW7Pre7Vq6%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.11.57.png?alt=media\&token=6b0a2c01-c4a1-4046-a49a-801995d31a86)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlp70B7xiZKTDYxw3k%2F-LRlqz65Zbn52tWVFuyo%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.01.59.png?alt=media\&token=32cecb8f-7ced-4c01-a468-ccc26e4cc2bd)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRlsyll-_vTWiAhDo5-%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.09.40.png?alt=media\&token=0ed2ea6e-b3d8-4d85-8212-05eae1114fe1)

Click on **Module custom fields** 

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRluBv3mdJaqc77eiUc%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.13.03.png?alt=media\&token=f12262e6-075d-4ccd-b33c-d2c37ce840c8)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRlvJiXAjaoV_s4ZbdW%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.19.38.png?alt=media\&token=770b2a2d-4954-4a58-af4a-73f04a9f3f38)

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

{% 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 %}

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRlzDTaaowg2chvQYDw%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.38.19.png?alt=media\&token=74f71827-85a9-4ae0-960f-933e4b20d096)

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

* 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 %}

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRm0aSPmudYOD6HZj6Y%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.48.44.png?alt=media\&token=5dbb578b-78ad-41c9-921c-3ca47f4b7334)

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

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRm2CQ0pbloL45D_wuM%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.54.34.png?alt=media\&token=372a6314-b9c9-4db2-8f7f-a8fcdd99d242)

![](https://2286267163-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRe_wMwHPyapTtlVxh7%2F-LRlrGBvIJH_QR8PL5pV%2F-LRm2Eg6l8zljlTg-u4x%2FCapture%20d%E2%80%99e%CC%81cran%202018-11-20%20a%CC%80%2023.54.56.png?alt=media\&token=b7b40847-499d-4d5d-ac78-ba032196a1cb)