Difference between revisions of "Field Revision Annotations"

From SmartWiki
Jump to: navigation, search
Line 22: Line 22:
 
The first step in configuring the Field Revision Annotation is to create an Annotation Type and permission it based on Roles.
 
The first step in configuring the Field Revision Annotation is to create an Annotation Type and permission it based on Roles.
  
You can then go to a UTA and configure Role based permissions against individual UTA Statuses to control who can view and edit the annotations, and who can modify fields in annotation mode.  
+
You can then go to a UTA and configure [[UTA role|UTA Role]] based permissions against individual UTA Statuses to control who can view and edit the annotations, and who can modify fields in annotation mode.  
  
 
===Creating an Annotation Type===
 
===Creating an Annotation Type===
Line 45: Line 45:
 
* Go to Permissions & Availability section .
 
* Go to Permissions & Availability section .
 
The following fields from the '''Edit Status''' form are related to Revision Annotations.
 
The following fields from the '''Edit Status''' form are related to Revision Annotations.
* '''Lock On Status''' -
+
 
 
* '''View Annotation Role''' -  
 
* '''View Annotation Role''' -  
 
* '''View and Create Annotation Roles''' -  
 
* '''View and Create Annotation Roles''' -  
 
* '''Edit Field in Annotation Mode Roles''' -  
 
* '''Edit Field in Annotation Mode Roles''' -  
 +
* '''Open Record in Annotation Mode''' -
  
 
==Notes==
 
==Notes==

Revision as of 06:59, 25 August 2016

Template:UnderConstruction



Feature Overview

Revision Annotations is feature that allows you to add annotations at the field level and allow edits to be made to specific fields while keeping the rest of the record locked.

Flexible Status based security allows you to configure role-based permissions to allow different users the ability to add annotations to fields while others the ability to edit the field value.

Illustrated

Annotation 2.pngSpacer.png Annotation 1a.png


Image 1. the Annotation Tab illustrated (above).
Image 2. Example annotations displayed on the Annotation Tab (above)

Configuring Field Revision Annotations

The first step in configuring the Field Revision Annotation is to create an Annotation Type and permission it based on Roles.

You can then go to a UTA and configure UTA Role based permissions against individual UTA Statuses to control who can view and edit the annotations, and who can modify fields in annotation mode.

Creating an Annotation Type

To use the Field Revision Annotation feature, an Annotation Type needs to be created. The Annotation Type also allows users to define role based permissions.

  • Click on the Configuration menu, then select the Roles & Permissions option.<>
  • The Annotation Type page is displayed.
  • To edit an existing Annotation Type click on the Annotation Type line on the left panel.
  • To create a new Annotation Type complete 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.

Configure Role based permissions against individual UTA Statuses

  • Edit the related Status setting to allow the annotations feature to be available for records in this status.
  • From the related UTA, click on the Settings icon.
  • Navigate 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 on the edit status icon).
  • Go to Permissions & Availability section .

The following fields from the Edit Status form are related to Revision Annotations.

  • View Annotation Role -
  • View and Create Annotation Roles -
  • Edit Field in Annotation Mode Roles -
  • Open Record in Annotation Mode -

Notes

  • Notes Options - options are delimited by semi-colon.