d42956bf26b18d5a31be8a450da91788c2e3764e
[freeside.git] / FS / FS / Conf.pm
1 package FS::Conf;
2
3 use vars qw($base_dir @config_items @base_items @card_types $DEBUG);
4 use Carp;
5 use IO::File;
6 use File::Basename;
7 use MIME::Base64;
8 use FS::ConfItem;
9 use FS::ConfDefaults;
10 use FS::Conf_compat17;
11 use FS::payby;
12 use FS::conf;
13 use FS::Record qw(qsearch qsearchs);
14 use FS::UID qw(dbh datasrc use_confcompat);
15
16 $base_dir = '%%%FREESIDE_CONF%%%';
17
18 $DEBUG = 0;
19
20 =head1 NAME
21
22 FS::Conf - Freeside configuration values
23
24 =head1 SYNOPSIS
25
26   use FS::Conf;
27
28   $conf = new FS::Conf;
29
30   $value = $conf->config('key');
31   @list  = $conf->config('key');
32   $bool  = $conf->exists('key');
33
34   $conf->touch('key');
35   $conf->set('key' => 'value');
36   $conf->delete('key');
37
38   @config_items = $conf->config_items;
39
40 =head1 DESCRIPTION
41
42 Read and write Freeside configuration values.  Keys currently map to filenames,
43 but this may change in the future.
44
45 =head1 METHODS
46
47 =over 4
48
49 =item new
50
51 Create a new configuration object.
52
53 =cut
54
55 sub new {
56   my($proto) = @_;
57   my($class) = ref($proto) || $proto;
58   my($self) = { 'base_dir' => $base_dir };
59   bless ($self, $class);
60 }
61
62 =item base_dir
63
64 Returns the base directory.  By default this is /usr/local/etc/freeside.
65
66 =cut
67
68 sub base_dir {
69   my($self) = @_;
70   my $base_dir = $self->{base_dir};
71   -e $base_dir or die "FATAL: $base_dir doesn't exist!";
72   -d $base_dir or die "FATAL: $base_dir isn't a directory!";
73   -r $base_dir or die "FATAL: Can't read $base_dir!";
74   -x $base_dir or die "FATAL: $base_dir not searchable (executable)!";
75   $base_dir =~ /^(.*)$/;
76   $1;
77 }
78
79 =item conf KEY [ AGENTNUM [ NODEFAULT ] ]
80
81 Returns the L<FS::conf> record for the key and agent.
82
83 =cut
84
85 sub conf {
86   my $self = shift;
87   $self->_config(@_);
88 }
89
90 =item config KEY [ AGENTNUM [ NODEFAULT ] ]
91
92 Returns the configuration value or values (depending on context) for key.
93 The optional agent number selects an agent specific value instead of the
94 global default if one is present.  If NODEFAULT is true only the agent
95 specific value(s) is returned.
96
97 =cut
98
99 sub _usecompat {
100   my ($self, $method) = (shift, shift);
101   carp "NO CONFIGURATION RECORDS FOUND -- USING COMPATIBILITY MODE"
102     if use_confcompat;
103   my $compat = new FS::Conf_compat17 ("$base_dir/conf." . datasrc);
104   $compat->$method(@_);
105 }
106
107 sub _config {
108   my($self,$name,$agentnum,$agentonly)=@_;
109   my $hashref = { 'name' => $name };
110   $hashref->{agentnum} = $agentnum;
111   local $FS::Record::conf = undef;  # XXX evil hack prevents recursion
112   my $cv = FS::Record::qsearchs('conf', $hashref);
113   if (!$agentonly && !$cv && defined($agentnum) && $agentnum) {
114     $hashref->{agentnum} = '';
115     $cv = FS::Record::qsearchs('conf', $hashref);
116   }
117   return $cv;
118 }
119
120 sub config {
121   my $self = shift;
122   return $self->_usecompat('config', @_) if use_confcompat;
123
124   carp "FS::Conf->config(". join(', ', @_). ") called"
125     if $DEBUG > 1;
126
127   my $cv = $self->_config(@_) or return;
128
129   if ( wantarray ) {
130     my $v = $cv->value;
131     chomp $v;
132     (split "\n", $v, -1);
133   } else {
134     (split("\n", $cv->value))[0];
135   }
136 }
137
138 =item config_binary KEY [ AGENTNUM [ NODEFAULT ] ]
139
140 Returns the exact scalar value for key.
141
142 =cut
143
144 sub config_binary {
145   my $self = shift;
146   return $self->_usecompat('config_binary', @_) if use_confcompat;
147
148   my $cv = $self->_config(@_) or return;
149   length($cv->value) ? decode_base64($cv->value) : '';
150 }
151
152 =item exists KEY [ AGENTNUM [ NODEFAULT ] ]
153
154 Returns true if the specified key exists, even if the corresponding value
155 is undefined.
156
157 =cut
158
159 sub exists {
160   my $self = shift;
161   return $self->_usecompat('exists', @_) if use_confcompat;
162
163   my($name, $agentnum)=@_;
164
165   carp "FS::Conf->exists(". join(', ', @_). ") called"
166     if $DEBUG > 1;
167
168   defined($self->_config(@_));
169 }
170
171 =item config_orbase KEY SUFFIX
172
173 Returns the configuration value or values (depending on context) for 
174 KEY_SUFFIX, if it exists, otherwise for KEY
175
176 =cut
177
178 # outmoded as soon as we shift to agentnum based config values
179 # well, mostly.  still useful for e.g. late notices, etc. in that we want
180 # these to fall back to standard values
181 sub config_orbase {
182   my $self = shift;
183   return $self->_usecompat('config_orbase', @_) if use_confcompat;
184
185   my( $name, $suffix ) = @_;
186   if ( $self->exists("${name}_$suffix") ) {
187     $self->config("${name}_$suffix");
188   } else {
189     $self->config($name);
190   }
191 }
192
193 =item key_orbase KEY SUFFIX
194
195 If the config value KEY_SUFFIX exists, returns KEY_SUFFIX, otherwise returns
196 KEY.  Useful for determining which exact configuration option is returned by
197 config_orbase.
198
199 =cut
200
201 sub key_orbase {
202   my $self = shift;
203   #no compat for this...return $self->_usecompat('config_orbase', @_) if use_confcompat;
204
205   my( $name, $suffix ) = @_;
206   if ( $self->exists("${name}_$suffix") ) {
207     "${name}_$suffix";
208   } else {
209     $name;
210   }
211 }
212
213 =item invoice_templatenames
214
215 Returns all possible invoice template names.
216
217 =cut
218
219 sub invoice_templatenames {
220   my( $self ) = @_;
221
222   my %templatenames = ();
223   foreach my $item ( $self->config_items ) {
224     foreach my $base ( @base_items ) {
225       my( $main, $ext) = split(/\./, $base);
226       $ext = ".$ext" if $ext;
227       if ( $item->key =~ /^${main}_(.+)$ext$/ ) {
228       $templatenames{$1}++;
229       }
230     }
231   }
232   
233   map { $_ } #handle scalar context
234   sort keys %templatenames;
235
236 }
237
238 =item touch KEY [ AGENT ];
239
240 Creates the specified configuration key if it does not exist.
241
242 =cut
243
244 sub touch {
245   my $self = shift;
246   return $self->_usecompat('touch', @_) if use_confcompat;
247
248   my($name, $agentnum) = @_;
249   unless ( $self->exists($name, $agentnum) ) {
250     $self->set($name, '', $agentnum);
251   }
252 }
253
254 =item set KEY VALUE [ AGENTNUM ];
255
256 Sets the specified configuration key to the given value.
257
258 =cut
259
260 sub set {
261   my $self = shift;
262   return $self->_usecompat('set', @_) if use_confcompat;
263
264   my($name, $value, $agentnum) = @_;
265   $value =~ /^(.*)$/s;
266   $value = $1;
267
268   warn "[FS::Conf] SET $name\n" if $DEBUG;
269
270   my $old = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum});
271   my $new = new FS::conf { $old ? $old->hash 
272                                 : ('name' => $name, 'agentnum' => $agentnum)
273                          };
274   $new->value($value);
275
276   my $error;
277   if ($old) {
278     $error = $new->replace($old);
279   } else {
280     $error = $new->insert;
281   }
282
283   die "error setting configuration value: $error \n"
284     if $error;
285
286 }
287
288 =item set_binary KEY VALUE [ AGENTNUM ]
289
290 Sets the specified configuration key to an exact scalar value which
291 can be retrieved with config_binary.
292
293 =cut
294
295 sub set_binary {
296   my $self  = shift;
297   return if use_confcompat;
298
299   my($name, $value, $agentnum)=@_;
300   $self->set($name, encode_base64($value), $agentnum);
301 }
302
303 =item delete KEY [ AGENTNUM ];
304
305 Deletes the specified configuration key.
306
307 =cut
308
309 sub delete {
310   my $self = shift;
311   return $self->_usecompat('delete', @_) if use_confcompat;
312
313   my($name, $agentnum) = @_;
314   if ( my $cv = FS::Record::qsearchs('conf', {name => $name, agentnum => $agentnum}) ) {
315     warn "[FS::Conf] DELETE $name\n";
316
317     my $oldAutoCommit = $FS::UID::AutoCommit;
318     local $FS::UID::AutoCommit = 0;
319     my $dbh = dbh;
320
321     my $error = $cv->delete;
322
323     if ( $error ) {
324       $dbh->rollback if $oldAutoCommit;
325       die "error setting configuration value: $error \n"
326     }
327
328     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
329
330   }
331 }
332
333 =item import_config_item CONFITEM DIR 
334
335   Imports the item specified by the CONFITEM (see L<FS::ConfItem>) into
336 the database as a conf record (see L<FS::conf>).  Imports from the file
337 in the directory DIR.
338
339 =cut
340
341 sub import_config_item { 
342   my ($self,$item,$dir) = @_;
343   my $key = $item->key;
344   if ( -e "$dir/$key" && ! use_confcompat ) {
345     warn "Inserting $key\n" if $DEBUG;
346     local $/;
347     my $value = readline(new IO::File "$dir/$key");
348     if ($item->type =~ /^(binary|image)$/ ) {
349       $self->set_binary($key, $value);
350     }else{
351       $self->set($key, $value);
352     }
353   }else {
354     warn "Not inserting $key\n" if $DEBUG;
355   }
356 }
357
358 =item verify_config_item CONFITEM DIR 
359
360   Compares the item specified by the CONFITEM (see L<FS::ConfItem>) in
361 the database to the legacy file value in DIR.
362
363 =cut
364
365 sub verify_config_item { 
366   return '' if use_confcompat;
367   my ($self,$item,$dir) = @_;
368   my $key = $item->key;
369   my $type = $item->type;
370
371   my $compat = new FS::Conf_compat17 $dir;
372   my $error = '';
373   
374   $error .= "$key fails existential comparison; "
375     if $self->exists($key) xor $compat->exists($key);
376
377   if ( $type !~ /^(binary|image)$/ ) {
378
379     {
380       no warnings;
381       $error .= "$key fails scalar comparison; "
382         unless scalar($self->config($key)) eq scalar($compat->config($key));
383     }
384
385     my (@new) = $self->config($key);
386     my (@old) = $compat->config($key);
387     unless ( scalar(@new) == scalar(@old)) { 
388       $error .= "$key fails list comparison; ";
389     }else{
390       my $r=1;
391       foreach (@old) { $r=0 if ($_ cmp shift(@new)); }
392       $error .= "$key fails list comparison; "
393         unless $r;
394     }
395
396   } else {
397
398     no warnings 'uninitialized';
399     $error .= "$key fails binary comparison; "
400       unless scalar($self->config_binary($key)) eq scalar($compat->config_binary($key));
401
402   }
403
404 #remove deprecated config on our own terms, not freeside-upgrade's
405 #  if ($error =~ /existential comparison/ && $item->section eq 'deprecated') {
406 #    my $proto;
407 #    for ( @config_items ) { $proto = $_; last if $proto->key eq $key;  }
408 #    unless ($proto->key eq $key) { 
409 #      warn "removed config item $error\n" if $DEBUG;
410 #      $error = '';
411 #    }
412 #  }
413
414   $error;
415 }
416
417 #item _orbase_items OPTIONS
418 #
419 #Returns all of the possible extensible config items as FS::ConfItem objects.
420 #See #L<FS::ConfItem>.  OPTIONS consists of name value pairs.  Possible
421 #options include
422 #
423 # dir - the directory to search for configuration option files instead
424 #       of using the conf records in the database
425 #
426 #cut
427
428 #quelle kludge
429 sub _orbase_items {
430   my ($self, %opt) = @_; 
431
432   my $listmaker = sub { my $v = shift;
433                         $v =~ s/_/!_/g;
434                         if ( $v =~ /\.(png|eps)$/ ) {
435                           $v =~ s/\./!_%./;
436                         }else{
437                           $v .= '!_%';
438                         }
439                         map { $_->name }
440                           FS::Record::qsearch( 'conf',
441                                                {},
442                                                '',
443                                                "WHERE name LIKE '$v' ESCAPE '!'"
444                                              );
445                       };
446
447   if (exists($opt{dir}) && $opt{dir}) {
448     $listmaker = sub { my $v = shift;
449                        if ( $v =~ /\.(png|eps)$/ ) {
450                          $v =~ s/\./_*./;
451                        }else{
452                          $v .= '_*';
453                        }
454                        map { basename $_ } glob($opt{dir}. "/$v" );
455                      };
456   }
457
458   ( map { 
459           my $proto;
460           my $base = $_;
461           for ( @config_items ) { $proto = $_; last if $proto->key eq $base;  }
462           die "don't know about $base items" unless $proto->key eq $base;
463
464           map { new FS::ConfItem { 
465                   'key'         => $_,
466                   'base_key'    => $proto->key,
467                   'section'     => $proto->section,
468                   'description' => 'Alternate ' . $proto->description . '  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Invoice_templates">billing documentation</a> for details.',
469                   'type'        => $proto->type,
470                 };
471               } &$listmaker($base);
472         } @base_items,
473   );
474 }
475
476 =item config_items
477
478 Returns all of the possible global/default configuration items as
479 FS::ConfItem objects.  See L<FS::ConfItem>.
480
481 =cut
482
483 sub config_items {
484   my $self = shift; 
485   return $self->_usecompat('config_items', @_) if use_confcompat;
486
487   ( @config_items, $self->_orbase_items(@_) );
488 }
489
490 =back
491
492 =head1 SUBROUTINES
493
494 =over 4
495
496 =item init-config DIR
497
498 Imports the configuration items from DIR (1.7 compatible)
499 to conf records in the database.
500
501 =cut
502
503 sub init_config {
504   my $dir = shift;
505
506   {
507     local $FS::UID::use_confcompat = 0;
508     my $conf = new FS::Conf;
509     foreach my $item ( $conf->config_items(dir => $dir) ) {
510       $conf->import_config_item($item, $dir);
511       my $error = $conf->verify_config_item($item, $dir);
512       return $error if $error;
513     }
514   
515     my $compat = new FS::Conf_compat17 $dir;
516     foreach my $item ( $compat->config_items ) {
517       my $error = $conf->verify_config_item($item, $dir);
518       return $error if $error;
519     }
520   }
521
522   $FS::UID::use_confcompat = 0;
523   '';  #success
524 }
525
526 =back
527
528 =head1 BUGS
529
530 If this was more than just crud that will never be useful outside Freeside I'd
531 worry that config_items is freeside-specific and icky.
532
533 =head1 SEE ALSO
534
535 "Configuration" in the web interface (config/config.cgi).
536
537 =cut
538
539 #Business::CreditCard
540 @card_types = (
541   "VISA card",
542   "MasterCard",
543   "Discover card",
544   "American Express card",
545   "Diner's Club/Carte Blanche",
546   "enRoute",
547   "JCB",
548   "BankCard",
549   "Switch",
550   "Solo",
551 );
552
553 @base_items = qw(
554 invoice_template
555 invoice_latex
556 invoice_latexreturnaddress
557 invoice_latexfooter
558 invoice_latexsmallfooter
559 invoice_latexnotes
560 invoice_latexcoupon
561 invoice_html
562 invoice_htmlreturnaddress
563 invoice_htmlfooter
564 invoice_htmlnotes
565 logo.png
566 logo.eps
567 );
568
569 my %msg_template_options = (
570   'type'        => 'select-sub',
571   'options_sub' => sub { 
572     my @templates = qsearch({
573         'table' => 'msg_template', 
574         'hashref' => { 'disabled' => '' },
575         'extra_sql' => ' AND '. 
576           $FS::CurrentUser::CurrentUser->agentnums_sql(null => 1),
577         });
578     map { $_->msgnum, $_->msgname } @templates;
579   },
580   'option_sub'  => sub { 
581                          my $msg_template = FS::msg_template->by_key(shift);
582                          $msg_template ? $msg_template->msgname : ''
583                        },
584   'per_agent' => 1,
585 );
586
587 my $_gateway_name = sub {
588   my $g = shift;
589   return '' if !$g;
590   ($g->gateway_username . '@' . $g->gateway_module);
591 };
592
593 my %payment_gateway_options = (
594   'type'        => 'select-sub',
595   'options_sub' => sub {
596     my @gateways = qsearch({
597         'table' => 'payment_gateway',
598         'hashref' => { 'disabled' => '' },
599       });
600     map { $_->gatewaynum, $_gateway_name->($_) } @gateways;
601   },
602   'option_sub'  => sub {
603     my $gateway = FS::payment_gateway->by_key(shift);
604     $_gateway_name->($gateway);
605   },
606 );
607
608 #Billing (81 items)
609 #Invoicing (50 items)
610 #UI (69 items)
611 #Self-service (29 items)
612 #...
613 #Unclassified (77 items)
614
615 @config_items = map { new FS::ConfItem $_ } (
616
617   {
618     'key'         => 'address',
619     'section'     => 'deprecated',
620     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
621     'type'        => 'text',
622   },
623
624   {
625     'key'         => 'alert_expiration',
626     'section'     => 'notification',
627     'description' => 'Enable alerts about billing method expiration (i.e. expiring credit cards).',
628     'type'        => 'checkbox',
629     'per_agent'   => 1,
630   },
631
632   {
633     'key'         => 'alerter_template',
634     'section'     => 'deprecated',
635     'description' => 'Template file for billing method expiration alerts (i.e. expiring credit cards).',
636     'type'        => 'textarea',
637     'per_agent'   => 1,
638   },
639   
640   {
641     'key'         => 'alerter_msgnum',
642     'section'     => 'notification',
643     'description' => 'Template to use for credit card expiration alerts.',
644     %msg_template_options,
645   },
646
647   {
648     'key'         => 'apacheip',
649     #not actually deprecated yet
650     #'section'     => 'deprecated',
651     #'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the current IP address to assign to new virtual hosts',
652     'section'     => '',
653     'description' => 'IP address to assign to new virtual hosts',
654     'type'        => 'text',
655   },
656   
657   {
658     'key'         => 'credit-card-surcharge-percentage',
659     'section'     => 'billing',
660     'description' => 'Add a credit card surcharge to invoices, as a % of the invoice total. WARNING: this is usually prohibited by merchant account / other agreements and/or law, but is currently lawful in AU and UK.',
661     'type'        => 'text',
662   },
663
664   {
665     'key'         => 'discount-show-always',
666     'section'     => 'billing',
667     'description' => 'Generate a line item on an invoice even when a package is discounted 100%',
668     'type'        => 'checkbox',
669   },
670   
671   {
672     'key'         => 'invoice-barcode',
673     'section'     => 'billing',
674     'description' => 'Display a barcode on HTML and PDF invoices',
675     'type'        => 'checkbox',
676   },
677
678   {
679     'key'         => 'encryption',
680     'section'     => 'billing',
681     'description' => 'Enable encryption of credit cards.',
682     'type'        => 'checkbox',
683   },
684
685   {
686     'key'         => 'encryptionmodule',
687     'section'     => 'billing',
688     'description' => 'Use which module for encryption?',
689     'type'        => 'text',
690   },
691
692   {
693     'key'         => 'encryptionpublickey',
694     'section'     => 'billing',
695     'description' => 'Your RSA Public Key - Required if Encryption is turned on.',
696     'type'        => 'textarea',
697   },
698
699   {
700     'key'         => 'encryptionprivatekey',
701     'section'     => 'billing',
702     'description' => 'Your RSA Private Key - Including this will enable the "Bill Now" feature.  However if the system is compromised, a hacker can use this key to decode the stored credit card information.  This is generally not a good idea.',
703     'type'        => 'textarea',
704   },
705
706   {
707     'key'         => 'billco-url',
708     'section'     => 'billing',
709     'description' => 'The url to use for performing uploads to the invoice mailing service.',
710     'type'        => 'text',
711     'per_agent'   => 1,
712   },
713
714   {
715     'key'         => 'billco-username',
716     'section'     => 'billing',
717     'description' => 'The login name to use for uploads to the invoice mailing service.',
718     'type'        => 'text',
719     'per_agent'   => 1,
720     'agentonly'   => 1,
721   },
722
723   {
724     'key'         => 'billco-password',
725     'section'     => 'billing',
726     'description' => 'The password to use for uploads to the invoice mailing service.',
727     'type'        => 'text',
728     'per_agent'   => 1,
729     'agentonly'   => 1,
730   },
731
732   {
733     'key'         => 'billco-clicode',
734     'section'     => 'billing',
735     'description' => 'The clicode to use for uploads to the invoice mailing service.',
736     'type'        => 'text',
737     'per_agent'   => 1,
738   },
739
740   {
741     'key'         => 'business-onlinepayment',
742     'section'     => 'billing',
743     'description' => '<a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support, at least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
744     'type'        => 'textarea',
745   },
746
747   {
748     'key'         => 'business-onlinepayment-ach',
749     'section'     => 'billing',
750     'description' => 'Alternate <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support for ACH transactions (defaults to regular <b>business-onlinepayment</b>).  At least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
751     'type'        => 'textarea',
752   },
753
754   {
755     'key'         => 'business-onlinepayment-namespace',
756     'section'     => 'billing',
757     'description' => 'Specifies which perl module namespace (which group of collection routines) is used by default.',
758     'type'        => 'select',
759     'select_hash' => [
760                        'Business::OnlinePayment' => 'Direct API (Business::OnlinePayment)',
761                        'Business::OnlineThirdPartyPayment' => 'Web API (Business::ThirdPartyPayment)',
762                      ],
763   },
764
765   {
766     'key'         => 'business-onlinepayment-description',
767     'section'     => 'billing',
768     'description' => 'String passed as the description field to <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a>.  Evaluated as a double-quoted perl string, with the following variables available: <code>$agent</code> (the agent name), and <code>$pkgs</code> (a comma-separated list of packages for which these charges apply - not available in all situations)',
769     'type'        => 'text',
770   },
771
772   {
773     'key'         => 'business-onlinepayment-email-override',
774     'section'     => 'billing',
775     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
776     'type'        => 'text',
777   },
778
779   {
780     'key'         => 'business-onlinepayment-email_customer',
781     'section'     => 'billing',
782     'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
783     'type'        => 'checkbox',
784   },
785
786   {
787     'key'         => 'business-onlinepayment-test_transaction',
788     'section'     => 'billing',
789     'description' => 'Turns on the Business::OnlinePayment test_transaction flag.  Note that not all gateway modules support this flag; if yours does not, transactions will still be sent live.',
790     'type'        => 'checkbox',
791   },
792
793   {
794     'key'         => 'countrydefault',
795     'section'     => 'UI',
796     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
797     'type'        => 'text',
798   },
799
800   {
801     'key'         => 'date_format',
802     'section'     => 'UI',
803     'description' => 'Format for displaying dates',
804     'type'        => 'select',
805     'select_hash' => [
806                        '%m/%d/%Y' => 'MM/DD/YYYY',
807                        '%d/%m/%Y' => 'DD/MM/YYYY',
808                        '%Y/%m/%d' => 'YYYY/MM/DD',
809                      ],
810   },
811
812   {
813     'key'         => 'date_format_long',
814     'section'     => 'UI',
815     'description' => 'Verbose format for displaying dates',
816     'type'        => 'select',
817     'select_hash' => [
818                        '%b %o, %Y' => 'Mon DDth, YYYY',
819                        '%e %b %Y'  => 'DD Mon YYYY',
820                      ],
821   },
822
823   {
824     'key'         => 'deletecustomers',
825     'section'     => 'UI',
826     'description' => 'Enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that the customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers\' packages if they cancel service.',
827     'type'        => 'checkbox',
828   },
829
830   {
831     'key'         => 'deleteinvoices',
832     'section'     => 'UI',
833     'description' => 'Enable invoices deletions.  Be very careful!  Deleting an invoice will remove all traces that the invoice ever existed!  Normally, you would apply a credit against the invoice instead.',  #invoice voiding?
834     'type'        => 'checkbox',
835   },
836
837   {
838     'key'         => 'deletepayments',
839     'section'     => 'billing',
840     'description' => 'Enable deletion of unclosed payments.  Really, with voids this is pretty much not recommended in any situation anymore.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.',
841     'type'        => [qw( checkbox text )],
842   },
843
844   {
845     'key'         => 'deletecredits',
846     #not actually deprecated yet
847     #'section'     => 'deprecated',
848     #'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable deletion of unclosed credits.  Be very careful!  Only delete credits that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.',
849     'section'     => '',
850     'description' => 'One or more comma-separated email addresses to be notified when a credit is deleted.',
851     'type'        => [qw( checkbox text )],
852   },
853
854   {
855     'key'         => 'deleterefunds',
856     'section'     => 'billing',
857     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
858     'type'        => 'checkbox',
859   },
860
861   {
862     'key'         => 'unapplypayments',
863     'section'     => 'deprecated',
864     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
865     'type'        => 'checkbox',
866   },
867
868   {
869     'key'         => 'unapplycredits',
870     'section'     => 'deprecated',
871     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to nable "unapplication" of unclosed credits.',
872     'type'        => 'checkbox',
873   },
874
875   {
876     'key'         => 'dirhash',
877     'section'     => 'shell',
878     'description' => 'Optional numeric value to control directory hashing.  If positive, hashes directories for the specified number of levels from the front of the username.  If negative, hashes directories for the specified number of levels from the end of the username.  Some examples: <ul><li>1: user -> <a href="#home">/home</a>/u/user<li>2: user -> <a href="#home">/home</a>/u/s/user<li>-1: user -> <a href="#home">/home</a>/r/user<li>-2: user -> <a href="#home">home</a>/r/e/user</ul>',
879     'type'        => 'text',
880   },
881
882   {
883     'key'         => 'disable_cust_attachment',
884     'section'     => '',
885     'description' => 'Disable customer file attachments',
886     'type'        => 'checkbox',
887   },
888
889   {
890     'key'         => 'max_attachment_size',
891     'section'     => '',
892     'description' => 'Maximum size for customer file attachments (leave blank for unlimited)',
893     'type'        => 'text',
894   },
895
896   {
897     'key'         => 'disable_customer_referrals',
898     'section'     => 'UI',
899     'description' => 'Disable new customer-to-customer referrals in the web interface',
900     'type'        => 'checkbox',
901   },
902
903   {
904     'key'         => 'editreferrals',
905     'section'     => 'UI',
906     'description' => 'Enable advertising source modification for existing customers',
907     'type'        => 'checkbox',
908   },
909
910   {
911     'key'         => 'emailinvoiceonly',
912     'section'     => 'invoicing',
913     'description' => 'Disables postal mail invoices',
914     'type'        => 'checkbox',
915   },
916
917   {
918     'key'         => 'disablepostalinvoicedefault',
919     'section'     => 'invoicing',
920     'description' => 'Disables postal mail invoices as the default option in the UI.  Be careful not to setup customers which are not sent invoices.  See <a href ="#emailinvoiceauto">emailinvoiceauto</a>.',
921     'type'        => 'checkbox',
922   },
923
924   {
925     'key'         => 'emailinvoiceauto',
926     'section'     => 'invoicing',
927     'description' => 'Automatically adds new accounts to the email invoice list',
928     'type'        => 'checkbox',
929   },
930
931   {
932     'key'         => 'emailinvoiceautoalways',
933     'section'     => 'invoicing',
934     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
935     'type'        => 'checkbox',
936   },
937
938   {
939     'key'         => 'emailinvoice-apostrophe',
940     'section'     => 'invoicing',
941     'description' => 'Allows the apostrophe (single quote) character in the email addresses in the email invoice list.',
942     'type'        => 'checkbox',
943   },
944
945   {
946     'key'         => 'exclude_ip_addr',
947     'section'     => '',
948     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
949     'type'        => 'textarea',
950   },
951   
952   {
953     'key'         => 'auto_router',
954     'section'     => '',
955     'description' => 'Automatically choose the correct router/block based on supplied ip address when possible while provisioning broadband services',
956     'type'        => 'checkbox',
957   },
958   
959   {
960     'key'         => 'hidecancelledpackages',
961     'section'     => 'UI',
962     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
963     'type'        => 'checkbox',
964   },
965
966   {
967     'key'         => 'hidecancelledcustomers',
968     'section'     => 'UI',
969     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
970     'type'        => 'checkbox',
971   },
972
973   {
974     'key'         => 'home',
975     'section'     => 'shell',
976     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
977     'type'        => 'text',
978   },
979
980   {
981     'key'         => 'invoice_from',
982     'section'     => 'required',
983     'description' => 'Return address on email invoices',
984     'type'        => 'text',
985     'per_agent'   => 1,
986   },
987
988   {
989     'key'         => 'invoice_subject',
990     'section'     => 'invoicing',
991     'description' => 'Subject: header on email invoices.  Defaults to "Invoice".  The following substitutions are available: $name, $name_short, $invoice_number, and $invoice_date.',
992     'type'        => 'text',
993     'per_agent'   => 1,
994   },
995
996   {
997     'key'         => 'invoice_usesummary',
998     'section'     => 'invoicing',
999     'description' => 'Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary.',
1000     'type'        => 'checkbox',
1001   },
1002
1003   {
1004     'key'         => 'invoice_template',
1005     'section'     => 'invoicing',
1006     'description' => 'Text template file for invoices.  Used if no invoice_html template is defined, and also seen by users using non-HTML capable mail clients.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Plaintext_invoice_templates">billing documentation</a> for details.',
1007     'type'        => 'textarea',
1008   },
1009
1010   {
1011     'key'         => 'invoice_html',
1012     'section'     => 'invoicing',
1013     'description' => 'Optional HTML template for invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#HTML_invoice_templates">billing documentation</a> for details.',
1014
1015     'type'        => 'textarea',
1016   },
1017
1018   {
1019     'key'         => 'invoice_htmlnotes',
1020     'section'     => 'invoicing',
1021     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
1022     'type'        => 'textarea',
1023     'per_agent'   => 1,
1024   },
1025
1026   {
1027     'key'         => 'invoice_htmlfooter',
1028     'section'     => 'invoicing',
1029     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
1030     'type'        => 'textarea',
1031     'per_agent'   => 1,
1032   },
1033
1034   {
1035     'key'         => 'invoice_htmlsummary',
1036     'section'     => 'invoicing',
1037     'description' => 'Summary initial page for HTML invoices.',
1038     'type'        => 'textarea',
1039     'per_agent'   => 1,
1040   },
1041
1042   {
1043     'key'         => 'invoice_htmlreturnaddress',
1044     'section'     => 'invoicing',
1045     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
1046     'type'        => 'textarea',
1047   },
1048
1049   {
1050     'key'         => 'invoice_latex',
1051     'section'     => 'invoicing',
1052     'description' => 'Optional LaTeX template for typeset PostScript invoices.  See the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Administration#Typeset_.28LaTeX.29_invoice_templates">billing documentation</a> for details.',
1053     'type'        => 'textarea',
1054   },
1055
1056   {
1057     'key'         => 'invoice_latextopmargin',
1058     'section'     => 'invoicing',
1059     'description' => 'Optional LaTeX invoice topmargin setting. Include units.',
1060     'type'        => 'text',
1061     'per_agent'   => 1,
1062     'validate'    => sub { shift =~
1063                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1064                              ? '' : 'Invalid LaTex length';
1065                          },
1066   },
1067
1068   {
1069     'key'         => 'invoice_latexheadsep',
1070     'section'     => 'invoicing',
1071     'description' => 'Optional LaTeX invoice headsep setting. Include units.',
1072     'type'        => 'text',
1073     'per_agent'   => 1,
1074     'validate'    => sub { shift =~
1075                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1076                              ? '' : 'Invalid LaTex length';
1077                          },
1078   },
1079
1080   {
1081     'key'         => 'invoice_latexaddresssep',
1082     'section'     => 'invoicing',
1083     'description' => 'Optional LaTeX invoice separation between invoice header
1084 and customer address. Include units.',
1085     'type'        => 'text',
1086     'per_agent'   => 1,
1087     'validate'    => sub { shift =~
1088                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1089                              ? '' : 'Invalid LaTex length';
1090                          },
1091   },
1092
1093   {
1094     'key'         => 'invoice_latextextheight',
1095     'section'     => 'invoicing',
1096     'description' => 'Optional LaTeX invoice textheight setting. Include units.',
1097     'type'        => 'text',
1098     'per_agent'   => 1,
1099     'validate'    => sub { shift =~
1100                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1101                              ? '' : 'Invalid LaTex length';
1102                          },
1103   },
1104
1105   {
1106     'key'         => 'invoice_latexnotes',
1107     'section'     => 'invoicing',
1108     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
1109     'type'        => 'textarea',
1110     'per_agent'   => 1,
1111   },
1112
1113   {
1114     'key'         => 'invoice_latexfooter',
1115     'section'     => 'invoicing',
1116     'description' => 'Footer for LaTeX typeset PostScript invoices.',
1117     'type'        => 'textarea',
1118     'per_agent'   => 1,
1119   },
1120
1121   {
1122     'key'         => 'invoice_latexsummary',
1123     'section'     => 'invoicing',
1124     'description' => 'Summary initial page for LaTeX typeset PostScript invoices.',
1125     'type'        => 'textarea',
1126     'per_agent'   => 1,
1127   },
1128
1129   {
1130     'key'         => 'invoice_latexcoupon',
1131     'section'     => 'invoicing',
1132     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
1133     'type'        => 'textarea',
1134     'per_agent'   => 1,
1135   },
1136
1137   {
1138     'key'         => 'invoice_latexextracouponspace',
1139     'section'     => 'invoicing',
1140     'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units.',
1141     'type'        => 'text',
1142     'per_agent'   => 1,
1143     'validate'    => sub { shift =~
1144                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1145                              ? '' : 'Invalid LaTex length';
1146                          },
1147   },
1148
1149   {
1150     'key'         => 'invoice_latexcouponfootsep',
1151     'section'     => 'invoicing',
1152     'description' => 'Optional LaTeX invoice separation between tear off coupon and footer. Include units.',
1153     'type'        => 'text',
1154     'per_agent'   => 1,
1155     'validate'    => sub { shift =~
1156                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1157                              ? '' : 'Invalid LaTex length';
1158                          },
1159   },
1160
1161   {
1162     'key'         => 'invoice_latexcouponamountenclosedsep',
1163     'section'     => 'invoicing',
1164     'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units.',
1165     'type'        => 'text',
1166     'per_agent'   => 1,
1167     'validate'    => sub { shift =~
1168                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1169                              ? '' : 'Invalid LaTex length';
1170                          },
1171   },
1172   {
1173     'key'         => 'invoice_latexcoupontoaddresssep',
1174     'section'     => 'invoicing',
1175     'description' => 'Optional LaTeX invoice separation between invoice data and the to address (usually invoice_latexreturnaddress).  Include units.',
1176     'type'        => 'text',
1177     'per_agent'   => 1,
1178     'validate'    => sub { shift =~
1179                              /^-?\d*\.?\d+(in|mm|cm|pt|em|ex|pc|bp|dd|cc|sp)$/
1180                              ? '' : 'Invalid LaTex length';
1181                          },
1182   },
1183
1184   {
1185     'key'         => 'invoice_latexreturnaddress',
1186     'section'     => 'invoicing',
1187     'description' => 'Return address for LaTeX typeset PostScript invoices.',
1188     'type'        => 'textarea',
1189   },
1190
1191   {
1192     'key'         => 'invoice_latexverticalreturnaddress',
1193     'section'     => 'invoicing',
1194     'description' => 'Place the return address under the company logo rather than beside it.',
1195     'type'        => 'checkbox',
1196     'per_agent'   => 1,
1197   },
1198
1199   {
1200     'key'         => 'invoice_latexcouponaddcompanytoaddress',
1201     'section'     => 'invoicing',
1202     'description' => 'Add the company name to the To address on the remittance coupon because the return address does not contain it.',
1203     'type'        => 'checkbox',
1204     'per_agent'   => 1,
1205   },
1206
1207   {
1208     'key'         => 'invoice_latexsmallfooter',
1209     'section'     => 'invoicing',
1210     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
1211     'type'        => 'textarea',
1212     'per_agent'   => 1,
1213   },
1214
1215   {
1216     'key'         => 'invoice_email_pdf',
1217     'section'     => 'invoicing',
1218     'description' => 'Send PDF invoice as an attachment to emailed invoices.  By default, includes the plain text invoice as the email body, unless invoice_email_pdf_note is set.',
1219     'type'        => 'checkbox'
1220   },
1221
1222   {
1223     'key'         => 'invoice_email_pdf_note',
1224     'section'     => 'invoicing',
1225     'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
1226     'type'        => 'textarea'
1227   },
1228
1229   {
1230     'key'         => 'invoice_print_pdf',
1231     'section'     => 'invoicing',
1232     'description' => 'Store postal invoices for download in PDF format rather than printing them directly.',
1233     'type'        => 'checkbox',
1234   },
1235
1236   { 
1237     'key'         => 'invoice_default_terms',
1238     'section'     => 'invoicing',
1239     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
1240     'type'        => 'select',
1241     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 3', 'Net 10', 'Net 15', 'Net 20', 'Net 21', 'Net 30', 'Net 45', 'Net 60', 'Net 90' ],
1242   },
1243
1244   { 
1245     'key'         => 'invoice_show_prior_due_date',
1246     'section'     => 'invoicing',
1247     'description' => 'Show previous invoice due dates when showing prior balances.  Default is to show invoice date.',
1248     'type'        => 'checkbox',
1249   },
1250
1251   { 
1252     'key'         => 'invoice_include_aging',
1253     'section'     => 'invoicing',
1254     'description' => 'Show an aging line after the prior balance section.  Only valud when invoice_sections is enabled.',
1255     'type'        => 'checkbox',
1256   },
1257
1258   { 
1259     'key'         => 'invoice_sections',
1260     'section'     => 'invoicing',
1261     'description' => 'Split invoice into sections and label according to package category when enabled.',
1262     'type'        => 'checkbox',
1263   },
1264
1265   { 
1266     'key'         => 'usage_class_as_a_section',
1267     'section'     => 'invoicing',
1268     'description' => 'Split usage into sections and label according to usage class name when enabled.  Only valid when invoice_sections is enabled.',
1269     'type'        => 'checkbox',
1270   },
1271
1272   { 
1273     'key'         => 'phone_usage_class_summary',
1274     'section'     => 'invoicing',
1275     'description' => 'Summarize usage per DID by usage class and display all CDRs together regardless of usage class. Only valid when svc_phone_sections is enabled.',
1276     'type'        => 'checkbox',
1277   },
1278
1279   { 
1280     'key'         => 'svc_phone_sections',
1281     'section'     => 'invoicing',
1282     'description' => 'Create a section for each svc_phone when enabled.  Only valid when invoice_sections is enabled.',
1283     'type'        => 'checkbox',
1284   },
1285
1286   {
1287     'key'         => 'finance_pkgclass',
1288     'section'     => 'billing',
1289     'description' => 'The default package class for late fee charges, used if the fee event does not specify a package class itself.',
1290     'type'        => 'select-pkg_class',
1291   },
1292
1293   { 
1294     'key'         => 'separate_usage',
1295     'section'     => 'invoicing',
1296     'description' => 'Split the rated call usage into a separate line from the recurring charges.',
1297     'type'        => 'checkbox',
1298   },
1299
1300   {
1301     'key'         => 'invoice_send_receipts',
1302     'section'     => 'deprecated',
1303     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
1304     'type'        => 'checkbox',
1305   },
1306
1307   {
1308     'key'         => 'payment_receipt',
1309     'section'     => 'notification',
1310     'description' => 'Send payment receipts.',
1311     'type'        => 'checkbox',
1312     'per_agent'   => 1,
1313   },
1314
1315   {
1316     'key'         => 'payment_receipt_msgnum',
1317     'section'     => 'notification',
1318     'description' => 'Template to use for payment receipts.',
1319     %msg_template_options,
1320   },
1321
1322   {
1323     'key'         => 'payment_receipt_email',
1324     'section'     => 'deprecated',
1325     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.',
1326     'type'        => [qw( checkbox textarea )],
1327   },
1328
1329   {
1330     'key'         => 'payment_receipt-trigger',
1331     'section'     => 'notification',
1332     'description' => 'When payment receipts are triggered.  Defaults to when payment is made.',
1333     'type'        => 'select',
1334     'select_hash' => [
1335                        'cust_pay'          => 'When payment is made.',
1336                        'cust_bill_pay_pkg' => 'When payment is applied.',
1337                      ],
1338     'per_agent'   => 1,
1339   },
1340
1341   {
1342     'key'         => 'trigger_export_insert_on_payment',
1343     'section'     => 'billing',
1344     'description' => 'Enable exports on payment application.',
1345     'type'        => 'checkbox',
1346   },
1347
1348   {
1349     'key'         => 'lpr',
1350     'section'     => 'required',
1351     'description' => 'Print command for paper invoices, for example `lpr -h\'',
1352     'type'        => 'text',
1353   },
1354
1355   {
1356     'key'         => 'lpr-postscript_prefix',
1357     'section'     => 'billing',
1358     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1359     'type'        => 'text',
1360   },
1361
1362   {
1363     'key'         => 'lpr-postscript_suffix',
1364     'section'     => 'billing',
1365     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
1366     'type'        => 'text',
1367   },
1368
1369   {
1370     'key'         => 'money_char',
1371     'section'     => '',
1372     'description' => 'Currency symbol - defaults to `$\'',
1373     'type'        => 'text',
1374   },
1375
1376   {
1377     'key'         => 'defaultrecords',
1378     'section'     => 'BIND',
1379     'description' => 'DNS entries to add automatically when creating a domain',
1380     'type'        => 'editlist',
1381     'editlist_parts' => [ { type=>'text' },
1382                           { type=>'immutable', value=>'IN' },
1383                           { type=>'select',
1384                             select_enum => {
1385                               map { $_=>$_ }
1386                                   #@{ FS::domain_record->rectypes }
1387                                   qw(A AAAA CNAME MX NS PTR SPF SRV TXT)
1388                             },
1389                           },
1390                           { type=> 'text' }, ],
1391   },
1392
1393   {
1394     'key'         => 'passwordmin',
1395     'section'     => 'password',
1396     'description' => 'Minimum password length (default 6)',
1397     'type'        => 'text',
1398   },
1399
1400   {
1401     'key'         => 'passwordmax',
1402     'section'     => 'password',
1403     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
1404     'type'        => 'text',
1405   },
1406
1407   {
1408     'key'         => 'password-noampersand',
1409     'section'     => 'password',
1410     'description' => 'Disallow ampersands in passwords',
1411     'type'        => 'checkbox',
1412   },
1413
1414   {
1415     'key'         => 'password-noexclamation',
1416     'section'     => 'password',
1417     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
1418     'type'        => 'checkbox',
1419   },
1420
1421   {
1422     'key'         => 'default-password-encoding',
1423     'section'     => 'password',
1424     'description' => 'Default storage format for passwords',
1425     'type'        => 'select',
1426     'select_hash' => [
1427       'plain'       => 'Plain text',
1428       'crypt-des'   => 'Unix password (DES encrypted)',
1429       'crypt-md5'   => 'Unix password (MD5 digest)',
1430       'ldap-plain'  => 'LDAP (plain text)',
1431       'ldap-crypt'  => 'LDAP (DES encrypted)',
1432       'ldap-md5'    => 'LDAP (MD5 digest)',
1433       'ldap-sha1'   => 'LDAP (SHA1 digest)',
1434       'legacy'      => 'Legacy mode',
1435     ],
1436   },
1437
1438   {
1439     'key'         => 'referraldefault',
1440     'section'     => 'UI',
1441     'description' => 'Default referral, specified by refnum',
1442     'type'        => 'select-sub',
1443     'options_sub' => sub { require FS::Record;
1444                            require FS::part_referral;
1445                            map { $_->refnum => $_->referral }
1446                                FS::Record::qsearch( 'part_referral', 
1447                                                     { 'disabled' => '' }
1448                                                   );
1449                          },
1450     'option_sub'  => sub { require FS::Record;
1451                            require FS::part_referral;
1452                            my $part_referral = FS::Record::qsearchs(
1453                              'part_referral', { 'refnum'=>shift } );
1454                            $part_referral ? $part_referral->referral : '';
1455                          },
1456   },
1457
1458 #  {
1459 #    'key'         => 'registries',
1460 #    'section'     => 'required',
1461 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
1462 #  },
1463
1464   {
1465     'key'         => 'report_template',
1466     'section'     => 'deprecated',
1467     'description' => 'Deprecated template file for reports.',
1468     'type'        => 'textarea',
1469   },
1470
1471   {
1472     'key'         => 'maxsearchrecordsperpage',
1473     'section'     => 'UI',
1474     'description' => 'If set, number of search records to return per page.',
1475     'type'        => 'text',
1476   },
1477
1478   {
1479     'key'         => 'session-start',
1480     'section'     => 'session',
1481     'description' => 'If defined, the command which is executed on the Freeside machine when a session begins.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
1482     'type'        => 'text',
1483   },
1484
1485   {
1486     'key'         => 'session-stop',
1487     'section'     => 'session',
1488     'description' => 'If defined, the command which is executed on the Freeside machine when a session ends.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
1489     'type'        => 'text',
1490   },
1491
1492   {
1493     'key'         => 'shells',
1494     'section'     => 'shell',
1495     'description' => 'Legal shells (think /etc/shells).  You probably want to `cut -d: -f7 /etc/passwd | sort | uniq\' initially so that importing doesn\'t fail with `Illegal shell\' errors, then remove any special entries afterwords.  A blank line specifies that an empty shell is permitted.',
1496     'type'        => 'textarea',
1497   },
1498
1499   {
1500     'key'         => 'showpasswords',
1501     'section'     => 'UI',
1502     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
1503     'type'        => 'checkbox',
1504   },
1505
1506   {
1507     'key'         => 'report-showpasswords',
1508     'section'     => 'UI',
1509     'description' => 'This is a terrible idea.  Do not enable it.  STRONGLY NOT RECOMMENDED.  Enables display of passwords on services reports.',
1510     'type'        => 'checkbox',
1511   },
1512
1513   {
1514     'key'         => 'signupurl',
1515     'section'     => 'UI',
1516     'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Self-Service_Installation">signup server CGI</a>, the customer view screen will display a customized link to the signup server with the appropriate customer as referral',
1517     'type'        => 'text',
1518   },
1519
1520   {
1521     'key'         => 'smtpmachine',
1522     'section'     => 'required',
1523     'description' => 'SMTP relay for Freeside\'s outgoing mail',
1524     'type'        => 'text',
1525   },
1526
1527   {
1528     'key'         => 'smtp-username',
1529     'section'     => '',
1530     'description' => 'Optional SMTP username for Freeside\'s outgoing mail',
1531     'type'        => 'text',
1532   },
1533
1534   {
1535     'key'         => 'smtp-password',
1536     'section'     => '',
1537     'description' => 'Optional SMTP password for Freeside\'s outgoing mail',
1538     'type'        => 'text',
1539   },
1540
1541   {
1542     'key'         => 'smtp-encryption',
1543     'section'     => '',
1544     'description' => 'Optional SMTP encryption method.  The STARTTLS methods require smtp-username and smtp-password to be set.',
1545     'type'        => 'select',
1546     'select_hash' => [ '25'           => 'None (port 25)',
1547                        '25-starttls'  => 'STARTTLS (port 25)',
1548                        '587-starttls' => 'STARTTLS / submission (port 587)',
1549                        '465-tls'      => 'SMTPS (SSL) (port 465)',
1550                      ],
1551   },
1552
1553   {
1554     'key'         => 'soadefaultttl',
1555     'section'     => 'BIND',
1556     'description' => 'SOA default TTL for new domains.',
1557     'type'        => 'text',
1558   },
1559
1560   {
1561     'key'         => 'soaemail',
1562     'section'     => 'BIND',
1563     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
1564     'type'        => 'text',
1565   },
1566
1567   {
1568     'key'         => 'soaexpire',
1569     'section'     => 'BIND',
1570     'description' => 'SOA expire for new domains',
1571     'type'        => 'text',
1572   },
1573
1574   {
1575     'key'         => 'soamachine',
1576     'section'     => 'BIND',
1577     'description' => 'SOA machine for new domains, with trailing `.\'',
1578     'type'        => 'text',
1579   },
1580
1581   {
1582     'key'         => 'soarefresh',
1583     'section'     => 'BIND',
1584     'description' => 'SOA refresh for new domains',
1585     'type'        => 'text',
1586   },
1587
1588   {
1589     'key'         => 'soaretry',
1590     'section'     => 'BIND',
1591     'description' => 'SOA retry for new domains',
1592     'type'        => 'text',
1593   },
1594
1595   {
1596     'key'         => 'statedefault',
1597     'section'     => 'UI',
1598     'description' => 'Default state or province (if not supplied, the default is `CA\')',
1599     'type'        => 'text',
1600   },
1601
1602   {
1603     'key'         => 'unsuspendauto',
1604     'section'     => 'billing',
1605     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due changes from positive to zero or negative as the result of a payment or credit',
1606     'type'        => 'checkbox',
1607   },
1608
1609   {
1610     'key'         => 'unsuspend-always_adjust_next_bill_date',
1611     'section'     => 'billing',
1612     'description' => 'Global override that causes unsuspensions to always adjust the next bill date under any circumstances.  This is now controlled on a per-package bases - probably best not to use this option unless you are a legacy installation that requires this behaviour.',
1613     'type'        => 'checkbox',
1614   },
1615
1616   {
1617     'key'         => 'usernamemin',
1618     'section'     => 'username',
1619     'description' => 'Minimum username length (default 2)',
1620     'type'        => 'text',
1621   },
1622
1623   {
1624     'key'         => 'usernamemax',
1625     'section'     => 'username',
1626     'description' => 'Maximum username length',
1627     'type'        => 'text',
1628   },
1629
1630   {
1631     'key'         => 'username-ampersand',
1632     'section'     => 'username',
1633     'description' => 'Allow the ampersand character (&amp;) in usernames.  Be careful when using this option in conjunction with <a href="../browse/part_export.cgi">exports</a> which execute shell commands, as the ampersand will be interpreted by the shell if not quoted.',
1634     'type'        => 'checkbox',
1635   },
1636
1637   {
1638     'key'         => 'username-letter',
1639     'section'     => 'username',
1640     'description' => 'Usernames must contain at least one letter',
1641     'type'        => 'checkbox',
1642     'per_agent'   => 1,
1643   },
1644
1645   {
1646     'key'         => 'username-letterfirst',
1647     'section'     => 'username',
1648     'description' => 'Usernames must start with a letter',
1649     'type'        => 'checkbox',
1650   },
1651
1652   {
1653     'key'         => 'username-noperiod',
1654     'section'     => 'username',
1655     'description' => 'Disallow periods in usernames',
1656     'type'        => 'checkbox',
1657   },
1658
1659   {
1660     'key'         => 'username-nounderscore',
1661     'section'     => 'username',
1662     'description' => 'Disallow underscores in usernames',
1663     'type'        => 'checkbox',
1664   },
1665
1666   {
1667     'key'         => 'username-nodash',
1668     'section'     => 'username',
1669     'description' => 'Disallow dashes in usernames',
1670     'type'        => 'checkbox',
1671   },
1672
1673   {
1674     'key'         => 'username-uppercase',
1675     'section'     => 'username',
1676     'description' => 'Allow uppercase characters in usernames.  Not recommended for use with FreeRADIUS with MySQL backend, which is case-insensitive by default.',
1677     'type'        => 'checkbox',
1678   },
1679
1680   { 
1681     'key'         => 'username-percent',
1682     'section'     => 'username',
1683     'description' => 'Allow the percent character (%) in usernames.',
1684     'type'        => 'checkbox',
1685   },
1686
1687   { 
1688     'key'         => 'username-colon',
1689     'section'     => 'username',
1690     'description' => 'Allow the colon character (:) in usernames.',
1691     'type'        => 'checkbox',
1692   },
1693
1694   { 
1695     'key'         => 'username-slash',
1696     'section'     => 'username',
1697     'description' => 'Allow the slash character (/) in usernames.  When using, make sure to set "Home directory" to fixed and blank in all svc_acct service definitions.',
1698     'type'        => 'checkbox',
1699   },
1700
1701   { 
1702     'key'         => 'username-equals',
1703     'section'     => 'username',
1704     'description' => 'Allow the equal sign character (=) in usernames.',
1705     'type'        => 'checkbox',
1706   },
1707
1708   {
1709     'key'         => 'safe-part_bill_event',
1710     'section'     => 'UI',
1711     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1712     'type'        => 'checkbox',
1713   },
1714
1715   {
1716     'key'         => 'show_ss',
1717     'section'     => 'UI',
1718     'description' => 'Turns on display/collection of social security numbers in the web interface.  Sometimes required by electronic check (ACH) processors.',
1719     'type'        => 'checkbox',
1720   },
1721
1722   {
1723     'key'         => 'show_stateid',
1724     'section'     => 'UI',
1725     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
1726     'type'        => 'checkbox',
1727   },
1728
1729   {
1730     'key'         => 'show_bankstate',
1731     'section'     => 'UI',
1732     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
1733     'type'        => 'checkbox',
1734   },
1735
1736   { 
1737     'key'         => 'agent_defaultpkg',
1738     'section'     => 'UI',
1739     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
1740     'type'        => 'checkbox',
1741   },
1742
1743   {
1744     'key'         => 'legacy_link',
1745     'section'     => 'UI',
1746     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
1747     'type'        => 'checkbox',
1748   },
1749
1750   {
1751     'key'         => 'legacy_link-steal',
1752     'section'     => 'UI',
1753     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
1754     'type'        => 'checkbox',
1755   },
1756
1757   {
1758     'key'         => 'queue_dangerous_controls',
1759     'section'     => 'UI',
1760     'description' => 'Enable queue modification controls on account pages and for new jobs.  Unless you are a developer working on new export code, you should probably leave this off to avoid causing provisioning problems.',
1761     'type'        => 'checkbox',
1762   },
1763
1764   {
1765     'key'         => 'security_phrase',
1766     'section'     => 'password',
1767     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1768     'type'        => 'checkbox',
1769   },
1770
1771   {
1772     'key'         => 'locale',
1773     'section'     => 'UI',
1774     'description' => 'Message locale',
1775     'type'        => 'select',
1776     'select_enum' => [ qw(en_US) ],
1777   },
1778
1779   {
1780     'key'         => 'signup_server-payby',
1781     'section'     => 'self-service',
1782     'description' => 'Acceptable payment types for the signup server',
1783     'type'        => 'selectmultiple',
1784     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1785   },
1786
1787   {
1788     'key'         => 'selfservice-payment_gateway',
1789     'section'     => 'self-service',
1790     'description' => 'Force the use of this payment gateway for self-service.',
1791     %payment_gateway_options,
1792   },
1793
1794   {
1795     'key'         => 'selfservice-save_unchecked',
1796     'section'     => 'self-service',
1797     'description' => 'In self-service, uncheck "Remember information" checkboxes by default (normally, they are checked by default).',
1798     'type'        => 'checkbox',
1799   },
1800
1801   {
1802     'key'         => 'signup_server-default_agentnum',
1803     'section'     => 'self-service',
1804     'description' => 'Default agent for the signup server',
1805     'type'        => 'select-sub',
1806     'options_sub' => sub { require FS::Record;
1807                            require FS::agent;
1808                            map { $_->agentnum => $_->agent }
1809                                FS::Record::qsearch('agent', { disabled=>'' } );
1810                          },
1811     'option_sub'  => sub { require FS::Record;
1812                            require FS::agent;
1813                            my $agent = FS::Record::qsearchs(
1814                              'agent', { 'agentnum'=>shift }
1815                            );
1816                            $agent ? $agent->agent : '';
1817                          },
1818   },
1819
1820   {
1821     'key'         => 'signup_server-default_refnum',
1822     'section'     => 'self-service',
1823     'description' => 'Default advertising source for the signup server',
1824     'type'        => 'select-sub',
1825     'options_sub' => sub { require FS::Record;
1826                            require FS::part_referral;
1827                            map { $_->refnum => $_->referral }
1828                                FS::Record::qsearch( 'part_referral', 
1829                                                     { 'disabled' => '' }
1830                                                   );
1831                          },
1832     'option_sub'  => sub { require FS::Record;
1833                            require FS::part_referral;
1834                            my $part_referral = FS::Record::qsearchs(
1835                              'part_referral', { 'refnum'=>shift } );
1836                            $part_referral ? $part_referral->referral : '';
1837                          },
1838   },
1839
1840   {
1841     'key'         => 'signup_server-default_pkgpart',
1842     'section'     => 'self-service',
1843     'description' => 'Default package for the signup server',
1844     'type'        => 'select-part_pkg',
1845   },
1846
1847   {
1848     'key'         => 'signup_server-default_svcpart',
1849     'section'     => 'self-service',
1850     'description' => 'Default service definition for the signup server - only necessary for services that trigger special provisioning widgets (such as DID provisioning).',
1851     'type'        => 'select-part_svc',
1852   },
1853
1854   {
1855     'key'         => 'signup_server-mac_addr_svcparts',
1856     'section'     => 'self-service',
1857     'description' => 'Service definitions which can receive mac addresses (current mapped to username for svc_acct).',
1858     'type'        => 'select-part_svc',
1859     'multiple'    => 1,
1860   },
1861
1862   {
1863     'key'         => 'signup_server-nomadix',
1864     'section'     => 'self-service',
1865     'description' => 'Signup page Nomadix integration',
1866     'type'        => 'checkbox',
1867   },
1868
1869   {
1870     'key'         => 'signup_server-service',
1871     'section'     => 'self-service',
1872     'description' => 'Service for the signup server - "Account (svc_acct)" is the default setting, or "Phone number (svc_phone)" for ITSP signup',
1873     'type'        => 'select',
1874     'select_hash' => [
1875                        'svc_acct'  => 'Account (svc_acct)',
1876                        'svc_phone' => 'Phone number (svc_phone)',
1877                        'svc_pbx'   => 'PBX (svc_pbx)',
1878                      ],
1879   },
1880   
1881   {
1882     'key'         => 'signup_server-prepaid-template-custnum',
1883     'section'     => 'self-service',
1884     'description' => 'When the signup server is used with prepaid cards and customer info is not required for signup, the contact/address info will be copied from this customer, if specified',
1885     'type'        => 'text',
1886   },
1887
1888   {
1889     'key'         => 'selfservice_server-base_url',
1890     'section'     => 'self-service',
1891     'description' => 'Base URL for the self-service web interface - necessary for some widgets to find their way, including retrieval of non-US state information and phone number provisioning.',
1892     'type'        => 'text',
1893   },
1894
1895   {
1896     'key'         => 'show-msgcat-codes',
1897     'section'     => 'UI',
1898     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1899     'type'        => 'checkbox',
1900   },
1901
1902   {
1903     'key'         => 'signup_server-realtime',
1904     'section'     => 'self-service',
1905     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1906     'type'        => 'checkbox',
1907   },
1908
1909   {
1910     'key'         => 'signup_server-classnum2',
1911     'section'     => 'self-service',
1912     'description' => 'Package Class for first optional purchase',
1913     'type'        => 'select-pkg_class',
1914   },
1915
1916   {
1917     'key'         => 'signup_server-classnum3',
1918     'section'     => 'self-service',
1919     'description' => 'Package Class for second optional purchase',
1920     'type'        => 'select-pkg_class',
1921   },
1922
1923   {
1924     'key'         => 'signup_server-third_party_as_card',
1925     'section'     => 'self-service',
1926     'description' => 'Allow customer payment type to be set to CARD even when using third-party credit card billing.',
1927     'type'        => 'checkbox',
1928   },
1929
1930   {
1931     'key'         => 'selfservice-xmlrpc',
1932     'section'     => 'self-service',
1933     'description' => 'Run a standalone self-service XML-RPC server on the backend (on port 8080).',
1934     'type'        => 'checkbox',
1935   },
1936
1937   {
1938     'key'         => 'backend-realtime',
1939     'section'     => 'billing',
1940     'description' => 'Run billing for backend signups immediately.',
1941     'type'        => 'checkbox',
1942   },
1943
1944   {
1945     'key'         => 'decline_msgnum',
1946     'section'     => 'notification',
1947     'description' => 'Template to use for credit card and electronic check decline messages.',
1948     %msg_template_options,
1949   },
1950
1951   {
1952     'key'         => 'declinetemplate',
1953     'section'     => 'deprecated',
1954     'description' => 'Template file for credit card and electronic check decline emails.',
1955     'type'        => 'textarea',
1956   },
1957
1958   {
1959     'key'         => 'emaildecline',
1960     'section'     => 'notification',
1961     'description' => 'Enable emailing of credit card and electronic check decline notices.',
1962     'type'        => 'checkbox',
1963     'per_agent'   => 1,
1964   },
1965
1966   {
1967     'key'         => 'emaildecline-exclude',
1968     'section'     => 'notification',
1969     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1970     'type'        => 'textarea',
1971     'per_agent'   => 1,
1972   },
1973
1974   {
1975     'key'         => 'cancel_msgnum',
1976     'section'     => 'notification',
1977     'description' => 'Template to use for cancellation emails.',
1978     %msg_template_options,
1979   },
1980
1981   {
1982     'key'         => 'cancelmessage',
1983     'section'     => 'deprecated',
1984     'description' => 'Template file for cancellation emails.',
1985     'type'        => 'textarea',
1986   },
1987
1988   {
1989     'key'         => 'cancelsubject',
1990     'section'     => 'deprecated',
1991     'description' => 'Subject line for cancellation emails.',
1992     'type'        => 'text',
1993   },
1994
1995   {
1996     'key'         => 'emailcancel',
1997     'section'     => 'notification',
1998     'description' => 'Enable emailing of cancellation notices.  Make sure to select the template in the cancel_msgnum option.',
1999     'type'        => 'checkbox',
2000     'per_agent'   => 1,
2001   },
2002
2003   {
2004     'key'         => 'bill_usage_on_cancel',
2005     'section'     => 'billing',
2006     'description' => 'Enable automatic generation of an invoice for usage when a package is cancelled.  Not all packages can do this.  Usage data must already be available.',
2007     'type'        => 'checkbox',
2008   },
2009
2010   {
2011     'key'         => 'require_cardname',
2012     'section'     => 'billing',
2013     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
2014     'type'        => 'checkbox',
2015   },
2016
2017   {
2018     'key'         => 'enable_taxclasses',
2019     'section'     => 'billing',
2020     'description' => 'Enable per-package tax classes',
2021     'type'        => 'checkbox',
2022   },
2023
2024   {
2025     'key'         => 'require_taxclasses',
2026     'section'     => 'billing',
2027     'description' => 'Require a taxclass to be entered for every package',
2028     'type'        => 'checkbox',
2029   },
2030
2031   {
2032     'key'         => 'enable_taxproducts',
2033     'section'     => 'billing',
2034     'description' => 'Enable per-package mapping to vendor tax data from CCH or elsewhere.',
2035     'type'        => 'checkbox',
2036   },
2037
2038   {
2039     'key'         => 'taxdatadirectdownload',
2040     'section'     => 'billing',  #well
2041     'description' => 'Enable downloading tax data directly from the vendor site. at least three lines: URL, username, and password.j',
2042     'type'        => 'textarea',
2043   },
2044
2045   {
2046     'key'         => 'ignore_incalculable_taxes',
2047     'section'     => 'billing',
2048     'description' => 'Prefer to invoice without tax over not billing at all',
2049     'type'        => 'checkbox',
2050   },
2051
2052   {
2053     'key'         => 'welcome_msgnum',
2054     'section'     => 'notification',
2055     'description' => 'Template to use for welcome messages when a svc_acct record is created.',
2056     %msg_template_options,
2057   },
2058
2059   {
2060     'key'         => 'welcome_email',
2061     'section'     => 'deprecated',
2062     'description' => 'Template file for welcome email.  Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.',
2063     'type'        => 'textarea',
2064     'per_agent'   => 1,
2065   },
2066
2067   {
2068     'key'         => 'welcome_email-from',
2069     'section'     => 'deprecated',
2070     'description' => 'From: address header for welcome email',
2071     'type'        => 'text',
2072     'per_agent'   => 1,
2073   },
2074
2075   {
2076     'key'         => 'welcome_email-subject',
2077     'section'     => 'deprecated',
2078     'description' => 'Subject: header for welcome email',
2079     'type'        => 'text',
2080     'per_agent'   => 1,
2081   },
2082   
2083   {
2084     'key'         => 'welcome_email-mimetype',
2085     'section'     => 'deprecated',
2086     'description' => 'MIME type for welcome email',
2087     'type'        => 'select',
2088     'select_enum' => [ 'text/plain', 'text/html' ],
2089     'per_agent'   => 1,
2090   },
2091
2092   {
2093     'key'         => 'welcome_letter',
2094     'section'     => '',
2095     'description' => 'Optional LaTex template file for a printed welcome letter.  A welcome letter is printed the first time a cust_pkg record is created.  See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation and the billing documentation for details on the template substitution language.  A variable exists for each fieldname in the customer record (<code>$first, $last, etc</code>).  The following additional variables are available<ul><li><code>$payby</code> - a friendler represenation of the field<li><code>$payinfo</code> - the masked payment information<li><code>$expdate</code> - the time at which the payment method expires (a UNIX timestamp)<li><code>$returnaddress</code> - the invoice return address for this customer\'s agent</ul>',
2096     'type'        => 'textarea',
2097   },
2098
2099 #  {
2100 #    'key'         => 'warning_msgnum',
2101 #    'section'     => 'notification',
2102 #    'description' => 'Template to use for warning messages, sent to the customer email invoice destination(s) when a svc_acct record has its usage drop below a threshold.',
2103 #    %msg_template_options,
2104 #  },
2105
2106   {
2107     'key'         => 'warning_email',
2108     'section'     => 'notification',
2109     'description' => 'Template file for warning email.  Warning emails are sent to the customer email invoice destination(s) each time a svc_acct record has its usage drop below a threshold or 0.  See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code> <li><code>$column</code> <li><code>$amount</code> <li><code>$threshold</code></ul>',
2110     'type'        => 'textarea',
2111   },
2112
2113   {
2114     'key'         => 'warning_email-from',
2115     'section'     => 'notification',
2116     'description' => 'From: address header for warning email',
2117     'type'        => 'text',
2118   },
2119
2120   {
2121     'key'         => 'warning_email-cc',
2122     'section'     => 'notification',
2123     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
2124     'type'        => 'text',
2125   },
2126
2127   {
2128     'key'         => 'warning_email-subject',
2129     'section'     => 'notification',
2130     'description' => 'Subject: header for warning email',
2131     'type'        => 'text',
2132   },
2133   
2134   {
2135     'key'         => 'warning_email-mimetype',
2136     'section'     => 'notification',
2137     'description' => 'MIME type for warning email',
2138     'type'        => 'select',
2139     'select_enum' => [ 'text/plain', 'text/html' ],
2140   },
2141
2142   {
2143     'key'         => 'payby',
2144     'section'     => 'billing',
2145     'description' => 'Available payment types.',
2146     'type'        => 'selectmultiple',
2147     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP) ],
2148   },
2149
2150   {
2151     'key'         => 'payby-default',
2152     'section'     => 'UI',
2153     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
2154     'type'        => 'select',
2155     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP HIDE) ],
2156   },
2157
2158   {
2159     'key'         => 'paymentforcedtobatch',
2160     'section'     => 'deprecated',
2161     'description' => 'See batch-enable_payby and realtime-disable_payby.  Used to (for CHEK): Cause per customer payment entry to be forced to a batch processor rather than performed realtime.',
2162     'type'        => 'checkbox',
2163   },
2164
2165   {
2166     'key'         => 'svc_acct-notes',
2167     'section'     => 'deprecated',
2168     'description' => 'Extra HTML to be displayed on the Account View screen.',
2169     'type'        => 'textarea',
2170   },
2171
2172   {
2173     'key'         => 'radius-password',
2174     'section'     => '',
2175     'description' => 'RADIUS attribute for plain-text passwords.',
2176     'type'        => 'select',
2177     'select_enum' => [ 'Password', 'User-Password', 'Cleartext-Password' ],
2178   },
2179
2180   {
2181     'key'         => 'radius-ip',
2182     'section'     => '',
2183     'description' => 'RADIUS attribute for IP addresses.',
2184     'type'        => 'select',
2185     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
2186   },
2187
2188   #http://dev.coova.org/svn/coova-chilli/doc/dictionary.chillispot
2189   {
2190     'key'         => 'radius-chillispot-max',
2191     'section'     => '',
2192     'description' => 'Enable ChilliSpot (and CoovaChilli) Max attributes, specifically ChilliSpot-Max-{Input,Output,Total}-{Octets,Gigawords}.',
2193     'type'        => 'checkbox',
2194   },
2195
2196   {
2197     'key'         => 'svc_acct-alldomains',
2198     'section'     => '',
2199     'description' => 'Allow accounts to select any domain in the database.  Normally accounts can only select from the domain set in the service definition and those purchased by the customer.',
2200     'type'        => 'checkbox',
2201   },
2202
2203   {
2204     'key'         => 'dump-scpdest',
2205     'section'     => '',
2206     'description' => 'destination for scp database dumps: user@host:/path',
2207     'type'        => 'text',
2208   },
2209
2210   {
2211     'key'         => 'dump-pgpid',
2212     'section'     => '',
2213     'description' => "Optional PGP public key user or key id for database dumps.  The public key should exist on the freeside user's public keyring, and the gpg binary and GnuPG perl module should be installed.",
2214     'type'        => 'text',
2215   },
2216
2217   {
2218     'key'         => 'users-allow_comp',
2219     'section'     => 'deprecated',
2220     'description' => '<b>DEPRECATED</b>, enable the <i>Complimentary customer</i> access right instead.  Was: Usernames (Freeside users, created with <a href="../docs/man/bin/freeside-adduser.html">freeside-adduser</a>) which can create complimentary customers, one per line.  If no usernames are entered, all users can create complimentary accounts.',
2221     'type'        => 'textarea',
2222   },
2223
2224   {
2225     'key'         => 'credit_card-recurring_billing_flag',
2226     'section'     => 'billing',
2227     'description' => 'This controls when the system passes the "recurring_billing" flag on credit card transactions.  If supported by your processor (and the Business::OnlinePayment processor module), passing the flag indicates this is a recurring transaction and may turn off the CVV requirement. ',
2228     'type'        => 'select',
2229     'select_hash' => [
2230                        'actual_oncard' => 'Default/classic behavior: set the flag if a customer has actual previous charges on the card.',
2231                        'transaction_is_recur' => 'Set the flag if the transaction itself is recurring, irregardless of previous charges on the card.',
2232                      ],
2233   },
2234
2235   {
2236     'key'         => 'credit_card-recurring_billing_acct_code',
2237     'section'     => 'billing',
2238     'description' => 'When the "recurring billing" flag is set, also set the "acct_code" to "rebill".  Useful for reporting purposes with supported gateways (PlugNPay, others?)',
2239     'type'        => 'checkbox',
2240   },
2241
2242   {
2243     'key'         => 'cvv-save',
2244     'section'     => 'billing',
2245     'description' => 'Save CVV2 information after the initial transaction for the selected credit card types.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
2246     'type'        => 'selectmultiple',
2247     'select_enum' => \@card_types,
2248   },
2249
2250   {
2251     'key'         => 'manual_process-pkgpart',
2252     'section'     => 'billing',
2253     'description' => 'Package to add to each manual credit card and ACH payments entered from the backend.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option.',
2254     'type'        => 'select-part_pkg',
2255   },
2256
2257   {
2258     'key'         => 'manual_process-display',
2259     'section'     => 'billing',
2260     'description' => 'When using manual_process-pkgpart, add the fee to the amount entered (default), or subtract the fee from the amount entered.',
2261     'type'        => 'select',
2262     'select_hash' => [
2263                        'add'      => 'Add fee to amount entered',
2264                        'subtract' => 'Subtract fee from amount entered',
2265                      ],
2266   },
2267
2268   {
2269     'key'         => 'manual_process-skip_first',
2270     'section'     => 'billing',
2271     'description' => "When using manual_process-pkgpart, omit the fee if it is the customer's first payment.",
2272     'type'        => 'checkbox',
2273   },
2274
2275   {
2276     'key'         => 'allow_negative_charges',
2277     'section'     => 'billing',
2278     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
2279     'type'        => 'checkbox',
2280   },
2281   {
2282       'key'         => 'auto_unset_catchall',
2283       'section'     => '',
2284       'description' => 'When canceling a svc_acct that is the email catchall for one or more svc_domains, automatically set their catchall fields to null.  If this option is not set, the attempt will simply fail.',
2285       'type'        => 'checkbox',
2286   },
2287
2288   {
2289     'key'         => 'system_usernames',
2290     'section'     => 'username',
2291     'description' => 'A list of system usernames that cannot be edited or removed, one per line.  Use a bare username to prohibit modification/deletion of the username in any domain, or username@domain to prohibit modification/deletetion of a specific username and domain.',
2292     'type'        => 'textarea',
2293   },
2294
2295   {
2296     'key'         => 'cust_pkg-change_svcpart',
2297     'section'     => '',
2298     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
2299     'type'        => 'checkbox',
2300   },
2301
2302   {
2303     'key'         => 'cust_pkg-change_pkgpart-bill_now',
2304     'section'     => '',
2305     'description' => "When changing packages, bill the new package immediately.  Useful for prepaid situations with RADIUS where an Expiration attribute based on the package must be present at all times.",
2306     'type'        => 'checkbox',
2307   },
2308
2309   {
2310     'key'         => 'disable_autoreverse',
2311     'section'     => 'BIND',
2312     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
2313     'type'        => 'checkbox',
2314   },
2315
2316   {
2317     'key'         => 'svc_www-enable_subdomains',
2318     'section'     => '',
2319     'description' => 'Enable selection of specific subdomains for virtual host creation.',
2320     'type'        => 'checkbox',
2321   },
2322
2323   {
2324     'key'         => 'svc_www-usersvc_svcpart',
2325     'section'     => '',
2326     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
2327     'type'        => 'select-part_svc',
2328     'multiple'    => 1,
2329   },
2330
2331   {
2332     'key'         => 'selfservice_server-primary_only',
2333     'section'     => 'self-service',
2334     'description' => 'Only allow primary accounts to access self-service functionality.',
2335     'type'        => 'checkbox',
2336   },
2337
2338   {
2339     'key'         => 'selfservice_server-phone_login',
2340     'section'     => 'self-service',
2341     'description' => 'Allow login to self-service with phone number and PIN.',
2342     'type'        => 'checkbox',
2343   },
2344
2345   {
2346     'key'         => 'selfservice_server-single_domain',
2347     'section'     => 'self-service',
2348     'description' => 'If specified, only use this one domain for self-service access.',
2349     'type'        => 'text',
2350   },
2351
2352   {
2353     'key'         => 'selfservice_server-login_svcpart',
2354     'section'     => 'self-service',
2355     'description' => 'If specified, only allow the specified svcparts to login to self-service.',
2356     'type'        => 'select-part_svc',
2357     'multiple'    => 1,
2358   },
2359   
2360   {
2361     'key'         => 'selfservice-recent-did-age',
2362     'section'     => 'self-service',
2363     'description' => 'If specified, defines "recent", in number of seconds, for "Download recently allocated DIDs" in self-service.',
2364     'type'        => 'text',
2365   },
2366
2367   {
2368     'key'         => 'selfservice_server-view-wholesale',
2369     'section'     => 'self-service',
2370     'description' => 'If enabled, use a wholesale package view in the self-service.',
2371     'type'        => 'checkbox',
2372   },
2373   
2374   {
2375     'key'         => 'selfservice-agent_signup',
2376     'section'     => 'self-service',
2377     'description' => 'Allow agent signup via self-service.',
2378     'type'        => 'checkbox',
2379   },
2380
2381   {
2382     'key'         => 'selfservice-agent_signup-agent_type',
2383     'section'     => 'self-service',
2384     'description' => 'Agent type when allowing agent signup via self-service.',
2385     'type'        => 'select-sub',
2386     'options_sub' => sub { require FS::Record;
2387                            require FS::agent_type;
2388                            map { $_->typenum => $_->atype }
2389                                FS::Record::qsearch('agent_type', {} ); # disabled=>'' } );
2390                          },
2391     'option_sub'  => sub { require FS::Record;
2392                            require FS::agent_type;
2393                            my $agent = FS::Record::qsearchs(
2394                              'agent_type', { 'typenum'=>shift }
2395                            );
2396                            $agent_type ? $agent_type->atype : '';
2397                          },
2398   },
2399
2400   {
2401     'key'         => 'selfservice-agent_login',
2402     'section'     => 'self-service',
2403     'description' => 'Allow agent login via self-service.',
2404     'type'        => 'checkbox',
2405   },
2406
2407   {
2408     'key'         => 'selfservice-self_suspend_reason',
2409     'section'     => 'self-service',
2410     'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
2411     'type'        => 'select-sub',
2412     'options_sub' => sub { require FS::Record;
2413                            require FS::reason;
2414                            my $type = qsearchs('reason_type', 
2415                              { class => 'S' }) 
2416                               or return ();
2417                            map { $_->reasonnum => $_->reason }
2418                                FS::Record::qsearch('reason', 
2419                                  { reason_type => $type->typenum } 
2420                                );
2421                          },
2422     'option_sub'  => sub { require FS::Record;
2423                            require FS::reason;
2424                            my $reason = FS::Record::qsearchs(
2425                              'reason', { 'reasonnum' => shift }
2426                            );
2427                            $reason ? $reason->reason : '';
2428                          },
2429
2430     'per_agent'   => 1,
2431   },
2432
2433   {
2434     'key'         => 'card_refund-days',
2435     'section'     => 'billing',
2436     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
2437     'type'        => 'text',
2438   },
2439
2440   {
2441     'key'         => 'agent-showpasswords',
2442     'section'     => '',
2443     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
2444     'type'        => 'checkbox',
2445   },
2446
2447   {
2448     'key'         => 'global_unique-username',
2449     'section'     => 'username',
2450     'description' => 'Global username uniqueness control: none (usual setting - check uniqueness per exports), username (all usernames are globally unique, regardless of domain or exports), or username@domain (all username@domain pairs are globally unique, regardless of exports).  disabled turns off duplicate checking completely and is STRONGLY NOT RECOMMENDED unless you REALLY need to turn this off.',
2451     'type'        => 'select',
2452     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
2453   },
2454
2455   {
2456     'key'         => 'global_unique-phonenum',
2457     'section'     => '',
2458     'description' => 'Global phone number uniqueness control: none (usual setting - check countrycode+phonenumun uniqueness per exports), or countrycode+phonenum (all countrycode+phonenum pairs are globally unique, regardless of exports).  disabled turns off duplicate checking completely and is STRONGLY NOT RECOMMENDED unless you REALLY need to turn this off.',
2459     'type'        => 'select',
2460     'select_enum' => [ 'none', 'countrycode+phonenum', 'disabled' ],
2461   },
2462
2463   {
2464     'key'         => 'global_unique-pbx_title',
2465     'section'     => '',
2466     'description' => 'Global phone number uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2467     'type'        => 'select',
2468     'select_enum' => [ 'enabled', 'disabled' ],
2469   },
2470
2471   {
2472     'key'         => 'global_unique-pbx_id',
2473     'section'     => '',
2474     'description' => 'Global PBX id uniqueness control: none (check uniqueness per exports), enabled (check across all services), or disabled (no duplicate checking).',
2475     'type'        => 'select',
2476     'select_enum' => [ 'enabled', 'disabled' ],
2477   },
2478
2479   {
2480     'key'         => 'svc_external-skip_manual',
2481     'section'     => 'UI',
2482     'description' => 'When provisioning svc_external services, skip manual entry of id and title fields in the UI.  Usually used in conjunction with an export that populates these fields (i.e. artera_turbo).',
2483     'type'        => 'checkbox',
2484   },
2485
2486   {
2487     'key'         => 'svc_external-display_type',
2488     'section'     => 'UI',
2489     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
2490     'type'        => 'select',
2491     'select_enum' => [ 'generic', 'artera_turbo', ],
2492   },
2493
2494   {
2495     'key'         => 'ticket_system',
2496     'section'     => '',
2497     'description' => 'Ticketing system integration.  <b>RT_Internal</b> uses the built-in RT ticketing system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:RT_Installation">integrated ticketing installation instructions</a>).   <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
2498     'type'        => 'select',
2499     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2500     'select_enum' => [ '', qw(RT_Internal RT_External) ],
2501   },
2502
2503   {
2504     'key'         => 'network_monitoring_system',
2505     'section'     => '',
2506     'description' => 'Networking monitoring system (NMS) integration.  <b>Torrus_Internal</b> uses the built-in Torrus ticketing system (see the <a href="http://www.freeside.biz/mediawiki/index.php/Freeside:2.1:Documentation:Torrus_Installation">integrated networking monitoring system installation instructions</a>).',
2507     'type'        => 'select',
2508     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
2509     'select_enum' => [ '', qw(Torrus_Internal) ],
2510   },
2511
2512   {
2513     'key'         => 'ticket_system-default_queueid',
2514     'section'     => '',
2515     'description' => 'Default queue used when creating new customer tickets.',
2516     'type'        => 'select-sub',
2517     'options_sub' => sub {
2518                            my $conf = new FS::Conf;
2519                            if ( $conf->config('ticket_system') ) {
2520                              eval "use FS::TicketSystem;";
2521                              die $@ if $@;
2522                              FS::TicketSystem->queues();
2523                            } else {
2524                              ();
2525                            }
2526                          },
2527     'option_sub'  => sub { 
2528                            my $conf = new FS::Conf;
2529                            if ( $conf->config('ticket_system') ) {
2530                              eval "use FS::TicketSystem;";
2531                              die $@ if $@;
2532                              FS::TicketSystem->queue(shift);
2533                            } else {
2534                              '';
2535                            }
2536                          },
2537   },
2538   {
2539     'key'         => 'ticket_system-force_default_queueid',
2540     'section'     => '',
2541     'description' => 'Disallow queue selection when creating new tickets from customer view.',
2542     'type'        => 'checkbox',
2543   },
2544   {
2545     'key'         => 'ticket_system-selfservice_queueid',
2546     'section'     => '',
2547     'description' => 'Queue used when creating new customer tickets from self-service.  Defautls to ticket_system-default_queueid if not specified.',
2548     #false laziness w/above
2549     'type'        => 'select-sub',
2550     'options_sub' => sub {
2551                            my $conf = new FS::Conf;
2552                            if ( $conf->config('ticket_system') ) {
2553                              eval "use FS::TicketSystem;";
2554                              die $@ if $@;
2555                              FS::TicketSystem->queues();
2556                            } else {
2557                              ();
2558                            }
2559                          },
2560     'option_sub'  => sub { 
2561                            my $conf = new FS::Conf;
2562                            if ( $conf->config('ticket_system') ) {
2563                              eval "use FS::TicketSystem;";
2564                              die $@ if $@;
2565                              FS::TicketSystem->queue(shift);
2566                            } else {
2567                              '';
2568                            }
2569                          },
2570   },
2571
2572   {
2573     'key'         => 'ticket_system-priority_reverse',
2574     'section'     => '',
2575     'description' => 'Enable this to consider lower numbered priorities more important.  A bad habit we picked up somewhere.  You probably want to avoid it and use the default.',
2576     'type'        => 'checkbox',
2577   },
2578
2579   {
2580     'key'         => 'ticket_system-custom_priority_field',
2581     'section'     => '',
2582     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
2583     'type'        => 'text',
2584   },
2585
2586   {
2587     'key'         => 'ticket_system-custom_priority_field-values',
2588     'section'     => '',
2589     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
2590     'type'        => 'textarea',
2591   },
2592
2593   {
2594     'key'         => 'ticket_system-custom_priority_field_queue',
2595     'section'     => '',
2596     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
2597     'type'        => 'text',
2598   },
2599
2600   {
2601     'key'         => 'ticket_system-escalation',
2602     'section'     => '',
2603     'description' => 'Enable priority escalation of tickets as part of daily batch processing.',
2604     'type'        => 'checkbox',
2605   },
2606
2607   {
2608     'key'         => 'ticket_system-rt_external_datasrc',
2609     'section'     => '',
2610     'description' => 'With external RT integration, the DBI data source for the external RT installation, for example, <code>DBI:Pg:user=rt_user;password=rt_word;host=rt.example.com;dbname=rt</code>',
2611     'type'        => 'text',
2612
2613   },
2614
2615   {
2616     'key'         => 'ticket_system-rt_external_url',
2617     'section'     => '',
2618     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
2619     'type'        => 'text',
2620   },
2621
2622   {
2623     'key'         => 'company_name',
2624     'section'     => 'required',
2625     'description' => 'Your company name',
2626     'type'        => 'text',
2627     'per_agent'   => 1, #XXX just FS/FS/ClientAPI/Signup.pm
2628   },
2629
2630   {
2631     'key'         => 'company_address',
2632     'section'     => 'required',
2633     'description' => 'Your company address',
2634     'type'        => 'textarea',
2635     'per_agent'   => 1,
2636   },
2637
2638   {
2639     'key'         => 'echeck-void',
2640     'section'     => 'deprecated',
2641     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of echeck payments in addition to refunds against the payment gateway',
2642     'type'        => 'checkbox',
2643   },
2644
2645   {
2646     'key'         => 'cc-void',
2647     'section'     => 'deprecated',
2648     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of credit card payments in addition to refunds against the payment gateway',
2649     'type'        => 'checkbox',
2650   },
2651
2652   {
2653     'key'         => 'unvoid',
2654     'section'     => 'deprecated',
2655     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
2656     'type'        => 'checkbox',
2657   },
2658
2659   {
2660     'key'         => 'address1-search',
2661     'section'     => 'UI',
2662     'description' => 'Enable the ability to search the address1 field from the quick customer search.  Not recommended in most cases as it tends to bring up too many search results - use explicit address searching from the advanced customer search instead.',
2663     'type'        => 'checkbox',
2664   },
2665
2666   {
2667     'key'         => 'address2-search',
2668     'section'     => 'UI',
2669     'description' => 'Enable a "Unit" search box which searches the second address field.  Useful for multi-tenant applications.  See also: cust_main-require_address2',
2670     'type'        => 'checkbox',
2671   },
2672
2673   {
2674     'key'         => 'cust_main-require_address2',
2675     'section'     => 'UI',
2676     'description' => 'Second address field is required (on service address only, if billing and service addresses differ).  Also enables "Unit" labeling of address2 on customer view and edit pages.  Useful for multi-tenant applications.  See also: address2-search',
2677     'type'        => 'checkbox',
2678   },
2679
2680   {
2681     'key'         => 'agent-ship_address',
2682     'section'     => '',
2683     'description' => "Use the agent's master service address as the service address (only ship_address2 can be entered, if blank on the master address).  Useful for multi-tenant applications.",
2684     'type'        => 'checkbox',
2685   },
2686
2687   { 'key'         => 'referral_credit',
2688     'section'     => 'deprecated',
2689     'description' => "Used to enable one-time referral credits in the amount of one month <i>referred</i> customer's recurring fee (irregardless of frequency).  Replace with a billing event on appropriate packages.",
2690     'type'        => 'checkbox',
2691   },
2692
2693   { 'key'         => 'selfservice_server-cache_module',
2694     'section'     => 'self-service',
2695     'description' => 'Module used to store self-service session information.  All modules handle any number of self-service servers.  Cache::SharedMemoryCache is appropriate for a single database / single Freeside server.  Cache::FileCache is useful for multiple databases on a single server, or when IPC::ShareLite is not available (i.e. FreeBSD).', #  _Database stores session information in the database and is appropriate for multiple Freeside servers, but may be slower.',
2696     'type'        => 'select',
2697     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
2698   },
2699
2700   {
2701     'key'         => 'hylafax',
2702     'section'     => 'billing',
2703     'description' => 'Options for a HylaFAX server to enable the FAX invoice destination.  They should be in the form of a space separated list of arguments to the Fax::Hylafax::Client::sendfax subroutine.  You probably shouldn\'t override things like \'docfile\'.  *Note* Only supported when using typeset invoices (see the invoice_latex configuration option).',
2704     'type'        => [qw( checkbox textarea )],
2705   },
2706
2707   {
2708     'key'         => 'cust_bill-ftpformat',
2709     'section'     => 'invoicing',
2710     'description' => 'Enable FTP of raw invoice data - format.',
2711     'type'        => 'select',
2712     'select_enum' => [ '', 'default', 'billco', ],
2713   },
2714
2715   {
2716     'key'         => 'cust_bill-ftpserver',
2717     'section'     => 'invoicing',
2718     'description' => 'Enable FTP of raw invoice data - server.',
2719     'type'        => 'text',
2720   },
2721
2722   {
2723     'key'         => 'cust_bill-ftpusername',
2724     'section'     => 'invoicing',
2725     'description' => 'Enable FTP of raw invoice data - server.',
2726     'type'        => 'text',
2727   },
2728
2729   {
2730     'key'         => 'cust_bill-ftppassword',
2731     'section'     => 'invoicing',
2732     'description' => 'Enable FTP of raw invoice data - server.',
2733     'type'        => 'text',
2734   },
2735
2736   {
2737     'key'         => 'cust_bill-ftpdir',
2738     'section'     => 'invoicing',
2739     'description' => 'Enable FTP of raw invoice data - server.',
2740     'type'        => 'text',
2741   },
2742
2743   {
2744     'key'         => 'cust_bill-spoolformat',
2745     'section'     => 'invoicing',
2746     'description' => 'Enable spooling of raw invoice data - format.',
2747     'type'        => 'select',
2748     'select_enum' => [ '', 'default', 'billco', ],
2749   },
2750
2751   {
2752     'key'         => 'cust_bill-spoolagent',
2753     'section'     => 'invoicing',
2754     'description' => 'Enable per-agent spooling of raw invoice data.',
2755     'type'        => 'checkbox',
2756   },
2757
2758   {
2759     'key'         => 'svc_acct-usage_suspend',
2760     'section'     => 'billing',
2761     'description' => 'Suspends the package an account belongs to when svc_acct.seconds or a bytecount is decremented to 0 or below (accounts with an empty seconds and up|down|totalbytes value are ignored).  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
2762     'type'        => 'checkbox',
2763   },
2764
2765   {
2766     'key'         => 'svc_acct-usage_unsuspend',
2767     'section'     => 'billing',
2768     'description' => 'Unuspends the package an account belongs to when svc_acct.seconds or a bytecount is incremented from 0 or below to a positive value (accounts with an empty seconds and up|down|totalbytes value are ignored).  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
2769     'type'        => 'checkbox',
2770   },
2771
2772   {
2773     'key'         => 'svc_acct-usage_threshold',
2774     'section'     => 'billing',
2775     'description' => 'The threshold (expressed as percentage) of acct.seconds or acct.up|down|totalbytes at which a warning message is sent to a service holder.  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
2776     'type'        => 'text',
2777   },
2778
2779   {
2780     'key'         => 'overlimit_groups',
2781     'section'     => '',
2782     'description' => 'RADIUS group (or comma-separated groups) to assign to svc_acct which has exceeded its bandwidth or time limit.',
2783     'type'        => 'text',
2784     'per_agent'   => 1,
2785   },
2786
2787   {
2788     'key'         => 'cust-fields',
2789     'section'     => 'UI',
2790     'description' => 'Which customer fields to display on reports by default',
2791     'type'        => 'select',
2792     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
2793   },
2794
2795   {
2796     'key'         => 'cust_pkg-display_times',
2797     'section'     => 'UI',
2798     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
2799     'type'        => 'checkbox',
2800   },
2801
2802   {
2803     'key'         => 'cust_pkg-always_show_location',
2804     'section'     => 'UI',
2805     'description' => "Always display package locations, even when they're all the default service address.",
2806     'type'        => 'checkbox',
2807   },
2808
2809   {
2810     'key'         => 'cust_pkg-group_by_location',
2811     'section'     => 'UI',
2812     'description' => "Group packages by location.",
2813     'type'        => 'checkbox',
2814   },
2815
2816   {
2817     'key'         => 'cust_pkg-show_fcc_voice_grade_equivalent',
2818     'section'     => 'UI',
2819     'description' => "Show a field on package definitions for assigning a DSO equivalency number suitable for use on FCC form 477.",
2820     'type'        => 'checkbox',
2821   },
2822
2823   {
2824     'key'         => 'cust_pkg-large_pkg_size',
2825     'section'     => 'UI',
2826     'description' => "In customer view, summarize packages with more than this many services.  Set to zero to never summarize packages.",
2827     'type'        => 'text',
2828   },
2829
2830   {
2831     'key'         => 'svc_acct-edit_uid',
2832     'section'     => 'shell',
2833     'description' => 'Allow UID editing.',
2834     'type'        => 'checkbox',
2835   },
2836
2837   {
2838     'key'         => 'svc_acct-edit_gid',
2839     'section'     => 'shell',
2840     'description' => 'Allow GID editing.',
2841     'type'        => 'checkbox',
2842   },
2843
2844   {
2845     'key'         => 'zone-underscore',
2846     'section'     => 'BIND',
2847     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
2848     'type'        => 'checkbox',
2849   },
2850
2851   {
2852     'key'         => 'echeck-nonus',
2853     'section'     => 'billing',
2854     'description' => 'Disable ABA-format account checking for Electronic Check payment info',
2855     'type'        => 'checkbox',
2856   },
2857
2858   {
2859     'key'         => 'voip-cust_cdr_spools',
2860     'section'     => 'telephony',
2861     'description' => 'Enable the per-customer option for individual CDR spools.',
2862     'type'        => 'checkbox',
2863   },
2864
2865   {
2866     'key'         => 'voip-cust_cdr_squelch',
2867     'section'     => 'telephony',
2868     'description' => 'Enable the per-customer option for not printing CDR on invoices.',
2869     'type'        => 'checkbox',
2870   },
2871
2872   {
2873     'key'         => 'voip-cdr_email',
2874     'section'     => 'telephony',
2875     'description' => 'Include the call details on emailed invoices (and HTML invoices viewed in the backend), even if the customer is configured for not printing them on the invoices.',
2876     'type'        => 'checkbox',
2877   },
2878
2879   {
2880     'key'         => 'voip-cust_email_csv_cdr',
2881     'section'     => 'telephony',
2882     'description' => 'Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.',
2883     'type'        => 'checkbox',
2884   },
2885
2886   {
2887     'key'         => 'cgp_rule-domain_templates',
2888     'section'     => '',
2889     'description' => 'Communigate Pro rule templates for domains, one per line, "svcnum Name"',
2890     'type'        => 'textarea',
2891   },
2892
2893   {
2894     'key'         => 'svc_forward-no_srcsvc',
2895     'section'     => '',
2896     'description' => "Don't allow forwards from existing accounts, only arbitrary addresses.  Useful when exporting to systems such as Communigate Pro which treat forwards in this fashion.",
2897     'type'        => 'checkbox',
2898   },
2899
2900   {
2901     'key'         => 'svc_forward-arbitrary_dst',
2902     'section'     => '',
2903     'description' => "Allow forwards to point to arbitrary strings that don't necessarily look like email addresses.  Only used when using forwards for weird, non-email things.",
2904     'type'        => 'checkbox',
2905   },
2906
2907   {
2908     'key'         => 'tax-ship_address',
2909     'section'     => 'billing',
2910     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.',
2911     'type'        => 'checkbox',
2912   }
2913 ,
2914   {
2915     'key'         => 'tax-pkg_address',
2916     'section'     => 'billing',
2917     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the package address instead (when present).',
2918     'type'        => 'checkbox',
2919   },
2920
2921   {
2922     'key'         => 'invoice-ship_address',
2923     'section'     => 'invoicing',
2924     'description' => 'Include the shipping address on invoices.',
2925     'type'        => 'checkbox',
2926   },
2927
2928   {
2929     'key'         => 'invoice-unitprice',
2930     'section'     => 'invoicing',
2931     'description' => 'Enable unit pricing on invoices.',
2932     'type'        => 'checkbox',
2933   },
2934
2935   {
2936     'key'         => 'invoice-smallernotes',
2937     'section'     => 'invoicing',
2938     'description' => 'Display the notes section in a smaller font on invoices.',
2939     'type'        => 'checkbox',
2940   },
2941
2942   {
2943     'key'         => 'invoice-smallerfooter',
2944     'section'     => 'invoicing',
2945     'description' => 'Display footers in a smaller font on invoices.',
2946     'type'        => 'checkbox',
2947   },
2948
2949   {
2950     'key'         => 'postal_invoice-fee_pkgpart',
2951     'section'     => 'billing',
2952     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
2953     'type'        => 'select-part_pkg',
2954   },
2955
2956   {
2957     'key'         => 'postal_invoice-recurring_only',
2958     'section'     => 'billing',
2959     'description' => 'The postal invoice fee is omitted on invoices without reucrring charges when this is set.',
2960     'type'        => 'checkbox',
2961   },
2962
2963   {
2964     'key'         => 'batch-enable',
2965     'section'     => 'deprecated', #make sure batch-enable_payby is set for
2966                                    #everyone before removing
2967     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
2968     'type'        => 'checkbox',
2969   },
2970
2971   {
2972     'key'         => 'batch-enable_payby',
2973     'section'     => 'billing',
2974     'description' => 'Enable batch processing for the specified payment types.',
2975     'type'        => 'selectmultiple',
2976     'select_enum' => [qw( CARD CHEK )],
2977   },
2978
2979   {
2980     'key'         => 'realtime-disable_payby',
2981     'section'     => 'billing',
2982     'description' => 'Disable realtime processing for the specified payment types.',
2983     'type'        => 'selectmultiple',
2984     'select_enum' => [qw( CARD CHEK )],
2985   },
2986
2987   {
2988     'key'         => 'batch-default_format',
2989     'section'     => 'billing',
2990     'description' => 'Default format for batches.',
2991     'type'        => 'select',
2992     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch',
2993                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
2994                        'paymentech', 'ach-spiritone', 'RBC'
2995                     ]
2996   },
2997
2998   #lists could be auto-generated from pay_batch info
2999   {
3000     'key'         => 'batch-fixed_format-CARD',
3001     'section'     => 'billing',
3002     'description' => 'Fixed (unchangeable) format for credit card batches.',
3003     'type'        => 'select',
3004     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
3005                        'csv-chase_canada-E-xactBatch', 'paymentech' ]
3006   },
3007
3008   {
3009     'key'         => 'batch-fixed_format-CHEK',
3010     'section'     => 'billing',
3011     'description' => 'Fixed (unchangeable) format for electronic check batches.',
3012     'type'        => 'select',
3013     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP',
3014                        'paymentech', 'ach-spiritone', 'RBC', 'td_eft1464'
3015                      ]
3016   },
3017
3018   {
3019     'key'         => 'batch-increment_expiration',
3020     'section'     => 'billing',
3021     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
3022     'type'        => 'checkbox'
3023   },
3024
3025   {
3026     'key'         => 'batchconfig-BoM',
3027     'section'     => 'billing',
3028     'description' => 'Configuration for Bank of Montreal batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
3029     'type'        => 'textarea',
3030   },
3031
3032   {
3033     'key'         => 'batchconfig-PAP',
3034     'section'     => 'billing',
3035     'description' => 'Configuration for PAP batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
3036     'type'        => 'textarea',
3037   },
3038
3039   {
3040     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
3041     'section'     => 'billing',
3042     'description' => 'Gateway ID for Chase Canada E-xact batching',
3043     'type'        => 'text',
3044   },
3045
3046   {
3047     'key'         => 'batchconfig-paymentech',
3048     'section'     => 'billing',
3049     'description' => 'Configuration for Chase Paymentech batching, five lines: 1. BIN, 2. Terminal ID, 3. Merchant ID, 4. Username, 5. Password (for batch uploads)',
3050     'type'        => 'textarea',
3051   },
3052
3053   {
3054     'key'         => 'batchconfig-RBC',
3055     'section'     => 'billing',
3056     'description' => 'Configuration for Royal Bank of Canada PDS batching, four lines: 1. Client number, 2. Short name, 3. Long name, 4. Transaction code.',
3057     'type'        => 'textarea',
3058   },
3059
3060   {
3061     'key'         => 'batchconfig-td_eft1464',
3062     'section'     => 'billing',
3063     'description' => 'Configuration for TD Bank EFT1464 batching, seven lines: 1. Originator ID, 2. Datacenter Code, 3. Short name, 4. Long name, 5. Returned payment branch number, 6. Returned payment account, 7. Transaction code.',
3064     'type'        => 'textarea',
3065   },
3066
3067   {
3068     'key'         => 'batch-manual_approval',
3069     'section'     => 'billing',
3070     'description' => 'Allow manual batch closure, which will approve all payments that do not yet have a status.  This is not advised, but is needed for payment processors that provide a report of rejected rather than approved payments.',
3071     'type'        => 'checkbox',
3072   },
3073
3074   {
3075     'key'         => 'payment_history-years',
3076     'section'     => 'UI',
3077     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
3078     'type'        => 'text',
3079   },
3080
3081   {
3082     'key'         => 'change_history-years',
3083     'section'     => 'UI',
3084     'description' => 'Number of years of change history to show by default.  Currently defaults to 0.5.',
3085     'type'        => 'text',
3086   },
3087
3088   {
3089     'key'         => 'cust_main-packages-years',
3090     'section'     => 'UI',
3091     'description' => 'Number of years to show old (cancelled and one-time charge) packages by default.  Currently defaults to 2.',
3092     'type'        => 'text',
3093   },
3094
3095   {
3096     'key'         => 'cust_main-use_comments',
3097     'section'     => 'UI',
3098     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
3099     'type'        => 'checkbox',
3100   },
3101
3102   {
3103     'key'         => 'cust_main-disable_notes',
3104     'section'     => 'UI',
3105     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
3106     'type'        => 'checkbox',
3107   },
3108
3109   {
3110     'key'         => 'cust_main_note-display_times',
3111     'section'     => 'UI',
3112     'description' => 'Display full timestamps (not just dates) for customer notes.',
3113     'type'        => 'checkbox',
3114   },
3115
3116   {
3117     'key'         => 'cust_main-ticket_statuses',
3118     'section'     => 'UI',
3119     'description' => 'Show tickets with these statuses on the customer view page.',
3120     'type'        => 'selectmultiple',
3121     'select_enum' => [qw( new open stalled resolved rejected deleted )],
3122   },
3123
3124   {
3125     'key'         => 'cust_main-max_tickets',
3126     'section'     => 'UI',
3127     'description' => 'Maximum number of tickets to show on the customer view page.',
3128     'type'        => 'text',
3129   },
3130
3131   {
3132     'key'         => 'cust_main-skeleton_tables',
3133     'section'     => '',
3134     'description' => 'Tables which will have skeleton records inserted into them for each customer.  Syntax for specifying tables is unfortunately a tricky perl data structure for now.',
3135     'type'        => 'textarea',
3136   },
3137
3138   {
3139     'key'         => 'cust_main-skeleton_custnum',
3140     'section'     => '',
3141     'description' => 'Customer number specifying the source data to copy into skeleton tables for new customers.',
3142     'type'        => 'text',
3143   },
3144
3145   {
3146     'key'         => 'cust_main-enable_birthdate',
3147     'section'     => 'UI',
3148     'descritpion' => 'Enable tracking of a birth date with each customer record',
3149     'type'        => 'checkbox',
3150   },
3151
3152   {
3153     'key'         => 'support-key',
3154     'section'     => '',
3155     'description' => 'A support key enables access to commercial services delivered over the network, such as the payroll module, access to the internal ticket system, priority support and optional backups.',
3156     'type'        => 'text',
3157   },
3158
3159   {
3160     'key'         => 'card-types',
3161     'section'     => 'billing',
3162     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
3163     'type'        => 'selectmultiple',
3164     'select_enum' => \@card_types,
3165   },
3166
3167   {
3168     'key'         => 'disable-fuzzy',
3169     'section'     => 'UI',
3170     'description' => 'Disable fuzzy searching.  Speeds up searching for large sites, but only shows exact matches.',
3171     'type'        => 'checkbox',
3172   },
3173
3174   { 'key'         => 'pkg_referral',
3175     'section'     => '',
3176     'description' => 'Enable package-specific advertising sources.',
3177     'type'        => 'checkbox',
3178   },
3179
3180   { 'key'         => 'pkg_referral-multiple',
3181     'section'     => '',
3182     'description' => 'In addition, allow multiple advertising sources to be associated with a single package.',
3183     'type'        => 'checkbox',
3184   },
3185
3186   {
3187     'key'         => 'dashboard-install_welcome',
3188     'section'     => 'UI',
3189     'description' => 'New install welcome screen.',
3190     'type'        => 'select',
3191     'select_enum' => [ '', 'ITSP_fsinc_hosted', ],
3192   },
3193
3194   {
3195     'key'         => 'dashboard-toplist',
3196     'section'     => 'UI',
3197     'description' => 'List of items to display on the top of the front page',
3198     'type'        => 'textarea',
3199   },
3200
3201   {
3202     'key'         => 'impending_recur_msgnum',
3203     'section'     => 'notification',
3204     'description' => 'Template to use for alerts about first-time recurring billing.',
3205     %msg_template_options,
3206   },
3207
3208   {
3209     'key'         => 'impending_recur_template',
3210     'section'     => 'deprecated',
3211     'description' => 'Template file for alerts about looming first time recurrant billing.  See the <a href="http://search.cpan.org/dist/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitition language.  Also see packages with a <a href="../browse/part_pkg.cgi">flat price plan</a>  The following variables are available<ul><li><code>$packages</code> allowing <code>$packages->[0]</code> thru <code>$packages->[n]</code> <li><code>$package</code> the first package, same as <code>$packages->[0]</code> <li><code>$recurdates</code> allowing <code>$recurdates->[0]</code> thru <code>$recurdates->[n]</code> <li><code>$recurdate</code> the first recurdate, same as <code>$recurdate->[0]</code> <li><code>$first</code> <li><code>$last</code></ul>',
3212 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
3213     'type'        => 'textarea',
3214   },
3215
3216   {
3217     'key'         => 'logo.png',
3218     'section'     => 'UI',  #'invoicing' ?
3219     'description' => 'Company logo for HTML invoices and the backoffice interface, in PNG format.  Suggested size somewhere near 92x62.',
3220     'type'        => 'image',
3221     'per_agent'   => 1, #XXX just view/logo.cgi, which is for the global
3222                         #old-style editor anyway...?
3223   },
3224
3225   {
3226     'key'         => 'logo.eps',
3227     'section'     => 'invoicing',
3228     'description' => 'Company logo for printed and PDF invoices, in EPS format.',
3229     'type'        => 'image',
3230     'per_agent'   => 1, #XXX as above, kinda
3231   },
3232
3233   {
3234     'key'         => 'selfservice-ignore_quantity',
3235     'section'     => 'self-service',
3236     'description' => 'Ignores service quantity restrictions in self-service context.  Strongly not recommended - just set your quantities correctly in the first place.',
3237     'type'        => 'checkbox',
3238   },
3239
3240   {
3241     'key'         => 'selfservice-session_timeout',
3242     'section'     => 'self-service',
3243     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
3244     'type'        => 'select',
3245     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
3246   },
3247
3248   {
3249     'key'         => 'disable_setup_suspended_pkgs',
3250     'section'     => 'billing',
3251     'description' => 'Disables charging of setup fees for suspended packages.',
3252     'type'        => 'checkbox',
3253   },
3254
3255   {
3256     'key'         => 'password-generated-allcaps',
3257     'section'     => 'password',
3258     'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
3259     'type'        => 'checkbox',
3260   },
3261
3262   {
3263     'key'         => 'datavolume-forcemegabytes',
3264     'section'     => 'UI',
3265     'description' => 'All data volumes are expressed in megabytes',
3266     'type'        => 'checkbox',
3267   },
3268
3269   {
3270     'key'         => 'datavolume-significantdigits',
3271     'section'     => 'UI',
3272     'description' => 'number of significant digits to use to represent data volumes',
3273     'type'        => 'text',
3274   },
3275
3276   {
3277     'key'         => 'disable_void_after',
3278     'section'     => 'billing',
3279     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
3280     'type'        => 'text',
3281   },
3282
3283   {
3284     'key'         => 'disable_line_item_date_ranges',
3285     'section'     => 'billing',
3286     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
3287     'type'        => 'checkbox',
3288   },
3289
3290   {
3291     'key'         => 'support_packages',
3292     'section'     => '',
3293     'description' => 'A list of packages eligible for RT ticket time transfer, one pkgpart per line.', #this should really be a select multiple, or specified in the packages themselves...
3294     'type'        => 'select-part_pkg',
3295     'multiple'    => 1,
3296   },
3297
3298   {
3299     'key'         => 'cust_main-require_phone',
3300     'section'     => '',
3301     'description' => 'Require daytime or night phone for all customer records.',
3302     'type'        => 'checkbox',
3303   },
3304
3305   {
3306     'key'         => 'cust_main-require_invoicing_list_email',
3307     'section'     => '',
3308     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
3309     'type'        => 'checkbox',
3310   },
3311
3312   {
3313     'key'         => 'svc_acct-display_paid_time_remaining',
3314     'section'     => '',
3315     'description' => 'Show paid time remaining in addition to time remaining.',
3316     'type'        => 'checkbox',
3317   },
3318
3319   {
3320     'key'         => 'cancel_credit_type',
3321     'section'     => 'billing',
3322     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
3323     'type'        => 'select-sub',
3324     'options_sub' => sub { require FS::Record;
3325                            require FS::reason_type;
3326                            map { $_->typenum => $_->type }
3327                                FS::Record::qsearch('reason_type', { class=>'R' } );
3328                          },
3329     'option_sub'  => sub { require FS::Record;
3330                            require FS::reason_type;
3331                            my $reason_type = FS::Record::qsearchs(
3332                              'reason_type', { 'typenum' => shift }
3333                            );
3334                            $reason_type ? $reason_type->type : '';
3335                          },
3336   },
3337
3338   {
3339     'key'         => 'referral_credit_type',
3340     'section'     => 'deprecated',
3341     'description' => 'Used to be the group to use for new, automatically generated credit reasons resulting from referrals.  Now set in a package billing event for the referral.',
3342     'type'        => 'select-sub',
3343     'options_sub' => sub { require FS::Record;
3344                            require FS::reason_type;
3345                            map { $_->typenum => $_->type }
3346                                FS::Record::qsearch('reason_type', { class=>'R' } );
3347                          },
3348     'option_sub'  => sub { require FS::Record;
3349                            require FS::reason_type;
3350                            my $reason_type = FS::Record::qsearchs(
3351                              'reason_type', { 'typenum' => shift }
3352                            );
3353                            $reason_type ? $reason_type->type : '';
3354                          },
3355   },
3356
3357   {
3358     'key'         => 'signup_credit_type',
3359     'section'     => 'billing', #self-service?
3360     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
3361     'type'        => 'select-sub',
3362     'options_sub' => sub { require FS::Record;
3363                            require FS::reason_type;
3364                            map { $_->typenum => $_->type }
3365                                FS::Record::qsearch('reason_type', { class=>'R' } );
3366                          },
3367     'option_sub'  => sub { require FS::Record;
3368                            require FS::reason_type;
3369                            my $reason_type = FS::Record::qsearchs(
3370                              'reason_type', { 'typenum' => shift }
3371                            );
3372                            $reason_type ? $reason_type->type : '';
3373                          },
3374   },
3375
3376   {
3377     'key'         => 'prepayment_discounts-credit_type',
3378     'section'     => 'billing',
3379     'description' => 'Enables the offering of prepayment discounts and establishes the credit reason type.',
3380     'type'        => 'select-sub',
3381     'options_sub' => sub { require FS::Record;
3382                            require FS::reason_type;
3383                            map { $_->typenum => $_->type }
3384                                FS::Record::qsearch('reason_type', { class=>'R' } );
3385                          },
3386     'option_sub'  => sub { require FS::Record;
3387                            require FS::reason_type;
3388                            my $reason_type = FS::Record::qsearchs(
3389                              'reason_type', { 'typenum' => shift }
3390                            );
3391                            $reason_type ? $reason_type->type : '';
3392                          },
3393
3394   },
3395
3396   {
3397     'key'         => 'cust_main-agent_custid-format',
3398     'section'     => '',
3399     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
3400     'type'        => 'select',
3401     'select_hash' => [
3402                        ''      => 'Numeric only',
3403                        '\d{7}' => 'Numeric only, exactly 7 digits',
3404                        'ww?d+' => 'Numeric with one or two letter prefix',
3405                      ],
3406   },
3407
3408   {
3409     'key'         => 'card_masking_method',
3410     'section'     => 'UI',
3411     'description' => 'Digits to display when masking credit cards.  Note that the first six digits are necessary to canonically identify the credit card type (Visa/MC, Amex, Discover, Maestro, etc.) in all cases.  The first four digits can identify the most common credit card types in most cases (Visa/MC, Amex, and Discover).  The first two digits can distinguish between Visa/MC and Amex.  Note: You should manually remove stored paymasks if you change this value on an existing database, to avoid problems using stored cards.',
3412     'type'        => 'select',
3413     'select_hash' => [
3414                        ''            => '123456xxxxxx1234',
3415                        'first6last2' => '123456xxxxxxxx12',
3416                        'first4last4' => '1234xxxxxxxx1234',
3417                        'first4last2' => '1234xxxxxxxxxx12',
3418                        'first2last4' => '12xxxxxxxxxx1234',
3419                        'first2last2' => '12xxxxxxxxxxxx12',
3420                        'first0last4' => 'xxxxxxxxxxxx1234',
3421                        'first0last2' => 'xxxxxxxxxxxxxx12',
3422                      ],
3423   },
3424
3425   {
3426     'key'         => 'disable_previous_balance',
3427     'section'     => 'invoicing',
3428     'description' => 'Disable inclusion of previous balance, payment, and credit lines on invoices',
3429     'type'        => 'checkbox',
3430   },
3431
3432   {
3433     'key'         => 'previous_balance-exclude_from_total',
3434     'section'     => 'invoicing',
3435     'description' => 'Do not include previous balance in the \'Total\' line.  Only meaningful when invoice_sections is false.  Optionally provide text to override the Total New Charges description',
3436     'type'        => [ qw(checkbox text) ],
3437   },
3438
3439   {
3440     'key'         => 'previous_balance-summary_only',
3441     'section'     => 'invoicing',
3442     'description' => 'Only show a single line summarizing the total previous balance rather than one line per invoice.',
3443     'type'        => 'checkbox',
3444   },
3445
3446   {
3447     'key'         => 'balance_due_below_line',
3448     'section'     => 'invoicing',
3449     'description' => 'Place the balance due message below a line.  Only meaningful when when invoice_sections is false.',
3450     'type'        => 'checkbox',
3451   },
3452
3453   {
3454     'key'         => 'usps_webtools-userid',
3455     'section'     => 'UI',
3456     'description' => 'Production UserID for USPS web tools.   Enables USPS address standardization.  See the <a href="http://www.usps.com/webtools/">USPS website</a>, register and agree not to use the tools for batch purposes.',
3457     'type'        => 'text',
3458   },
3459
3460   {
3461     'key'         => 'usps_webtools-password',
3462     'section'     => 'UI',
3463     'description' => 'Production password for USPS web tools.   Enables USPS address standardization.  See <a href="http://www.usps.com/webtools/">USPS website</a>, register and agree not to use the tools for batch purposes.',
3464     'type'        => 'text',
3465   },
3466
3467   {
3468     'key'         => 'cust_main-auto_standardize_address',
3469     'section'     => 'UI',
3470     'description' => 'When using USPS web tools, automatically standardize the address without asking.',
3471     'type'        => 'checkbox',
3472   },
3473
3474   {
3475     'key'         => 'cust_main-require_censustract',
3476     'section'     => 'UI',
3477     'description' => 'Customer is required to have a census tract.  Useful for FCC form 477 reports. See also: cust_main-auto_standardize_address',
3478     'type'        => 'checkbox',
3479   },
3480
3481   {
3482     'key'         => 'census_year',
3483     'section'     => 'UI',
3484     'description' => 'The year to use in census tract lookups',
3485     'type'        => 'select',
3486     'select_enum' => [ qw( 2010 2009 2008 ) ],
3487   },
3488
3489   {
3490     'key'         => 'company_latitude',
3491     'section'     => 'UI',
3492     'description' => 'Your company latitude (-90 through 90)',
3493     'type'        => 'text',
3494   },
3495
3496   {
3497     'key'         => 'company_longitude',
3498     'section'     => 'UI',
3499     'description' => 'Your company longitude (-180 thru 180)',
3500     'type'        => 'text',
3501   },
3502
3503   {
3504     'key'         => 'disable_acl_changes',
3505     'section'     => '',
3506     'description' => 'Disable all ACL changes, for demos.',
3507     'type'        => 'checkbox',
3508   },
3509
3510   {
3511     'key'         => 'disable_settings_changes',
3512     'section'     => '',
3513     'description' => 'Disable all settings changes, for demos, except for the usernames given in the comma-separated list.',
3514     'type'        => [qw( checkbox text )],
3515   },
3516
3517   {
3518     'key'         => 'cust_main-edit_agent_custid',
3519     'section'     => 'UI',
3520     'description' => 'Enable editing of the agent_custid field.',
3521     'type'        => 'checkbox',
3522   },
3523
3524   {
3525     'key'         => 'cust_main-default_agent_custid',
3526     'section'     => 'UI',
3527     'description' => 'Display the agent_custid field when available instead of the custnum field.',
3528     'type'        => 'checkbox',
3529   },
3530
3531   {
3532     'key'         => 'cust_main-title-display_custnum',
3533     'section'     => 'UI',
3534     'description' => 'Add the display_custom (agent_custid or custnum) to the title on customer view pages.',
3535     'type'        => 'checkbox',
3536   },
3537
3538   {
3539     'key'         => 'cust_bill-default_agent_invid',
3540     'section'     => 'UI',
3541     'description' => 'Display the agent_invid field when available instead of the invnum field.',
3542     'type'        => 'checkbox',
3543   },
3544
3545   {
3546     'key'         => 'cust_main-auto_agent_custid',
3547     'section'     => 'UI',
3548     'description' => 'Automatically assign an agent_custid - select format',
3549     'type'        => 'select',
3550     'select_hash' => [ '' => 'No',
3551                        '1YMMXXXXXXXX' => '1YMMXXXXXXXX',
3552                      ],
3553   },
3554
3555   {
3556     'key'         => 'cust_main-default_areacode',
3557     'section'     => 'UI',
3558     'description' => 'Default area code for customers.',
3559     'type'        => 'text',
3560   },
3561
3562   {
3563     'key'         => 'order_pkg-no_start_date',
3564     'section'     => 'UI',
3565     'description' => 'Don\'t set a default start date for new packages.',
3566     'type'        => 'checkbox',
3567   },
3568
3569   {
3570     'key'         => 'mcp_svcpart',
3571     'section'     => '',
3572     'description' => 'Master Control Program svcpart.  Leave this blank.',
3573     'type'        => 'text', #select-part_svc
3574   },
3575
3576   {
3577     'key'         => 'cust_bill-max_same_services',
3578     'section'     => 'invoicing',
3579     'description' => 'Maximum number of the same service to list individually on invoices before condensing to a single line listing the number of services.  Defaults to 5.',
3580     'type'        => 'text',
3581   },
3582
3583   {
3584     'key'         => 'cust_bill-consolidate_services',
3585     'section'     => 'invoicing',
3586     'description' => 'Consolidate service display into fewer lines on invoices rather than one per service.',
3587     'type'        => 'checkbox',
3588   },
3589
3590   {
3591     'key'         => 'suspend_email_admin',
3592     'section'     => '',
3593     'description' => 'Destination admin email address to enable suspension notices',
3594     'type'        => 'text',
3595   },
3596
3597   {
3598     'key'         => 'email_report-subject',
3599     'section'     => '',
3600     'description' => 'Subject for reports emailed by freeside-fetch.  Defaults to "Freeside report".',
3601     'type'        => 'text',
3602   },
3603
3604   {
3605     'key'         => 'selfservice-head',
3606     'section'     => 'self-service',
3607     'description' => 'HTML for the HEAD section of the self-service interface, typically used for LINK stylesheet tags',
3608     'type'        => 'textarea', #htmlarea?
3609     'per_agent'   => 1,
3610   },
3611
3612
3613   {
3614     'key'         => 'selfservice-body_header',
3615     'section'     => 'self-service',
3616     'description' => 'HTML header for the self-service interface',
3617     'type'        => 'textarea', #htmlarea?
3618     'per_agent'   => 1,
3619   },
3620
3621   {
3622     'key'         => 'selfservice-body_footer',
3623     'section'     => 'self-service',
3624     'description' => 'HTML footer for the self-service interface',
3625     'type'        => 'textarea', #htmlarea?
3626     'per_agent'   => 1,
3627   },
3628
3629
3630   {
3631     'key'         => 'selfservice-body_bgcolor',
3632     'section'     => 'self-service',
3633     'description' => 'HTML background color for the self-service interface, for example, #FFFFFF',
3634     'type'        => 'text',
3635     'per_agent'   => 1,
3636   },
3637
3638   {
3639     'key'         => 'selfservice-box_bgcolor',
3640     'section'     => 'self-service',
3641     'description' => 'HTML color for self-service interface input boxes, for example, #C0C0C0',
3642     'type'        => 'text',
3643     'per_agent'   => 1,
3644   },
3645
3646   {
3647     'key'         => 'selfservice-text_color',
3648     'section'     => 'self-service',
3649     'description' => 'HTML text color for the self-service interface, for example, #000000',
3650     'type'        => 'text',
3651     'per_agent'   => 1,
3652   },
3653
3654   {
3655     'key'         => 'selfservice-link_color',
3656     'section'     => 'self-service',
3657     'description' => 'HTML link color for the self-service interface, for example, #0000FF',
3658     'type'        => 'text',
3659     'per_agent'   => 1,
3660   },
3661
3662   {
3663     'key'         => 'selfservice-vlink_color',
3664     'section'     => 'self-service',
3665     'description' => 'HTML visited link color for the self-service interface, for example, #FF00FF',
3666     'type'        => 'text',
3667     'per_agent'   => 1,
3668   },
3669
3670   {
3671     'key'         => 'selfservice-hlink_color',
3672     'section'     => 'self-service',
3673     'description' => 'HTML hover link color for the self-service interface, for example, #808080',
3674     'type'        => 'text',
3675     'per_agent'   => 1,
3676   },
3677
3678   {
3679     'key'         => 'selfservice-alink_color',
3680     'section'     => 'self-service',
3681     'description' => 'HTML active (clicked) link color for the self-service interface, for example, #808080',
3682     'type'        => 'text',
3683     'per_agent'   => 1,
3684   },
3685
3686   {
3687     'key'         => 'selfservice-font',
3688     'section'     => 'self-service',
3689     'description' => 'HTML font CSS for the self-service interface, for example, 0.9em/1.5em Arial, Helvetica, Geneva, sans-serif',
3690     'type'        => 'text',
3691     'per_agent'   => 1,
3692   },
3693
3694   {
3695     'key'         => 'selfservice-title_color',
3696     'section'     => 'self-service',
3697     'description' => 'HTML color for the self-service title, for example, #000000',
3698     'type'        => 'text',
3699     'per_agent'   => 1,
3700   },
3701
3702   {
3703     'key'         => 'selfservice-title_align',
3704     'section'     => 'self-service',
3705     'description' => 'HTML alignment for the self-service title, for example, center',
3706     'type'        => 'text',
3707     'per_agent'   => 1,
3708   },
3709   {
3710     'key'         => 'selfservice-title_size',
3711     'section'     => 'self-service',
3712     'description' => 'HTML font size for the self-service title, for example, 3',
3713     'type'        => 'text',
3714     'per_agent'   => 1,
3715   },
3716
3717   {
3718     'key'         => 'selfservice-title_left_image',
3719     'section'     => 'self-service',
3720     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3721     'type'        => 'image',
3722     'per_agent'   => 1,
3723   },
3724
3725   {
3726     'key'         => 'selfservice-title_right_image',
3727     'section'     => 'self-service',
3728     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3729     'type'        => 'image',
3730     'per_agent'   => 1,
3731   },
3732
3733   {
3734     'key'         => 'selfservice-menu_skipblanks',
3735     'section'     => 'self-service',
3736     'description' => 'Skip blank (spacer) entries in the self-service menu',
3737     'type'        => 'checkbox',
3738     'per_agent'   => 1,
3739   },
3740
3741   {
3742     'key'         => 'selfservice-menu_skipheadings',
3743     'section'     => 'self-service',
3744     'description' => 'Skip the unclickable heading entries in the self-service menu',
3745     'type'        => 'checkbox',
3746     'per_agent'   => 1,
3747   },
3748
3749   {
3750     'key'         => 'selfservice-menu_bgcolor',
3751     'section'     => 'self-service',
3752     'description' => 'HTML color for the self-service menu, for example, #C0C0C0',
3753     'type'        => 'text',
3754     'per_agent'   => 1,
3755   },
3756
3757   {
3758     'key'         => 'selfservice-menu_fontsize',
3759     'section'     => 'self-service',
3760     'description' => 'HTML font size for the self-service menu, for example, -1',
3761     'type'        => 'text',
3762     'per_agent'   => 1,
3763   },
3764   {
3765     'key'         => 'selfservice-menu_nounderline',
3766     'section'     => 'self-service',
3767     'description' => 'Styles menu links in the self-service without underlining.',
3768     'type'        => 'checkbox',
3769     'per_agent'   => 1,
3770   },
3771
3772
3773   {
3774     'key'         => 'selfservice-menu_top_image',
3775     'section'     => 'self-service',
3776     'description' => 'Image used for the top of the menu in the self-service interface, in PNG format.',
3777     'type'        => 'image',
3778     'per_agent'   => 1,
3779   },
3780
3781   {
3782     'key'         => 'selfservice-menu_body_image',
3783     'section'     => 'self-service',
3784     'description' => 'Repeating image used for the body of the menu in the self-service interface, in PNG format.',
3785     'type'        => 'image',
3786     'per_agent'   => 1,
3787   },
3788
3789   {
3790     'key'         => 'selfservice-menu_bottom_image',
3791     'section'     => 'self-service',
3792     'description' => 'Image used for the bottom of the menu in the self-service interface, in PNG format.',
3793     'type'        => 'image',
3794     'per_agent'   => 1,
3795   },
3796
3797   {
3798     'key'         => 'selfservice-bulk_format',
3799     'section'     => 'deprecated',
3800     'description' => 'Parameter arrangement for selfservice bulk features',
3801     'type'        => 'select',
3802     'select_enum' => [ '', 'izoom-soap', 'izoom-ftp' ],
3803     'per_agent'   => 1,
3804   },
3805
3806   {
3807     'key'         => 'selfservice-bulk_ftp_dir',
3808     'section'     => 'deprecated',
3809     'description' => 'Enable bulk ftp provisioning in this folder',
3810     'type'        => 'text',
3811     'per_agent'   => 1,
3812   },
3813
3814   {
3815     'key'         => 'signup-no_company',
3816     'section'     => 'self-service',
3817     'description' => "Don't display a field for company name on signup.",
3818     'type'        => 'checkbox',
3819   },
3820
3821   {
3822     'key'         => 'signup-recommend_email',
3823     'section'     => 'self-service',
3824     'description' => 'Encourage the entry of an invoicing email address on signup.',
3825     'type'        => 'checkbox',
3826   },
3827
3828   {
3829     'key'         => 'signup-recommend_daytime',
3830     'section'     => 'self-service',
3831     'description' => 'Encourage the entry of a daytime phone number  invoicing email address on signup.',
3832     'type'        => 'checkbox',
3833   },
3834
3835   {
3836     'key'         => 'svc_phone-radius-default_password',
3837     'section'     => 'telephony',
3838     'description' => 'Default password when exporting svc_phone records to RADIUS',
3839     'type'        => 'text',
3840   },
3841
3842   {
3843     'key'         => 'svc_phone-allow_alpha_phonenum',
3844     'section'     => 'telephony',
3845     'description' => 'Allow letters in phone numbers.',
3846     'type'        => 'checkbox',
3847   },
3848
3849   {
3850     'key'         => 'svc_phone-domain',
3851     'section'     => 'telephony',
3852     'description' => 'Track an optional domain association with each phone service.',
3853     'type'        => 'checkbox',
3854   },
3855
3856   {
3857     'key'         => 'svc_phone-phone_name-max_length',
3858     'section'     => 'telephony',
3859     'description' => 'Maximum length of the phone service "Name" field (svc_phone.phone_name).  Sometimes useful to limit this (to 15?) when exporting as Caller ID data.',
3860     'type'        => 'text',
3861   },
3862   
3863   {
3864     'key'         => 'svc_phone-lnp',
3865     'section'     => 'telephony',
3866     'description' => 'Enables Number Portability features for svc_phone',
3867     'type'        => 'checkbox',
3868   },
3869
3870   {
3871     'key'         => 'default_phone_countrycode',
3872     'section'     => '',
3873     'description' => 'Default countrcode',
3874     'type'        => 'text',
3875   },
3876
3877   {
3878     'key'         => 'cdr-charged_party-field',
3879     'section'     => 'telephony',
3880     'description' => 'Set the charged_party field of CDRs to this field.',
3881     'type'        => 'select-sub',
3882     'options_sub' => sub { my $fields = FS::cdr->table_info->{'fields'};
3883                            map { $_ => $fields->{$_}||$_ }
3884                            grep { $_ !~ /^(acctid|charged_party)$/ }
3885                            FS::Schema::dbdef->table('cdr')->columns;
3886                          },
3887     'option_sub'  => sub { my $f = shift;
3888                            FS::cdr->table_info->{'fields'}{$f} || $f;
3889                          },
3890   },
3891
3892   #probably deprecate in favor of cdr-charged_party-field above
3893   {
3894     'key'         => 'cdr-charged_party-accountcode',
3895     'section'     => 'telephony',
3896     'description' => 'Set the charged_party field of CDRs to the accountcode.',
3897     'type'        => 'checkbox',
3898   },
3899
3900   {
3901     'key'         => 'cdr-charged_party-accountcode-trim_leading_0s',
3902     'section'     => 'telephony',
3903     'description' => 'When setting the charged_party field of CDRs to the accountcode, trim any leading zeros.',
3904     'type'        => 'checkbox',
3905   },
3906
3907 #  {
3908 #    'key'         => 'cdr-charged_party-truncate_prefix',
3909 #    'section'     => '',
3910 #    'description' => 'If the charged_party field has this prefix, truncate it to the length in cdr-charged_party-truncate_length.',
3911 #    'type'        => 'text',
3912 #  },
3913 #
3914 #  {
3915 #    'key'         => 'cdr-charged_party-truncate_length',
3916 #    'section'     => '',
3917 #    'description' => 'If the charged_party field has the prefix in cdr-charged_party-truncate_prefix, truncate it to this length.',
3918 #    'type'        => 'text',
3919 #  },
3920
3921   {
3922     'key'         => 'cdr-charged_party_rewrite',
3923     'section'     => 'telephony',
3924     'description' => 'Do charged party rewriting in the freeside-cdrrewrited daemon; useful if CDRs are being dropped off directly in the database and require special charged_party processing such as cdr-charged_party-accountcode or cdr-charged_party-truncate*.',
3925     'type'        => 'checkbox',
3926   },
3927
3928   {
3929     'key'         => 'cdr-taqua-da_rewrite',
3930     'section'     => '',
3931     'description' => 'For the Taqua CDR format, a comma-separated list of directory assistance 800 numbers.  Any CDRs with these numbers as "BilledNumber" will be rewritten to the "CallingPartyNumber" (and CallType "12") on import.',
3932     'type'        => 'text',
3933   },
3934
3935   {
3936     'key'         => 'cust_pkg-show_autosuspend',
3937     'section'     => 'UI',
3938     'description' => 'Show package auto-suspend dates.  Use with caution for now; can slow down customer view for large insallations.',
3939     'type'        => 'checkbox',
3940   },
3941
3942   {
3943     'key'         => 'cdr-asterisk_forward_rewrite',
3944     'section'     => 'telephony',
3945     'description' => 'Enable special processing for CDRs representing forwarded calls: For CDRs that have a dcontext that starts with "Local/" but does not match dst, set charged_party to dst, parse a new dst from dstchannel, and set amaflags to "2" ("BILL"/"BILLING").',
3946     'type'        => 'checkbox',
3947   },
3948
3949   {
3950     'key'         => 'sg-multicustomer_hack',
3951     'section'     => '',
3952     'description' => "Don't use this.",
3953     'type'        => 'checkbox',
3954   },
3955
3956   {
3957     'key'         => 'sg-ping_username',
3958     'section'     => '',
3959     'description' => "Don't use this.",
3960     'type'        => 'text',
3961   },
3962
3963   {
3964     'key'         => 'sg-ping_password',
3965     'section'     => '',
3966     'description' => "Don't use this.",
3967     'type'        => 'text',
3968   },
3969
3970   {
3971     'key'         => 'sg-login_username',
3972     'section'     => '',
3973     'description' => "Don't use this.",
3974     'type'        => 'text',
3975   },
3976
3977   {
3978     'key'         => 'mc-outbound_packages',
3979     'section'     => '',
3980     'description' => "Don't use this.",
3981     'type'        => 'select-part_pkg',
3982     'multiple'    => 1,
3983   },
3984
3985   {
3986     'key'         => 'disable-cust-pkg_class',
3987     'section'     => 'UI',
3988     'description' => 'Disable the two-step dropdown for selecting package class and package, and return to the classic single dropdown.',
3989     'type'        => 'checkbox',
3990   },
3991
3992   {
3993     'key'         => 'queued-max_kids',
3994     'section'     => '',
3995     'description' => 'Maximum number of queued processes.  Defaults to 10.',
3996     'type'        => 'text',
3997   },
3998
3999   {
4000     'key'         => 'queued-sleep_time',
4001     'section'     => '',
4002     'description' => 'Time to sleep between attempts to find new jobs to process in the queue.  Defaults to 10.  Installations doing real-time CDR processing for prepaid may want to set it lower.',
4003     'type'        => 'text',
4004   },
4005
4006   {
4007     'key'         => 'cancelled_cust-noevents',
4008     'section'     => 'billing',
4009     'description' => "Don't run events for cancelled customers",
4010     'type'        => 'checkbox',
4011   },
4012
4013   {
4014     'key'         => 'agent-invoice_template',
4015     'section'     => 'invoicing',
4016     'description' => 'Enable display/edit of old-style per-agent invoice template selection',
4017     'type'        => 'checkbox',
4018   },
4019
4020   {
4021     'key'         => 'svc_broadband-manage_link',
4022     'section'     => 'UI',
4023     'description' => 'URL for svc_broadband "Manage Device" link.  The following substitutions are available: $ip_addr.',
4024     'type'        => 'text',
4025   },
4026
4027   #more fine-grained, service def-level control could be useful eventually?
4028   {
4029     'key'         => 'svc_broadband-allow_null_ip_addr',
4030     'section'     => '',
4031     'description' => '',
4032     'type'        => 'checkbox',
4033   },
4034
4035   {
4036     'key'         => 'tax-report_groups',
4037     'section'     => '',
4038     'description' => 'List of grouping possibilities for tax names on reports, one per line, "label op value" (op can be = or !=).',
4039     'type'        => 'textarea',
4040   },
4041
4042   {
4043     'key'         => 'tax-cust_exempt-groups',
4044     'section'     => '',
4045     'description' => 'List of grouping possibilities for tax names, for per-customer exemption purposes, one tax name per line.  For example, "GST" would indicate the ability to exempt customers individually from taxes named "GST" (but not other taxes).',
4046     'type'        => 'textarea',
4047   },
4048
4049   {
4050     'key'         => 'cust_main-default_view',
4051     'section'     => 'UI',
4052     'description' => 'Default customer view, for users who have not selected a default view in their preferences.',
4053     'type'        => 'select',
4054     'select_hash' => [
4055       #false laziness w/view/cust_main.cgi and pref/pref.html
4056       'basics'          => 'Basics',
4057       'notes'           => 'Notes',
4058       'tickets'         => 'Tickets',
4059       'packages'        => 'Packages',
4060       'payment_history' => 'Payment History',
4061       'change_history'  => 'Change History',
4062       'jumbo'           => 'Jumbo',
4063     ],
4064   },
4065
4066   {
4067     'key'         => 'enable_tax_adjustments',
4068     'section'     => 'billing',
4069     'description' => 'Enable the ability to add manual tax adjustments.',
4070     'type'        => 'checkbox',
4071   },
4072
4073   {
4074     'key'         => 'rt-crontool',
4075     'section'     => '',
4076     'description' => 'Enable the RT CronTool extension.',
4077     'type'        => 'checkbox',
4078   },
4079
4080   {
4081     'key'         => 'pkg-balances',
4082     'section'     => 'billing',
4083     'description' => 'Enable experimental package balances.  Not recommended for general use.',
4084     'type'        => 'checkbox',
4085   },
4086
4087   {
4088     'key'         => 'pkg-addon_classnum',
4089     'section'     => 'billing',
4090     'description' => 'Enable the ability to restrict additional package orders based on package class.',
4091     'type'        => 'checkbox',
4092   },
4093
4094   {
4095     'key'         => 'cust_main-edit_signupdate',
4096     'section'     => 'UI',
4097     'descritpion' => 'Enable manual editing of the signup date.',
4098     'type'        => 'checkbox',
4099   },
4100
4101   {
4102     'key'         => 'svc_acct-disable_access_number',
4103     'section'     => 'UI',
4104     'descritpion' => 'Disable access number selection.',
4105     'type'        => 'checkbox',
4106   },
4107
4108   {
4109     'key'         => 'cust_bill_pay_pkg-manual',
4110     'section'     => 'UI',
4111     'description' => 'Allow manual application of payments to line items.',
4112     'type'        => 'checkbox',
4113   },
4114
4115   {
4116     'key'         => 'cust_credit_bill_pkg-manual',
4117     'section'     => 'UI',
4118     'description' => 'Allow manual application of credits to line items.',
4119     'type'        => 'checkbox',
4120   },
4121
4122   {
4123     'key'         => 'breakage-days',
4124     'section'     => 'billing',
4125     'description' => 'If set to a number of days, after an account goes that long without activity, recognizes any outstanding payments and credits as "breakage" by creating a breakage charge and invoice.',
4126     'type'        => 'text',
4127     'per_agent'   => 1,
4128   },
4129
4130   {
4131     'key'         => 'breakage-pkg_class',
4132     'section'     => 'billing',
4133     'description' => 'Package class to use for breakage reconciliation.',
4134     'type'        => 'select-pkg_class',
4135   },
4136
4137   {
4138     'key'         => 'disable_cron_billing',
4139     'section'     => 'billing',
4140     'description' => 'Disable billing and collection from being run by freeside-daily and freeside-monthly, while still allowing other actions to run, such as notifications and backup.',
4141     'type'        => 'checkbox',
4142   },
4143
4144   {
4145     'key'         => 'svc_domain-edit_domain',
4146     'section'     => '',
4147     'description' => 'Enable domain renaming',
4148     'type'        => 'checkbox',
4149   },
4150
4151   {
4152     'key'         => 'enable_legacy_prepaid_income',
4153     'section'     => '',
4154     'description' => "Enable legacy prepaid income reporting.  Only useful when you have imported pre-Freeside packages with longer-than-monthly duration, and need to do prepaid income reporting on them before they've been invoiced the first time.",
4155     'type'        => 'checkbox',
4156   },
4157
4158   {
4159     'key'         => 'cust_main-exports',
4160     'section'     => '',
4161     'description' => 'Export(s) to call on cust_main insert, modification and deletion.',
4162     'type'        => 'select-sub',
4163     'multiple'    => 1,
4164     'options_sub' => sub {
4165       require FS::Record;
4166       require FS::part_export;
4167       my @part_export =
4168         map { qsearch( 'part_export', {exporttype => $_ } ) }
4169           keys %{FS::part_export::export_info('cust_main')};
4170       map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
4171     },
4172     'option_sub'  => sub {
4173       require FS::Record;
4174       require FS::part_export;
4175       my $part_export = FS::Record::qsearchs(
4176         'part_export', { 'exportnum' => shift }
4177       );
4178       $part_export
4179         ? $part_export->exporttype.' to '.$part_export->machine
4180         : '';
4181     },
4182   },
4183
4184   {
4185     'key'         => 'cust_tag-location',
4186     'section'     => 'UI',
4187     'description' => 'Location where customer tags are displayed.',
4188     'type'        => 'select',
4189     'select_enum' => [ 'misc_info', 'top' ],
4190   },
4191
4192   {
4193     'key'         => 'maestro-status_test',
4194     'section'     => 'UI',
4195     'description' => 'Display a link to the maestro status test page on the customer view page',
4196     'type'        => 'checkbox',
4197   },
4198
4199   {
4200     'key'         => 'cust_main-custom_link',
4201     'section'     => 'UI',
4202     'description' => 'URL to use as source for the "Custom" tab in the View Customer page.  The custnum will be appended.',
4203     'type'        => 'text',
4204   },
4205
4206   {
4207     'key'         => 'cust_main-custom_title',
4208     'section'     => 'UI',
4209     'description' => 'Title for the "Custom" tab in the View Customer page.',
4210     'type'        => 'text',
4211   },
4212
4213   {
4214     'key'         => 'part_pkg-default_suspend_bill',
4215     'section'     => 'billing',
4216     'description' => 'Default the "Continue recurring billing while suspended" flag to on for new package definitions.',
4217     'type'        => 'checkbox',
4218   },
4219   
4220   {
4221     'key'         => 'qual-alt-address-format',
4222     'section'     => 'UI',
4223     'description' => 'Enable the alternate address format (location type, number, and kind) on qualifications',
4224     'type'        => 'checkbox',
4225   },
4226   
4227   {
4228     'key'         => 'note-classes',
4229     'section'     => 'UI',
4230     'description' => 'Use customer note classes',
4231     'type'        => 'select',
4232     'select_hash' => [
4233                        0 => 'Disabled',
4234                        1 => 'Enabled',
4235                        2 => 'Enabled, with tabs',
4236                      ],
4237   },
4238
4239   {
4240     'key'         => 'svc_acct-cf_privatekey-message',
4241     'section'     => '',
4242     'description' => 'For internal use: HTML displayed when cf_privatekey field is set.',
4243     'type'        => 'textarea',
4244   },
4245
4246   {
4247     'key'         => 'menu-prepend_links',
4248     'section'     => 'UI',
4249     'description' => 'Links to prepend to the main menu, one per line, with format "URL Link Label (optional ALT popup)".',
4250     'type'        => 'textarea',
4251   },
4252
4253   {
4254     'key'         => 'cust_main-external_links',
4255     'section'     => 'UI',
4256     'description' => 'External links available in customer view, one per line, with format "URL Link Label (optional ALT popup)".  The URL will have custnum appended.',
4257     'type'        => 'textarea',
4258   },
4259   
4260   {
4261     'key'         => 'svc_phone-did-summary',
4262     'section'     => 'invoicing',
4263     'description' => 'Enable DID activity summary for past 30 days on invoices, showing # DIDs activated/deactivated/ported-in/ported-out and total minutes usage',
4264     'type'        => 'checkbox',
4265   },
4266   
4267   {
4268     'key'         => 'opensips_gwlist',
4269     'section'     => 'telephony',
4270     'description' => 'For svc_phone OpenSIPS dr_rules export, gwlist column value, per-agent',
4271     'type'        => 'text',
4272     'per_agent'   => 1,
4273     'agentonly'   => 1,
4274   },
4275
4276   {
4277     'key'         => 'opensips_description',
4278     'section'     => 'telephony',
4279     'description' => 'For svc_phone OpenSIPS dr_rules export, description column value, per-agent',
4280     'type'        => 'text',
4281     'per_agent'   => 1,
4282     'agentonly'   => 1,
4283   },
4284   
4285   {
4286     'key'         => 'opensips_route',
4287     'section'     => 'telephony',
4288     'description' => 'For svc_phone OpenSIPS dr_rules export, routeid column value, per-agent',
4289     'type'        => 'text',
4290     'per_agent'   => 1,
4291     'agentonly'   => 1,
4292   },
4293
4294   {
4295     'key'         => 'cust_bill-no_recipients-error',
4296     'section'     => 'invoicing',
4297     'description' => 'For customers with no invoice recipients, throw a job queue error rather than the default behavior of emailing the invoice to the invoice_from address.',
4298     'type'        => 'checkbox',
4299   },
4300
4301   {
4302     'key'         => 'cust_main-status_module',
4303     'section'     => 'UI',
4304     'description' => 'Which module to use for customer status display.  The "Classic" module (the default) considers accounts with cancelled recurring packages but un-cancelled one-time charges Inactive.  The "Recurring" module considers those customers Cancelled.  Similarly for customers with suspended recurring packages but one-time charges.', #other differences?
4305     'type'        => 'select',
4306     'select_enum' => [ 'Classic', 'Recurring' ],
4307   },
4308
4309   { 
4310     'key'         => 'username-pound',
4311     'section'     => 'username',
4312     'description' => 'Allow the pound character (#) in usernames.',
4313     'type'        => 'checkbox',
4314   },
4315
4316   {
4317     'key'         => 'ie-compatibility_mode',
4318     'section'     => 'UI',
4319     'description' => "Compatibility mode META tag for Internet Explorer, used on the customer view page.  Not necessary in normal operation unless custom content (notes, cust_main-custom_link) is included on customer view that is incompatibile with newer IE verisons.",
4320     'type'        => 'select',
4321     'select_enum' => [ '', '7', 'EmulateIE7', '8', 'EmulateIE8' ],
4322   },
4323
4324   { key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4325   { key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4326   { key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4327   { key => "bindprimary", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4328   { key => "bindsecondaries", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4329   { key => "bsdshellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4330   { key => "cyrus", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4331   { key => "cp_app", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4332   { key => "erpcdmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4333   { key => "icradiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4334   { key => "icradius_mysqldest", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4335   { key => "icradius_mysqlsource", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4336   { key => "icradius_secrets", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4337   { key => "maildisablecatchall", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4338   { key => "mxmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4339   { key => "nsmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4340   { key => "arecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4341   { key => "cnamerecords", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4342   { key => "nismachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4343   { key => "qmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4344   { key => "radiusmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4345   { key => "sendmailconfigpath", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4346   { key => "sendmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4347   { key => "sendmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4348   { key => "shellmachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4349   { key => "shellmachine-useradd", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4350   { key => "shellmachine-userdel", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4351   { key => "shellmachine-usermod", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4352   { key => "shellmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4353   { key => "radiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4354   { key => "textradiusprepend", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4355   { key => "username_policy", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4356   { key => "vpopmailmachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4357   { key => "vpopmailrestart", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4358   { key => "safe-part_pkg", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4359   { key => "selfservice_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4360   { key => "signup_server-quiet", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4361   { key => "signup_server-email", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4362   { key => "vonage-username", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4363   { key => "vonage-password", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4364   { key => "vonage-fromnumber", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
4365
4366 );
4367
4368 1;
4369