# Glossary

The terms you'll see in FiveDash, from what an organization is to what a whitelist code is.

Source: https://fivedash.fivex.gg/docs/en/getting-started/glossary

FiveDash uses a few words with a very specific meaning. This glossary explains each one, in the order you usually run into them. The Portuguese names in parentheses are what you see when the dashboard is in Português.

## Structure

| Term                                      | What it is                                                                                                                                                                                                         |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Organization** (Organização)            | Your team's space in FiveDash. It has a name, an icon, its own address, a plan, members and one or more servers. An account can belong to several organizations and switch between them at the top of the sidebar. |
| **Organization address** (Endereço)       | The start of every dashboard URL: `/cidade-exemplo/...`. Lowercase letters, numbers and hyphens, 3 to 32 characters. Change it in **Settings → General**.                                                          |
| **Server** (Servidor) / **city** (cidade) | Each FiveM server in the organization. Each one has its own Discord bot, store, logs, rules website and CDN. The dashboard calls the server a "city" in many texts.                                                |
| **Server address**                        | A `cfx.re/join/...` link or `IP:port`, optional. It's used to show status, players and the join button in Connect.                                                                                                 |
| **Extra server** (Servidor extra)         | Each server beyond the one your tier includes. It's billed separately, with the same modules.                                                                                                                      |
| **City language** (Idioma da cidade)      | The language of what the bot writes on Discord and of that server's store, checkout, rules website and transcripts. It's separate from the dashboard's language.                                                   |

## Modules and pages

| Term                       | What it is                                                                                                                                                                               |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Module** (Módulo)        | One of the dashboard's six areas: **Discord**, **Store**, **Logs**, **Rules**, **CDN** and **Server**. The first five are added to the plan one by one; **Server** always comes with it. |
| **Page** (Página) / area   | Each item inside a module, like **Tickets** or **Orders**. Team access is given page by page.                                                                                            |
| **Overview** (Visão geral) | The first page of a module, with numbers and activity. The **Server** module's overview is each server's home page.                                                                      |
| **Coming soon** (Em breve) | Pages that show in the sidebar but don't open yet                                                                                                                                        |

## Team and access

| Term                         | What it is                                                                                                                                                                                                     |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Owner** (Dono)             | Whoever owns the organization. Has full access, handles the plan, changes roles, transfers and deletes the organization. There's only one.                                                                     |
| **Admin**                    | Sees, manages and configures every page on every server, invites members and adds servers. Only the owner changes admins.                                                                                      |
| **Member** (Membro)          | Only sees the pages and servers given to them, at the level chosen for each.                                                                                                                                   |
| **Role** (Função)            | Owner, Admin or Member                                                                                                                                                                                         |
| **Access level**             | What a member can do on a page: **None**, **View**, **Manage** or **Configure**. Each level includes the ones below it.                                                                                        |
| **View** (Ver)               | Look at the page without changing anything                                                                                                                                                                     |
| **Manage** (Gerenciar)       | Act on what's on the page: approve a whitelist, decide a suggestion, undo a punishment, mark an order as delivered                                                                                             |
| **Configure** (Configurar)   | Also change the page's settings and panels                                                                                                                                                                     |
| **Preset** (predefinição)    | A ready-made starting point for a module's access: **No access**, **Read-only**, **Full access**, **Support**, **Whitelist team**, **Moderation**, **Customer service**, **Catalogue**, **Finance** and others |
| **All servers / Per server** | Where a member's access applies: the same on every server (new ones included) or different access on each chosen server                                                                                        |
| **Invite** (Convite)         | The link sent by e-mail for someone to join the organization. It stays **Pending** until the person accepts.                                                                                                   |
| **Transfer** (Transferência) | The owner's request to hand the organization over to another account. It's valid for 7 days.                                                                                                                   |

## Plan

