> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/assessment-framework/notes-standard-implementation.md). # Notes (Standard Implementation) ## Description Using the standard Notes functionality in the Assessment Framework you can attach Questions, Actions, and Information notes to specific questions in an assessment. Other users can reply and the system creates an ongoing forum-like cascade of replies until a user closes the original note. Notes are color coded based on type and status, and closed conversations drop to the bottom of the user interface. Users can easily see notes associated with a particular question or be taken to the question to which that a specific note relates. ## Use The Notes function is a useful tool for collecting feedback and additional information on all aspects of the Assessment Framework application. In the simple implementation, users can see and work on all comments. Notes are stored at the company level and stay with the test application through the publishing process, which supports a multi-stage review and audit process. With the addition of a simple logicnet, you can also limit the visibility of notes to users based on user name, version, or other variables. ## Standard Configuration Features ### Notes Types In the standard configuration there are three note types the user can create: * Question notes (colored dark gold/brown) * Information notes (colored blue) * Action notes (colored red) When a user selects a question in the observation panel of the Assessment Framework, the system outlines any associated notes, as in the first note in the image below. (Styling can be customized to suit.) ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-1321b6c53296142638ae3d27806dcc4d057d2d90%2Fa539234d-185a-42a4-be57-8a30167d2383.png?alt=media) ### New Note There are several ways users can create a new note: 1. Create new **general** notes by clicking NEW. These notes are not associated with any particular aspect of the application. 2. First CTRL+click on the relevant question block(s) in the observation panel, and then click ***New*** and enter the comments Note that the CTRL+click creates a thin red border around each selection. Users can select one more blocks prior to clicking ***New*** ### Dynamic Link between Notes and Question Blocks When a user reselects a note, the system displays a red border around any associated element. See the screenshot below where Q4 is showing the thin red border when the user clicks the Q4 note, and the same with Q2 where the user is taken to the question on Tab 1. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-e1fa20636ab80820b425d5ad158d279bb0a4d825%2F7be71711-efe0-45e0-b66d-955e98ffea8b.gif?alt=media) **Reply to Note** Users can create multiple replies to an initial note by clicking on the ***Reply*** button and entering text. The system hides replies by default for inactive notes; the red Action note above is an example. Clicking on the note expands and displays all replies in time order. The system updates the original note timestamp to the latest reply timestamp so users can identify which, if any, notes have new replies. ### Close Note Close notes by clicking the ***Close*** button. The system shades closed notes in dark gold/brown and moves them to the bottom of the list of notes. You cannot reopen a closed note. ## Advanced Setting: Limiting Visibility to Notes (Simple Configuration) The standard notes configuration puts all notes in a common database accessible by the Designer running the project in TEST, as well as any published versions of the project. It is possible to limit the visibility of Notes by setting a Notes group identifier. For example, setting the group identifier to v2 for the v2 published version of an application means that any Notes added by users running the v1 published version will not be shown. You can also to specify the identifier in the *onstart* folder with a *set data object* part. The identifier path is **data.meta.comments\_group\_id**. #### Useful Tip for Editorial vs Production Additionally, you could establish a rule in the *onstart* folder that checks for the condition **\_current.is\_test = 1**. If true then set the identifier to TEST, otherwise set to PROD. This will ensure that any Notes added during development or testing are not visible in the production runtime versions. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-0aa0de3022be8f1f20104575928eaa8ea3f76be5%2F49776094-cba2-4f70-9553-4f8164c4b58a.gif?alt=media) It is also possible to add a radio-list question in the model that is populated by all unique values of the group identifier. You could use this approach to allow the runtime user to narrow down **Notes** to specific other users; for example, if there is a supervising administrator who needs to review information, questions, and actions by author. If you look at the *notes\_local* table in the example project you will see other variables you might use in creating more sophisticated rules around Notes; for instance, when looking at multiple versions (pkg\_version) and/or multiple assessment applications (pkg\_category). ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-d27f44df602b3159304f6605fbed04b8fb3db1ae%2Fa2aeb7cd-68f6-4ebf-bb6a-59d6909991b8.gif?alt=media) ## Example Project Download the Notes Example (Standard).zip project [here](/release-9/example-gallery/example-projects-for-parts/notes-example-project-for-standard-asf-configuration.md). The notes tables are visible in the resources/data folder to show you how Notes work. For standard installations, the Notes database is at the company level and works across versions and applications. Suggestions: * Run the project in TEST and add some notes/replies. * Publish the project and note that TEST notes are not visible in the production version. * Decide whether the standard Notes functionality and customization described here is sufficient for your purposes. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/assessment-framework/notes-standard-implementation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.