Files
wekan/docs/DeveloperDocs/Card-Email-Field-Inventory.json
T
Lauri Ojansivu 0071dde0f3 Flow fields on cards: Blocked with a reason, Class of service with Expedite's WIP limit, MoSCoW and WSJF.
Four Kanban and Scrum practices other tools have, kept on the card
(card.flow, models/lib/cardFlow.js), offline and with no AI:

- Blocked: ticked with a reason; who marked it and since when are the
  server's. A red Blocked badge on the minicard, the reason its tooltip.
- Class of service: Standard, Fixed date, Expedite, Intangible. Expedite
  has a WIP limit of one open card per board; a second is refused.
- MoSCoW priority: Must, Should, Could, Won't have.
- WSJF score: business value, time criticality and risk reduction divided
  by job size, each on the 1-20 scale; shown once every part is set.

Each is a row of Board Settings / Card in the Card section, off on the
card and the minicard until a board turns it on, and an Admin Panel /
Features / Card field that hides it on every board. Written only by the
setCardFlow method, which checks the card edit right, an assigned-only
member's own cards and the values; a client write of flow is denied.
Translated in every language.

Thanks to xet7 !
2026-11-20 08:08:26 +02:00

205 lines
6.7 KiB
JSON

[
{
"fields": [
"title",
"description"
],
"handling": "Footer resolves the authorized source card or board; stale link copies are excluded."
},
{
"fields": [
"boardId",
"listId",
"swimlaneId",
"sort",
"subtaskSort",
"listEnteredAt",
"lastMoveReason"
],
"handling": "Readable placement in ordinary Details and the separate local wrapper section; foreign list/lane names are excluded."
},
{
"fields": [
"recurrenceInterval",
"lastRecurrenceAt"
],
"handling": "Ordinary Details and local wrapper Details; recurrence setters use the displayed card ID."
},
{
"fields": [
"flowStartAt",
"flowInterruptions",
"flowUserId",
"pomodoroStartAt",
"pomodoroPhase",
"pomodoroCount",
"pomodoroUserId",
"pomodoroWorkMinutes"
],
"handling": "Persisted snapshots and public owner names in ordinary and local wrapper Details."
},
{
"fields": [
"scrum"
],
"handling": "Six visible fields in ordinary/local wrapper Details; sprint and release names require the same board. Internal Scrum snapshots and revisions are excluded."
},
{
"fields": [
"flow"
],
"handling": "The Kanban and Scrum flow fields (models/lib/cardFlow.js: blocked and why, class of service, MoSCoW, WSJF) are not in card emails yet; blockedBy is a user id and is never written into a message."
},
{
"fields": [
"archived",
"archivedAt",
"createdAt",
"modifiedAt",
"dateLastActivity",
"cardNumber",
"color"
],
"handling": "Ordinary/source Details. Both link types separately include local archive state/date and lifecycle timestamps. Card number/color follow getRealCard(): source-owned for linked cards, local for linked-board wrappers. Target-board archive state remains in target Details."
},
{
"fields": [
"receivedAt",
"startAt",
"dueAt",
"endAt",
"spentTime",
"isOvertime",
"dueComplete"
],
"handling": "Ordinary/source Details. Linked-board Details includes four dates, spent time, overtime and due-complete from the current target."
},
{
"fields": [
"members",
"assignees",
"requesters",
"assigners",
"requestedBy",
"assignedBy",
"userId"
],
"handling": "Ordinary/source Details resolves public names for account references; requestedBy/assignedBy are prose. Linked-board Members and Assignees use deduplicated active target members with public names, matching card getters. Linked-board local creator/requesters/assigners appear separately with the wrapper board scope."
},
{
"fields": [
"labelIds",
"customFields",
"stickers",
"locationName",
"locationAddress",
"locationLatitude",
"locationLongitude",
"locations"
],
"handling": "Ordinary/source Details with custom-field visibility and definition checks. Linked-board local Details renders these wrapper-owned fields with local definitions, admin visibility and policy fingerprints."
},
{
"fields": [
"parentId",
"parentIds",
"cardDependencies",
"targetId_gantt",
"linkType_gantt"
],
"handling": "Ordinary/source Details resolves authorized targets and groups duplicate labels. Linked-board wrapper relationships use the same authorized resolver and durable related-source evidence. Dependency color/icon are presentation metadata, not separate targets."
},
{
"fields": [
"vote",
"poker"
],
"handling": "Ordinary/source and linked-board Details use disclosure checks. Private voter identities and unfinished Poker choices are excluded; voting configuration is not serialized wholesale."
},
{
"fields": [
"coverId"
],
"handling": "Live selected attachment manifest identifies the cover without exporting an internal ID."
},
{
"fields": [
"type",
"linkedId"
],
"handling": "Control source resolution and durable identity checks; not raw prose fields."
},
{
"fields": [
"scrumRevision",
"syncSourceKey",
"syncLastSource",
"syncExternalId",
"syncSourceType",
"syncLabelIds",
"syncIssueState",
"syncClosedByWeKan",
"deletedAt",
"deletedBy",
"deleteBatchId",
"linkId_gantt"
],
"handling": "Internal provenance, revision, deletion and renderer identifiers are excluded; deletion still governs eligibility."
},
{
"fields": [
"showActivities",
"showListOnMinicard",
"showListOnCard",
"showChecklistAtMinicard",
"hideFinishedChecklistIfItemsAreHidden",
"shownFields",
"hiddenFields"
],
"handling": "Display preferences do not become email content. Discussion selection is controlled by the mail action."
},
{
"fields": [
"mapX",
"mapY"
],
"handling": "Positions on the board's Map view image (#3256), as percentages of that image; they mean nothing without it, so they are not email content."
},
{
"fields": [
"attachedCardIds"
],
"handling": "#3257: ids of the cards attached to this one. Their titles are read only by someone who may read those cards (attachedCardsInfo), so these ids are not email content."
},
{
"fields": [
"customFieldLinks"
],
"handling": "#5681: ids of the cards whose custom fields are linked to this one, with the direction and the link's creator. Link bookkeeping, not card content: the linked values are ordinary customFields, so these ids are not email content."
},
{
"fields": [
"email"
],
"handling": "#794: the email this card came from or was sent as - sender, recipients, subject and the Message-IDs that thread replies onto it (server/emailToCard.js, server/emailView.js). Mail bookkeeping, not card content: excluded, so a card mailed onward never discloses who wrote to the board or the addresses of the conversation."
},
{
"fields": [
"cardKind"
],
"handling": "#2012: whether the card is a Story or a Task. It selects which custom fields the card offers; those fields are covered by customFields above, so the kind itself is not email content."
},
{
"fields": [
"columnSetValues"
],
"handling": "#211: the card's column in each of the board's column sets, as set-id to column-id. Board-view bookkeeping like the Map positions; the ids mean nothing without the board, so they are not email content."
},
{
"fields": [
"drawings"
],
"handling": "#1178: the strokes of the card's drawings, kept so a drawing can be edited again. The drawing itself is a PNG attachment, covered by the attachments manifest; the strokes are not email content."
}
]