starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Enable custom fields and tags for journal entries #4789

New Issue
Closed
opened 2025-12-29 19:20:31 +01:00 by adam · 3 comments
adam commented 2025-12-29 19:20:31 +01:00
Owner
Copy Link

Originally created by @maznu on GitHub (Apr 19, 2021).

NetBox version

v2.11

Feature type

Data model extension

Proposed functionality

The journal is an absolutely fantastic addition, thank you! If we made a PR, would extending the journal entry model to support custom fields be accepted? I notice that none of the other "Extras" support CFs.

Use case

We have a semi-public "engineering log" of updates to various VMs, devices, etc. We've already backported data from that into the Netbox journal. We'd like to create an interface from our CRM/control panel to sync over our "notes" to Netbox, but those are more private (may contain personal data, software serial numbers, etc).

I'd love to retool our status page and engineering log to pull journal information from Netbox. It would be great if, when carrying out future maintenances, we could tag or custom-field whether or not a journal entry in Netbox is e.g. "Public" or "Private" so that we're effectively publishing to just one place.

Other use cases could include

  • CF "warning/danger in force until [datetime]" — e.g. at-risk or outage maintenance windows
  • CF "review [datetime]" — a report could pull out "danger" and "warning" items that may need re-visiting
  • tag for "field engineer jobsheet" — the backlog of little "I'll get round to it when I'm next at site" jobs (we use "flags" in our CRM for this kind of todo list)

Database changes

Add JSON blob for CFs to journalentry table, with default {}.

External dependencies

None anticipated.

Originally created by @maznu on GitHub (Apr 19, 2021). ### NetBox version v2.11 ### Feature type Data model extension ### Proposed functionality The journal is an absolutely fantastic addition, thank you! If we made a PR, would extending the journal entry model to support custom fields be accepted? I notice that none of the other "Extras" support CFs. ### Use case We have a semi-public "engineering log" of updates to various VMs, devices, etc. We've already backported data from that into the Netbox journal. We'd like to create an interface from our CRM/control panel to sync over our "notes" to Netbox, but those are more private (may contain personal data, software serial numbers, etc). I'd love to retool our status page and engineering log to pull journal information from Netbox. It would be great if, when carrying out future maintenances, we could tag or custom-field whether or not a journal entry in Netbox is e.g. "Public" or "Private" so that we're effectively publishing to just one place. Other use cases could include * CF "warning/danger in force until [datetime]" — e.g. at-risk or outage maintenance windows * CF "review [datetime]" — a report could pull out "danger" and "warning" items that may need re-visiting * tag for "field engineer jobsheet" — the backlog of little "I'll get round to it when I'm next at site" jobs (we use "flags" in our CRM for this kind of todo list) ### Database changes Add JSON blob for CFs to `journalentry` table, with default `{}`. ### External dependencies None anticipated.
adam added the type: featurepending closure labels 2025-12-29 19:20:31 +01:00
adam closed this issue 2025-12-29 19:20:31 +01:00
adam commented 2025-12-29 19:20:32 +01:00
Author
Owner
Copy Link

@MalfuncEddie commented on GitHub (May 28, 2021):

I would also like the ability to add kinds (info success,danger ...) like TODO, decision ...
But this can be fixed with a custom_kind field

@MalfuncEddie commented on GitHub (May 28, 2021): I would also like the ability to add kinds (info success,danger ...) like TODO, decision ... But this can be fixed with a custom_kind field
adam commented 2025-12-29 19:20:32 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jul 28, 2021):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Jul 28, 2021): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 19:20:32 +01:00
Author
Owner
Copy Link

@proudbro commented on GitHub (Jul 29, 2021):

It would be nice to have some kind of unifying attribute for the tags. It could be custom field or any other field or parent object

@proudbro commented on GitHub (Jul 29, 2021): It would be nice to have some kind of unifying attribute for the tags. It could be custom field or any other field or parent object
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pending closure type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4789
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?