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',
90 # basic customer rights
92 'Customer rights' => [
95 #'View Customer | View tickets',
97 'View customer history',
99 'Complimentary customer', #aka users-allow_comp
100 { 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
101 'Add customer note', #NEW
102 'Edit customer note', #NEW
103 'Download attachment', #NEW
104 'Add attachment', #NEW
105 'Edit attachment', #NEW
106 'Bill customer now', #NEW
107 'Bulk send customer notices', #NEW
111 # customer package rights
113 'Customer package rights' => [
114 'View customer packages', #NEW
115 'Order customer package',
117 'Change customer package',
118 'Bulk change customer packages',
119 'Edit customer package dates',
120 'Customize customer package',
121 'Suspend customer package',
122 'Suspend customer package later',
123 'Unsuspend customer package',
124 'Cancel customer package immediately',
125 'Cancel customer package later',
126 'Delay suspension events',
127 'Add on-the-fly cancel reason', #NEW
128 'Add on-the-fly suspend reason', #NEW
129 'Edit customer package invoice details', #NEW
130 'Edit customer package comments', #NEW
134 # customer service rights
136 'Customer service rights' => [
137 'View customer services', #NEW
138 'Provision customer service',
139 'Recharge customer service', #NEW
140 'Unprovision customer service',
141 'Change customer service', #NEWNEW
143 'Edit home dir', #NEW
144 'Edit www config', #NEW
145 'Edit domain catchall', #NEW
146 'Edit domain nameservice', #NEW
147 'Manage domain registration',
149 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
153 # customer invoice/financial info rights
155 'Customer invoice / financial info rights' => [
157 'Resend invoices', #NEWNEW
158 'View customer tax exemptions', #yow
159 'Add customer tax adjustment', #new, but no need to phase in
160 'View customer batched payments', #NEW
161 'View customer pending payments', #NEW
162 'Edit customer pending payments', #NEW
163 'View customer billing events', #NEW
167 # customer payment rights
169 'Customer payment rights' => [
171 'Post payment batch',
172 'Apply payment', #NEWNEW
173 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
175 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
177 { 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.
182 # customer credit rights
184 'Customer credit and refund rights' => [
186 'Apply credit', #NEWNEW
187 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
188 { 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.
189 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
190 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
191 'Delete refund', #NEW
192 'Add on-the-fly credit reason', #NEW
196 # customer voiding rights..
198 'Customer void rights' => [
199 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
200 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
202 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
208 # report/listing rights...
210 'Reporting/listing rights' => [
212 'List zip codes', #NEW
217 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
218 'Billing event reports',
219 'Receivables report',
226 'Miscellaneous rights' => [
227 { rightname=>'Job queue', global=>1 },
228 { rightname=>'Time queue', global=>1 },
229 { rightname=>'Process batches', global=>1 },
230 { rightname=>'Reprocess batches', global=>1 },
231 { rightname=>'Redownload resolved batches', global=>1 },
232 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
233 { rightname=>'Export', global=>1 },
234 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
240 #'Database access rights' => [
241 { rightname=>'Raw SQL', global=>1 }, #NEW
245 # setup/config rights
247 'Configuration rights' => [
248 'Edit advertising sources',
249 { rightname=>'Edit global advertising sources', global=>1 },
251 'Edit package definitions',
252 { rightname=>'Edit global package definitions', global=>1 },
254 'Edit billing events',
255 { rightname=>'Edit global billing events', global=>1 },
257 { rightname=>'Dialup configuration' },
258 { rightname=>'Dialup global configuration', global=>1 },
260 { rightname=>'Broadband configuration' },
261 { rightname=>'Broadband global configuration', global=>1 },
263 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
265 { rightname=>'Configuration download', }, #description of how it affects
266 #search/elements/search.html
278 Returns a list of right names.
284 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
289 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
290 category names and values are list references of rights. Each element of the
291 list reference scalar right name or a hashref with the following keys:
295 =item rightname - Right name
297 =item desc - Extended right description
299 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
313 Damn those infernal six-legged creatures!
317 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>