Using Uplink

Workflows

A workflow is an automation you build yourself. On the Workflows page (under Automation), an admin makes one in three steps: when something happens, only if some checks are true, then a list of things to do, one after another. Staff can see them and their history but not change them.

#When

  • Cases and sessions: a ban, unban, kick, warn, jail, any case, a session starting or ending, a session poll getting its votes, and a ban lifted by itself.
  • Safety: someone bans or kicks many players, a mass ban being undone, and an alert raised by Uplink.
  • The server: a player joins or leaves, a mod call comes in, or someone runs a command in the game.
  • Staff and departments: a staff member clocks in or out, and someone joins, leaves, or is promoted or demoted in a department.
  • The CAD: a new call comes in (any department), someone presses the panic button, a call has had no unit for a number of minutes you pick, or a Flock camera reads a plate that has a BOLO. These have the call's number, type, place and priority to use in your steps, but no player, so they can post, ping, lock chat or raise an alert, not kick or ban.
  • Time: every so often (every 5 minutes up to every day), at a set time of day on the days you pick, or when someone presses Run now on a button workflow.

#Only if

Add checks such as the reason contains a word, the player is a certain person, a count is at least a number, how many players are in the game, or a session is running. You choose whether every check or any one check has to be true. With none, it runs every time.

#Then

  • Discord: post a message (a card or plain text, with an optional role ping), rename a channel (handy for a status channel), lock the chat channels, or open them again.
  • In the game: show a message or hint to everyone, or send the player a private message.
  • Moderation: warn, kick, ban, jail or add a note to the player (saved as a case done by the workflow), add them to the watchlist, or raise an alert on the dashboard.
  • Wait: pause up to two minutes between steps.

Words in braces like {player}, {reason} and {staff} are filled in, and the editor lists the ones each trigger has. Names and reasons cannot ping anyone.

#Status and history

  • Every workflow shows as Active, Paused or Needs attention when its last run had a step that failed. The top of the page counts them and the runs in the last day.
  • The run history lists every run with each step and what it did. Test runs a workflow once with made-up values: Discord messages are posted and marked as a test, everything else is only described.
  • Give workflows a section and they are grouped under that name on the page.
  • A step a workflow takes never sets other workflows off, so they cannot loop. You can also set a pause between runs, and a server can have 25 workflows with up to 8 steps each.