| Term                                 | What it is                                                                                                          |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| **Tier** (Nível)                     | **Plus**, **Pro** or **Ultra**. It applies to the whole organization. Don't mix it up with a member's access level. |
| **Full bundle** (Pacote completo)    | All 5 modules together, at 25% off their sum                                                                        |
| **FiveDash AI** (FiveDash IA)        | The plan add-on with the tickets' AI attendant and the Store, Logs and Rules assistants                             |
| **Free trial** (Teste grátis)        | 7 days with every module and the AI unlocked, no card                                                               |
| **Pix Automático**                   | The payment method that renews the plan on its own: you authorize it once in your bank's app                        |
| **Sales fee** (Taxa sobre as vendas) | FiveDash's share of the store's paid orders: 3% on Plus, 1.5% on Pro and 0% on Ultra                                |
| **Coupon** (Cupom)                   | A discount code applied when paying for the plan                                                                    |

## City and game

| Term                                     | What it is                                                                                                                                                                              |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **fivedash resource** (recurso fivedash) | The resource you install on your city. It detects the framework and applies in game what FiveDash decides: whitelist, store deliveries and logs.                                        |
| **Server key** (chave)                   | The code that links the city to the dashboard. It starts with `fdk_` (e.g. `fdk_xxxxxxxx`), lives in `fivedash/config.lua` and is only shown when generated.                            |
| **Game connection** (Conexão com o jogo) | The card in **Server → Overview** that shows whether the resource is connected, the framework, the whitelist and the last sync                                                          |
| **Framework**                            | Your city's base: Creative Network Enchanted, Qbox, QBCore, ESX, ox_core or vRP/vRPex                                                                                                   |
| **Sync** (sincronização)                 | The frequent exchange between the resource and the dashboard. Without a recent sync, the server shows **Disconnected**.                                                                 |
| **Whitelist**                            | The approval process to play in the city, run on Discord                                                                                                                                |
| **Unlock** (liberação)                   | Unlocking an approved player's ID right in the game, through the resource                                                                                                               |
| **Code** (codiguinho)                    | A code that lets someone in without going through the whitelist. The team generates codes for partners, giveaways or anyone they want to let in. It can have a use limit and an expiry. |
| **Game ID** (ID na cidade)               | The player's character identifier (passport, account and so on, depending on the framework). Store deliveries go to it.                                                                 |

## Discord

| Term                         | What it is                                                                           |
| ---------------------------- | ------------------------------------------------------------------------------------ |
| **Bot**                      | Your city's Discord bot, with the name and picture you choose                        |
| **Ticket**                   | A support conversation opened by a player on Discord, with a transcript and a rating |
| **Transcript** (transcrição) | A ticket's history, kept for as long as your plan allows                             |
| **Connect**                  | The Discord panel with the city's live status and a join button                      |
| **Summons** (Alinhamento)    | Calling a member in for a talk, with a deadline to show up in the room or ticket     |
| **Clock-in** (Ponto)         | Your team clocks in on a channel                                                     |
| **Creators**                 | Your city's content creators program, with levels                                    |
| **Protection** (Proteção)    | Anti-link, anti-spam, limits for your own team and anti-raid                         |

## Other

| Term                                  | What it is                                                       |
| ------------------------------------- | ---------------------------------------------------------------- |
| **Command menu** (Paleta de comandos) | The dashboard's search, opened with **Ctrl K** or **⌘K**         |
| **Assistant** (Assistente)            | The AI panel next to the Store, Logs and Rules pages             |
| **Sample** (Exemplo)                  | Sample data that only shows when the dashboard runs on localhost |

## Next steps

[Introduction](https://fivedash.fivex.gg/docs/en/getting-started/introduction)

What FiveDash is.

[Team and permissions](https://fivedash.fivex.gg/docs/en/dashboard/team-and-permissions)

Levels and presets in detail.

[Plans and billing](https://fivedash.fivex.gg/docs/en/getting-started/plans-and-billing)

Tiers, prices and limits.

[Install the resource](https://fivedash.fivex.gg/docs/en/getting-started/install-resource)

Key, framework and connection.
