Bruk av note-kommandoer i bofh

Bofh har kommandoer for å knytte notater (merkelapper, "gul lapp") til ulike objekter (entiteter).  Dette dokumentet inneholder dokumentasjon og eksempler for disse kommandoene.

 

Innholdsfortegnelse

Kort om notater

Notater er merkelapper som kan knyttes til objekter (entiteter) i Cerebrum. Dette kan bl.a. brukes for å notere ned dokumentasjon for upersonlige brukerkontoer.

Notater kan knyttes til bl.a. brukerkontoer, personer, grupper, og ou-er.  En merkelapp består av en emnelinje (subject) og tekstinnhold (body).  Det er ingen grense for hvor mange notater et objekt kan ha knyttet til seg.

Notat-felter
NavnTypeBeskrivelse
note-idintUnik ID for notat
created-atdatetimeTidspunkt for opprettelse av notat (dato, tidspunkt, og tidssone)
creator-idintUnik ID til brukerkontoen som opprettet notatet
entity-idintUnik ID til objektet som notatet omhandler
subjectstrEmnelinje — en tittel, kort beskrivelse, eller kategorisering av notatet (maks 70 tegn)
bodystrNotatets innhold (maks 1024 tegn)

Kommandoer

note add

note add <entity> <subject> <body>

Legger til et nytt notat. Eksempel:

> note add example Description "Foo bar baz"
Note #2 was added to entity id=123

note remove

note remove <entity> <note-id>

Fjerner et notat. Eksempel

> note remove example 2
Description "Foo bar baz"
Note #2 associated with entity id=123 was removed

note list

note list <entity> [note-filter+]

Liste ut notat knyttet til et objekt.  Resultater kan filtreres ved behov.  Eksempel:

> note list example
Note Id | Entity Id | Creator Id |       Date       |            Subject
------- + --------- + ---------- + ---------------- + ------------------------------
      1 |       123 |          2 | 2026-06-15 10:50 | Earlier example
      2 |       123 |          2 | 2026-07-15 14:10 | Description

note details

note details <note-id>

Slå opp og vise et notat og all informasjon knyttet til notatet. Eksempel:

> note details 2
Note Id:      2
Creator:      bootstrap_account (2)
Entity Id:    123
Entity Type:  account
Date:         2026-07-15 14:10
Subject:      Description

Foo bar baz

note show

note show <entity>

Legacy-kommando for å vise alle notat knyttet til et objekt. Eksempel

> note show example
2 note(s) found for entity id=123:

Note #1 added by bootstrap_account on 2026-06-15 10:50:
Earlier Example: This is an older message

Note #2 added by bootstrap_account on 2026-07-15 14:10:
Description: Foo bar baz

Argumenter

note-id

Unik id for et notat.

help arg_help note-id

entity

Finner/velger et objekt som kan ha et notat knyttet til seg. Man kan typisk oppgi et brukernavn for å velge en brukerkonto, eller oppgi oppslag:verdi for andre objekter, f.eks.:

  • account:<brukernavn>
  • person:<brukernavn>
  • group:<gruppenavn>
  • id:<entity-id>

Mer informasjon i bofh:

help arg_help id:target:entity

note-filter

Filter for bruk i søk/utlisting av notater. Man kan filtere på:

  • dato (before, after) — Notater opprettet før eller etter et tidspunkt
  • tekst (subject, body) — Notater med gitt innhold

Bofh gir mer informasjon om hvordan filter kan brukes og settes sammen:

help arg_help note-filter

Tilgang

Funksjonaliteten er kun tilgjengelig for brukere som har fått dette tildelt gjennom bofh sitt tilgangssystem, og tilgangen skal kun gies til driftsbrukere eller driftsgrupper.

Tilgang tildeles med operasjonssett NotesManager, f.eks.:

> access grant NotesManager it-usit-foo-drift global_group

For andre operasjonssett kan enkelt-operasjoner legges inn:

  • entity_note_add
  • entity_note_remove
  • entity_note_show

Tilgangssjekk bryr seg ikke om objekttype, så disse kan tildeles et hvilket som helst operasjonssett, og dermed gjelde alle objekter.

Publisert 5. aug. 2026 13:52 - Sist endret 6. aug. 2026 11:44