- Dashboard Home
- Bot User Guide
- Manufacturing Ledger
- Program Orders
- Facility Eco Orders
- Settings
- About
ShockBot Discord User Guide
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /neworder | Slash Command | N/A | Starts a New Order Ticket For use with FacEco and WarEco |
| order-type | String Choice | facility war-eco | Pre-defined choice: Facility or WarEco |
| order-customer | String Input | text | User input for customer name. Max 20 characters |
| order-regiment | String Input | text | User input for customer regiment. Max 10 characters |
All tickets must be started with /neworder. This command reads the current ticket channel name, creates a ticket log in the ShockBot database, and generates an empty ticket embed in the discord channel the command was used in. ShockBot logs the Discord Clan ID, Channel ID, and Message ID of the reply sent to the user.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /addline | Slash Command | N/A | Adds a new line item For use with FacEco and WarEco |
| eco-type | Sub-Command Group | facility war-eco | Pre-defined choice: Facility or WarEco |
| order-customer | Integer Input | # | User input for quantity |
All tickets lines must be added with /addline. Choices appear depending on user selection, and may be de-activated by either at the program level or item level by PMs.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /removeline | Slash Command | N/A | Removes an existing line item For use with FacEco and WarEco |
| line | Integer Input | # | User input for target line |
Ticket line items can be removed using /removeline. The user specifies the line item being removed and ShockBot will check the specified line to ensure it exists. If the line does not exist, the bot will inform the user of the error.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /payorder | Slash Command | N/A | Add or remove ticket payment For use with FacEco and WarEco |
| action | String Choice | add remove | Pre-defined choice: add or remove |
| primary | Integer Input | # | User input for primary payment. |
| secondary | Integer Input | # | User input for secondary payment. |
All ticket payments are handled using /payorder. Payment can be added beyond the cost of the ticket, but payment value cannot go below 0. Primary payments go towards the upper payment option while secondary payments go towards the lower payment option.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /movetoproduction | Slash Command | N/A | Moves ticket to production workflow For use with FacEco and WarEco |
Tickets with the Paid status are able to be moved to the production workflow. Tickets in production prevent lines or payments to be added or subtracted from the current totals.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /startproduction | Slash Command | N/A | Starts printing an existing line item For use with FacEco and WarEco |
| line | Integer Input | # | User input for target line |
| qty | Integer Input | # | User input for target quantity |
Ticket line items can be marked currently printing by using /startproduction. The user specifies the line item being delivered along with the quantity of that line being delivered. ShockBot will check the specified line for the numbrer of prints in queue. If the quantity to produce is greater than the number of prints in queue, the bot will inform the user of the error. After completion of the transaction, a follow-up reply will be sent by ShockBot informing the customer the print completion datestamp and user of the command for record keeping.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /ecodelivery | Slash Command | N/A | Delivers an existing line item with user-specified quantity For use with FacEco and WarEco |
| line | Integer Input | # | User input for target line |
| qty | Integer Input | # | User input for target quantity |
Ticket line items can be marked as delivered by using /ecodelivery. The user specifies the line item being delivered along with the quantity of that line being delivered. ShockBot will check the specified line for the numbrer of completed prints. If the quantity to deliver is greater than the number of completed prints, the bot will inform the user of the error. After completion of the transaction, a follow-up reply will be sent by ShockBot informing the customer the datestamp and user of the command for record keeping.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /completeorder | Slash Command | N/A | Marks the order as complete For use with FacEco and WarEco |
All tickets must be completed with /completeorder or /cancelorder. This command reads the current ticket channel name and ticket status to determine if all lines have been delivered before allowing the ticket status to changed from Delivered to Complete. Only completed tickets will count against the live production totals.
| Parameter | Data Type | User Input | Description |
|---|---|---|---|
| /cancelorder | Slash Command | N/A | Marks the order as cancelled For use with FacEco and WarEco |
All tickets must be completed with /completeorder or /cancelorder. This command sets the current ticket status as Cancelled. Cancelling a ticket within a ticket channel prevents the channel from containing another ShockBot ticket. Customers will need to start another TicketBot ticket (new channel) to place a new order. Tickets status cannot be changed from Cancelled using Discord-level commands.