Skip to main content

CnTeamWorkloadWidget

The team today: each person with their initials, name, an availability line, their open count and a load bar, under a header note that says how many are present ("4 of 5 present"). Board DqTeamwachtrij draws it as "Team vandaag"; every app with a work queue can place it. Registered under the team-workload type; place it from the manifest (there is no config form yet), on a dashboard or in an index page's side panel.

The counts come from the app: source names an endpoint that answers one row per person. The availability comes from Nextcloud's user status, read on the client through the OCS user status API, so no app needs a server helper for it:

  • a status message reads as the person wrote it, with the time it ends: "In a meeting until 14:00";
  • otherwise the status: Available (online), Away, Busy (do not disturb);
  • without a status the person reads as Absent today.

Present means any status but offline. The viewer comes first, marked "(you)", the others by name. A bar is full at capacity open items (else at the highest count) and turns red from 90 percent.

Manifest​

{
"id": "team-today",
"type": "team-workload",
"title": "Team today",
"content": {
"source": {
"url": "/apps/dossiq/api/work-queue/workload",
"responsePath": "handlers",
"userField": "handler",
"nameField": "displayName",
"countField": "openCaseCount"
},
"capacity": 12,
"countLabel": { "one": "{count} case", "other": "{count} cases" }
}
}

Content​

KeyDescription
source{ url, responsePath?, userField?, nameField?, countField? }. The url goes through generateUrl and is read with the viewer's session. The rows are read at responsePath (else the body), each with the user id at userField (default userId), the name at nameField (default displayName) and the open count at countField (default count).
capacityThe count at a full bar. Without it the highest count is.
countLabel{ one, other } with {count}, through the app's translate. Without it the count reads "{count} open".
emptyTextShown without anyone to list, through the app's translate.
hideWhenEmptyRender nothing at all when there is no one to list, including when the read is refused (a 403 for someone who is not a coordinator). Default false.
rowRouteMakes each person's row a button that opens their work. A route name is given the person as query[rowRouteParam]; a route location ({ name, params?, query? }) has {user} in its values replaced by the person's user id.
rowRouteParamThe query key a route-name rowRoute receives the user id under. Default assignee.

The header note is reported through the header event, which the dashboard card and the index page's side panel draw in the card's title row.

Props​

PropTypeDefaultDescription
contentobject{}The source, capacity and labels (see above).

Reference (auto-generated)​

OpenRegister reliance​

none: this component does not touch OpenRegister, directly or through anything it imports. 0 direct references, 0 files reached through imports.

See the reliance overview for the filterable list.

Props​

NameTypeRequiredDefaultDescription
contentobject\{\}The widget's content: source, capacity, countLabel, emptyText.

Events​

NamePayloadDescription
header—The card header's parts: { link, note, action, pill }, the note being how many are present.