Quickstart: save and share the first query

The shortest way from “the plugin is installed” to “a named query exists, and its address shows somebody else the same result”. Four steps, about ten minutes.

Prerequisites

wkdoqueries, wkdoworkitems, wkdocore, wkdostorage and wkcore are installed and enabled.
A project with work items in it.

Step 1: open the hub

Open the project's Queries hub:

/doku.php?id=en:projects:acme:queries&do=wkdoqueries

You get a result grid over the project's work items, with the columns #, Title, Type, State, Assignee, Priority and Updated.

Step 2: filter and sort

Add conditions on fields — State on Active, say — and sort by a field. Both are validated against the fields that actually exist.

The line Results: n above the grid says how many items match.

Step 3: look at a result without leaving the list

Open a row in the preview drawer. It shows the item without taking you out of the result list — enough to answer “is this the one I mean”.

The preview is read-only. Editing belongs to the work-item editor, where the concurrency check, the guards and the audit trail live.

Step 4: save and share

Save the query under a Name. Choose the visibility Private or Project.

Then copy the address from the address bar and open it in a second browser, or send it on.

Check the result

The query is listed under Saved queries and reopens with one click. At visibility Project others with access to the project see it too.
The shared address shows the same sort order — the sort state is encoded in the address. What you send is therefore what the other person sees, and not the same query with their own sort applied.

If a field a saved query filters on is later removed, the query does not break. That condition is dropped and the rest still runs. Remember the consequence: a dropped condition no longer narrows, so the query silently becomes broader. A saved query that suddenly returns far more than it used to usually has this cause and not a change in the data.

Next step

wkdoworkitems — edit the items the query finds.
wkdoboards — the same set as a kanban board.
wkdoqueries (German) — the package page: the field validator and the sort encoding in the address.