Changes

Field Revision Annotations

12,544 bytes added, 19:34, 6 September 2022

→‎Setting Statuses for UTA-based Annotation Types

{{UnderConstruction}}==Overview==Annotations is a feature that allows users to add or view annotations at the individual field level (ex: [[Standard Fields]] such as name or address, and also [[Custom Fields]]). These edits to specific fields can be made while keeping the rest of the record locked. 

Flexible [[Role Based Security|role-based security]] allows the [[Global User Administrator|System Administrator]] to configure [[UTA role]]-based permissions: different users will have the ability to view or add annotations to fields, while others the ability to edit that field value. 

__notoc__Our annotations feature offers you, the SmartSimple user, an additional communications vehicle for both [[Internal|internal]] and [[External|external]] [[User|users]]. While annotations are similar to the [[Notes]] feature, it is targeted towards individual fields. For example: If one of your grants administrators is reviewing an application, and notices that a particular field needs to be revised by the applicant - the administrator can then highlight this field with an annotation and send a comment to the applicant concerning which edit to make. The applicant can review the comment and make the appropriate change. 

==Feature OverviewConfiguration - Essentials==In order to configure Field Revision Annotations for your SmartSimple [[instance]], you must create an '''Annotation Type '''and permission it based on [[User Role|roles]]. 

Revision Annotations is feature that allows Following this, you then have the ability to go into a [[Universal Tracking Application]] and configure [[UTA Role]]-based permissions against individual UTA [[Status|statuses]] to add control who can view and edit the annotations at the field level , and allow edits who is able to be made to specific modify the fields while keeping the rest of the record lockedin annotation mode.  

Flexible Status ===Creating an Annotation Type===The '''Annotation Type '''is necessary to use the Field Revision Annotation feature; it allows users to define role-based security permissions to control who can use that specific type of annotation. 1. Click the 9-square menu icon on the top right of your page.  :: {{Icon-Menu}} 2. Under the heading '''Configuration, '''select '''Global Settings.''' 3. In the first tab of Global Settings (labeled '''System'''), select '''Annotation Types. ''' :: [[File:Annotation types.png|500px|border]]: :* This will open up the list of available Annotation Types in the system. If you do not have any already configured in your system, the page will be blank. :* To edit an existing Annotation Type, simply click the '''pencil icon '''on the left of the annotation name. 4. Click the '''+ '''button on the top left to create a new Annotation Type.  5. Provide an appropriate name, caption and description for your new Annotation Type. ::: [[File:New annotation type.png|650px|border]]:: ::* The Name and Caption field are normally labelled the same, if not similarly. ::* The Description field is important to fill out for the configuration and creation of all [[SmartSimple]] features: it is best practice to provide guidance in case anyone else needs to modify or use your configuration ::* The [[Display Order]] field determines where on the page a user will see your Annotation Type listed. The Display Order works from lowest to highest number - ex: inserting 1 into the field will ensure that your type is listed first, and any type with a display order greater than 1 will be listed afterwards in ascending order. If nothing is inputted the system defaults to a display order beginning at 100 and rising in increments of 100 for subsequent fields.::* The Colour field allows you to configure choose which colour your annotations will appear when they are written with this type. 6. When you have filled out all the fields to create a new Annotation Type, click '''Save. ''' ===Setting Permissions and Availability===After completing the steps to creating a new Annotation Type, this will bring you to the '''Edit '''page for that type.  1. Select the second tab on the Annotation Type editing page, labelled '''Permissions and Availability.''' :::: [[File:Annotation type permissions.png|650px|border]] :: ::* '''View & Create - '''Click into the text box to select which [[User Role|roles]] will have the ability to both view and create this Annotation Type. The default will be '''Everyone. '''If you have a role-specific annotation - for example, a '''Reviewer '''Annotation Type, then you should only select the roles that need access to this type, such as those with the role '''Reviewer '''assigned. ::* '''View Only -''' Click into the text box to select which roles will have the ability to view this Annotation Type. The default will be '''Everyone. '''A role-specific annotation type, such as those for '''Reviewers, '''might only require specific roles to see but ''not'' create this annotation type, such as '''Employee '''or '''Applicant. '''2. After selecting the appropriate roles to access your Annotation Type, click '''Save.''' ===Setting Statuses for UTA-based permissions Annotation Types===After building your Annotation Type, go to the UTA that you want this annotation to be available for. For example, a '''Reviewer '''Annotation Type that is written by a reviewer to be seen by an applicant is appropriately associated with a Grants Manager application. In this series of steps, we will select the '''Status '''that will allow different users the ability Annotation Type to add annotations be used by the roles that have been assigned.  1. To find your UTA, click the 9-square menu icon on the top right of the page. :::: {{Icon-Menu}} 2. Under the heading '''Applications, '''select the desired application to fields while others open up its details.  3. Click the '''gear icon '''on the top of the ability page to go into '''Configuration Mode. ''' :::: [[File:Config settings.png|200px|border]]4. Go to edit the field valuesecond tab of the Configuration Settings - this displays the settings associated with the [[Level 1 Entity]] of the application. <pre> The nomenclature for your application and configuration tabs will differ depending on your SmartSimple instance.</pre>

