new customer report/flattened package report (ticket 1428)
[freeside.git] / httemplate / elements / menu.html
1 <script type="text/javascript" src="<%$fsurl%>elements/cssexpr.js"></script>
2
3 % if ( $opt{'position'} eq 'top' ) {
4
5   <script type="text/javascript" src="<%$fsurl%>elements/xmenu.top.js"></script>
6   <link href="<%$fsurl%>elements/xmenu.top.css" type="text/css" rel="stylesheet">
7
8 % } else {  # elsif ( $opt{'position'} eq 'left' ) {
9
10   <script type="text/javascript" src="<%$fsurl%>elements/xmenu.js"></script>
11   <link href="<%$fsurl%>elements/xmenu.css" type="text/css" rel="stylesheet">
12
13 % }
14
15 <link href="<%$fsurl%>elements/freeside.css" type="text/css" rel="stylesheet">
16
17 <SCRIPT TYPE="text/javascript">
18
19   webfxMenuImagePath      = "<%$fsurl%>images/";
20   webfxMenuUseHover       = 1;
21   webfxMenuShowTime       = 300;
22   webfxMenuHideTime       = 500;
23
24   var myBar = new WebFXMenuBar;
25
26 % foreach my $item ( keys %menu ) {
27 %
28 %     my( $url_or_submenu, $tooltip ) = @{ $menu{$item} };
29 %
30 %     if ( ref($url_or_submenu) ) {
31 %
32 %         #warn $item;
33 %
34 %         my( $subhtml, $submenuname ) = submenu($url_or_submenu, $item);
35
36           <% $subhtml %>
37           myBar.add(new WebFXMenuButton("<% $item %>", null, "<% $tooltip %>", <% $submenuname %> ));
38
39 %     } else { 
40     
41           myBar.add(new WebFXMenuButton("<% $item %>", "<% $url_or_submenu %>", "<% $tooltip %>" ));
42
43 %     }
44 %
45 % }
46
47   myBar.show( null, 'vertical' );
48   myBar.width = 154;
49
50 </SCRIPT>
51
52 <%init>
53 my( %opt ) = @_;
54 my $conf = new FS::Conf;
55 my $fsurl = $opt{'freeside_baseurl'};
56
57 my $curuser = $FS::CurrentUser::CurrentUser;
58
59 #Active tickets not assigned to a customer
60
61 tie my %report_customers_lists, 'Tie::IxHash',
62   'by customer number' => [ $fsurl. 'search/cust_main.cgi?browse=custnum', '' ],
63   'by last name' => [ $fsurl. 'search/cust_main.cgi?browse=last', '' ],
64   'by company name' => [ $fsurl. 'search/cust_main.cgi?browse=company', '' ],
65 ;
66 $report_customers_lists{'by active trouble tickets'} = [ $fsurl. 'search/cust_main.cgi?browse=tickets', '' ]
67   if $conf->config('ticket_system');
68
69 $report_customers_lists{'advanced customer reports'} = [ $fsurl. 'search/report_cust_main.html', '' ]
70   if ( $curuser->access_right('List customers') &&
71        $curuser->access_right('List packages')
72      );
73
74 tie my %report_customers_search, 'Tie::IxHash';
75 $report_customers_search{'by ordering employee'} = [ $fsurl. 'search/cust_main-otaker.cgi' ]
76   if $curuser->access_right('Configuration');
77
78 tie my %report_customers, 'Tie::IxHash',
79   'List customers' => [ \%report_customers_lists, 'List customers' ],
80 ;
81 $report_customers{'Search customers'} = [ \%report_customers_search, 'Search customers' ]
82   if keys %report_customers_search;
83 $report_customers{'Zip code distribution'} = [ $fsurl.'search/report_cust_main-zip.html', 'Zip codes by number of customers' ];
84
85 tie my %report_invoices_open, 'Tie::IxHash',
86   'All open invoices' => [ $fsurl.'search/cust_bill.html?OPEN_date', 'All invoices with an unpaid balance' ],
87   '15 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN15_date', 'Invoices 15 days or older with an unpaid balance' ],
88   '30 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN30_date', 'Invoices 30 days or older with an unpaid balance' ],
89   '60 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN60_date', 'Invoices 60 days or older with an unpaid balance' ],
90   '90 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN90_date', 'Invoices 90 days or older with an unpaid balance' ],
91   '120 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN120_date', 'Invoices 120 days or older with an unpaid balance' ],
92 ;
93
94 tie my %report_invoices, 'Tie::IxHash',
95   'Open invoices' => [ \%report_invoices_open, 'Open invoices' ],
96   'All invoices'  => [ $fsurl. 'search/cust_bill.html?date', 'List all invoices' ],
97   'Advanced invoice reports' => [ $fsurl.'search/report_cust_bill.html', 'by agent, date range, etc.' ],
98 ;
99
100 tie my %report_services, 'Tie::IxHash';
101 if ( $curuser->access_right('Configuration') ) {
102   $report_services{'Service definitions'} =  [ $fsurl.'browse/part_svc.cgi?orderby=active', 'Service definitions by number of active packages' ];
103   $report_services{'separator'} =  '';
104 }
105 foreach my $svcdb ( FS::part_svc->svc_tables() ) {
106
107   my $name =        "FS::$svcdb"->table_info->{'name_plural'}
108              || PL( "FS::$svcdb"->table_info->{'name'}        );
109   my $lcname = lc($name);
110   my $longname = "FS::$svcdb"->table_info->{'longname_plural'} || $name;
111   my $lclongname = lc($longname);
112   my $sorts = "FS::$svcdb"->table_info->{'sorts'} || [ 'svcnum' ];
113   $sorts = [ $sorts ] unless ref($sorts);
114   my %svc_url = ( 'm'      => $m,
115                   'action' => 'search',
116                   'svcdb'  => $svcdb,
117                 );
118
119   tie my %report_svc, 'Tie::IxHash';
120
121   foreach my $sort ( @$sorts ) {
122
123     my $field_info = FS::part_svc->svc_table_fields($svcdb)->{$sort};
124     my $label = $field_info->{'label_sort'} || 'by '.$field_info->{'label'};
125
126     my $title = "All $lcname";
127     $title .= " $label"
128       if scalar(@$sorts) > 1;
129
130     $report_svc{$title} =
131       [ svc_url( %svc_url, 'query' => "magic=all;sortby=$sort" ),
132         '',
133       ];
134   }
135
136   if ( $curuser->access_right('View/link unlinked services') ) {
137     $report_svc{"Unlinked $lcname"} = 
138       [ svc_url( %svc_url, 'query' => "magic=unlinked;sortby=". $sorts->[0] ),
139         "Pre-Freeside $lcname without a customer record",
140       ];
141   }
142
143   $report_services{$name} = [ \%report_svc, $longname ];
144
145 }
146
147 tie my %report_packages, 'Tie::IxHash';
148 if (    $curuser->access_right('Edit package definitions')
149      || $curuser->access_right('Edit global package definitions')
150    )
151 {
152   $report_packages{'Package definitions'} =  [ $fsurl.'browse/part_pkg.cgi?active=1', 'Package definitions by number of active packages' ];
153   $report_packages{'separator'} =  '';
154 }
155 if ( $curuser->access_right('Financial reports') ) {
156   $report_packages{'Package churn'} =  [ $fsurl.'graph/report_cust_pkg.html', 'Orders, suspensions and cancellations summary graph' ];
157   $report_packages{'separator2'} =  '';
158 }
159 $report_packages{'All customer packages'} =  [ $fsurl.'search/cust_pkg.cgi?pkgnum', 'List all customer packages', ];
160 $report_packages{'Suspended customer packages'} =  [ $fsurl.'search/cust_pkg.cgi?magic=suspended', 'List suspended packages' ];
161 $report_packages{'Customer packages with unconfigured services'} =  [ $fsurl.'search/cust_pkg.cgi?APKG_pkgnum', 'List packages which have provisionable services' ];
162 $report_packages{'Advanced package reports'} =  [ $fsurl.'search/report_cust_pkg.html', 'by agent, date range, status, package definition' ];
163
164 tie my %report_rating, 'Tie::IxHash',
165   'RADIUS sessions' => [ $fsurl.'search/sqlradius.html', '' ],
166   'Call Detail Records (CDRs)' => [ $fsurl.'search/report_cdr.html', '' ],
167 ;
168
169 tie my %report_bill_event, 'Tie::IxHash',
170   'All billing events' => [ $fsurl.'search/report_cust_event.html', 'All billing events for a date range' ],
171   'Billing event errors' => [ $fsurl.'search/report_cust_event.html?failed=1', 'Failed credit cards, processor or printer problems, etc.' ],
172   'All invoice events' => [ $fsurl.'search/cust_bill_event.html', 'Reports on deprecated, old-style invoice events for a date range' ],
173   'Invoice event errors' => [ $fsurl.'search/cust_bill_event.html?failed=1', 'Reports on deprecated, old-style events for failed credit cards, processor or printer problems, etc.' ],
174 ;
175
176 tie my %report_financial, 'Tie::IxHash', 
177   'Sales, Credits and Receipts' => [ $fsurl.'graph/report_money_time.html', 'Sales, credits and receipts summary graph' ],
178   'Sales Report' => [ $fsurl.'graph/report_cust_bill_pkg.html', 'Sales report and graph (by agent, package class and/or date range)' ],
179   'Credit Report' => [ $fsurl.'search/report_cust_credit.html', 'Credit report (by employee and/or date range)' ],
180   'Payment Report' => [ $fsurl.'search/report_cust_pay.html', 'Payment report (by type and/or date range)' ],
181 ;
182 $report_financial{'Payment Batch Report'} = [ $fsurl.'search/pay_batch.html', 'Payment batches (by status and/or date range)' ]
183   if $conf->exists('batch-enable');
184 $report_financial{'A/R Aging'} = [ $fsurl.'search/report_receivables.html', 'Accounts Receivable Aging report' ];
185 $report_financial{'Prepaid Income'} = [ $fsurl.'search/report_prepaid_income.html', 'Prepaid income (unearned revenue)  report' ];
186 $report_financial{'Sales Tax Liability'} = [ $fsurl.'search/report_tax.html', 'Sales tax liability report' ];
187 ;
188
189 tie my %report_menu, 'Tie::IxHash';
190 $report_menu{'Customers'}   = [ \%report_customers, 'Customer reports'  ]
191   if $curuser->access_right('List customers');
192 $report_menu{'Invoices'}    =  [ \%report_invoices,  'Invoice reports'   ]
193   if $curuser->access_right('List invoices');
194 $report_menu{'Packages'}    =  [ \%report_packages,  'Package reports'   ]
195   if $curuser->access_right('List packages');
196 $report_menu{'Services'}    =  [ \%report_services,  'Services reports'  ]
197   if $curuser->access_right('List services');
198 $report_menu{'Usage'} =  [ \%report_rating,    'Usage reports'  ]
199   if $curuser->access_right('List rating data');
200 $report_menu{'Billing events'} =  [ \%report_bill_event, 'Billing events' ]
201   if $curuser->access_right('Billing event reports');
202 $report_menu{'Financial'}  = [ \%report_financial, 'Financial reports' ]
203   if $curuser->access_right('Financial reports');
204
205 tie my %tools_importing, 'Tie::IxHash',
206   'Import customers from CSV file' => [ $fsurl.'misc/cust_main-import.cgi', '' ],
207   'Import customer comments from CSV file' => [ $fsurl.'misc/cust_main_note-import.html', '' ],
208   'Import one-time charges from CSV file' => [ $fsurl.'misc/cust_main-import_charges.cgi', '' ],
209   'Import Call Detail Records (CDRs) from CSV file' => [ $fsurl.'misc/cdr-import.html', '' ],
210 ;
211
212 tie my %tools_exporting, 'Tie::IxHash',
213   'Download database dump' => [ $fsurl. 'misc/dump.cgi', '' ],
214 ;
215
216 #    <!-- <BR>View active NAS ports: 
217 #      <A HREF="browse/nas.cgi">session server</A> -->
218 #      <!-- or <A HREF="browse/nas-sqlradius.cgi">RADIUS</A>
219 #    <BR> -->
220
221 tie my %tools_menu, 'Tie::IxHash', ();
222 $tools_menu{'Quick payment entry'} =  [ $fsurl.'misc/batch-cust_pay.html', 'Enter multiple payments in a batch' ]
223   if $curuser->access_right('Post payment batch');
224 $tools_menu{'Process payment batches'} = [ $fsurl.'search/pay_batch.cgi?magic=_date;open=1;intransit=1', 'Process credit card and electronic check batches' ]
225   if $conf->exists('batch-enable') && $curuser->access_right('Process batches');
226 $tools_menu{'Job Queue'} =  [ $fsurl.'search/queue.html', 'View pending job queue' ]
227   if $curuser->access_right('Job queue');
228 $tools_menu{'Time Queue'} =  [ $fsurl.'search/timeworked.html', 'View pending support time' ]
229   if $curuser->access_right('Time queue');
230 $tools_menu{'Importing'} =  [ \%tools_importing, 'Import tools' ]
231   if $curuser->access_right('Import');
232 $tools_menu{'Exporting'} =  [ \%tools_exporting, 'Export tools' ]
233   if $curuser->access_right('Export');
234
235 tie my %config_employees, 'Tie::IxHash',
236   'View/Edit employees' => [ $fsurl.'browse/access_user.html', 'Setup internal users' ],
237   'View/Edit employee groups' => [ $fsurl.'browse/access_group.html', 'Employee groups allow you to control access to the backend' ],
238 ;
239
240 tie my %config_export_svc_pkg, 'Tie::IxHash',
241   'View/Edit exports'              => [ $fsurl.'browse/part_export.cgi', 'Provisioning services to external machines, databases and APIs' ],
242   'View/Edit service definitions'  => [ $fsurl.'browse/part_svc.cgi', 'Services are items you offer to your customers' ],
243   'View/Edit package definitions'  => [ $fsurl.'browse/part_pkg.cgi', 'One or more services are grouped together into a package and given pricing information. Customers purchase packages, not services' ],
244   'View/Edit package classes'      => [ $fsurl.'browse/pkg_class.html', 'Package classes define groups of packages, for reporting and convenience purposes.' ],
245   'View/Edit cancel reason types'  => [ $fsurl.'browse/reason_type.html?class=C', 'Cancel reason types define groups of reasons, for reporting and convenience purposes.' ],
246   'View/Edit cancel reasons'       => [ $fsurl.'browse/reason.html?class=C', 'Cancel reasons explain why a service was cancelled.' ],
247   'View/Edit suspend reason types' => [ $fsurl.'browse/reason_type.html?class=S', 'Suspend reason types define groups of reasons, for reporting and convenience purposes.' ],
248   'View/Edit suspend reasons' => [ $fsurl.'browse/reason.html?class=S', 'Suspend reasons explain why a service was suspended.' ],
249 ;
250
251 tie my %config_agent, 'Tie::IxHash',
252   'View/Edit agent types' => [ $fsurl.'browse/agent_type.cgi', 'Agent types define groups of package definitions that you can then assign to particular agents' ],
253   'View/Edit agents'      => [ $fsurl.'browse/agent.cgi', 'Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their type)' ],
254 ;
255
256 tie my %config_billing, 'Tie::IxHash',
257   'View/Edit payment gateways'         => [ $fsurl.'browse/payment_gateway.html', 'Credit card and electronic check processors' ];
258 $config_billing{'View/Edit billing events'} = [ $fsurl.'browse/part_event.html', 'Billing actions for customers, invoices and packages' ]
259     if $curuser->access_right('Edit billing events')
260     || $curuser->access_right('Edit global billing events');
261 if ( $curuser->access_right('Configuration') ) {
262   $config_billing{'View/Edit invoice events'}         = [ $fsurl.'browse/part_bill_event.cgi', 'Deprecated, old-style actions for overdue invoices' ];
263   $config_billing{'View/Edit invoice templates'}      = [ $fsurl.'browse/invoice_template.html', 'Edit templates for HTML, plaintext and typeset invoices' ];
264   $config_billing{'View/Edit prepaid cards'}          = [ $fsurl.'search/prepay_credit.html', 'View outstanding cards, generate new cards' ];
265   $config_billing{'View/Edit call rates and regions'} = [ $fsurl.'browse/rate.cgi', 'Manage rate plans, regions and prefixes for VoIP and call billing' ];
266   $config_billing{'View/Edit locales and tax rates'}  = [ $fsurl.'browse/cust_main_county.cgi', 'Change tax rates, or break down a country into states, or a state into counties and assign different tax rates to each' ];
267 }
268
269 tie my %config_dialup, 'Tie::IxHash',
270   'View/Edit access numbers' => [ $fsurl.'browse/svc_acct_pop.cgi', 'Points of Presence' ],
271 ;
272
273 tie my %config_broadband, 'Tie::IxHash',
274   'View/Edit routers'        => [ $fsurl.'browse/router.cgi', 'Broadband access routers' ],
275   'View/Edit address blocks' => [ $fsurl.'browse/addr_block.cgi', 'Manage address blocks and block assignments to broadband routers' ],
276 ;
277
278 tie my %config_misc, 'Tie::IxHash';
279 $config_misc{'View/Edit advertising sources'} = [ $fsurl.'browse/part_referral.html', 'Where a customer heard about your service.  Tracked for informational purposes' ]
280   if $curuser->access_right('Edit advertising sources')
281   || $curuser->access_right('Edit global advertising sources');
282 if ( $curuser->access_right('Configuration') ) {
283   $config_misc{'View/Edit virtual fields'} = [ $fsurl.'browse/part_virtual_field.cgi', 'Locally defined fields', ];
284   $config_misc{'View/Edit message catalog'} = [ $fsurl.'browse/msgcat.cgi', 'Change error messages and other customizable labels' ];
285   $config_misc{'View/Edit inventory classes and inventory'} = [ $fsurl.'browse/inventory_class.html', 'Setup inventory classes and stock inventory' ];
286 }
287
288 tie my %config_menu, 'Tie::IxHash';
289 if ( $curuser->access_right('Configuration' ) ) {
290   %config_menu = (
291     'Settings'      => [ $fsurl.'config/config-view.cgi', '' ],
292     'separator'     => '', #its a separator!
293     'Employees'     => [ \%config_employees, '' ],
294     'Provisioning, services and packages'
295                     => [ \%config_export_svc_pkg, ''    ],
296     'Resellers'     => [ \%config_agent, ''    ],
297   );
298 }
299 $config_menu{'Billing'} = [ \%config_billing, ''    ]
300   if $curuser->access_right('Edit billing events')
301   || $curuser->access_right('Edit global billing events');
302 if ( $curuser->access_right('Configuration') ) {
303   $config_menu{'Dialup'}  = [ \%config_dialup, ''    ];
304   $config_menu{'Fixed (username-less) broadband'} = 
305                             [ \%config_broadband, ''    ];
306 }
307 $config_menu{'Miscellaneous'} = [ \%config_misc, ''    ]
308   if $curuser->access_right('Edit advertising sources')
309   || $curuser->access_right('Edit global advertising sources');
310
311 tie my %menu, 'Tie::IxHash',
312   'Billing Main'   => [ $fsurl, 'Billing start page', ],
313 ;
314 if ( $conf->config('ticket_system') ) {
315   $menu{'Ticketing Main'} =
316     [ 
317       ( $conf->config('ticket_system') eq 'RT_External'
318         ? FS::TicketSystem->baseurl()
319         : $fsurl.'rt/'
320       ),
321       'Ticketing start page',
322     ],
323 }
324 $menu{'Reports'} = [ \%report_menu, 'Lists, reporting and graphing' ]
325   if keys %report_menu;
326 $menu{'Tools'} = [ \%tools_menu, 'Tools' ]
327   if keys %tools_menu;
328 $menu{'Configuration'} = [ \%config_menu, 'Configuraiton and setup' ]
329   if $curuser->access_right('Edit advertising sources')
330   || $curuser->access_right('Edit global advertising sources');
331
332 use vars qw($gmenunum);
333 $gmenunum = 0;
334
335 sub submenu {
336   my($submenu, $title) = @_;
337   my $menunum = $gmenunum++;
338
339   #return two args: html, menuname
340
341   "var myMenu$menunum = new WebFXMenu;\n".
342   #"myMenu$menunum.useAutoPosition = true;\n".
343   "myMenu$menunum.emptyText = '$title';\n".
344
345   (
346     join("\n", map {
347
348       if ( !ref( $submenu->{$_} ) ) {
349
350         "myMenu$menunum.add(new WebFXMenuSeparator());";
351
352       } else {
353
354         my($url_or_submenu, $tooltip ) = @{ $submenu->{$_} };
355         if ( ref($url_or_submenu) ) {
356
357           my($subhtml, $submenuname ) = submenu($url_or_submenu, $_); #mmm, recursion
358
359           "$subhtml\n".
360           "myMenu$menunum.add(new WebFXMenuItem(\"$_\", null, \"$tooltip\", $submenuname ));";
361
362         } else {
363
364           "myMenu$menunum.add(new WebFXMenuItem(\"$_\", \"$url_or_submenu\", \"$tooltip\" ));";
365
366         }
367
368       }
369
370     } keys %$submenu )
371   ). "\n".
372   "myMenu$menunum.width = 280;\n",
373
374   "myMenu$menunum";
375
376 }
377
378 </%init>
379