Changes between Version 12 and Version 14 of TimingAndEstimationPluginUserManual

Timestamp:

1970-01-01T10:24:02+10:00 (55 years ago)

Author:

Timing and Estimation Plugin

Comment:

--

TimingAndEstimationPluginUserManual

@@ +1 @@
+
 
 [[PageOutline]]
@@ -20 +21 @@
  * '''Ticket Rate''' The ability to attach a cost per hour or total amount to an individual ticket
 
-== Management Page ==
+== Billing / Management Page / Time Reports ==
 This page provide a small interface for querying the tickets and adding a bill date at the current time.  
 This interface mostly just gives you links that match the interface to open any of the give reports,
 providing it the correct set of input parameters
 
+The direct url is '/Billing'.
+
+=== No Permissions Branch ===
 The 'Management' button should be in the main title bar.  It is possible that if you are viewing at a low resolution, it was pushed off the edge of the screen.  Also if you are not logged in with report_view permissions, it will not show that button.
 
-The direct url is '/billing'.
+=== Permissions Branch ===
+The 'Time Reports' button should be in the main title bar.  Whether or not you see this will be based on whether your user has TIME_VIEW permissions.
+
+
 
 
 === Set Bill Date ===
 
-This button will add now as a bill date.  This is mostly to make it easier to select the last time you billed.
-
-=== Configuration ===
-==== TimingAndEstimation ====
-{{{
-#!ini
-[timingandestimation]
-#change what permission is required to view the billing/management screen
-# default is REPORT_VIEW
-billing_permission=TRAC_ADMIN
-}}}
+This button will add now as a bill date.  This is mostly to make it easier to select the last time you billed. 
 
 == Reports ==
@@ -78 +75 @@
  '''The reports can only be called from the Management Page. They will not work from the Trac View Tickets page. (Due to the custom variables that need values).'''
 
+== Permissions Branch ==
+Recently a branch of this plugin was sponsored by [http://www.obsidiansoft.com/ Obsidian Software] so that it would support per field permissions.  
+
+This is accomplished with Genshi 5 stream filters in trac 11.  This code draws from the [http://trac-hacks.org/wiki/BlackMagicTicketTweaksPlugin BlackMagicTicketTweaksPlugin]
+{{{
+#!html
+<br />
+<a href="http://www.obsidiansoft.com/" >
+<img src="http://trac-hacks.org/attachment/wiki/TimeEstimationUserManual/obsidian-logo.gif?format=raw" />
+</a>
+}}}
+
+=== Configuration ===
+There is a new trac.ini configuration section which is filled in by default as follows.
+{{{
+#!ini
+[field settings] # per field permissions
+
+# a list of all the fields to apply permissions to
+fields = billable, totalhours, hours, estimatedhours, internal
+
+# a bunch of:
+# field.permission = PERMISSION:consequence
+#
+#  If PERMISSION=ALWAYS, then the consequence always occurs
+#    eg: billable.permission = ALWAYS:hide 
+#        will always result in billable being hidden, irrespective of user permissions    
+#
+# where consequence is one of: hide, remove, disable
+#    hide - replaces with hidden input
+#    remove - removes element
+#    disable - removes input in favor of text
+billable.permission = TIME_VIEW:hide, TIME_RECORD:disable
+totalhours.permission = TIME_VIEW:remove, TIME_RECORD:disable
+hours.permission = TIME_VIEW:remove, TIME_RECORD:disable
+estimatedhours.permission = TIME_RECORD:disable
+internal.permission = TIME_RECORD:hide
+}}}
+
+It also adds an "Internal" checkbox which allows you to set a ticket as internal.  For this policy to work correctly you need to add a line to the trac section of the config telling it which permission policies to use.  (The setup will attempt to put this line of configuration in place. )  The permission that looks at currently is 'TIME_ADMIN'.  To change that group set the internalgroup of the ticket section in the trac.ini as follows:
+
+{{{
+#!ini
+[ticket]
+internalgroup = TRAC_ADMIN #or whatever group / permission you want
+
+[trac]
+permission_policies = InternalTicketsPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
+}}}
+
 == Future Improvements ==
- * [http://trac-hacks.org/wiki/TimingAndEstimationPlugin See tickets] at the [http://trac-hacks.org/wiki/TimingAndEstimationPlugin project trac]
+ * [http://trac-hacks.org/report/9?COMPONENT=TimingAndEstimationPlugin See tickets] at the [http://trac-hacks.org/wiki/TimingAndEstimationPlugin project trac]