==Illustrated==[[Image:Annotation_25.png|link=|500px]][[Image:SpacerSelect '''Statuses '''under the heading '''General Settings.png|link=]] [[Image:Annotation_1a.png|link=|700px]] '''

:::: [[File:Statuses config.png|500px|border]] 

A list of statuses associated with the Level 1 Entity of your UTA will appear. 

''Image 16. Select the status that you want to add this Annotation Tab illustrated (above)Type to.''<br />''Image 2. Example annotations displayed on the Annotation Tab (above)''<br /> 

==Configuring Field Revision Annotations==::* If the status you would like to add an Annotation Type to has not yet been created, learn [[Status#Creating UTA Statuses|how to create a status]]. ::*: [[File:Under review status.png|300px|border]]

The first step in configuring the Field Revision Annotation In this example, the '''Under Review '''status is to create appropriate for an Annotation Type and permission it based on Rolesthat pertains to a '''Reviewer. '''

You can then go to a UTA and configure Role based permissions against individual UTA Statuses to control who can view and edit The details of the annotations, and who can modify fields in annotation modestatus will open.  

7. Click the second tab of the Status page, titled '''Permissions & Availability. ''' :::: [[File:Annotation for status.png|600px|border]] {| class="wikitable"|-||'''Annotation System Role Permission'''||'''View: '''Who is allowed to view the annotations associated with this status '''View and Create: '''Who is allowed to both view and create annotations on this status '''Edit Field: '''Who is allowed to edit specific fields that have annotations on them in this status '''Anonymize Creator: '''Choose which roles you would like to hide the identity of when they create annotations on this status |-||'''Annotation Association Role Permissions'''||'''View: '''Which roles will be ''associated ''to view the annotations with this status '''View and Create: '''Which associated roles will be able to both view and create annotations on this status '''Edit Field: '''Which associated roles will be able to edit specific fields that have annotations on them in this status '''Anonymize Creator: '''Choose which associated roles you would like to hide the identity of when they create annotations on this status ::* Good examples of associated roles might be users with '''Contractor '''roles, or a '''Grant Writer '''who is working on multiple grants at the same time, etc |}8. Once you are done permissioning the annotation feature on a specific UTA status, click '''Save. ''' ===Enabling Annotation Permissions===Now you need to enable annotation permissions on the newly created Annotation Type. 1. Click the 9-square menu icon on the top right of your page. :::: {{Icon-Menu}} 2. Under '''Configuration, '''select '''Global Settings.''' 3. Click '''Annotation Permissions, '''which is available on the first tab.  Two tabs will appear: the first for '''Global Permissions '''and the second for '''Status Specific Permissions. '''Enabling permissions for your Annotation Type can be successfully configured from both tabs. Since you have a status-specific Annotation Type - a '''Reviewer Type '''for the status '''Under Review '''- the Status Specific Permissions tab is applicable. :::: [[File:Status specific annotation permission.png|400px|border]]::: :::* '''Entity Type: '''Select the entity that your status and Annotation Type falls under. In this case, it is a specific UTA and the Level 1 Entity that we configured our Annotation Type for. :::* '''Status: '''Select the status that your Annotation Type applies to. In this case, it is the '''Under Review '''status. :::* Set '''System Role '''and '''Association Role '''permissions, as applicable and necessary. 4. Click '''Save. ''' ===Creating Using Annotation Types===After an Annotation Typehas been created, configured onto a UTA Entity and Status, and role-based permissions were enabled on the status and in Global Settings, you can double-check that your annotation works by going to the UTA you want to use the annotation for. 1. Click the 9-square menu icon on the top right of your page. ::::: {{Icon-Menu}}2. Under the '''Applications '''heading, select the appropriate application.  3. Select the Level 1 Entity that has the appropriate status the Annotation Type is configured for. In this example, it must be one that has '''Status - Under Review. ''' 4. Select the '''Annotations '''feature, which appears on the left-side menu of the Level 1 Entity page.  ::::: [[File:Annotations side bar.png|150px|border]]5. A list of annotations will appear. If there are no annotations yet, the page will be blank. To create a new annotation, click the '''pencil icon '''on the right hand side of the page.  ::::: [[File:Annotation mode.png|150px|border]]When you are in '''Annotation Mode, '''all of the fields can now be clicked into and annotations can be created and viewed based on which roles you have permissioned. Clicking into a field will open up a window with a '''pencil icon '''that you can click to create a new annotation. ::::: [[File:New annotation.png|border]]::::: [[File:Annotation fill in window.png|850px|border]]Under '''Annotation Type, '''select the type that you have created to ensure that the correct and appropriate roles will have access to this annotation.After filling in the content of your annotation, click '''Save. '''Any viewer with a role that is permissioned to Edit Fields will be able to view and edit the field that you have written an annotation for.===Using Field Annotations===If the user has '''View Annotation '''or '''View and Create Annotation '''permissions, they would automatically see the '''Annotations '''tab along the left hand side of the screen.  :: [[File:Annotations left hand menu.png|170px|border]]If they clicked on this tab, it would open up any of the Annotations that have been created on this record.  :: [[File:Annotations examples.png|1000px|border]] The [[Standard Fields|standard]] or [[Custom Fields|custom field]] that the Annotations exists against will appear at the top of each individual Annotation - in the example above, these fields are '''Branch '''and '''Supporting Sponsorship Document. ''' The '''Annotation Type '''and the annotation content will appear right below the field title.  On the bottom right will be the creator of the annotation and the time and date stamp that it was created. ===Editing or Replying to Annotations===If the user has '''Edit Field''' ''and '''''View and Create Annotations'''''' '''permissions, when they open up a record on they will be able to view which field has an annotation highlighted against it, and they will have the ability to click into the field directly in order to employ the necessary edits to solve the annotation issue.  * Clicking into a field caption which has ''no previous annotations''' '''''will allow them to create a New Annotation. * Clicking into a field caption which ''does have previous annotations ''will allow them to '''Modify '''the field - they are then presented with the '''Edit Field '''screen, but their ability to edit the individual field is controlled by the associated [[Field Permissions]]. * The '''Edit Field '''functionality is only relevant when the record is on [[Status Lock|locked on status]] and the user has '''View Annotations '''permissions set for their role.  :: [[File:Annotations reply modify.png|600px|border]] In this above example, the '''Branch '''field is highlighted in orange to demonstrate that there is an Annotation against it. A user, by clicking into this field, will enable the Annotation to pop up. They will see the content of the Annotation, the creator of the Annotation (unless the '''Anonymize Creator '''functionality has been permissioned), the date and time stamp, and the '''Reply/Modify '''button. * '''Note: '''If the user only has '''View '''permissions and not '''View and Create Annotation '''permissions, they will not be able to access the '''New Annotation '''or see the '''Reply/Modify '''buttons against individual fields, although they will automatically see the Annotations tab along the left hand side of the screen. 

To use the Field Revision Annotation feature, an Annotation Type needs A user who clicks into the '''Reply/Modify '''button will enable a pop-up to be created. The Annotation Type also allows users to define role based permissions.appear:

* Click on the '''Configuration''' menu, then select the ''':: [[Roles & PermissionsFile:Annotations modifying.png|800px|border]]''' option.<>* The '''Annotation Type''' page is displayed.* To edit an existing Annotation Type click on the Annotation Type line on previous annotation(s) will appear at the left panel. * To create a new Annotation Type complete bottom of the field options listed under the '''New Annotation Type''' section. . . ::* View & Create: define those roles that can both view and create this Annotation type::* View only: define those roles that are only able to view this Annotation type * Click '''Save'''window. 

===Configure Role based permissions against individual UTA Statuses===To change the '''Field Value, '''simply select the '''binoculars icon '''to look up different fields and to select a changed one. In this example, since the previous annotation notes that the branch is incorrect, the user could look up into the '''Field Value '''to select the correct branch and '''Save '''the change.

* Edit ===Revision History===The '''Revision History '''feature will list the related Status setting to allow full annotation history in one place. This history is updated each time changes are submitted through the annotations feature to be available for records in this statusAnnotation [[Submit & Save buttons|submit button]]. 

* From the related UTA, click on the '''Configuration SettingsNote: ''' icon.* Navigate The record must be under [[Status Lock]] in order for the Annotation Submit button to Level 1, 2, or 3 tab, and click on the '''Statuses''' hyperlink.* Create a new status (click on the '''+ New Status''' icon) or edit an existing status (click appear on the edit status icon).* Complete the '''Edit Status''' form.* Click '''Save'''page.

====Status Form Options====The following fields from To access the history, click the '''Edit StatusOptions ''' form are related to Revision Annotationsbutton on the top left of the page.* '''Lock On Status''' A drop- * '''View Annotation Role''' down of available features will appear - * click on '''View and Create Annotation Roles''' - * ''Revision History. 'Edit Field in Annotation Mode Roles''' -

==Notes==* The history will show both when the field is edited and when the record is submitted. A user'''Notes Options''' - options are delimited s ability to access the Revision History section is controlled by semithe [[UTA Settings -colonSecurity|UTA Security Settings]].

:: [[File:Annotation revision history.png|400px|border]] ==See Also==* [[Notes Overview]][[Category:Under ConstructionAnnotations]]

• ← Older edit

Garrett Alford

Smartstaff

282

edits