1 <script type="text/javascript" src="<%$fsurl%>elements/cssexpr.js"></script>
3 % if ( $opt{'position'} eq 'top' ) {
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">
8 % } else { # elsif ( $opt{'position'} eq 'left' ) {
10 <script type="text/javascript" src="<%$fsurl%>elements/xmenu.js"></script>
11 <link href="<%$fsurl%>elements/xmenu.css" type="text/css" rel="stylesheet">
15 % unless ( $opt{'nocss'} ) {
16 <link href="<%$fsurl%>elements/freeside.css" type="text/css" rel="stylesheet">
17 <link href="<%$fsurl%>elements/freeside-print.css" type="text/css" rel="stylesheet" media="print">
19 <link href="<%$fsurl%>elements/freeside-menu.css" type="text/css" rel="stylesheet">
21 <SCRIPT TYPE="text/javascript">
23 % my $fs_popup = include( '/elements/popup_link_onclick.html',
24 % 'action' => $fsurl.'docs/about.html',
25 % 'label' => emt('Freeside'),
26 % 'style' => 'color:#999999',
27 % 'actionlabel' => emt('About'),
30 % 'color' => '#7e0079',
31 % #'scrolling' => 'no',
33 % $fs_popup =~ s/return false;//;
34 function about_freeside() {
38 webfxMenuImagePath = "<%$fsurl%>images/";
39 webfxMenuUseHover = 1;
40 webfxMenuShowTime = 300;
41 webfxMenuHideTime = 500;
43 var myBar = new WebFXMenuBar;
47 % my( $subhtml, $submenuname ) = submenu(\%menu, 'Freeside');
49 myBar.add(new WebFXMenuButton("Freeside",
52 <% $submenuname |n %>));
55 % foreach my $item ( keys %menu ) {
57 % my( $url_or_submenu, $tooltip ) = @{ $menu{$item} };
59 % if ( ref($url_or_submenu) ) {
63 % my( $subhtml, $submenuname ) = submenu($url_or_submenu, $item);
66 myBar.add(new WebFXMenuButton(<% mt($item) |js_string %>, null, <% mt($tooltip) |js_string %>, <% $submenuname |n %> ));
70 myBar.add(new WebFXMenuButton(<% mt($item) |js_string %>, "<% $url_or_submenu %>", <% mt($tooltip) |js_string %> ));
76 myBar.show( null, 'vertical' );
83 my $conf = new FS::Conf;
84 my $fsurl = $opt{'freeside_baseurl'};
86 my $mobile = $opt{'mobile'} || 0;
88 my $curuser = $FS::CurrentUser::CurrentUser;
90 #XXX Active tickets not assigned to a customer
92 tie my %report_prospects, 'Tie::IxHash',
93 'List prospects' => [ $fsurl. 'search/prospect_main.html', '' ],
94 'Advanced prospect reports' => [ $fsurl. 'search/report_prospect_main.html', '' ],
97 tie my %report_quotations, 'Tie::IxHash',
98 'List quotations' => [ $fsurl. 'search/quotation.html', '' ],
99 'Advanced quotation reports' => [ $fsurl. 'search/report_quotation.html', '' ],
102 tie my %report_customers_lists, 'Tie::IxHash',
103 'by customer number' => [ $fsurl. 'search/cust_main.cgi?browse=custnum', '' ],
104 'by last name' => [ $fsurl. 'search/cust_main.cgi?browse=last', '' ],
105 'by company name' => [ $fsurl. 'search/cust_main.cgi?browse=company', '' ],
107 $report_customers_lists{'by active trouble tickets'} = [ $fsurl. 'search/cust_main.cgi?browse=tickets', '' ]
108 if $conf->config('ticket_system');
109 $report_customers_lists{'with USPS-unvalidated addresses'} = [ $fsurl. 'search/cust_main.cgi?browse=uspsunvalid', '' ]
110 if $conf->config('usps_webtools-userid') && $conf->config('usps_webtools-password');
112 tie my %report_customers, 'Tie::IxHash';
113 $report_customers{'List customers'} = [ \%report_customers_lists, 'List customers' ]
114 if $curuser->access_right('List all customers');
115 $report_customers{'Zip code distribution'} = [ $fsurl. 'search/report_cust_main-zip.html', 'Zip codes by number of customers' ];
116 $report_customers{'Customer signup report'} = [ $fsurl. 'graph/report_cust_signup.html', 'New customer signups by date' ],
117 $report_customers{'Advanced customer reports'} = [ $fsurl. 'search/report_cust_main.html', 'by status, signup date, agent, etc.' ]
118 if $curuser->access_right('Advanced customer search');
120 tie my %report_invoices_open, 'Tie::IxHash',
121 'All open invoices' => [ $fsurl.'search/cust_bill.html?OPEN_date', 'All invoices with an unpaid balance' ],
122 '15 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN15_date', 'Invoices 15 days or older with an unpaid balance' ],
123 '30 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN30_date', 'Invoices 30 days or older with an unpaid balance' ],
124 '60 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN60_date', 'Invoices 60 days or older with an unpaid balance' ],
125 '90 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN90_date', 'Invoices 90 days or older with an unpaid balance' ],
126 '120 day open invoices' => [ $fsurl.'search/cust_bill.html?OPEN120_date', 'Invoices 120 days or older with an unpaid balance' ],
129 tie my %report_invoices, 'Tie::IxHash',
130 'Open invoices' => [ \%report_invoices_open, 'Open invoices' ],
131 'All invoices' => [ $fsurl. 'search/cust_bill.html?date', 'List all invoices' ],
132 'Advanced invoice reports' => [ $fsurl.'search/report_cust_bill.html', 'by agent, date range, etc.' ],
134 'Line items' => [ $fsurl. 'search/report_cust_bill_pkg.html', 'Individual line item detail' ],
137 tie my %report_discounts, 'Tie::IxHash',
138 'Discount graph' => [ $fsurl. 'graph/report_cust_bill_pkg_discount.html', 'Discount overview per month' ],
139 'Discount detail' => [ $fsurl.'search/report_cust_bill_pkg_discount.html', 'Discount report (by employee and/or date range)' ],
141 'Package discounts' => [ $fsurl.'search/report_cust_pkg_discount.html', 'Active/inactive discounts by package' ],
144 tie my %report_services, 'Tie::IxHash';
145 if ( $curuser->access_right('Configuration') ) {
146 $report_services{'Service definitions'} = [ $fsurl.'browse/part_svc.cgi?orderby=active', 'Service definitions by number of active packages' ];
147 $report_services{'separator'} = '';
150 if ( $curuser->access_right('List services') ) {
151 $report_services{'Unprovisioned services'} = [ $fsurl.'search/report_unprovisioned_services.html', 'Unprovisioned services' ];
152 $report_services{'separator2'} = '';
155 foreach my $svcdb ( FS::part_svc->svc_tables() ) {
157 my $name = "FS::$svcdb"->table_info->{'name_plural'}
158 || PL( "FS::$svcdb"->table_info->{'name'} );
159 my $lcname = "FS::$svcdb"->table_info->{'lcname_plural'} || lc($name);
160 my $lcsname = lc("FS::$svcdb"->table_info->{'name'});
161 my $longname = "FS::$svcdb"->table_info->{'longname_plural'} || $name;
162 my $lclongname = lc($longname);
163 my $sorts = "FS::$svcdb"->table_info->{'sorts'} || [ 'svcnum' ];
164 $sorts = [ $sorts ] unless ref($sorts);
165 my %svc_url = ( 'm' => $m,
166 'action' => 'search',
170 tie my %report_svc, 'Tie::IxHash';
172 foreach my $sort ( @$sorts ) {
174 my $field_info = FS::part_svc->svc_table_fields($svcdb)->{$sort};
175 my $label = $field_info->{'label_sort'} || 'by '.$field_info->{'label'};
177 my $title = "All $lcname";
179 if scalar(@$sorts) > 1;
181 $report_svc{$title} =
182 [ svc_url( %svc_url, 'query' => "magic=all;sortby=$sort" ),
187 if ( $svcdb eq 'svc_acct' ) {
189 $report_svc{"All $lcname never logged in"} =
190 [ svc_url( %svc_url, 'query' => "magic=nologin;sortby=svcnum" ),
194 } elsif ( $svcdb eq 'svc_phone' ) {
196 $report_svc{"${name}' total usage by time period"} =
197 [ $fsurl. 'search/report_svc_phone_usage.html',
198 'Total usage (minutes, and amount billed) for the specified time period, per phone number.',
200 $report_svc{"${name} by state"} =
201 [ $fsurl. 'search/phone_state.html',
202 'Current or historical phone services broken down by state.',
207 if ( $curuser->access_right('View/link unlinked services') ) {
208 $report_svc{"Unlinked $lcname"} =
209 [ svc_url( %svc_url, 'query' => "magic=unlinked;sortby=". $sorts->[0] ),
210 "Pre-Freeside $lcname without a customer record",
214 $report_svc{"Advanced $lcsname reports"} =
215 [ $fsurl."search/report_$svcdb.html", '' ]
216 if $svcdb =~ /^svc_(acct|broadband|hardware|phone)$/
217 && $curuser->access_right("Services: $name: Advanced search");
219 if ( $svcdb eq 'svc_phone' ) {
221 $report_svc{"Phone number (DID) availability"} =
222 [ $fsurl."search/report_phone_avail.html", '' ];
223 $report_svc{"Inventory/Provisioning Status"} =
224 [ $fsurl."search/phone_inventory_provisioned.html", '' ];
226 } elsif ( $svcdb eq 'svc_dsl' ) {
228 $report_svc{'Qualifications'} = [ $fsurl. 'search/qual.cgi', #XXX qual.html
234 $report_services{$name} = [ \%report_svc, $longname ]
235 if $curuser->access_right("Services: $name");
239 tie my %report_packages, 'Tie::IxHash';
240 $report_packages{'Package definitions (by # active)'} = [ $fsurl.'browse/part_pkg.cgi?active=1', 'Package definitions by number of active packages' ]
241 if $curuser->access_right('Edit package definitions')
242 || $curuser->access_right('Edit global package definitions');
243 $report_packages{'Package costs'} = [ $fsurl.'graph/report_cust_pkg_cost.html', 'Package setup and recurring costs graph' ]
244 if $curuser->access_right('Financial reports');
245 $report_packages{'separator'} = ''
246 if keys %report_packages;
247 if ( $curuser->access_right('Financial reports') ) {
248 $report_packages{'Package churn'} = [ $fsurl.'graph/report_cust_pkg.html', 'Orders, suspensions and cancellations summary graph' ];
249 $report_packages{'separator2'} = '';
251 $report_packages{'All customer packages'} = [ $fsurl.'search/cust_pkg.cgi?pkgnum', 'List all customer packages', ];
252 $report_packages{'Package summary'} = [ $fsurl.'search/cust_pkg_summary.html', 'Show package sales summary', ]
253 if $curuser->access_right('Summarize packages');
254 $report_packages{'Suspended customer packages'} = [ $fsurl.'search/cust_pkg.cgi?magic=suspended', 'List suspended packages' ];
255 $report_packages{'Suspension summary'} = [ $fsurl.'search/cust_pkg_susp.html', 'Show suspension activity', ]
256 if $curuser->access_right('Summarize packages');
257 $report_packages{'Customer packages with unconfigured services'} = [ $fsurl.'search/cust_pkg.cgi?APKG_pkgnum', 'List packages which have provisionable services' ];
258 $report_packages{'FCC Form 477 packages'} = [ $fsurl.'search/report_477.html', 'Summarize packages by census tract for particular types' ]
259 if $conf->exists('cust_main-require_censustract');
260 $report_packages{'Advanced package reports'} = [ $fsurl.'search/report_cust_pkg.html', 'by agent, date range, status, package definition' ];
262 tie my %report_inventory, 'Tie::IxHash',
263 'Inventory by agent' => [ $fsurl.'search/report_agent_inventory.html', '' ],
264 'Inventory activity' => [ $fsurl.'search/report_h_inventory_item.html', '' ],
267 tie my %report_rating, 'Tie::IxHash';
268 $report_rating{'RADIUS sessions'} = [ $fsurl.'search/sqlradius.html', '' ]
269 if $curuser->access_right("Usage: RADIUS sessions");
270 $report_rating{'RADIUS data usage'} = [ $fsurl.'search/report_sqlradius_usage.html', '' ]
271 if $curuser->access_right("Usage: RADIUS sessions");
272 $report_rating{'Call Detail Records (CDRs)'} = [ $fsurl.'search/report_cdr.html', '' ]
273 if $curuser->access_right("Usage: Call Detail Records (CDRs)");
274 $report_rating{'Unrateable CDRs'} = [ $fsurl.'search/cdr.html?freesidestatus=failed;cdrbatchnum=_ALL_' ]
275 if $curuser->access_right("Usage: Unrateable CDRs");
276 if ( $curuser->access_right("Usage: Time worked") ) {
277 $report_rating{'Time worked'} = [ $fsurl.'search/report_rt_transaction.html', '' ];
278 $report_rating{'Time worked summary'} = [ $fsurl.'search/report_rt_ticket.html', '' ];
281 tie my %report_ticketing_statistics, 'Tie::IxHash',
282 'Tickets per day per Queue' => [ $fsurl.'rt/RTx/Statistics/CallsQueueDay', 'View the number of tickets created, resolved or deleted in a specific Queue, over the requested period of days' ],
283 'Ticket status by Queue' => [ $fsurl.'rt/RTx/Statistics/OpenStalled', 'View numbers of new, open and stalled tickets in a selected Queue' ],
284 'Tickets per day (multiple Queues)' => [ $fsurl.'rt/RTx/Statistics/CallsMultiQueue', 'View tickets created, resolved or deleted on in one or more Queues over a specified time period' ],
285 'Tickets per Day of Week' => [ $fsurl.'rt/RTx/Statistics/DayOfWeek', 'View trends showing when tickets are created, resolved or deleted' ],
286 'Time to resolve' => [ $fsurl.'rt/RTx/Statistics/Resolution', 'View how long tickets take to be resolved by Queue' ],
287 'Time to resolve (scatter graph)' => [ $fsurl.'rt/RTx/Statistics/TimeToResolve', 'View a detailed scatter graph of time to resolve tickets by Queue' ],
290 tie my %report_ticketing, 'Tie::IxHash',
291 # fix TimeToResolve extension? or redo in a more modern way?
292 # 'Resolved by owner' => [ $fsurl.'rt/Tools/Reports/ResolvedByOwner.html', '' ],
293 # 'Resolved in date range' => [ $fsurl.'rt/Tools/Reports/ResolvedByDates.html', '' ],
294 # 'Created in date range' => [ $fsurl.'rt/Tools/Reports/CreatedByDates.html', '' ],
296 'Statistics' => [ \%report_ticketing_statistics, '' ],
298 'Advanced ticket reports' => [ $fsurl.'rt/Search/Build.html?NewQuery=1', 'List tickets by any criteria' ],
301 tie my %report_employees, 'Tie::IxHash';
302 $report_employees{'Employee Commission Report'} = [ $fsurl.'search/report_employee_commission.html', '' ]
303 if $curuser->access_right('Employees: Commission Report');
304 $report_employees{'Employee Audit Report'} = [ $fsurl.'search/report_employee_audit.html', 'Employee audit report' ]
305 if $curuser->access_right('Employees: Audit Report');
308 tie my %report_bill_event, 'Tie::IxHash',
309 'All billing events' => [ $fsurl.'search/report_cust_event.html', 'All billing events for a date range' ],
310 'Billing event errors' => [ $fsurl.'search/report_cust_event.html?failed=1', 'Failed credit cards, processor or printer problems, etc.' ],
311 # 'All invoice events' => [ $fsurl.'search/cust_bill_event.html', 'Reports on deprecated, old-style invoice events for a date range' ],
312 # '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.' ],
315 tie my %report_payments, 'Tie::IxHash',
316 'Payments' => [ $fsurl.'search/report_cust_pay.html', 'Payment report (by type and/or date range)' ],
318 $report_payments{'Pending Payments'} = [ $fsurl.'search/cust_pay_pending.html?magic=_date;statusNOT=done', 'Pending real-time payments' ]
319 if $curuser->access_right('View customer pending payments');
320 $report_payments{'Voided Payments'} = [ $fsurl.'search/report_cust_pay.html?void=1', 'Voided payment report (by type and/or date range)' ]
321 if $curuser->access_right('View customer pending payments');
322 $report_payments{'Unapplied Payments'} = [ $fsurl.'search/report_cust_pay.html?unapplied=1', 'Unapplied payment report (by type and/or date range)' ];
323 $report_payments{'Payment Batches'} = [ $fsurl.'search/pay_batch.html', 'Payment batches (by status and/or date range)' ]
324 if $conf->exists('batch-enable') || $conf->config('batch-enable_payby');
325 $report_payments{'Unapplied Payment Aging'} = [ $fsurl.'search/report_unapplied_cust_pay.html', 'Unapplied payment aging report' ];
326 $report_payments{'Deleted Payments / Payment history table'} = [ $fsurl.'search/report_h_cust_pay.html', 'Deleted payments / payment history table' ]
327 if $conf->exists('payment-history-report');
329 tie my %report_credits, 'Tie::IxHash',
330 'Credit Report' => [ $fsurl.'search/report_cust_credit.html', 'Credit report (by employee and/or date range)' ],
331 'Credit application detail' => [ $fsurl.'search/report_cust_credit_bill_pkg.html', 'Line item application detail' ],
332 'Unapplied Credits' => [ $fsurl.'search/report_cust_credit.html?unapplied=1', 'Unapplied credit report (by type and/or date range)' ],
335 tie my %report_refunds, 'Tie::IxHash',
336 'Refund Report' => [ $fsurl.'search/report_cust_refund.html', 'Refund report (by type and/or date range)' ],
337 'Unapplied Refunds' => [ $fsurl.'search/report_cust_refund.html?unapplied=1', 'Unapplied refund report (by type and/or date range)' ],
340 tie my %report_sales, 'Tie::IxHash',
341 'Sales, Credits and Receipts' => [ $fsurl.'graph/report_money_time.html', 'Sales, credits and receipts summary graph' ],
342 'Daily Sales, Credits and Receipts' => [ $fsurl.'graph/report_money_time_daily.html', 'Sales, credits and receipts (broken down by day) summary graph' ],
343 'Sales Report' => [ $fsurl.'graph/report_cust_bill_pkg.html', 'Sales report and graph (by agent, package class and/or date range)' ],
344 'Rated Call Sales Report' => [ $fsurl.'graph/report_cust_bill_pkg_detail.html', 'Sales report and graph (by agent, package class, usage class and/or date range)' ],
345 'Sales with Advertising Source' => [ $fsurl.'search/report_cust_bill_pkg_referral.html' ],
346 'Agent Commissions' => [ $fsurl.'search/report_agent_commission.html' ],
347 'Sales Person Commissions' => [ $fsurl.'search/report_sales_commission.html' ],
350 tie my %report_financial, 'Tie::IxHash';
351 if( $curuser->access_right('Financial reports') ) {
353 %report_financial = (
354 'Sales' => [ \%report_sales, 'Sales reports', ],
355 'Credits' => [ \%report_credits, 'Credit reports', ],
356 'Refunds' => [ \%report_refunds, 'Refund reports', ],
358 $report_financial{'A/R Aging'} = [ $fsurl.'search/report_receivables.html', 'Accounts Receivable Aging report' ];
359 $report_financial{'Prepaid Income'} = [ $fsurl.'search/report_prepaid_income.html', 'Prepaid income (unearned revenue) report' ];
361 my $taxproducts = $conf->exists('enable_taxproducts');
362 $report_financial{'Tax Liability'. ($taxproducts ? ' (internal tax data)' : '')} = [ $fsurl.'search/report_tax.html', 'Tax liability report (internal tax data)' ];
363 $report_financial{'Tax Liability (vendor tax data)'} = [ $fsurl.'search/report_newtax.html', 'Tax liability report (vendor tax data)' ]
366 # most sites don't need this but there isn't really a config to enable it
367 $report_financial{'E911 Fee Summary'} = [ $fsurl.'search/report_e911.html', 'E911 fee summary' ];
369 $report_financial{'Customer Accounting Summary'} = [ $fsurl.'search/report_customer_accounting_summary.html', 'Customer accounting summary report' ];
371 } elsif($curuser->access_right('Receivables report')) {
373 $report_financial{'A/R Aging'} = [ $fsurl.'search/report_receivables.html', 'Accounts Receivable Aging report' ];
375 } # else $report_financial contains nothing.
377 tie my %report_logs, 'Tie::IxHash';
378 $report_logs{'System log'} = [ $fsurl.'search/log.html', 'View system events and debugging information.' ],
379 if $curuser->access_right('View system logs')
380 || $curuser->access_right('Configuration');
381 $report_logs{'Outgoing messages'} = [ $fsurl.'search/cust_msg.html', 'View outgoing message log' ]
382 if $curuser->access_right('View email logs')
383 || $curuser->access_right('Configuration');
385 tie my %report_menu, 'Tie::IxHash';
386 $report_menu{'Prospects'} = [ \%report_prospects, 'Prospect reports' ]
387 if $curuser->access_right('List prospects');
388 $report_menu{'Quotations'} = [ \%report_quotations, 'Quotation reports' ]
389 if $curuser->access_right('List quotations');
390 $report_menu{'Customers'} = [ \%report_customers, 'Customer reports' ]
391 if $curuser->access_right('List customers');
392 $report_menu{'Invoices'} = [ \%report_invoices, 'Invoice reports' ]
393 if $curuser->access_right('List invoices');
394 $report_menu{'Discounts'} = [ \%report_discounts, 'Discount reports' ]
395 if $curuser->access_right('Financial reports');
396 $report_menu{'Payments'} = [ \%report_payments, 'Payment reports' ]
397 if $curuser->access_right('Financial reports');
398 $report_menu{'Packages'} = [ \%report_packages, 'Package reports' ]
399 if $curuser->access_right('List packages');
400 $report_menu{'Services'} = [ \%report_services, 'Services reports' ]
401 if $curuser->access_right('List services');
402 $report_menu{'Inventory'} = [ \%report_inventory, 'Inventory reports' ]
403 if $curuser->access_right('Configuration'); #XXX List inventory?
404 $report_menu{'Usage'} = [ \%report_rating, 'Usage reports' ]
405 if $curuser->access_right('List rating data');
406 $report_menu{'Tickets'} = [ \%report_ticketing, 'Ticket reports' ]
407 if $conf->config('ticket_system')
408 ;#&& FS::TicketSystem->access_right(\%session, 'Something');
409 $report_menu{'Employees'} = [ \%report_employees, 'Employee reports' ]
410 if keys %report_employees;
411 $report_menu{'Billing events'} = [ \%report_bill_event, 'Billing events' ]
412 if $curuser->access_right('Billing event reports');
413 $report_menu{'Financial'} = [ \%report_financial, 'Financial reports' ]
414 if $curuser->access_right('Financial reports')
415 or $curuser->access_right('Receivables report');
416 $report_menu{'Logs'} = [ \%report_logs, 'System and email logs' ]
417 if (keys %report_logs); # empty if the user has no rights to it
418 $report_menu{'SQL Query'} = [ $fsurl.'search/report_sql.html', 'SQL Query']
419 if $curuser->access_right('Raw SQL');
421 tie my %tools_importing, 'Tie::IxHash',
422 'Customers' => [ $fsurl.'misc/cust_main-import.cgi', '' ],
423 'Customer packages' => [ $fsurl.'misc/cust_pkg-import.html', '' ],
424 'Customer comments from CSV file' => [ $fsurl.'misc/cust_main_note-import.html', '' ],
425 'One-time charges from CSV file' => [ $fsurl.'misc/cust_main-import_charges.cgi', '' ],
426 'Payments from CSV file' => [ $fsurl.'misc/cust_pay-import.cgi', '' ],
427 'Phone numbers (DIDs)' => [ $fsurl.'misc/phone_avail-import.html', '' ],
428 'Call Detail Records (CDRs)' => [ $fsurl.'misc/cdr-import.html', '' ],
430 if ( $conf->exists('enable_taxproducts') ) {
431 if ( $conf->exists('taxdatadirectdownload') ) {
432 $tools_importing{'Tax rates from vendor site'} =
433 [ $fsurl.'misc/tax-fetch_and_import.cgi', '' ];
435 $tools_importing{'Tax rates from CSV files'} =
436 [ $fsurl.'misc/tax-import.cgi', '' ];
440 tie my %tools_exporting, 'Tie::IxHash',
441 'Download database dump' => [ $fsurl. 'misc/dump.cgi', '' ],
444 tie my %tools_ticketing_articles, 'Tie::IxHash',
445 'Overview' => [ $fsurl.'rt/Articles/index.html', '' ],
446 'Search' => [ $fsurl.'rt/Articles/Article/Search.html', '' ],
447 'Topics' => [ $fsurl.'rt/Articles/Topics.html', '' ],
450 tie my %tools_ticketing, 'Tie::IxHash',
451 'Articles' => [ \%tools_ticketing_articles, '' ],
452 'My Day' => [ $fsurl.'rt/Tools/MyDay.html', '' ],
453 'My Reminders' => [ $fsurl.'rt/Tools/MyReminders.html', '' ],
454 'Offline' => [ $fsurl.'rt/Tools/Offline.html', '' ],
455 'Approval' => [ $fsurl.'rt/Approvals/', '' ],
457 $tools_ticketing{'Cron Tool'} = [ $fsurl.'rt/Developer/CronTool/', '' ]
458 if $conf->exists('rt-crontool');
460 tie my %tools_menu, 'Tie::IxHash', ();
461 $tools_menu{'Quick payment entry'} = [ $fsurl.'misc/batch-cust_pay.html', 'Enter multiple payments in a batch' ]
462 if $curuser->access_right('Post payment batch');
463 $tools_menu{'Process payment batches'} = [ $fsurl.'search/pay_batch.cgi?magic=_date;open=1;intransit=1', 'Process credit card and electronic check batches' ]
464 if ( $conf->exists('batch-enable') || $conf->config('batch-enable_payby') )
465 && $curuser->access_right('Process batches');
466 $tools_menu{'Download invoice batches'} = [ $fsurl.'search/bill_batch.cgi' ]
467 if $curuser->access_right('Process invoice batches')
468 || $curuser->access_right('Process global invoice batches')
469 || $curuser->access_right('Configuration'); #XXX remove in 2.5
470 #now there's a standalone event#if $conf->exists('invoice_print_pdf');
471 $tools_menu{'Bulk DID Orders'} = [ $fsurl.'browse/did_order.html', 'View/manage bulk DID orders' ]
472 if $curuser->access_right('Import');
473 $tools_menu{'Job Queue'} = [ $fsurl.'search/queue.html', 'View pending job queue' ]
474 if $curuser->access_right('Job queue');
475 $tools_menu{'Ticketing'} = [ \%tools_ticketing, 'Ticketing tools' ]
476 if $conf->config('ticket_system');
477 $tools_menu{'Customer email settings'} = [ $fsurl.'misc/manage_cust_email.html' ]
478 if $curuser->access_right('Edit customer');
479 $tools_menu{'Business card scan'} = [ $fsurl.'edit/prospect_main-upload.html' ]
480 if $curuser->access_right('New prospect');
481 $tools_menu{'Time Queue'} = [ $fsurl.'search/report_timeworked.html', 'View pending support time' ]
482 if $curuser->access_right('Time queue');
483 $tools_menu{'Attachments'} = [ $fsurl.'browse/cust_attachment.html', 'View customer attachments' ]
484 if !$conf->config('disable_cust_attachment') and $curuser->access_right('View attachments') and $curuser->access_right('Browse attachments');
485 $tools_menu{'Importing'} = [ \%tools_importing, 'Import tools' ]
486 if $curuser->access_right('Import');
487 $tools_menu{'Exporting'} = [ \%tools_exporting, 'Export tools' ]
488 if $curuser->access_right('Export');
490 tie my %config_employees, 'Tie::IxHash',
491 'Employees' => [ $fsurl.'browse/access_user.html', 'Setup internal users' ],
492 'Employee groups' => [ $fsurl.'browse/access_group.html', 'Employee groups allow you to control access to the backend' ],
495 tie my %config_dialup, 'Tie::IxHash',
496 'Access numbers' => [ $fsurl.'browse/svc_acct_pop.cgi', 'Points of Presence' ],
499 tie my %config_broadband, 'Tie::IxHash',
500 'Towers' => [ $fsurl.'browse/tower.html', 'Towers and sectors' ],
501 'Routers' => [ $fsurl.'browse/router.cgi', 'Broadband access routers' ],
502 'Address blocks' => [ $fsurl.'browse/addr_block.cgi', 'Manage address blocks and block assignments to broadband routers' ],
505 tie my %config_phone, 'Tie::IxHash',
506 'View/Edit phone device types' => [ $fsurl.'browse/part_device.html', 'Phone device types' ],
507 'View/Edit bulk DID vendors' => [ $fsurl.'browse/did_vendor.html', 'Bulk DID vendors' ],
508 'View/Edit Carriers' => [ $fsurl.'browse/cdr_carrier.html', 'Carriers' ],
511 tie my %config_radius, 'Tie::IxHash',
512 'RADIUS Groups' => [ $fsurl.'browse/radius_group.html', 'Manage RADIUS groups' ],
513 'RADIUS Clients' => [ $fsurl.'browse/nas.html', 'Manage RADIUS clients' ],
516 tie my %config_cable, 'Tie::IxHash',
517 'Cable providers' => [ $fsurl.'browse/cable_provider.html', '' ],
518 'Cable modem models' => [ $fsurl.'browse/cable_model.html', '' ],
521 tie my %config_export_svc, 'Tie::IxHash', ();
522 if ( $curuser->access_right('Configuration') ) {
523 $config_export_svc{'Service definitions'} = [ $fsurl.'browse/part_svc.cgi', 'Services are items you offer to your customers' ];
524 $config_export_svc{'Service classes'} = [ $fsurl.'browse/part_svc_class.html', 'Services classes are user-defined, informational types for services' ];
525 $config_export_svc{'Provisioning exports'} = [ $fsurl.'browse/part_export.cgi', 'Provisioning services to external machines, databases and APIs' ];
527 $config_export_svc{'Dialup'} = [ \%config_dialup, '' ]
528 if $curuser->access_right('Dialup configuration');
529 $config_export_svc{'Wireless broadband'} = [ \%config_broadband, '' ]
530 if $curuser->access_right('Broadband configuration');
531 $config_export_svc{'Phone'} = [ \%config_phone, '' ]
532 if $curuser->access_right('Configuration');
533 $config_export_svc{'RADIUS'} = [ \%config_radius, '' ]
534 if $curuser->access_right('Configuration');
535 $config_export_svc{'Cable'} = [ \%config_cable, '' ]
536 if $curuser->access_right('Configuration');
537 $config_export_svc{'Hardware types'} = [ $fsurl.'browse/hardware_class.html', 'Set up hardware type catalog' ]
538 if $curuser->access_right('Configuration');
540 tie my %config_pkg_reason, 'Tie::IxHash',
541 'Cancel reasons' => [ $fsurl.'browse/reason.html?class=C', 'Cancel reasons explain why a service was cancelled.' ],
542 'Cancel reason types' => [ $fsurl.'browse/reason_type.html?class=C', 'Cancel reason types define groups of reasons.' ],
543 'Suspend reasons' => [ $fsurl.'browse/reason.html?class=S', 'Suspend reasons explain why a service was suspended.' ],
544 'Suspend reason types' => [ $fsurl.'browse/reason_type.html?class=S', 'Suspend reason types define groups of reasons.' ],
547 tie my %config_pkg, 'Tie::IxHash', ();
548 $config_pkg{'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' ]
549 if $curuser->access_right('Edit package definitions')
550 || $curuser->access_right('Edit global package definitions');
551 if ( $curuser->access_right('Configuration') ) {
553 #package grouping sub-menu?
554 $config_pkg{'Package classes'} = [ $fsurl.'browse/pkg_class.html', 'Package classes define groups of packages, for taxation, ordering convenience and reporting.' ];
555 $config_pkg{'Package categories'} = [ $fsurl.'browse/pkg_category.html', 'Package categories define groups of package classes, for invoice sections.' ];
556 $config_pkg{'Package report classes'} = [ $fsurl.'browse/part_pkg_report_option.html', 'Package classes define optional groups of packages for reporting only.' ];
557 #eo package grouping sub-menu
559 $config_pkg{'Discounts'} = [ $fsurl.'browse/discount.html', '' ];
560 $config_pkg{'Discount classes'} = [ $fsurl.'browse/discount_class.html', '' ];
561 $config_pkg{'Cancel/Suspend Reasons'} = [ \%config_pkg_reason, '' ];
564 tie my %config_cust, 'Tie::IxHash',
565 'Customer tags' => [ $fsurl.'browse/part_tag.html', '' ],
566 'Customer classes' => [ $fsurl.'browse/cust_class.html', 'Customer classes define groups of customers for reporting.' ],
567 'Customer categories' => [ $fsurl.'browse/cust_category.html', 'Customer categories define groups of customer classes.' ],
568 'separator' => '', #its a separator!
569 'Contact types' => [ $fsurl.'browse/contact_class.html', ''], #XXX useful description
572 $config_cust{'Note classes'} = [ $fsurl.'browse/cust_note_class.html', 'Note classes define groups of customer notes for reporting.' ]
573 if ($conf->exists('note-classes') && $conf->config('note-classes') > 0);
575 tie my %config_agent, 'Tie::IxHash',
576 'Agent types' => [ $fsurl.'browse/agent_type.cgi', 'Agent types define groups of package definitions that you can then assign to particular agents' ],
577 '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)' ],
578 'Agent payment gateways' => [ $fsurl.'browse/payment_gateway.html', 'Credit card and electronic check processors for agent overrides' ];
581 tie my %config_sales, 'Tie::IxHash',
582 'Sales People' => [ $fsurl.'browse/sales.html', 'Sales people bring in new business.' ],
585 tie my %config_billing_rates, 'Tie::IxHash',
586 'Rate plans' => [ $fsurl.'browse/rate.cgi', 'Manage rate plans' ],
587 'Regions and prefixes' => [ $fsurl.'browse/rate_region.html', 'Manage regions and prefixes' ],
588 'Usage classes' => [ $fsurl.'browse/usage_class.html', 'Usage classes define groups of usage for taxation.' ],
589 'Time periods' => [ $fsurl.'browse/rate_time.html', 'Time periods define days and hours for rate plans' ],
590 'Edit rates with Excel' => [ $fsurl.'misc/rate_edit_excel.html', 'Download and edit rates with Excel, then upload changes.' ], #"Edit with Excel" ?
591 'separator' => '', #its a separator!
592 'Tiering plans' => [ $fsurl.'browse/rate_tier.html', 'Rating tiers' ],
595 tie my %config_billing, 'Tie::IxHash';
596 # 'Payment gateways' => [ $fsurl.'browse/payment_gateway.html', 'Credit card and electronic check processors' ];
597 $config_billing{'Billing events'} = [ $fsurl.'browse/part_event.html', 'Billing actions for customers, invoices and packages' ]
598 if $curuser->access_right('Edit billing events')
599 || $curuser->access_right('Edit global billing events');
600 if ( $curuser->access_right('Configuration') ) {
601 #$config_billing{'Invoice events'} = [ $fsurl.'browse/part_bill_event.cgi', 'Deprecated, old-style actions for overdue invoices' ];
602 $config_billing{'Invoice configurations'} = [ $fsurl.'browse/invoice_conf.html', 'Adjust invoice settings for special-purpose notices' ];
603 $config_billing{'Invoice templates'} = [ $fsurl.'browse/invoice_template.html', 'Edit templates for HTML, plaintext and typeset invoices' ];
604 $config_billing{'Prepaid cards'} = [ $fsurl.'search/prepay_credit.html', 'View outstanding cards, generate new cards' ];
605 $config_billing{'Call rates and regions'} = [ \%config_billing_rates, 'Manage rate plans, regions and prefixes for VoIP and call billing' ];
607 my $config_taxes_name = 'Locales and tax rates'.
608 ( $conf->exists('enable_taxproducts')
609 ? ' (internal tax class system)'
612 $config_billing{$config_taxes_name} = [ $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' ];
613 $config_billing{'Tax rates (vendor data tax products system)'} = [ $fsurl.'browse/tax_rate.cgi', 'Edit tax rates for the vendor data tax products system' ]
614 if $conf->exists('enable_taxproducts');
615 $config_billing{'Tax classes'} = [ $fsurl. 'browse/part_pkg_taxclass.html', 'Tax classes' ];
617 $config_billing{'Credit reasons'} = [ $fsurl.'browse/reason.html?class=R', 'Credit reasons explain why a credit was issued.' ];
618 $config_billing{'Credit reason types'} = [ $fsurl.'browse/reason_type.html?class=R', 'Credit reason types define groups of reasons.' ];
621 #XXX also to be unified
622 tie my %config_ticketing_groups, 'Tie::IxHash',
623 'Select' => [ $fsurl.'rt/Admin/Groups', '' ],
624 'Create' => [ $fsurl.'rt/Admin/Groups/Modify.html?Create=1', '' ],
627 tie my %config_ticketing_queues, 'Tie::IxHash',
628 'Select' => [ $fsurl.'rt/Admin/Queues', '' ],
629 'Create' => [ $fsurl.'rt/Admin/Queues/Modify.html?Create=1', '' ],
632 tie my %config_ticketing_customfields, 'Tie::IxHash',
633 'Select' => [ $fsurl.'rt/Admin/CustomFields', '' ],
634 'Create' => [ $fsurl.'rt/Admin/CustomFields/Modify.html?Create=1', '' ],
637 tie my %config_ticketing_articles_classes, 'Tie::IxHash',
638 'Select' => [ $fsurl.'rt/Admin/Articles/Classes/', '' ],
639 'Create' => [ $fsurl.'rt/Admin/Articles/Classes/Modify.html?Create=1', '' ],
642 tie my %config_ticketing_articles_customfields, 'Tie::IxHash',
643 'Select' => [ $fsurl.'rt/Admin/CustomFields/index.html?type=RT%3A%3AClass-RT%3A%3AArticle', '' ],
644 'Create' => [ $fsurl.'rt/Admin/CustomFields/Modify.html?Create=1&LookupType=RT%3A%3AClass-RT%3A%3AArticle', '' ],
647 tie my %config_ticketing_articles, 'Tie::IxHash',
648 'Classes' => [ \%config_ticketing_articles_classes, '' ],
649 'Custom Fields' => [ \%config_ticketing_articles_customfields, '' ],
652 tie my %config_ticketing, 'Tie::IxHash',
653 'Ticketing Users' => [ $fsurl.'rt/Admin/Users', 'Edit ticketing users' ], #XXX to be unified
654 'Ticketing Groups' => [ \%config_ticketing_groups, 'View/Edit ticketing groups and group membership' ], #XXX to be unified
655 'Ticketing Queues' => [ \%config_ticketing_queues, 'View/Edit ticketing queues and queue-specific properties' ],
656 'Ticket Custom Fields' => [ \%config_ticketing_customfields, 'View/Edit ticketing custom fields' ],
657 'Ticketing Global' => [ $fsurl.'rt/Admin/Global', 'View/Edit ticketing configuration applicable to all queues' ], #XXX the individual items
658 'Ticketing Articles' => [ \%config_ticketing_articles, '' ],
659 #"System Configuraiton"? useless, just makes people report errors about missing Module::Versions::Report #'Ticketing Tools' => [ $fsurl.'rt/Admin/Tools', '' ],
662 tie my %config_nms, 'Tie::IxHash',
663 'View/Edit virtual ports' => [ $fsurl.'browse/torrus_srvderive.html', '' ],
666 tie my %config_misc, 'Tie::IxHash';
667 $config_misc{'Message templates'} = [ $fsurl.'browse/msg_template.html', 'Templates for customer notices' ]
668 if $curuser->access_right(['View templates', 'View global templates',
669 'Edit templates', 'Edit global templates', ]);
670 $config_misc{'Advertising sources'} = [ $fsurl.'browse/part_referral.html', 'Where a customer heard about your service.' ]
671 if $curuser->access_right('Edit advertising sources')
672 || $curuser->access_right('Edit global advertising sources');
673 if ( $curuser->access_right('Configuration') ) {
674 $config_misc{'Custom fields'} = [ $fsurl.'browse/part_virtual_field.html', 'Locally defined fields', ];
675 $config_misc{'Translation strings'} = [ $fsurl.'browse/msgcat.html', 'Translations and other customizable labels for each locale' ];
677 $config_misc{'Inventory classes and inventory'} = [ $fsurl.'browse/inventory_class.html', 'Setup inventory classes and stock inventory' ]
678 if $curuser->access_right('Edit inventory')
679 || $curuser->access_right('Edit global inventory')
680 || $curuser->access_right('Configuration');
682 $config_misc{'Upload targets'} = [ $fsurl.'browse/upload_target.html', 'Billing and payment upload destinations' ]
683 if $curuser->access_right('Configuration');
685 tie my %config_menu, 'Tie::IxHash';
686 if ( $curuser->access_right('Configuration' ) ) {
688 'Settings' => [ $fsurl.'config/config-view.cgi', '' ],
689 'separator' => '', #its a separator!
690 'Companies' => [ \%config_agent, '' ],
694 $config_menu{'Sales People'} = [ \%config_sales, '' ]
695 if $curuser->access_right('Edit sales people');
697 if ( $curuser->access_right('Configuration' ) ) {
698 $config_menu{'Employees'} = [ \%config_employees, '' ];
699 $config_menu{'separator2'} = ''; #its a separator!
700 $config_menu{'Customers'} = [ \%config_cust, '' ];
701 #or this? 'Customers and Contacts'
704 $config_menu{'Packages'} = [ \%config_pkg, '' ]
705 if $curuser->access_right('Configuration' )
706 || $curuser->access_right('Edit package definitions')
707 || $curuser->access_right('Edit global package definitions');
709 if ( $curuser->access_right('Configuration' ) ) {
710 $config_menu{'Services'} = [ \%config_export_svc, '' ];
711 $config_menu{separator3} = '';
714 $config_menu{'Billing'} = [ \%config_billing, '' ]
715 if $curuser->access_right('Edit billing events')
716 || $curuser->access_right('Edit global billing events');
717 $config_menu{'Ticketing'} = [ \%config_ticketing, '' ]
718 if $conf->config('ticket_system')
719 && FS::TicketSystem->access_right(\%session, 'ShowConfigTab');
720 $config_menu{'Network Monitoring'} = [ \%config_nms, '' ]
721 if $curuser->access_right('Configure network monitoring')
722 && $conf->config('network_monitoring_system') eq 'Torrus_Internal';
724 if ( $curuser->access_right('Configuration' )
725 || $curuser->access_right('Edit advertising sources')
726 || $curuser->access_right('Edit global advertising sources')
728 $config_menu{separator9} = '';
729 $config_menu{'Miscellaneous'} = [ \%config_misc, '' ];
733 my $wiki = 'http://www.freeside.biz/mediawiki/index.php';
734 my $doc_link = $conf->config('support-key')
735 ? "$wiki/Supported:Documentation"
736 : $curuser->access_right('Configuration')
737 ? "$wiki/Freeside:2.1:Documentation"
738 : "$wiki/Freeside:2.1:Documentation:User";
741 if $conf->config('ticket_system') eq 'RT_Internal';
743 tie my %help_menu, 'Tie::IxHash';
744 my $agentnum = $conf->config('brand-agent');
746 my $company_name = $conf->config('company_name', $agentnum);
747 $help_menu{"About $company_name"} = [ "javascript:about_freeside()", '' ];
749 $help_menu{'Billing documentation'} = [ $doc_link, 'Freeside documentation' ];
750 $help_menu{'Ticketing documentation'} = [ 'http://wiki.bestpractical.com/', 'Request Tracker Wiki' ]
751 if $conf->config('ticket_system') eq 'RT_Internal';
752 $help_menu{'Networking monitoring documentation'} = [ 'http://torrus.org/userguide.pod.html', 'Torrus User Guide' ]
753 if $conf->config('network_monitoring_system') eq 'Torrus_Internal';
754 $help_menu{'separator'} = '';
755 $help_menu{"About Freeside v$FS::VERSION"} = [ "javascript:about_freeside()", '' ];
756 $help_menu{"About RT v$RT::VERSION"} = [ 'http://www.bestpractical.com/rt', 'Request Tracker Homepage' ]
757 if $conf->config('ticket_system') eq 'RT_Internal';
758 $help_menu{"About Torrus v1.0.9"} = [ 'http://www.torrus.org/', 'Torrus Homepage' ] #XXX manual version
759 if $conf->config('network_monitoring_system') eq 'Torrus_Internal';
763 tie my %menu, 'Tie::IxHash';
765 if ( $conf->config('menu-prepend_links')) {
766 my @links = split(/\n/, $conf->config('menu-prepend_links'));
767 foreach my $link (@links) {
768 $link =~ /^\s*(\S+)\s+(.*?)(\s*\(([^\)]*)\))?$/ or next;
769 my($url, $label, $alt) = ($1, $2, $4);
770 $menu{$label} = [ $url, $alt ];
774 $menu{'Billing Main'} = [ $fsurl, 'Billing start page', ];
776 if ( $conf->config('ticket_system') ) {
777 $menu{'Ticketing Main'} =
779 ( $conf->config('ticket_system') eq 'RT_External'
780 ? FS::TicketSystem->baseurl()
783 'Ticketing start page',
787 if ( $conf->config('network_monitoring_system') eq 'Torrus_Internal' &&
788 $curuser->access_right('Configure network monitoring') ) {
789 $menu{'Network Main'} =
790 [ $fsurl.'torrus/main', 'Network monitoring start page' ],
793 $menu{'New prospect'} = [ $fsurl.'edit/prospect_main.html', 'Add a new prospect' ]
794 if $curuser->access_right('New prospect');
795 $menu{'New customer'} = [ $fsurl.'edit/cust_main.cgi', 'Add a new customer' ]
796 if $curuser->access_right('New customer');
797 $menu{'Reports'} = [ \%report_menu, 'Lists, reporting and graphing' ]
798 if keys %report_menu;
799 $menu{'Tools'} = [ \%tools_menu, 'Tools' ]
801 $menu{'Configuration'} = [ \%config_menu, 'Configuration and setup' ]
802 if $curuser->access_right('Configuration')
803 || $curuser->access_right('Edit package definitions')
804 || $curuser->access_right('Edit global package definitions')
805 || $curuser->access_right('Edit billing events')
806 || $curuser->access_right('Edit global billing events')
807 || $curuser->access_right('Dialup configuration')
808 || $curuser->access_right('Wireless broadband configuration')
809 || $curuser->access_right('Phone configuration')
810 || $curuser->access_right('Edit advertising sources')
811 || $curuser->access_right('Edit global advertising sources');
812 $menu{'Help'} = [ \%help_menu, '' ];
815 use vars qw($gmenunum);
819 my($submenu, $title) = @_;
820 my $menunum = $gmenunum++;
822 #return two args: html, menuname
824 "var myMenu$menunum = new WebFXMenu;\n".
825 #"myMenu$menunum.useAutoPosition = true;\n".
826 # "myMenu$menunum.emptyText = '$title';\n".
827 "myMenu$menunum.emptyText = '';\n".
832 if ( !ref( $submenu->{$_} ) ) {
834 "myMenu$menunum.add(new WebFXMenuSeparator());";
838 my($url_or_submenu, $tooltip ) = @{ $submenu->{$_} };
839 if ( ref($url_or_submenu) ) {
841 my($subhtml, $submenuname ) = submenu($url_or_submenu, $_); #mmm, recursion
844 "myMenu$menunum.add(new WebFXMenuItem(\"$_\", null, \"$tooltip\", $submenuname ));";
848 "myMenu$menunum.add(new WebFXMenuItem(\"$_\", \"$url_or_submenu\", \"$tooltip\" ));";
856 "myMenu$menunum.width = 256;\n",