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