📘

Dokumentationsförfaranden

circulations crm_office 🛡️ RLS Protected

Dokumentumsökningar & prövningar <unk> Process- och API-dokumentation som har härledts från kod.

Fachliche Bestimmung: Dokumentationsprocesser och API-dokumentation som är avledda från kod.

⚡ Arbetsflöden och livscykler (2) 🗄️ Datamodeller & fält (3) 🔌 Inledande punkter (UI & API) (23) 🛡️ Reglering och efterlevnad

⚡ Arbetsflöden och livscykler

Användarföreskrifter: cirkulationsmedel `plan:command_circulation_agent`

Tjänststyrd plan (durable_plan), start: manual_command.

1. circulation_agent

circulation_agent

{"key": "execute_command", "label": "Befehl prüfen, ausführen oder zur Freigabe vorlegen", "adapter": "agent.execute", "agent": "circulation_agent", "condition_fact": null}

Aktionen: circulation_agent

Omlopp `status:circulation`

Observable_only_observable_state machine.

1. draft

Förberedande

Status <unk>utkast <unk> omlopp av den statliga maskinen.

2. active

Aktiva

Status <unk>aktiv <unk> omloppsläge.

3. completed

fullbordade

Status <unk> fullbordad<unk> av den statliga maskinens omloppsrutan.

4. rejected

Avvisad

Status <unk>förkastad <unk> omlopp av maskinen.

5. returned

återlämnat

Status återlämnat av statusmaskinens omlopp.

6. cancelled

Avbokade

Status <unk>annuleras<unk> av driftsättningen av driftssystemet.

🗄️ Datamodeller & fält

CirculationComments circulation_comments RLS Aktiv

13 Fält / kolumner

Tabelle circulation_comments

Feldname	Uppgifter	Förpliktelse	Schlüssel	Arbetsuppgifter
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`step_id`	`UUID`	Nein	FK ➔ circulation_steps.id	Feld step_id
`document_id`	`UUID`	Ja *	FK ➔ documents.id	Feld document_id
`author_id`	`UUID`	Nein	FK ➔ organization_users.id	Feld author_id
`page`	`INTEGER`	Ja *	-	Feld page
`x`	`FLOAT`	Ja *	-	Feld x
`y`	`FLOAT`	Ja *	-	Feld y
`text`	`TEXT`	Ja *	-	Feld text
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

CirculationStamps circulation_stamps RLS Aktiv

16 Fält / kolumner

Tabelle circulation_stamps

Feldname	Uppgifter	Förpliktelse	Schlüssel	Arbetsuppgifter
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`step_id`	`UUID`	Nein	FK ➔ circulation_steps.id	Feld step_id
`document_id`	`UUID`	Ja *	FK ➔ documents.id	Feld document_id
`placed_by`	`UUID`	Nein	FK ➔ organization_users.id	Feld placed_by
`page`	`INTEGER`	Ja *	-	Feld page
`x`	`FLOAT`	Ja *	-	Feld x
`y`	`FLOAT`	Ja *	-	Feld y
`width`	`FLOAT`	Ja *	-	Feld width
`height`	`FLOAT`	Ja *	-	Feld height
`text`	`VARCHAR(255)`	Ja *	-	Feld text
`color`	`VARCHAR(7)`	Ja *	-	Feld color
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

CirculationSteps circulation_steps RLS Aktiv

17 Fält / kolumner

Tabelle circulation_steps

Feldname	Uppgifter	Förpliktelse	Schlüssel	Arbetsuppgifter
`circulation_id`	`UUID`	Ja *	FK ➔ document_circulations.id	Feld circulation_id
`position`	`INTEGER`	Ja *	-	Feld position
`assignee_id`	`UUID`	Ja *	FK ➔ organization_users.id	Feld assignee_id
`status`	`VARCHAR(48)`	Ja *	-	Feld status
`instructions`	`TEXT`	Nein	-	Feld instructions
`assigned_at`	`DATETIME`	Nein	-	Feld assigned_at
`started_at`	`DATETIME`	Nein	-	Feld started_at
`completed_at`	`DATETIME`	Nein	-	Feld completed_at
`decision`	`VARCHAR(32)`	Nein	-	Feld decision
`notes`	`TEXT`	Nein	-	Feld notes
`due_at`	`DATETIME`	Nein	-	Feld due_at
`decision_comment`	`TEXT`	Nein	-	Feld decision_comment
`id`	`UUID`	Nein	PK	Feld id
`tenant_id`	`UUID`	Ja *	FK ➔ organizations.id	Feld tenant_id
`created_at`	`DATETIME`	Ja *	-	Feld created_at
`updated_at`	`DATETIME`	Ja *	-	Feld updated_at
`metadata`	`JSONB`	Ja *	-	Feld metadata

🔌 Inledande punkter (UI & API)

Art	Förberedelse	Slutpunkt / väg	Titel & Zweck	Förmåga
⚡ REST API	DELETE	`/api/v1/circulations/{circulation_id}/assignees/{step_id}`	remove_assignee Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	DELETE	`/api/v1/circulations/{circulation_id}/documents/{document_id}`	remove_document Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	GET	`/api/v1/circulations`	list_circulations Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}`	get_circulation Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}/documents/{document_id}/preview`	document_preview Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/api/v1/circulations/{circulation_id}/final-pdf`	download_final_pdf Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/circulations`	circulations_page Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/circulations/new`	circulation_create_page Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	GET	`/circulations/{circulation_id}`	circulation_detail_page Semantic binding: inventory_only; mutation=False	`circulations`
⚡ REST API	PATCH	`/api/v1/circulations/{circulation_id}`	update_circulation Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	PATCH	`/api/v1/circulations/{circulation_id}/assignees/{step_id}`	update_assignee Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations`	create_circulation Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/assignees`	add_assignee Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/begin-review`	begin_review Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/cancel`	cancel_circulation Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/comments`	add_comment Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/complete-step`	complete_step Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/documents`	add_document Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/return`	return_for_revision Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/stamps`	add_stamp Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/start`	start_circulation Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/steps/reorder`	reorder_steps Semantic binding: operator_surface; mutation=True	`circulations`
⚡ REST API	POST	`/api/v1/circulations/{circulation_id}/upload`	upload_document Semantic binding: operator_surface; mutation=True	`circulations`

🛡️ Reglering och efterlevnad

Dieses Modul unterliegt folgenden gesetzlichen, regulatorischen und Revisionsstandards:

Företagsförvaltning
En sådan information ska användas för att kunna identifiera en person som är underrättad om att den har en sådan information.