# Summons Summon a member to talk with the staff using /alinhar, with a deadline to show up in a call or open a ticket, and track it all in the panel. Source: https://fivedash.fivex.gg/docs/en/discord/alignment Summons is how the staff calls someone from the city in for a talk. With **/alinhar**, staff pick the member, write the reason and set a deadline. The bot posts a notice in the channel, sends a DM and, if you want, gives a pending role. When the person joins the summons voice room or opens a ticket, attendance is marked automatically. If the deadline passes, the notice turns red and they get another DM. It's for owners and staff who need talks on a schedule, without losing track of anyone. ## Before you start * The **Discord** module must be on the organization's plan, on the **Pro** or **Ultra** plan. On Plus, the Summons page doesn't open. * The city's bot must be connected to the server. See [Bot](https://fivedash.fivex.gg/docs/en/discord/bot). * For attendance through the voice room to be marked automatically, the bot must be receiving live events. If it isn't, the page warns you; opening a ticket and marking attendance from the panel still work. * For attendance by ticket, set up the [Tickets](https://fivedash.fivex.gg/docs/en/discord/tickets) module. * If you use the **Pending role**, the bot's role must be above it. Access level in the panel (**Summons** area): | Level | What it allows | | ------------- | -------------------------------------------- | | **View** | Summons and numbers | | **Manage** | Mark attendance, extend deadlines and cancel | | **Configure** | Command, channels, rooms and messages | ## Turn on summons ### Open Summons In the panel, go to **Discord → Summons** and open the **Settings** tab. ### Turn the module on Turn on **Turn on summons**. It starts off. ### Set the team and the default deadline Under **Commands**, pick the staff roles in **Who can use it**, the **Default deadline** and, if you want, the **Protected roles**. ### Pick where to notify Under **Where to notify**, pick the **Summons channel**. It's required. ### Pick how the person shows up Under **How to show up**, pick the **Voice rooms** and/or leave **Opening a ticket counts** on. At least one of the two has to apply. ### Save Click **Save** on the **You have unsaved changes** bar. ## How a summons works 1. Someone on the staff uses `/alinhar membro motivo prazo` on Discord. The reply is private. 2. The bot gives the **Pending role** (if set), sends the DM, posts the notice in the **Summons channel** and logs it in the **Log channel** (if set). The notice shows **Waiting**. 3. The person shows up by joining one of the **Voice rooms** or opening a ticket (if **Opening a ticket counts** is on). Staff can also mark it with `/alinhado` or from the panel. 4. Once they show up, the notice switches to **Showed up**, the pending role is removed and the log is updated. 5. If the deadline ends first, the notice turns red, the person gets the **Missed deadline** DM (if on) and the summons becomes **Didn't show up**. They can still show up: then it reads **Showed up · late**. Each member has only one waiting summons at a time. Anyone already sitting in the room when the bot reconnects counts too: the bot checks who's already there. ## The commands on Discord Command and option names stay in Portuguese in every city language. | Command | Options | What it does | | ----------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | `/alinhar` | `membro` (required), `motivo` (optional, up to 500 characters), `prazo` (optional) | Summons the member. Without `prazo`, the panel's **Default deadline** applies. | | `/alinhado` | `membro` (required) | Marks the member's open summons (waiting or overdue) as done. | Who can use them: members with one of the roles picked in **Who can use it**. Administrators and members with **Manage Server** always can. With no roles picked, only they can. The bot refuses `/alinhar` when the module is off, when the target is a bot, themselves or has a protected role, and when the member already has a waiting summons. `prazo` deadlines: 15 minutes, 30 minutes, 1 hour, 2 hours, 3 hours, 6 hours, 12 hours, 1 day, 2 days, 3 days and 7 days. See every bot command in [Commands](https://fivedash.fivex.gg/docs/en/discord/commands). ## Settings ### Commands | Field | What it does | Default | | -------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **Who can use it** | The roles that can use /alinhar. Members with one of these roles can use /alinhar and /alinhado. Up to 25 roles. | None (**Administrators only**) | | **Default deadline** | When the team doesn't pick a deadline in the command. Same choices as `prazo`. | 2 hours | | **Protected roles** | Members with one of these roles can't be summoned. Up to 25 roles. | None | ### Where to notify | Field | What it does | Default | | ---------------------- | --------------------------------------------------------------------------------------------------------------- | ------- | | **Summons channel** | The public notice goes here and updates on its own: waiting, showed up or overdue. Required with the module on. | None | | **Mention the member** | The notice pings whoever was summoned. Off, the name shows without a ping. | On | | **Notify by DM** | The person gets the reason and the deadline in private, with shortcuts to the room and the ticket. | On | | **Show who summoned** | Puts the name of whoever used /alinhar in the DM. | On | ### How to show up | Field | What it does | Default | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | **Voice rooms** | Joining one of them counts as showing up, right away. The first becomes the **Join room** button. Up to 5 rooms. | None | | **Opening a ticket counts** | Opening a ticket also counts as showing up. | On | | **Categories that count** | Only tickets in these categories count. With none picked, any category counts. Up to 25. If the tickets module has no categories yet, you see **Set up tickets**. | Any category | ### While waiting | Field | What it does | Default | | --------------------------------- | ------------------------------------------------------------------------------------- | ------- | | **Pending role** | Given on /alinhar and taken away when the person shows up or the summons is canceled. | None | | **Notify when the deadline ends** | A second DM reminds them the deadline passed and that it can still be sorted out. | On | ### Discord log | Field | What it does | Default | | --------------- | -------------------------------------------------------------------------------------------------------------------- | ------------- | | **Log channel** | Every summons, attendance, missed deadline and cancellation becomes a message here. With no channel: **Panel only**. | None | | **Messages** | Channel notice, DM and missed deadline. | Default texts | | **Embed** | Colors per status, photo, server and buttons. | See below | ### Customize messages | Tab | When it's sent | | ------------------- | -------------------------------------------------------------------------------------------------------------- | | **Channel notice** | Posted in the summons channel. The status (waiting, showed up, overdue) shows below it and updates on its own. | | **DM** | Sent privately as soon as /alinhar is used. | | **Missed deadline** | Sent privately when the deadline ends and the person still hasn't shown up. | Each text takes up to 1,500 characters and an optional image, wide (2:1), at the end of the message. The channel notice can never be empty; the DM and the missed-deadline DM can only be empty when they're turned off. Variables: | Variable | What it shows | | ------------ | ---------------------------------------------------- | | `{membro}` | Mentions who was summoned (@Player) | | `{nome}` | The summoned member's name | | `{servidor}` | The Discord server's name | | `{motivo}` | The reason written in /alinhar | | `{prazo}` | Time left ("in 2 hours"), kept up to date by Discord | | `{horario}` | The day and time the deadline ends | | `{sala}` | The summons' first voice room | | `{equipe}` | Who used /alinhar | | `{caso}` | The summons number (#012) | Default channel notice (English city): ```text ### {{warning}} Summons {caso} {membro}, the team needs to talk to you. **Reason:** {motivo} Show up in {sala} or open a ticket by **{horario}** ({prazo}). ``` ### Customize embed | Field | What it does | Default | | ----------------------------------------- | ------------------------------------------------------------------ | --------- | | **Waiting** **Color** | The notice and the DM while the deadline runs. | `#F0B232` | | **Showed up** **Color** | The notice after the person shows up, and the log. | `#57F287` | | **Overdue** **Color** | The notice, the DM and the log when the deadline ends. | `#ED4245` | | **Member's photo in the notice** | The summoned member's photo in the corner of the notice. | On | | **Server at the top of the DMs** | The server's name and icon above the private messages. | On | | **"Join room" and "Open ticket" buttons** | Shortcuts under the notice and the DMs, while the summons is open. | On | Canceled summons turn gray. The preview has four views: **Notice**, **DM**, **Overdue** and **Log**. ## Track summons ### Overview The **Overview** tab shows the week's **Summons**, **Waiting now**, **Time to show up** (median), the share who **Showed up on time**, the **Summons and attendance** chart, **How they showed up** (voice room, ticket or by the team), **Running deadlines** (who still needs to show up) and **Who summons the most**. ### Log The **Log** tab lists every /alinhar. The tiles at the top filter by status: **Waiting**, **Showed up**, **Didn't show up** and **Canceled**. Search by member, team, reason, ID or number. | Status | What it means | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- | | **Waiting** | The deadline is running. | | **Showed up** | The person showed up (through the voice room, a ticket or marked by the team). With **· late** if it was after the deadline. | | **Didn't show up** | The deadline ended and they haven't shown up yet. They can still show up or have the deadline extended. | | **Canceled** | The team closed the summons. | ## Change a summons from the panel Needs the **Manage** level. Open the summons in **Discord → Summons → Log** and use one of the actions: | Action | What it does | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Mark attendance** | Closes it as **Showed up**, marked by you. Use it when the talk happened some other way. | | **Extend deadline** | Under **More time from the deadline**, pick 30 minutes, 1 hour, 3 hours, 12 hours or 1 day. If the deadline already passed, it counts from now and the summons goes back to **Waiting**. The notice on Discord is updated. | | **Cancel summons** | Asks **Why cancel (optional)**. The channel notice turns gray and the pending role is removed. | ### Open the summons In **Discord → Summons → Log**, click the summons row. ### Extend the deadline Click **Extend deadline** and pick how much more time. ### Check You see **Deadline extended by 1 hour** (or the time you picked) with the new deadline. The notice on Discord already shows the new time. ## FAQ **The person joined the room and wasn't marked.** Check that the room is in **Voice rooms** and that the page doesn't show the warning that the bot isn't receiving live events. Meanwhile, use **Mark attendance** or `/alinhado`. **Can I summon the same person twice?** Not while a summons is waiting. Extend the existing one's deadline or cancel it first. **The pending role wasn't given.** The bot's role must be above the pending role in Server Settings → Roles. ## Next steps [Tickets](https://fivedash.fivex.gg/docs/en/discord/tickets)Set up the categories that count as showing up. [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation)/ban, /kick and /mute with reason and proof. [Commands](https://fivedash.fivex.gg/docs/en/discord/commands)Every bot command and who uses it. [Team and permissions](https://fivedash.fivex.gg/docs/en/dashboard/team-and-permissions)Give each person the right level.