1 package FS::AccessRight;
4 use vars qw(@rights); # %rights);
9 FS::AccessRight - Access control rights.
15 my @rights = FS::AccessRight->rights;
17 #my %rights = FS::AccessRight->rights_categorized;
18 tie my %rights, 'Tie::IxHash', FS::AccessRight->rights_categorized;
19 foreach my $category ( keys %rights ) {
20 my @category_rights = @{ $rights{$category} };
25 Access control rights - Permission to perform specific actions that can be
26 assigned to users and/or groups.
32 # '_desc' => 'Access to high-level reporting',
34 # 'Configuration' => [
35 # '_desc' => 'Access to configuration',
40 # '_desc' => 'Master access to reseller configuration',
45 # 'export_svc_pkg' => [
46 # '_desc' => 'Access to export, service and package configuration',
47 # 'part_export' => {},
54 # '_desc' => 'Access to billing configuration',
55 # 'payment_gateway' => {},
56 # 'part_bill_event' => {},
57 # 'prepay_credit' => {},
59 # 'cust_main_county' => {},
63 # '_desc' => 'Access to dialup configuraiton',
64 # 'svc_acct_pop' => {},
68 # '_desc' => 'Access to broadband configuration',
74 # 'part_referral' => {},
75 # 'part_virtual_field' => {},
77 # 'inventory_class' => {},
84 ##turn it into a more hash-like structure, but ordered via IxHash
86 #well, this is what we have for now. getting better.
87 tie my %rights, 'Tie::IxHash',
92 'Contact and Prospect rights' => [
98 #'View customer contacts',
104 # basic customer rights
106 'Customer rights' => [
109 #'View Customer | View tickets',
111 'Edit customer tags',
112 'Edit referring customer',
113 'View customer history',
115 'Unsuspend customer',
117 'Complimentary customer', #aka users-allow_comp
119 'Merge customer across agents',
120 { rightname=>'Delete customer', desc=>"Enable customer deletions. Be very careful! Deleting a customer will remove all traces that this customer ever existed! It should probably only be used when auditing a legacy database. Normally, you cancel all of a customer's packages if they cancel service." }, #aka. deletecustomers
121 'Bill customer now', #NEW
122 'Bulk send customer notices', #NEW
123 { rightname=>'View customers of all agents', global=>1 },
127 # customer package rights
129 'Customer package rights' => [
130 'View customer packages', #NEW
131 'Order customer package',
133 'Modify one-time charge',
134 'Change customer package',
135 'Detach customer package',
136 'Bulk change customer packages',
137 'Edit customer package dates',
138 'Discount customer package', #NEW
139 'Custom discount customer package', #NEW
140 'Customize customer package',
141 'Suspend customer package',
142 'Suspend customer package later',
143 'Unsuspend customer package',
144 'Cancel customer package immediately',
145 'Cancel customer package later',
146 'Un-cancel customer package',
147 'Delay suspension events',
148 'Customize billing during suspension',
149 'Add on-the-fly cancel reason', #NEW
150 'Add on-the-fly suspend reason', #NEW
151 'Edit customer package invoice details', #NEW
152 'Edit customer package comments', #NEW
153 'Qualify service', #NEW
154 'Waive setup fee', #NEW
155 'View appointments', #NEWNEW
157 'View package definition costs', #NEWNEW
158 'Change package contract end date',
162 # customer service rights
164 'Customer service rights' => [
165 'View customer services', #NEW
166 'Provision customer service',
167 'Bulk provision customer service',
168 'Bulk move customer services', #NEWNEW
169 'Recharge customer service', #NEW
170 'Unprovision customer service',
171 'Change customer service', #NEWNEW
174 'Edit home dir', #NEW
175 'Edit www config', #NEW
176 'Edit domain catchall', #NEW
177 'Edit domain nameservice', #NEW
178 'Manage domain registration',
180 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
184 # customer invoice/financial info rights
186 'Customer invoice / financial info rights' => [
188 'Resend invoices', #NEWNEW
189 { rightname=>'Print and mail invoices', desc=>"Print and mail via Freeside's web service", }, ##NEWER than NEWNEWNEW
193 'View customer tax exemptions', #yow
194 'Edit customer tax exemptions', #NEWNEW
195 'Add customer tax adjustment', #new, but no need to phase in
196 'View customer batched payments', #NEW
197 'View customer pending payments', #NEW
198 'Edit customer pending payments', #NEW
199 'View customer billing events', #NEW
200 'View legacy typeset statements', #new, but no need to phase in
204 # customer payment rights
206 'Customer payment rights' => [
208 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
209 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
210 'Post check payment',
212 'Post payment batch',
213 'Apply payment', #NEWNEW
214 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
215 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
216 'Process credit card payment',
217 'Process Echeck payment',
218 { rightname=>'Delete payment', desc=>'Enable deletion of unclosed payments. Be very careful! Only delete payments that were data-entry errors, not adjustments.' }, #aka. deletepayments Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.
222 # customer credit rights
224 'Customer credit and refund rights' => [
226 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
227 'Credit line items', #NEWNEWNEW
228 'Apply credit', #NEWNEW
229 'Void credit', #NEWER than things marked NEWNEWNEW
230 'Unvoid credit', #NEWER than things marked NEWNEWNEW
231 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
232 { rightname=>'Delete credit', desc=>'Enable deletion of unclosed credits. Be very careful! Only delete credits that were data-entry errors, not adjustments.' }, #aka. deletecredits Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.
234 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
237 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
238 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
239 'Refund credit card payment',
240 'Refund Echeck payment',
241 'Delete refund', #NEW
242 'Add on-the-fly credit reason', #NEW
243 'Add on-the-fly void credit reason',
247 # customer voiding rights..
249 'Customer payment void rights' => [
250 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
251 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
253 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
259 # note/attachment rights...
261 'Customer note and attachment rights' => [
262 'Add customer note', #NEW
263 'Edit customer note', #NEW
264 'View attachments', #NEW
265 'Browse attachments', #NEW
266 'Download attachment', #NEW
267 'Add attachment', #NEW
268 'Edit attachment', #NEW
269 'Delete attachment', #NEW
270 'View deleted attachments', #NEW
271 'Undelete attachment', #NEW
272 'Purge attachment', #NEW
276 # report/listing rights...
278 'Reporting/listing rights' => [
282 'List all customers',
283 'Advanced customer search',
284 'List zip codes', #NEW
288 'Summarize packages',
290 'List service passwords',
292 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
293 'Billing event reports',
294 'Receivables report',
296 { rightname=>'Send reports to customers', global=>1 },
297 { rightname=> 'List inventory', global=>1 },
298 { rightname=>'View email logs', global=>1 },
299 { rightname=>'View system logs' },
301 'Download report data',
302 'Services: Accounts',
303 'Services: Accounts: Advanced search',
305 'Services: Certificates',
306 'Services: Mail forwards',
307 'Services: Virtual hosting services',
308 'Services: Wireless broadband services',
309 'Services: Wireless broadband services: Advanced search',
311 'Services: Cable subscribers',
312 'Services: Dish services',
313 'Services: Hardware',
314 'Services: Hardware: Advanced search',
315 'Services: Phone numbers',
316 'Services: Phone numbers: Advanced search',
319 'Services: Mailing lists',
320 'Services: Alarm services',
321 'Services: External services',
322 'Services: Circuits',
324 'Services: Fiber: Advanced search',
325 'Usage: RADIUS sessions',
326 'Usage: Call Detail Records (CDRs)',
327 'Usage: Unrateable CDRs',
328 'Usage: Time worked',
329 { rightname=>'Employees: Commission Report', global=>1 },
330 { rightname=>'Employees: Audit Report', global=>1 },
332 #{ rightname => 'List customers of all agents', global=>1 },
338 'Miscellaneous rights' => [
339 { rightname=>'Job queue', global=>1 },
340 { rightname=>'Time queue', global=>1 },
341 { rightname=>'Process batches', }, #Process payment batches
342 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
343 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
344 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
345 { rightname=>'Process invoice batches', },
346 { rightname=>'Process global invoice batches', global=>1 },
347 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
348 { rightname=>'Export', global=>1 },
349 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
355 #'Database access rights' => [
356 { rightname=>'Raw SQL', global=>1 }, #NEW
359 #'Employee preference rights' => [
360 { rightname=>'Employee preference telephony integration' },
366 # setup/config rights
368 'Configuration rights' => [
369 'Edit advertising sources',
370 { rightname=>'Edit global advertising sources', global=>1 },
374 'Edit package definitions',
375 { rightname=>'Edit global package definitions', global=>1 },
376 'Edit package definition costs',
378 'Bulk edit package definitions',
380 'Edit FCC report configuration',
381 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
384 #{ rightname=>'Edit global CDR rates', global=>1, },
386 'Edit fee definitions',
387 { rightname=>'Edit global fee definitions', global=>1 },
389 'Edit billing events',
390 { rightname=>'Edit global billing events', global=>1 },
393 { rightname=>'View global templates', global=>1 },
395 { rightname=>'Edit global templates', global=>1 },
398 { rightname=>'Edit global inventory', global=>1 },
400 { rightname=>'Dialup configuration' },
401 { rightname=>'Dialup global configuration', global=>1 },
403 { rightname=>'Broadband configuration' },
404 { rightname=>'Broadband global configuration', global=>1 },
406 { rightname=>'Alarm configuration' },
407 { rightname=>'Alarm global configuration', global=>1 },
409 { rightname=> 'Configure network monitoring', global=>1 },
411 #{ rightname=>'Edit employees', global=>1, },
412 #{ rightname=>'Edit employee groupss', global=>1, },
414 { rightname=>'Edit custom fields', global=>1 },
416 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
418 { rightname=>'Configuration download', }, #description of how it affects
419 #search/elements/search.html
431 Returns the full list of right names.
437 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
440 =item default_superuser_rights
442 Most (but not all) right names.
446 sub default_superuser_rights {
448 my %omit = map { $_=>1 } (
454 'Edit customer package dates',
456 'Usage: Time worked',
457 'Redownload resolved batches',
459 'Configuration download',
460 'View customers of all agents',
461 'View/link unlinked services',
465 'Void invoices',#people are overusing this when credits are more appropriate
467 'View legacy typeset statments',
470 no warnings 'uninitialized';
471 grep { ! $omit{$_} } $class->rights;
476 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
477 category names and values are list references of rights. Each element of the
478 list reference scalar right name or a hashref with the following keys:
482 =item rightname - Right name
484 =item desc - Extended right description
486 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
500 Damn those infernal six-legged creatures!
504 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>